@openfn/language-odoo 1.0.0 → 1.0.2

package/ast.json

@@ -8,7 +8,7 @@
         "options"
       ],
       "docs": {
-        "description": "Create a record in Odoo",
+        "description": "Create a record in Odoo.\nYou can pass an external ID to the options object to create a record with a specific ID.\nYou can also pass a downloadNewRecord option to download the whole created resource in the response.",
         "tags": [
           {
             "title": "public",
@@ -17,7 +17,13 @@
           },
           {
             "title": "example",
-            "description": "create(\"res.partner\", { name: \"Kool Keith\" }, {externalId: 23});"
+            "description": "create('res.partner', { name: 'Kool Keith' }, { externalId: 23 });",
+            "caption": "Create a partner record with an external Id"
+          },
+          {
+            "title": "example",
+            "description": "create('res.partner', { name: 'Kool Keith' }, { downloadNewRecord: true });",
+            "caption": "Create a partner record and download the whole record in the response"
           },
           {
             "title": "function",
@@ -44,13 +50,17 @@
           },
           {
             "title": "param",
-            "description": "Optional external ID for the record.",
+            "description": "Options to send to the request.",
             "type": {
               "type": "NameExpression",
-              "name": "object"
+              "name": "CreateOptions"
             },
             "name": "options"
           },
+          {
+            "title": "state",
+            "description": "{OdooState}"
+          },
           {
             "title": "returns",
             "description": null,
@@ -80,7 +90,7 @@
           },
           {
             "title": "example",
-            "description": "read(\"res.partner\", [1] , [name]);",
+            "description": "read(\"res.partner\", [1] , ['name']);",
             "caption": "Download records with select fields"
           },
           {
@@ -113,13 +123,26 @@
           },
           {
             "title": "param",
-            "description": "An optional array of fields to read from the record.",
-            "type": {
-              "type": "NameExpression",
-              "name": "string"
+            "description": "An optional array of field strings to read from the record.",
+            "type": {
+              "type": "TypeApplication",
+              "expression": {
+                "type": "NameExpression",
+                "name": "Array"
+              },
+              "applications": [
+                {
+                  "type": "NameExpression",
+                  "name": "string"
+                }
+              ]
             },
             "name": "fields"
           },
+          {
+            "title": "state",
+            "description": "{OdooState}"
+          },
           {
             "title": "returns",
             "description": null,
@@ -183,6 +206,10 @@
             },
             "name": "data"
           },
+          {
+            "title": "state",
+            "description": "{OdooState}"
+          },
           {
             "title": "returns",
             "description": null,
@@ -236,6 +263,10 @@
             },
             "name": "recordId"
           },
+          {
+            "title": "state",
+            "description": "{OdooState}"
+          },
           {
             "title": "returns",
             "description": null,

package/dist/index.cjs

@@ -100,21 +100,35 @@ async function login(state) {
   }
   return state;
 }
-function create(model, data, options) {
+function create(model, data, options = {}) {
   return async (state) => {
+    const mergedOptions = { downloadNewRecord: false, ...options };
     const [resolvedModel, resolvedData, resolvedOptions] = (0, import_util.expandReferences)(
       state,
       model,
       data,
-      options
+      mergedOptions
     );
-    console.log(resolvedModel, resolvedData, resolvedOptions);
-    const response = await odooConn.create(
-      resolvedModel,
-      resolvedData,
-      resolvedOptions.externalId
-    );
-    return (0, import_language_common.composeNextState)(state, response);
+    console.log(`Creating a ${resolvedModel} resource...`);
+    try {
+      let newRecordId = await odooConn.create(
+        resolvedModel,
+        resolvedData,
+        resolvedOptions == null ? void 0 : resolvedOptions.externalId
+      );
+      if (resolvedOptions.downloadNewRecord) {
+        console.log(
+          `Fetching ${resolvedModel} resource with id ${newRecordId}......`
+        );
+        const newRecord = await odooConn.read(resolvedModel, [newRecordId], []);
+        return (0, import_language_common.composeNextState)(state, newRecord);
+      } else {
+        return (0, import_language_common.composeNextState)(state, newRecordId);
+      }
+    } catch (e) {
+      console.error(`Error creating ${resolvedModel} resource: ${e}`);
+      throw e;
+    }
   };
 }
 function read(model, recordId, fields2 = []) {
@@ -125,7 +139,7 @@ function read(model, recordId, fields2 = []) {
       recordId,
       fields2
     );
-    console.log(resolvedModel, resolvedRecordId, resolvedFields);
+    console.log(`Reading a ${resolvedModel} resource...`);
     const response = await odooConn.read(
       resolvedModel,
       resolvedRecordId,
@@ -142,7 +156,7 @@ function update(model, recordId, data) {
       recordId,
       data
     );
-    console.log(resolvedModel, resolvedRecordId, resolvedData);
+    console.log(`Updating a ${resolvedModel} resource...`);
     const response = await odooConn.update(
       resolvedModel,
       resolvedRecordId,
@@ -158,7 +172,7 @@ function deleteRecord(model, recordId) {
       model,
       recordId
     );
-    console.log(resolvedModel, resolvedRecordId);
+    console.log(`Deleting a ${resolvedModel} resource...`);
     const response = await odooConn.delete(resolvedModel, resolvedRecordId);
     return (0, import_language_common.composeNextState)(state, response);
   };

package/dist/index.js

@@ -73,21 +73,35 @@ async function login(state) {
   }
   return state;
 }
-function create(model, data, options) {
+function create(model, data, options = {}) {
   return async (state) => {
+    const mergedOptions = { downloadNewRecord: false, ...options };
     const [resolvedModel, resolvedData, resolvedOptions] = expandReferences(
       state,
       model,
       data,
-      options
+      mergedOptions
     );
-    console.log(resolvedModel, resolvedData, resolvedOptions);
-    const response = await odooConn.create(
-      resolvedModel,
-      resolvedData,
-      resolvedOptions.externalId
-    );
-    return composeNextState(state, response);
+    console.log(`Creating a ${resolvedModel} resource...`);
+    try {
+      let newRecordId = await odooConn.create(
+        resolvedModel,
+        resolvedData,
+        resolvedOptions == null ? void 0 : resolvedOptions.externalId
+      );
+      if (resolvedOptions.downloadNewRecord) {
+        console.log(
+          `Fetching ${resolvedModel} resource with id ${newRecordId}......`
+        );
+        const newRecord = await odooConn.read(resolvedModel, [newRecordId], []);
+        return composeNextState(state, newRecord);
+      } else {
+        return composeNextState(state, newRecordId);
+      }
+    } catch (e) {
+      console.error(`Error creating ${resolvedModel} resource: ${e}`);
+      throw e;
+    }
   };
 }
 function read(model, recordId, fields2 = []) {
@@ -98,7 +112,7 @@ function read(model, recordId, fields2 = []) {
       recordId,
       fields2
     );
-    console.log(resolvedModel, resolvedRecordId, resolvedFields);
+    console.log(`Reading a ${resolvedModel} resource...`);
     const response = await odooConn.read(
       resolvedModel,
       resolvedRecordId,
@@ -115,7 +129,7 @@ function update(model, recordId, data) {
       recordId,
       data
     );
-    console.log(resolvedModel, resolvedRecordId, resolvedData);
+    console.log(`Updating a ${resolvedModel} resource...`);
     const response = await odooConn.update(
       resolvedModel,
       resolvedRecordId,
@@ -131,7 +145,7 @@ function deleteRecord(model, recordId) {
       model,
       recordId
     );
-    console.log(resolvedModel, resolvedRecordId);
+    console.log(`Deleting a ${resolvedModel} resource...`);
     const response = await odooConn.delete(resolvedModel, resolvedRecordId);
     return composeNextState(state, response);
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/language-odoo",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "OpenFn odoo adaptor",
   "type": "module",
   "exports": {

package/types/Adaptor.d.ts

@@ -1,3 +1,16 @@
+/**
+ * State object
+ * @typedef {Object} OdooState
+ * @property data - The response body (as JSON)
+ * @property response - The HTTP response from the Odoo server (excluding the body)
+ * @property references - An array of all previous data objects used in the Job
+ */
+/**
+ * Options object
+ * @typedef {Object} CreateOptions
+ * @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`.
+ */
 /**
  * Execute a sequence of operations.
  * Wraps `language-common/execute` to make working with this API easier.
@@ -13,31 +26,37 @@
 export function execute(...operations: Operations): Operation;
 export function setMockClient(mock: any): void;
 /**
- * Create a record in Odoo
+ * Create a record in Odoo.
+ * You can pass an external ID to the options object to create a record with a specific ID.
+ * You can also pass a downloadNewRecord option to download the whole created resource in the response.
  * @public
- * @example
- * create("res.partner", { name: "Kool Keith" }, {externalId: 23});
+ * @example <caption> Create a partner record with an external Id </caption>
+ * create('res.partner', { name: 'Kool Keith' }, { externalId: 23 });
+ * @example <caption> Create a partner record and download the whole record in the response </caption>
+ * create('res.partner', { name: 'Kool Keith' }, { downloadNewRecord: true });
  * @function
  * @param {string} model - The specific record model i.e. "res.partner"
  * @param {object} data - The data to be created in JSON.
- * @param {object} options - Optional external ID for the record.
+ * @param {CreateOptions} options - Options to send to the request.
+ * @state {OdooState}
  * @returns {Operation}
  */
-export function create(model: string, data: object, options: object): Operation;
+export function create(model: string, data: object, options?: CreateOptions): Operation;
 /**
  * Get a record from Odoo. Returns all fields unless a field list is provided as a third argument
  * @public
  * @example <caption>Download records with select fields</caption>
- * read("res.partner", [1] , [name]);
+ * read("res.partner", [1] , ['name']);
  * @example <caption>Download a single record with all fields</caption>
  * read("res.partner", $.recordIds);
  * @function
  * @param {string} model - The specific record model from i.e. "res.partner"
  * @param {number} recordId - An array of record IDs to read.
- * @param {string} fields - An optional array of fields to read from the record.
+ * @param {string[]} fields - An optional array of field strings to read from the record.
+ * @state {OdooState}
  * @returns {Operation}
  */
-export function read(model: string, recordId: number, fields?: string): Operation;
+export function read(model: string, recordId: number, fields?: string[]): Operation;
 /**
  * Update a record in Odoo
  * @public
@@ -47,6 +66,7 @@ export function read(model: string, recordId: number, fields?: string): Operatio
  * @param {string} model - The specific record model i.e. "res.partner"
  * @param {number} recordId - The specific recordId to be updated.
  * @param {object} data - The data to be updated in JSON.
+ * @state {OdooState}
  * @returns {Operation}
  */
 export function update(model: string, recordId: number, data: object): Operation;
@@ -58,7 +78,38 @@ export function update(model: string, recordId: number, data: object): Operation
  * @function
  * @param {string} model - The specific record model i.e. "res.partner"
  * @param {number} recordId - The specific recordId to be deleted.
+ * @state {OdooState}
  * @returns {Operation}
  */
 export function deleteRecord(model: string, recordId: number): Operation;
+/**
+ * State object
+ */
+export type OdooState = {
+    /**
+     * - The response body (as JSON)
+     */
+    data: any;
+    /**
+     * - The HTTP response from the Odoo server (excluding the body)
+     */
+    response: any;
+    /**
+     * - An array of all previous data objects used in the Job
+     */
+    references: any;
+};
+/**
+ * Options object
+ */
+export type CreateOptions = {
+    /**
+     * - An optional id to be used in the request
+     */
+    externalId: number;
+    /**
+     * - 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`.
+     */
+    downloadNewRecord: boolean;
+};
 export { dataPath, dataValue, dateFns, each, field, fields, fn, http, lastReferenceValue, merge, sourceValue } from "@openfn/language-common";