feat: update sdk to handle optional paramaters

vuestorefront-community · Jan 3, 2025 · cd4ef81 · cd4ef81
1 parent 3a0598a
commit cd4ef81
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 17 deletions.
diff --git a/packages/sdk-api-client/src/api/mutation/index.ts b/packages/sdk-api-client/src/api/mutation/index.ts
@@ -2,7 +2,7 @@ import { Endpoints, OdooIntegrationContext, MutationMetadataParams } from '../..
 import consola from 'consola';
 
 export const mutation: Endpoints['mutation'] = async <ApiParams, ApiResponseType>(context: OdooIntegrationContext, metadata: MutationMetadataParams, params?: ApiParams) => {
-
+ 
   if(!metadata || !metadata.mutationName) {
     const msg = 'Developer Error: mutationName is required'
     consola.error(msg);

diff --git a/packages/sdk/src/connector.ts b/packages/sdk/src/connector.ts
@@ -31,18 +31,18 @@ export const odooConnector = (options: Options): Methods => {
   };
 
   if (options.ofetch) {
-    mutation = async <ApiParams, ApiResponseType>(metadata: MutationMetadataParams, params?: ApiParams): Promise<ApiResponseType> => {
-      return options.ofetch('/api/odoo/mutation', { method: 'POST', body: [metadata, params], cache: 'no-cache', watch: false, ...options.ofetchOptions } as any);
+    mutation = async <ApiParams, ApiResponseType>(metadata: MutationMetadataParams, params?: ApiParams, opt?: { headers: any }): Promise<ApiResponseType> => {
+      return options.ofetch('/api/odoo/mutation', { method: 'POST', body: [metadata, params], cache: 'no-cache', watch: false, ...opt } as any);
     };
 
-    query = async <ApiParams, ApiResponseType>(metadata: QueryMetadataParams, params?: ApiParams): Promise<ApiResponseType> =>{
+    query = async <ApiParams, ApiResponseType>(metadata: QueryMetadataParams, params?: ApiParams, opt?: { headers: any }): Promise<ApiResponseType> =>{
       const cacheKey = metadata.cacheKey || hash({ ...metadata, ...params });
-      return options.ofetch('/api/odoo/query', { method: 'POST', body: [metadata, params], cache: 'no-cache', watch: false, key: cacheKey, ...options.ofetchOptions } as any);
+      return options.ofetch('/api/odoo/query', { method: 'POST', body: [metadata, params], cache: 'no-cache', watch: false, key: cacheKey, ...opt } as any);
     };
 
-    queryNoCache = async <ApiParams, ApiResponseType>(metadata: QueryMetadataParams, params?: ApiParams): Promise<ApiResponseType> =>{
+    queryNoCache = async <ApiParams, ApiResponseType>(metadata: QueryMetadataParams, params?: ApiParams, opt?: { headers: any }): Promise<ApiResponseType> =>{
       const cacheKey = metadata.cacheKey || hash({ ...metadata, ...params });
-      return options.ofetch('/api/odoo/query-no-cache', { method: 'POST', body: [metadata, params], cache: 'no-cache', watch: false, key: cacheKey, ...options.ofetchOptions } as any);
+      return options.ofetch('/api/odoo/query-no-cache', { method: 'POST', body: [metadata, params], cache: 'no-cache', watch: false, key: cacheKey, ...opt } as any);
     };
   }
 

diff --git a/packages/sdk/src/methods/mutation/index.ts b/packages/sdk/src/methods/mutation/index.ts
@@ -3,10 +3,11 @@ import { MutationMetadataParams } from '@erpgap/odoo-sdk-api-client';
 import { client } from '../../index';
 
 /**
- * Make the query
- *
- * @example
+ * Mutate the Odoo API
+ * @param metadata The metadata of the mutation - Example: { mutationName: MutationName.CreateUpdatePartner }
+ * @param params The parameters of the mutation (typed by ApiParams ) - Example: { id: countryId }
+ * @returns The response of the mutation (typed by ApiResponseType)
  */
-export async function mutation<ApiParams, ApiResponseType,>(metadata: MutationMetadataParams, params?: ApiParams): Promise<ApiResponseType> {
-  return await client.post('mutation', [metadata, params]);
+export async function mutation<ApiParams, ApiResponseType>(metadata: MutationMetadataParams, params?: ApiParams, opt?: { headers: any }): Promise<ApiResponseType> {
+  return await client.post('mutation', [metadata, params], opt);
 }
diff --git a/packages/sdk/src/methods/query/index.ts b/packages/sdk/src/methods/query/index.ts
@@ -2,10 +2,11 @@ import { QueryMetadataParams, Endpoints } from '@erpgap/odoo-sdk-api-client';
 import { client } from '../../client';
 
 /**
- * Make the query
- *
- * @example
+ * Query the Odoo API
+ * @param metadata The metadata of the query - Example: { queryName: QueryName.GetWebsiteHomepage }
+ * @param params The parameters of the query (typed by ApiParams ) - Example: { id: countryId }
+ * @returns The response of the query (typed by ApiResponseType)
  */
-export async function query<ApiParams, ApiResponseType>(metadata: QueryMetadataParams, params?: ApiParams): Promise<ApiResponseType> {
-  return await client.post('query', [metadata, params]);
+export async function query<ApiParams, ApiResponseType>(metadata: QueryMetadataParams, params?: ApiParams, opt?: { headers: any }): Promise<ApiResponseType> {
+  return await client.post('query', [metadata, params], opt);
 }