Merge pull request #146 from vtex/schema-client

Feature / Schema client

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Added
+
+- Schema client created
+
 ## [1.5.3] - 2023-05-04
 
 ### Fixed

node/clients/index.ts

@@ -4,6 +4,7 @@ import type { Affiliates, UserAffiliation } from 'vtex.affiliates'
 
 import AuthenticationClient from './authenticationClient'
 import CheckoutExtended from './checkout'
+import SchemasClient from './schemas'
 
 export class Clients extends IOClients {
   public get affiliates() {
@@ -24,4 +25,8 @@ export class Clients extends IOClients {
   public get authentication() {
     return this.getOrSet('authentication', AuthenticationClient)
   }
+
+  public get schemas() {
+    return this.getOrSet('schemas', SchemasClient)
+  }
 }

node/clients/schemas.ts

@@ -0,0 +1,33 @@
+import type { InstanceOptions, IOContext, RequestConfig } from '@vtex/api'
+import { ExternalClient } from '@vtex/api'
+
+const routes = {
+  schemas: (dataEntity: string) => `/dataentities/${dataEntity}/schemas`,
+  delete: (dataEntity: string, schemaName: string) =>
+    `dataentities/${dataEntity}/schemas/${schemaName}`,
+}
+
+export default class SchemasClient extends ExternalClient {
+  constructor(context: IOContext, options?: InstanceOptions) {
+    super(`http://${context.account}.myvtex.com/api`, context, {
+      ...options,
+      headers: {
+        ...options?.headers,
+        VtexIdclientAutCookie: context.authToken,
+        'Content-Type': 'application/json',
+      },
+    })
+  }
+
+  public getSchemas(dataEntity: string, config?: RequestConfig): Promise<any> {
+    return this.http.get(routes.schemas(dataEntity), config)
+  }
+
+  public deleteSchemas(
+    dataEntity: string,
+    schemaName: string,
+    config?: RequestConfig
+  ): Promise<any> {
+    return this.http.delete(routes.delete(dataEntity, schemaName), config)
+  }
+}

node/index.ts

@@ -35,6 +35,7 @@ import { getAffiliate } from './resolvers/getAffiliate'
 import { fieldResolvers } from './resolvers/fieldResolvers'
 import { getAffiliateByEmail } from './resolvers/getAffiliateByEmail'
 import { getWorkspaces } from './resolvers/getWorkspaces'
+import { getSchemas } from './middlewares/getSchemas'
 
 const TIMEOUT_MS = 1000
 
@@ -90,6 +91,9 @@ declare global {
 export default new Service({
   clients,
   routes: {
+    schemas: method({
+      GET: [getSchemas],
+    }),
     affiliate: method({
       POST: [authenticateRequest, validateCreate, createAffiliate],
       PATCH: [authenticateRequest, validateUpdate, updateAffiliate],

node/middlewares/getSchemas.ts

@@ -0,0 +1,22 @@
+export async function getSchemas(ctx: Context, next: () => Promise<unknown>) {
+  const {
+    clients: { schemas },
+    vtex: { logger },
+  } = ctx
+
+  try {
+    const schemaList = await schemas.getSchemas('vtex_affiliates_Affiliates')
+
+    console.info('testing', schemaList)
+    ctx.message = `Schema list retrieved`
+    ctx.status = 200
+  } catch (err) {
+    logger.error({
+      metric: 'get-affiliate-schema',
+      message: err.message,
+    })
+    throw new Error('Error getting affiliate schemas')
+  }
+
+  await next()
+}

node/package.json

@@ -9,7 +9,7 @@
     "@types/jest": "^27.0.2",
     "@types/node": "^12.0.0",
     "@types/ramda": "types/npm-ramda#dist",
-    "@vtex/api": "6.45.21",
+    "@vtex/api": "6.45.22",
     "@vtex/test-tools": "^3.4.1",
     "@vtex/tsconfig": "^0.5.6",
     "typescript": "3.9.7"

node/service.json

@@ -6,6 +6,10 @@
   "maxReplicas": 4,
   "workers": 1,
   "routes": {
+    "schemas": {
+      "path": "/_v/affiliateSchemas",
+      "public": true
+    },
     "affiliate": {
       "path": "/_v/affiliate",
       "public": true

node/yarn.lock

@@ -1658,10 +1658,10 @@
   resolved "https://registry.yarnpkg.com/@types/zen-observable/-/zen-observable-0.8.3.tgz#781d360c282436494b32fe7d9f7f8e64b3118aa3"
   integrity sha512-fbF6oTd4sGGy0xjHPKAt+eS2CrxJ3+6gQ3FGcBoIJR2TLAyCkCyI8JqZNy+FeON0AhVgNJoUumVoZQjBFUqHkw==
 
-"@vtex/[email protected].21":
-  version "6.45.21"
-  resolved "https://registry.yarnpkg.com/@vtex/api/-/api-6.45.21.tgz#2f5ea4a14dfbf426f6fbad140caf23c89060b313"
-  integrity sha512-Yo4og5bSM1n5WSQ3u8nsqEHicvxdyOZX3uA0KtQHbS4frSeA4hcGRuupsFHQ13eZZGMy4OR4fJO7ZQfkj8qLhQ==
+"@vtex/[email protected].22":
+  version "6.45.22"
+  resolved "https://registry.yarnpkg.com/@vtex/api/-/api-6.45.22.tgz#fa9bbfde1a4d4fbbaf6cce9f6dbc9bb9ee929ba3"
+  integrity sha512-g5cGUDhF4FADgSMpQmce/bnIZumwGlPG2cabwbQKIQ+cCFMZqOEM/n+YQb1+S8bCyHkzW3u/ZABoyCKi5/nxxg==
   dependencies:
     "@types/koa" "^2.11.0"
     "@types/koa-compose" "^3.2.3"

react/components/admin/commissions/CommissionsTable.tsx

@@ -53,8 +53,8 @@ const CommissionsTable: FC = () => {
   const {
     culture: { locale },
   } = useRuntime()
+
   const view = useDataViewState()
-
   const modal = useModalState()
   const showToast = useToast()
   const [selectedRow, setSelectedRow] = useState<TableColumns>()