@openfn/language-odoo 2.0.0 → 2.1.1

package/ast.json

@@ -278,6 +278,207 @@
         ]
       },
       "valid": true
+    },
+    {
+      "name": "searchRecord",
+      "params": [
+        "model",
+        "domain"
+      ],
+      "docs": {
+        "description": "Search a record from Odoo. Only returns record IDs. Use `searchReadRecord` to download full\nrecords which match the criteria.",
+        "tags": [
+          {
+            "title": "public",
+            "description": null,
+            "type": null
+          },
+          {
+            "title": "example",
+            "description": "searchRecord('res.partner', {\n  country_id: 'United States',\n});"
+          },
+          {
+            "title": "function",
+            "description": null,
+            "name": null
+          },
+          {
+            "title": "param",
+            "description": "The specific record model i.e. \"res.partner\"",
+            "type": {
+              "type": "NameExpression",
+              "name": "string"
+            },
+            "name": "model"
+          },
+          {
+            "title": "param",
+            "description": "Optional search domain to filter records.",
+            "type": {
+              "type": "NameExpression",
+              "name": "object"
+            },
+            "name": "domain"
+          },
+          {
+            "title": "state",
+            "description": "{OdooState}"
+          },
+          {
+            "title": "state",
+            "description": "data - An array of matching record IDs"
+          },
+          {
+            "title": "returns",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            }
+          }
+        ]
+      },
+      "valid": true
+    },
+    {
+      "name": "searchReadRecord",
+      "params": [
+        "model",
+        "domain",
+        "fields",
+        "options"
+      ],
+      "docs": {
+        "description": "Search and a read record from Odoo. It returns the records that match the search criteria, with the specified fields or full records if no fields are given.",
+        "tags": [
+          {
+            "title": "public",
+            "description": null,
+            "type": null
+          },
+          {
+            "title": "example",
+            "description": "searchReadRecord('res.partner', {\n  country_id: 'United States',\n});",
+            "caption": "Search and read a record with a domain filter"
+          },
+          {
+            "title": "example",
+            "description": "searchReadRecord(\n  'res.partner',\n  {\n    is_company: true,\n  },\n  ['name']\n);",
+            "caption": "Search and read a record with specific fields"
+          },
+          {
+            "title": "example",
+            "description": "searchReadRecord('res.partner', {}, [], {\n  limit: 200,\n});",
+            "caption": "Fetch records with a limit"
+          },
+          {
+            "title": "function",
+            "description": null,
+            "name": null
+          },
+          {
+            "title": "param",
+            "description": "The specific record model i.e. \"res.partner\"",
+            "type": {
+              "type": "NameExpression",
+              "name": "string"
+            },
+            "name": "model"
+          },
+          {
+            "title": "param",
+            "description": "Optional search domain to filter records.",
+            "type": {
+              "type": "NameExpression",
+              "name": "object"
+            },
+            "name": "domain"
+          },
+          {
+            "title": "param",
+            "description": "An optional array of field strings to read from the record. i.e  ['name', 'state_id']",
+            "type": {
+              "type": "TypeApplication",
+              "expression": {
+                "type": "NameExpression",
+                "name": "Array"
+              },
+              "applications": [
+                {
+                  "type": "NameExpression",
+                  "name": "string"
+                }
+              ]
+            },
+            "name": "fields"
+          },
+          {
+            "title": "param",
+            "description": "Additional options to configure the search.",
+            "type": {
+              "type": "OptionalType",
+              "expression": {
+                "type": "NameExpression",
+                "name": "object"
+              }
+            },
+            "name": "options",
+            "default": "{}"
+          },
+          {
+            "title": "param",
+            "description": "Maximum number of records to fetch. If undefined, defaults to 1000, and all records available will be fetched.",
+            "type": {
+              "type": "OptionalType",
+              "expression": {
+                "type": "NameExpression",
+                "name": "number"
+              }
+            },
+            "name": "options.limit",
+            "default": "1000"
+          },
+          {
+            "title": "param",
+            "description": "The index of the first record to return.",
+            "type": {
+              "type": "OptionalType",
+              "expression": {
+                "type": "NameExpression",
+                "name": "number"
+              }
+            },
+            "name": "options.offset",
+            "default": "0"
+          },
+          {
+            "title": "param",
+            "description": "The number of records to fetch in each request. Defaults to 200.",
+            "type": {
+              "type": "OptionalType",
+              "expression": {
+                "type": "NameExpression",
+                "name": "number"
+              }
+            },
+            "name": "options.pageSize",
+            "default": "200"
+          },
+          {
+            "title": "state",
+            "description": "{OdooState}"
+          },
+          {
+            "title": "returns",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            }
+          }
+        ]
+      },
+      "valid": false
     }
   ],
   "exports": [],

package/dist/index.cjs

@@ -39,6 +39,8 @@ __export(src_exports, {
   lastReferenceValue: () => import_language_common2.lastReferenceValue,
   merge: () => import_language_common2.merge,
   read: () => read,
+  searchReadRecord: () => searchReadRecord,
+  searchRecord: () => searchRecord,
   setMockClient: () => setMockClient,
   sourceValue: () => import_language_common2.sourceValue,
   update: () => update
@@ -61,6 +63,8 @@ __export(Adaptor_exports, {
   lastReferenceValue: () => import_language_common2.lastReferenceValue,
   merge: () => import_language_common2.merge,
   read: () => read,
+  searchReadRecord: () => searchReadRecord,
+  searchRecord: () => searchRecord,
   setMockClient: () => setMockClient,
   sourceValue: () => import_language_common2.sourceValue,
   update: () => update
@@ -175,6 +179,58 @@ function deleteRecord(model, recordId) {
     return (0, import_language_common.composeNextState)(state, response);
   };
 }
+function searchRecord(model, domain = {}) {
+  return async (state) => {
+    const [resolvedModel, resolvedDomain] = (0, import_util.expandReferences)(
+      state,
+      model,
+      domain
+    );
+    console.log(`Searching ${resolvedModel} resource...`);
+    const response = await odooConn.search(resolvedModel, resolvedDomain);
+    return (0, import_language_common.composeNextState)(state, response);
+  };
+}
+function searchReadRecord(model, domain = {}, fields2 = [], options = {}) {
+  return async (state) => {
+    const results = [];
+    const [resolvedModel, resolvedDomain, resolvedFields, resolvedOptions] = (0, import_util.expandReferences)(state, model, domain, fields2, options);
+    const { limit = 1e3, offset = 0, pageSize = 200 } = resolvedOptions;
+    let totalFetched = 0;
+    let nextOffset = offset;
+    if (limit <= 0 || pageSize <= 0) {
+      return (0, import_language_common.composeNextState)(state, {
+        rows: results,
+        nextOffset: null,
+        totalFetched
+      });
+    }
+    while (totalFetched < limit) {
+      const remainingItems = limit - totalFetched;
+      const fetchSize = Math.min(pageSize, remainingItems);
+      console.log(
+        `Searching and reading ${resolvedModel} resources. From offset ${nextOffset} with limit ${fetchSize}...`
+      );
+      const rows = await odooConn.searchRead(
+        resolvedModel,
+        resolvedDomain,
+        resolvedFields,
+        {
+          offset: nextOffset,
+          limit: fetchSize
+        }
+      );
+      results.push(...rows);
+      totalFetched += rows.length;
+      nextOffset += rows.length;
+      if (rows.length === 0 || rows.length < fetchSize || totalFetched >= limit) {
+        nextOffset = null;
+        break;
+      }
+    }
+    return (0, import_language_common.composeNextState)(state, { rows: results, nextOffset, totalFetched });
+  };
+}
 
 // src/index.js
 var src_default = Adaptor_exports;
@@ -193,6 +249,8 @@ var src_default = Adaptor_exports;
   lastReferenceValue,
   merge,
   read,
+  searchReadRecord,
+  searchRecord,
   setMockClient,
   sourceValue,
   update

package/dist/index.js

@@ -20,6 +20,8 @@ __export(Adaptor_exports, {
   lastReferenceValue: () => lastReferenceValue,
   merge: () => merge,
   read: () => read,
+  searchReadRecord: () => searchReadRecord,
+  searchRecord: () => searchRecord,
   setMockClient: () => setMockClient,
   sourceValue: () => sourceValue,
   update: () => update
@@ -148,6 +150,58 @@ function deleteRecord(model, recordId) {
     return composeNextState(state, response);
   };
 }
+function searchRecord(model, domain = {}) {
+  return async (state) => {
+    const [resolvedModel, resolvedDomain] = expandReferences(
+      state,
+      model,
+      domain
+    );
+    console.log(`Searching ${resolvedModel} resource...`);
+    const response = await odooConn.search(resolvedModel, resolvedDomain);
+    return composeNextState(state, response);
+  };
+}
+function searchReadRecord(model, domain = {}, fields2 = [], options = {}) {
+  return async (state) => {
+    const results = [];
+    const [resolvedModel, resolvedDomain, resolvedFields, resolvedOptions] = expandReferences(state, model, domain, fields2, options);
+    const { limit = 1e3, offset = 0, pageSize = 200 } = resolvedOptions;
+    let totalFetched = 0;
+    let nextOffset = offset;
+    if (limit <= 0 || pageSize <= 0) {
+      return composeNextState(state, {
+        rows: results,
+        nextOffset: null,
+        totalFetched
+      });
+    }
+    while (totalFetched < limit) {
+      const remainingItems = limit - totalFetched;
+      const fetchSize = Math.min(pageSize, remainingItems);
+      console.log(
+        `Searching and reading ${resolvedModel} resources. From offset ${nextOffset} with limit ${fetchSize}...`
+      );
+      const rows = await odooConn.searchRead(
+        resolvedModel,
+        resolvedDomain,
+        resolvedFields,
+        {
+          offset: nextOffset,
+          limit: fetchSize
+        }
+      );
+      results.push(...rows);
+      totalFetched += rows.length;
+      nextOffset += rows.length;
+      if (rows.length === 0 || rows.length < fetchSize || totalFetched >= limit) {
+        nextOffset = null;
+        break;
+      }
+    }
+    return composeNextState(state, { rows: results, nextOffset, totalFetched });
+  };
+}
 
 // src/index.js
 var src_default = Adaptor_exports;
@@ -166,6 +220,8 @@ export {
   lastReferenceValue,
   merge,
   read,
+  searchReadRecord,
+  searchRecord,
   setMockClient,
   sourceValue,
   update

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@openfn/language-odoo",
   "label": "Odoo",
-  "version": "2.0.0",
-  "description": "OpenFn adaptor for Odoo",
+  "version": "2.1.1",
+  "description": "OpenFn adaptor for Odoo (ERP)",
   "type": "module",
   "exports": {
     ".": {

package/types/Adaptor.d.ts

@@ -12,6 +12,15 @@
  * @property {number} externalId - An optional id to be used in the request
  * @property {boolean} downloadNewRecord - An option defaulted to `false` incase a user intends to receive the whole created resource in the response. The collective response will be written in `state.data`.
  */
+/**
+ * Options object
+ * @typedef {Object} SearchOptions
+ * @property {number} limit - Limit the number of records to return
+ * @property {number} offset - Set to the number of records to skip
+ * @property {string} order - Order to sort the records by. i.e "name, desc"
+ * @property {object} context - Context to be used in the request. i.e `{lang: 'en_US', timezone: 'UTC'}`.
+ *
+ */
 /**
  * Execute a sequence of operations.
  * Wraps `language-common/execute` to make working with this API easier.
@@ -83,6 +92,57 @@ export function update(model: string, recordId: number, data: object): Operation
  * @returns {Operation}
  */
 export function deleteRecord(model: string, recordId: number): Operation;
+/**
+ * Search a record from Odoo. Only returns record IDs. Use `searchReadRecord` to download full
+ * records which match the criteria.
+ * @public
+ * @example
+ * searchRecord('res.partner', {
+ *   country_id: 'United States',
+ * });
+ * @function
+ * @param {string} model - The specific record model i.e. "res.partner"
+ * @param {object} domain - Optional search domain to filter records.
+ * @state {OdooState}
+ * @state data - An array of matching record IDs
+ * @returns {Operation}
+ */
+export function searchRecord(model: string, domain?: object): Operation;
+/**
+ * Search and a read record from Odoo. It returns the records that match the search criteria, with the specified fields or full records if no fields are given.
+ * @public
+ * @example <caption>Search and read a record with a domain filter</caption>
+ * searchReadRecord('res.partner', {
+ *   country_id: 'United States',
+ * });
+ * @example <caption>Search and read a record with specific fields</caption>
+ * searchReadRecord(
+ *   'res.partner',
+ *   {
+ *     is_company: true,
+ *   },
+ *   ['name']
+ * );
+ * @example <caption> Fetch records with a limit</caption>
+ * searchReadRecord('res.partner', {}, [], {
+ *   limit: 200,
+ * });
+ * @function
+ * @param {string} model - The specific record model i.e. "res.partner"
+ * @param {object} domain - Optional search domain to filter records.
+ * @param {string[]} fields - An optional array of field strings to read from the record. i.e  ['name', 'state_id']
+ * @param {object} [options = {}] - Additional options to configure the search.
+ * @param {number} [options.limit=1000] - Maximum number of records to fetch. If undefined, defaults to 1000, and all records available will be fetched.
+ * @param {number} [options.offset=0] - The index of the first record to return.
+ * @param {number} [options.pageSize=200] - The number of records to fetch in each request. Defaults to 200.
+ * @state {OdooState}
+ * @returns {Operation}
+ */
+export function searchReadRecord(model: string, domain?: object, fields?: string[], options?: {
+    limit?: number;
+    offset?: number;
+    pageSize?: number;
+}): Operation;
 /**
  * State object
  */
@@ -113,4 +173,25 @@ export type CreateOptions = {
      */
     downloadNewRecord: boolean;
 };
+/**
+ * Options object
+ */
+export type SearchOptions = {
+    /**
+     * - Limit the number of records to return
+     */
+    limit: number;
+    /**
+     * - Set to the number of records to skip
+     */
+    offset: number;
+    /**
+     * - Order to sort the records by. i.e "name, desc"
+     */
+    order: string;
+    /**
+     * - Context to be used in the request. i.e `{lang: 'en_US', timezone: 'UTC'}`.
+     */
+    context: object;
+};
 export { dataPath, dataValue, dateFns, each, field, fields, fn, lastReferenceValue, merge, sourceValue } from "@openfn/language-common";