@openfn/language-odoo 1.0.0

package/configuration-schema.json

@@ -0,0 +1,59 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "properties": {
+    "baseUrl": {
+      "title": "Base URL",
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "The base URL (http://www.example.com)",
+      "format": "uri",
+      "minLength": 1,
+      "default": "http://localhost",
+      "examples": [
+        "https://dev.newlogic-demo.com"
+      ]
+    },
+    "username": {
+      "title": "Username",
+      "type": "string",
+      "description": "Username",
+      "default": "admin",
+      "examples": [
+        "test@openfn.org"
+      ]
+    },
+    "password": {
+      "title": "Password",
+      "type": "string",
+      "description": "Password",
+      "default": "admin",
+      "writeOnly": true,
+      "examples": [
+        "@some(!)Str0ngp4ss0w0rd"
+      ]
+    },
+    "database": {
+      "title": "Database Name",
+      "type": "string",
+      "default": "devel",
+      "description": "Database Name",
+      "examples": [
+        "devel"
+      ]
+    }
+  },
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "password",
+    "username",
+    "database",
+    "baseUrl"
+  ]
+}

package/dist/index.cjs

@@ -0,0 +1,188 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.js
+var src_exports = {};
+__export(src_exports, {
+  create: () => create,
+  dataPath: () => import_language_common2.dataPath,
+  dataValue: () => import_language_common2.dataValue,
+  dateFns: () => import_language_common2.dateFns,
+  default: () => src_default,
+  deleteRecord: () => deleteRecord,
+  each: () => import_language_common2.each,
+  execute: () => execute,
+  field: () => import_language_common2.field,
+  fields: () => import_language_common2.fields,
+  fn: () => import_language_common2.fn,
+  http: () => import_language_common2.http,
+  lastReferenceValue: () => import_language_common2.lastReferenceValue,
+  merge: () => import_language_common2.merge,
+  read: () => read,
+  setMockClient: () => setMockClient,
+  sourceValue: () => import_language_common2.sourceValue,
+  update: () => update
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/Adaptor.js
+var Adaptor_exports = {};
+__export(Adaptor_exports, {
+  create: () => create,
+  dataPath: () => import_language_common2.dataPath,
+  dataValue: () => import_language_common2.dataValue,
+  dateFns: () => import_language_common2.dateFns,
+  deleteRecord: () => deleteRecord,
+  each: () => import_language_common2.each,
+  execute: () => execute,
+  field: () => import_language_common2.field,
+  fields: () => import_language_common2.fields,
+  fn: () => import_language_common2.fn,
+  http: () => import_language_common2.http,
+  lastReferenceValue: () => import_language_common2.lastReferenceValue,
+  merge: () => import_language_common2.merge,
+  read: () => read,
+  setMockClient: () => setMockClient,
+  sourceValue: () => import_language_common2.sourceValue,
+  update: () => update
+});
+var import_language_common = require("@openfn/language-common");
+var import_util = require("@openfn/language-common/util");
+var import_odoo_await = __toESM(require("odoo-await"), 1);
+var import_language_common2 = require("@openfn/language-common");
+var odooConn = null;
+function execute(...operations) {
+  const initialState = {
+    references: [],
+    data: null
+  };
+  return (state) => {
+    return (0, import_language_common.execute)(login, ...operations)({ ...initialState, ...state });
+  };
+}
+function setMockClient(mock) {
+  odooConn = mock;
+}
+async function login(state) {
+  const { baseUrl, username, password, database } = state.configuration;
+  odooConn = new import_odoo_await.default({
+    baseUrl,
+    db: database,
+    username,
+    password
+  });
+  try {
+    await odooConn.connect();
+  } catch (err) {
+    console.log(`\u2717 Error: ${err}`);
+    odooConn = null;
+  }
+  return state;
+}
+function create(model, data, options) {
+  return async (state) => {
+    const [resolvedModel, resolvedData, resolvedOptions] = (0, import_util.expandReferences)(
+      state,
+      model,
+      data,
+      options
+    );
+    console.log(resolvedModel, resolvedData, resolvedOptions);
+    const response = await odooConn.create(
+      resolvedModel,
+      resolvedData,
+      resolvedOptions.externalId
+    );
+    return (0, import_language_common.composeNextState)(state, response);
+  };
+}
+function read(model, recordId, fields2 = []) {
+  return async (state) => {
+    const [resolvedModel, resolvedRecordId, resolvedFields] = (0, import_util.expandReferences)(
+      state,
+      model,
+      recordId,
+      fields2
+    );
+    console.log(resolvedModel, resolvedRecordId, resolvedFields);
+    const response = await odooConn.read(
+      resolvedModel,
+      resolvedRecordId,
+      resolvedFields
+    );
+    return (0, import_language_common.composeNextState)(state, response);
+  };
+}
+function update(model, recordId, data) {
+  return async (state) => {
+    const [resolvedModel, resolvedRecordId, resolvedData] = (0, import_util.expandReferences)(
+      state,
+      model,
+      recordId,
+      data
+    );
+    console.log(resolvedModel, resolvedRecordId, resolvedData);
+    const response = await odooConn.update(
+      resolvedModel,
+      resolvedRecordId,
+      resolvedData
+    );
+    return (0, import_language_common.composeNextState)(state, response);
+  };
+}
+function deleteRecord(model, recordId) {
+  return async (state) => {
+    const [resolvedModel, resolvedRecordId] = (0, import_util.expandReferences)(
+      state,
+      model,
+      recordId
+    );
+    console.log(resolvedModel, resolvedRecordId);
+    const response = await odooConn.delete(resolvedModel, resolvedRecordId);
+    return (0, import_language_common.composeNextState)(state, response);
+  };
+}
+
+// src/index.js
+var src_default = Adaptor_exports;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  create,
+  dataPath,
+  dataValue,
+  dateFns,
+  deleteRecord,
+  each,
+  execute,
+  field,
+  fields,
+  fn,
+  http,
+  lastReferenceValue,
+  merge,
+  read,
+  setMockClient,
+  sourceValue,
+  update
+});

package/dist/index.js

@@ -0,0 +1,161 @@
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+
+// src/Adaptor.js
+var Adaptor_exports = {};
+__export(Adaptor_exports, {
+  create: () => create,
+  dataPath: () => dataPath,
+  dataValue: () => dataValue,
+  dateFns: () => dateFns,
+  deleteRecord: () => deleteRecord,
+  each: () => each,
+  execute: () => execute,
+  field: () => field,
+  fields: () => fields,
+  fn: () => fn,
+  http: () => http,
+  lastReferenceValue: () => lastReferenceValue,
+  merge: () => merge,
+  read: () => read,
+  setMockClient: () => setMockClient,
+  sourceValue: () => sourceValue,
+  update: () => update
+});
+import {
+  execute as commonExecute,
+  composeNextState
+} from "@openfn/language-common";
+import { expandReferences } from "@openfn/language-common/util";
+import Odoo from "odoo-await";
+import {
+  dataPath,
+  dataValue,
+  dateFns,
+  each,
+  field,
+  fields,
+  fn,
+  http,
+  lastReferenceValue,
+  merge,
+  sourceValue
+} from "@openfn/language-common";
+var odooConn = null;
+function execute(...operations) {
+  const initialState = {
+    references: [],
+    data: null
+  };
+  return (state) => {
+    return commonExecute(login, ...operations)({ ...initialState, ...state });
+  };
+}
+function setMockClient(mock) {
+  odooConn = mock;
+}
+async function login(state) {
+  const { baseUrl, username, password, database } = state.configuration;
+  odooConn = new Odoo({
+    baseUrl,
+    db: database,
+    username,
+    password
+  });
+  try {
+    await odooConn.connect();
+  } catch (err) {
+    console.log(`\u2717 Error: ${err}`);
+    odooConn = null;
+  }
+  return state;
+}
+function create(model, data, options) {
+  return async (state) => {
+    const [resolvedModel, resolvedData, resolvedOptions] = expandReferences(
+      state,
+      model,
+      data,
+      options
+    );
+    console.log(resolvedModel, resolvedData, resolvedOptions);
+    const response = await odooConn.create(
+      resolvedModel,
+      resolvedData,
+      resolvedOptions.externalId
+    );
+    return composeNextState(state, response);
+  };
+}
+function read(model, recordId, fields2 = []) {
+  return async (state) => {
+    const [resolvedModel, resolvedRecordId, resolvedFields] = expandReferences(
+      state,
+      model,
+      recordId,
+      fields2
+    );
+    console.log(resolvedModel, resolvedRecordId, resolvedFields);
+    const response = await odooConn.read(
+      resolvedModel,
+      resolvedRecordId,
+      resolvedFields
+    );
+    return composeNextState(state, response);
+  };
+}
+function update(model, recordId, data) {
+  return async (state) => {
+    const [resolvedModel, resolvedRecordId, resolvedData] = expandReferences(
+      state,
+      model,
+      recordId,
+      data
+    );
+    console.log(resolvedModel, resolvedRecordId, resolvedData);
+    const response = await odooConn.update(
+      resolvedModel,
+      resolvedRecordId,
+      resolvedData
+    );
+    return composeNextState(state, response);
+  };
+}
+function deleteRecord(model, recordId) {
+  return async (state) => {
+    const [resolvedModel, resolvedRecordId] = expandReferences(
+      state,
+      model,
+      recordId
+    );
+    console.log(resolvedModel, resolvedRecordId);
+    const response = await odooConn.delete(resolvedModel, resolvedRecordId);
+    return composeNextState(state, response);
+  };
+}
+
+// src/index.js
+var src_default = Adaptor_exports;
+export {
+  create,
+  dataPath,
+  dataValue,
+  dateFns,
+  src_default as default,
+  deleteRecord,
+  each,
+  execute,
+  field,
+  fields,
+  fn,
+  http,
+  lastReferenceValue,
+  merge,
+  read,
+  setMockClient,
+  sourceValue,
+  update
+};

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@openfn/language-odoo",
+  "version": "1.0.0",
+  "description": "OpenFn odoo adaptor",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "author": "Open Function Group",
+  "license": "LGPLv3",
+  "files": [
+    "dist/",
+    "types/",
+    "ast.json",
+    "configuration-schema.json"
+  ],
+  "dependencies": {
+    "odoo-await": "^3.4.1",
+    "@openfn/language-common": "2.3.0"
+  },
+  "devDependencies": {
+    "assertion-error": "2.0.0",
+    "chai": "4.3.6",
+    "deep-eql": "4.1.1",
+    "esno": "^0.16.3",
+    "mocha": "9.2.2",
+    "rimraf": "3.0.2",
+    "undici": "^5.22.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/openfn/adaptors.git"
+  },
+  "types": "types/index.d.ts",
+  "main": "dist/index.cjs",
+  "scripts": {
+    "build": "pnpm clean && build-adaptor odoo",
+    "test": "mocha --experimental-specifier-resolution=node --no-warnings",
+    "test:watch": "mocha -w --experimental-specifier-resolution=node --no-warnings",
+    "clean": "rimraf dist types docs",
+    "pack": "pnpm pack --pack-destination ../../dist",
+    "lint": "eslint src"
+  }
+}

package/types/Adaptor.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Execute a sequence of operations.
+ * Wraps `language-common/execute` to make working with this API easier.
+ * @example
+ * execute(
+ *   create('foo'),
+ *   delete('bar')
+ * )(state)
+ * @private
+ * @param {Operations} operations - Operations to be performed.
+ * @returns {Operation}
+ */
+export function execute(...operations: Operations): Operation;
+export function setMockClient(mock: any): void;
+/**
+ * Create a record in Odoo
+ * @public
+ * @example
+ * create("res.partner", { name: "Kool Keith" }, {externalId: 23});
+ * @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.
+ * @returns {Operation}
+ */
+export function create(model: string, data: object, options: object): 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]);
+ * @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.
+ * @returns {Operation}
+ */
+export function read(model: string, recordId: number, fields?: string): Operation;
+/**
+ * Update a record in Odoo
+ * @public
+ * @example
+ * update("res.partner", 54 , {name: 'Jane Doe'});
+ * @function
+ * @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.
+ * @returns {Operation}
+ */
+export function update(model: string, recordId: number, data: object): Operation;
+/**
+ * Delete a record from Odoo
+ * @public
+ * @example
+ * deleteRecord("res.partner", 54 );
+ * @function
+ * @param {string} model - The specific record model i.e. "res.partner"
+ * @param {number} recordId - The specific recordId to be deleted.
+ * @returns {Operation}
+ */
+export function deleteRecord(model: string, recordId: number): Operation;
+export { dataPath, dataValue, dateFns, each, field, fields, fn, http, lastReferenceValue, merge, sourceValue } from "@openfn/language-common";

package/types/index.d.ts

@@ -0,0 +1,3 @@
+export default Adaptor;
+export * from "./Adaptor";
+import * as Adaptor from "./Adaptor";