Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vtex/io-clients
https://github.com/vtex/io-clients
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/vtex/io-clients
- Owner: vtex
- Created: 2020-08-19T18:59:36.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-28T19:05:46.000Z (about 1 year ago)
- Last Synced: 2024-11-18T14:55:38.686Z (about 2 months ago)
- Language: TypeScript
- Size: 1.49 MB
- Stars: 27
- Watchers: 22
- Forks: 18
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
VTEX IO Clients
Collection of ready-to-use VTEX IO Clients to access VTEX APIs
This exports **Clients**, **Client Factories** and Typescript **typings** to help you connecting a VTEX IO application with VTEX Core Commerce modules on Node.js services.
## Installing
```
yarn add @vtex/clients
```
## Available Clients
| **Client Name** | **Implemented Methods** | Observations |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Affiliate | `registerAffiliate`, `changeNotification`, `createSeller`, `getSellerList` | - |
| Catalog | `getProductsAndSkus`, `getSkuById`, `changeNotification`, `createSeller`, `getSellerList`, `getSellerById`, `getSkuContext`, `getCategoryById`, `getBrandById` | - |
| Checkout | `getOrderFormConfiguration`, `setOrderFormConfiguration`, `setSingleCustomData` | - |
| Logistics | `getDockById`, `pickupById`, `listPickupPoints`, `nearPickupPoints`, `shipping`, `listInventoryBySku` | - |
| OMS | `listOrders`, `userLastOrder`, `order`, `orderNotification`, `cancelOrder` | - |
| OMS Proxy | `orders`, `orderFormId`, `customData`, `register` | You will have to declare a dependency and a policy on your app. You can check out [this document](https://www.notion.so/How-to-use-the-OMS-API-Proxy-application-e82f11ff896247c58a7e2e658d631516). |
| Rates and Benefits | `getAllBenefits`, `getPromotionById`, `createOrUpdatePromotion`, `createMultipleSkuPromotion`, `updateMultipleSkuPromotion` | Uses ADMIN_TOKEN as authMethod by default. |
| Suggestions | `getAllSuggestions`, `getSuggestionById`, `sendSkuSuggestion`, `deleteSkuSuggestion`, `getAllVersions`, `getVersionById` | - |
## Available Factories
| **Factory** | **Implemented Methods** | Observations |
| ----------- | ------------------------------------------------------------------------ | ---------------------------------------- |
| Master Data | `get`, `save`, `update`, `saveOrUpdate`, `saveOrUpdatePartial`, `delete`, `search`, `searchRaw`, `scroll` | Use the `masterDataFor` helper function. |
| VBase | `get`, `getRaw`, `getWithMetadata`, `save`, `trySaveIfhashMatches` | Use the `vbaseFor` helper function. |
---
> Note: Some of the methods might need some policies to be inserted on your application's `manifest.json` file.
> Master Data Builder: There are two versions of Master Data Builder version 1.x and 2.x both can be used. Version 2.x presents a new feature to create schemas more intelligently, avoiding their excessive creation. To use version 2.x, it is important to make this explicit in the app's Manifest and pass the new major parameter in the masterDataFor function (e.g. masterDataFor('books', undefined, 2))
## How to use
1. Install this package on the `node/` folder of your VTEX IO app:
```
yarn add @vtex/clients
```
### Clients
1. Import the individual Client on your app's Clients configuration (`node/clients/index.ts`):
```typescript
import { Catalog } from '@vtex/clients'
```
2. Add a new getter on the `Clients` class with the imported Client:
```typescript
public get catalog() {
return this.getOrSet('catalog', Catalog)
}
```
3. Now, you can use the available client's on the app's _resolver functions_!
```typescript
ctx.clients.catalog.getSkuById(...)
```
### Factories
1. Import the helper method for the Factory you want to use:
```typescript
import { masterDataFor, vbaseFor } from '@vtex/clients
```
2. Following the instructions for each factory, use its method to create a Client class.
```typescript
const BooksClient = masterDataFor('books')
const ContractsClient = vbaseFor('contracts')
// Optional - Export the type to be able to use it as a type parameter
export type ContractsClient = InstanceType
```
> 🚨 Warning: If you are NOT using the version 1.x of Masterdata builder, you should call masterDataFor passing the major version being used as the third parameter ```masterDataFor('books', undefined, 2)```.
3. Add new getters on the `Clients` class with the created Client:
```typescript
public get books() {
return this.getOrSet('books', BooksClient)
}
public get contracts() {
return this.getOrSet('contracts', ContractsClient)
}
```
4. Now, you can use the client with the provided methods by the Factory on your app's resolvers.
```typescript
ctx.clients.books.save({ name: 'Example Book' })
ctx.clients.contracts.save('example-key', { id: 'example-id' })
```
For more information, read [How to use and create Clients on VTEX IO](https://www.notion.so/How-to-use-and-create-Clients-on-VTEX-IO-1dbd20c928c642d0ba059d5efbe7874b).
## Authorization
Every Client method should accept an option `authMethod` parameter that declares which token will be used on that HTTP call. By default, **the request will use the `authToken` of the app**.
Here are the available options for that parameter:
| **Option** | **Description** |
|-------------|--------------------------------------------------|
| AUTH_TOKEN | Use the current app's token _(default)_ |
| STORE_TOKEN | Use the current authenticated store user's token |
| ADMIN_TOKEN | Use the current authenticated admin user's token |
## API Reference
To discover and learn more about VTEX Core Commerce APIs, read [VTEX Developer Portal](https://developers.vtex.com/reference).
## Contributing
Feel free to **submit new Clients** to this package, as long as they help to connect with VTEX Core Commerce APIs.
In order to test your new feature or fix using `vtex link` (command used for linking a service application in IO, for example), follow these steps:
- Guarantee that `@vtex/api` version is the same in both IO service and `@vtex/clients`;
- Run `yarn && yarn install-peers` in package;
- Run `yarn build && yarn unlink && yarn link` in package;
- Delete `node_modules` inside your service application (this step is not obligatory but might fix some issues);
- You might need to remove the dependency `@vtex/clients` from your service's `package.json` to avoid conflicts;
- Run `yarn unlink @vtex/clients && yarn link @vtex/clients && yarn` in your service;
- Now you can link your service application with `vtex link`.
## Releasing
We have a Github Action configured to **release the package on NPM for every Release tag** pushed into the repository. So, in order to have this project published:
1. Merge the Pull Request on the main branch, after having your changes approved.
2. Run `git checkout master && git pull` on your local repository.
3. Use the [releasy](https://www.npmjs.com/package/releasy) tool to push a new release (_e.g_: `releasy minor --stable`).
4. Check the result of the process on Github checking the status on the latest commit.