merge commit

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Changed
+- Master Data Builder usage
+- New function that extends MD Client to use a specific schema
+
 ## [1.7.0] - 2023-10-09
 
 ## [1.6.1] - 2023-10-09

manifest.json

@@ -27,7 +27,6 @@
     "node": "6.x",
     "docs": "0.x",
     "react": "3.x",
-    "masterdata": "1.x",
     "graphql": "1.x",
     "store": "0.x",
     "messages": "1.x",
@@ -97,9 +96,7 @@
   },
   "billingOptions": {
     "type": "free",
-    "availableCountries": [
-      "*"
-    ],
+    "availableCountries": ["*"],
     "support": {
       "url": "https://support.vtex.com/hc/requests"
     }

node/clients/index.ts

@@ -6,16 +6,23 @@ import AuthenticationClient from './authenticationClient'
 import CheckoutExtended from './checkout'
 import IdentityClient from './IdentityClient'
 import VtexId from './vtexId'
+import { withCustomSchema } from '../utils/withCustomSchema'
 
 export class Clients extends IOClients {
   public get affiliates() {
-    return this.getOrSet('affiliates', masterDataFor<Affiliates>('affiliates'))
+    return this.getOrSet(
+      'affiliates',
+      withCustomSchema('1.7.0', masterDataFor<Affiliates>('affiliates'))
+    )
   }
 
   public get userAffiliation() {
     return this.getOrSet(
       'userAffiliation',
-      masterDataFor<UserAffiliation>('userAffiliation')
+      withCustomSchema(
+        '1.7.0',
+        masterDataFor<UserAffiliation>('userAffiliation')
+      )
     )
   }
 

node/utils/withCustomSchema.ts

@@ -0,0 +1,88 @@
+import type { InstanceOptions, IOContext } from '@vtex/api'
+import type { PaginationArgs, WithMetadata } from '@vtex/clients'
+import { MasterDataEntity } from '@vtex/clients'
+
+type ScrollInput<K> = {
+  fields: Array<ThisType<K> | '_all'>
+  sort?: string
+  size?: number
+  mdToken?: string
+}
+
+export const withCustomSchema = <TEntity extends Record<string, unknown>>(
+  schema: string,
+  _MasterdataClient: new (
+    context: IOContext,
+    options?: InstanceOptions
+  ) => MasterDataEntity<TEntity>
+): new (
+  context: IOContext,
+  options?: InstanceOptions
+) => MasterDataEntity<TEntity> => {
+  return class extends MasterDataEntity<TEntity> {
+    public dataEntity: string
+    public schema: string
+    public client: MasterDataEntity<TEntity>
+
+    constructor(ctx: IOContext, options?: InstanceOptions) {
+      super(ctx, options)
+      this.client = new _MasterdataClient(ctx, options)
+      this.dataEntity = this.client.dataEntity
+      this.schema = schema
+      this.client.schema = schema
+    }
+
+    public save(entity: TEntity) {
+      return this.client.save(entity)
+    }
+
+    public update(id: string, fields: Partial<TEntity>) {
+      return this.client.update(id, fields)
+    }
+
+    public saveOrUpdate(fields: TEntity & { id: string }) {
+      return this.client.saveOrUpdate(fields)
+    }
+
+    public delete(id: string) {
+      return this.client.delete(id)
+    }
+
+    // These es-lint disables are needed because I have to extend the class and its methods surpass the max params.
+    // eslint-disable-next-line max-params
+    public search<K extends keyof WithMetadata<TEntity>>(
+      pagination: PaginationArgs,
+      fields: Array<ThisType<K> | '_all'>,
+      sort?: string,
+      where?: string
+    ): Promise<Array<Pick<WithMetadata<TEntity>, K>>> {
+      return this.client.search(pagination, fields, sort, where)
+    }
+
+    // eslint-disable-next-line max-params
+    public searchRaw<K extends keyof WithMetadata<TEntity>>(
+      pagination: PaginationArgs,
+      fields: Array<ThisType<K> | '_all'>,
+      sort?: string,
+      where?: string
+    ): Promise<{
+      data: Array<Pick<WithMetadata<TEntity>, K>>
+      pagination: { total: number; page: number; pageSize: number }
+    }> {
+      return this.client.searchRaw(pagination, fields, sort, where)
+    }
+
+    public get<K extends keyof WithMetadata<TEntity>>(
+      id: string,
+      fields: Array<ThisType<K> | '_all'>
+    ) {
+      return this.client.get(id, fields)
+    }
+
+    public async scroll<K extends keyof WithMetadata<TEntity>>(
+      input: ScrollInput<K>
+    ) {
+      return this.client.scroll(input)
+    }
+  }
+}