@openfn/language-beyonic 0.1.2 → 0.1.4

package/ast.json

@@ -2,6 +2,49 @@
   "operations": [],
   "exports": [],
   "common": [
+    {
+      "name": "fn",
+      "params": [
+        "func"
+      ],
+      "docs": {
+        "description": "Creates a custom step (or operation) for more flexible job writing.",
+        "tags": [
+          {
+            "title": "public",
+            "description": null,
+            "type": null
+          },
+          {
+            "title": "example",
+            "description": "fn(state => {\n  // do some things to state\n  return state;\n});"
+          },
+          {
+            "title": "function",
+            "description": null,
+            "name": null
+          },
+          {
+            "title": "param",
+            "description": "is the function",
+            "type": {
+              "type": "NameExpression",
+              "name": "Function"
+            },
+            "name": "func"
+          },
+          {
+            "title": "returns",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            }
+          }
+        ]
+      },
+      "valid": true
+    },
     {
       "name": "sourceValue",
       "params": [
@@ -32,6 +75,14 @@
               "name": "String"
             },
             "name": "path"
+          },
+          {
+            "title": "returns",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            }
           }
         ]
       },
@@ -110,6 +161,14 @@
               "name": "String"
             },
             "name": "path"
+          },
+          {
+            "title": "returns",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            }
           }
         ]
       },
@@ -145,6 +204,14 @@
               "name": "String"
             },
             "name": "path"
+          },
+          {
+            "title": "returns",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            }
           }
         ]
       },
@@ -190,6 +257,14 @@
               "name": "Value"
             },
             "name": "value"
+          },
+          {
+            "title": "returns",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Field"
+            }
           }
         ]
       },

package/dist/index.cjs

@@ -25,8 +25,19 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.js
 var src_exports = {};
 __export(src_exports, {
-  Adaptor: () => Adaptor_exports,
-  default: () => src_default
+  createCollectionRequest: () => createCollectionRequest,
+  createContact: () => createContact,
+  createPayment: () => createPayment,
+  dataPath: () => import_language_common2.dataPath,
+  dataValue: () => import_language_common2.dataValue,
+  default: () => src_default,
+  execute: () => execute,
+  field: () => import_language_common2.field,
+  fields: () => import_language_common2.fields,
+  fn: () => import_language_common2.fn,
+  lastReferenceValue: () => import_language_common2.lastReferenceValue,
+  merge: () => import_language_common2.merge,
+  sourceValue: () => import_language_common2.sourceValue
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -41,11 +52,12 @@ __export(Adaptor_exports, {
   execute: () => execute,
   field: () => import_language_common2.field,
   fields: () => import_language_common2.fields,
+  fn: () => import_language_common2.fn,
   lastReferenceValue: () => import_language_common2.lastReferenceValue,
   merge: () => import_language_common2.merge,
   sourceValue: () => import_language_common2.sourceValue
 });
-var import_language_common = require("language-common");
+var import_language_common = require("@openfn/language-common");
 
 // src/Client.js
 var import_superagent = __toESM(require("superagent"), 1);
@@ -62,7 +74,7 @@ function post({ apiToken, body, url }) {
 
 // src/Adaptor.js
 var import_url = require("url");
-var import_language_common2 = require("language-common");
+var import_language_common2 = require("@openfn/language-common");
 function execute(...operations) {
   const initialState = {
     references: [],
@@ -116,5 +128,16 @@ function createCollectionRequest(data) {
 var src_default = Adaptor_exports;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  Adaptor
+  createCollectionRequest,
+  createContact,
+  createPayment,
+  dataPath,
+  dataValue,
+  execute,
+  field,
+  fields,
+  fn,
+  lastReferenceValue,
+  merge,
+  sourceValue
 });

package/dist/index.js

@@ -15,11 +15,15 @@ __export(Adaptor_exports, {
   execute: () => execute,
   field: () => field,
   fields: () => fields,
+  fn: () => fn,
   lastReferenceValue: () => lastReferenceValue,
   merge: () => merge,
   sourceValue: () => sourceValue
 });
-import { execute as commonExecute, expandReferences } from "language-common";
+import {
+  execute as commonExecute,
+  expandReferences
+} from "@openfn/language-common";
 
 // src/Client.js
 import request from "superagent";
@@ -37,6 +41,7 @@ function post({ apiToken, body, url }) {
 // src/Adaptor.js
 import { resolve as resolveUrl } from "url";
 import {
+  fn,
   field,
   fields,
   sourceValue,
@@ -44,7 +49,7 @@ import {
   dataPath,
   dataValue,
   lastReferenceValue
-} from "language-common";
+} from "@openfn/language-common";
 function execute(...operations) {
   const initialState = {
     references: [],
@@ -97,6 +102,17 @@ function createCollectionRequest(data) {
 // src/index.js
 var src_default = Adaptor_exports;
 export {
-  Adaptor_exports as Adaptor,
-  src_default as default
+  createCollectionRequest,
+  createContact,
+  createPayment,
+  dataPath,
+  dataValue,
+  src_default as default,
+  execute,
+  field,
+  fields,
+  fn,
+  lastReferenceValue,
+  merge,
+  sourceValue
 };

package/package.json

@@ -1,8 +1,16 @@
 {
   "name": "@openfn/language-beyonic",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "beyonic Language Pack for OpenFn",
-  "main": "dist/index.cjs",
+  "homepage": "https://docs.openfn.org",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/openfn/adaptors.git"
+  },
+  "exports": {
+    "import": "./dist/index.js",
+    "require": "./dist/index.cjs"
+  },
   "author": "Open Function Group",
   "license": "LGPLv3",
   "files": [
@@ -12,32 +20,29 @@
     "configuration-schema.json"
   ],
   "dependencies": {
+    "@openfn/language-common": "^1.7.4",
     "JSONPath": "^0.10.0",
-    "language-common": "github:openfn/language-common",
     "lodash-fp": "^0.10.2",
     "superagent": "^8.0.0"
   },
   "devDependencies": {
+    "@openfn/buildtools": "^1.0.2",
     "@openfn/simple-ast": "0.4.1",
     "assertion-error": "2.0.0",
     "chai": "4.3.6",
     "deep-eql": "4.1.1",
+    "esno": "^0.16.3",
     "mocha": "7.2.0",
-    "sinon": "1.17.7",
-    "superagent-mock": "1.12.0",
-    "esno": "0.16.3",
-    "rimraf": "3.0.2",
-    "@openfn/buildtools": "^1.0.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/openfn/adaptors.git"
+    "rimraf": "3.0.2"
   },
   "type": "module",
   "types": "types/index.d.ts",
+  "main": "dist/index.cjs",
   "scripts": {
     "build": "pnpm clean && build-adaptor beyonic",
-    "clean": "rm -rf dist types docs",
+    "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"
   }
 }

package/types/Adaptor.d.ts

@@ -0,0 +1,103 @@
+/** @module Adaptor */
+/**
+ * Execute a sequence of operations.
+ * Wraps `language-common/execute`, and prepends initial state for beyonic.
+ * @example
+ * execute(
+ *   create('foo'),
+ *   delete('bar')
+ * )(state)
+ * @constructor
+ * @param {Operations} operations - Operations to be performed.
+ * @returns {Operation}
+ */
+export function execute(...operations: Operations): Operation;
+export class execute {
+    /** @module Adaptor */
+    /**
+     * Execute a sequence of operations.
+     * Wraps `language-common/execute`, and prepends initial state for beyonic.
+     * @example
+     * execute(
+     *   create('foo'),
+     *   delete('bar')
+     * )(state)
+     * @constructor
+     * @param {Operations} operations - Operations to be performed.
+     * @returns {Operation}
+     */
+    constructor(...operations: Operations);
+}
+/**
+ * Create a payment
+ * @example
+ * execute(
+ *   createPayment(data)
+ * )(state)
+ * @constructor
+ * @param {object} data - Payload data for the payment
+ * @returns {Operation}
+ */
+export function createPayment(data: object): Operation;
+export class createPayment {
+    /**
+     * Create a payment
+     * @example
+     * execute(
+     *   createPayment(data)
+     * )(state)
+     * @constructor
+     * @param {object} data - Payload data for the payment
+     * @returns {Operation}
+     */
+    constructor(data: object);
+}
+/**
+ * Create a contact
+ * @example
+ * execute(
+ *   createContact(data)
+ * )(state)
+ * @constructor
+ * @param {object} data - Payload data for the contact
+ * @returns {Operation}
+ */
+export function createContact(data: object): Operation;
+export class createContact {
+    /**
+     * Create a contact
+     * @example
+     * execute(
+     *   createContact(data)
+     * )(state)
+     * @constructor
+     * @param {object} data - Payload data for the contact
+     * @returns {Operation}
+     */
+    constructor(data: object);
+}
+/**
+ * Create a collection request
+ * @example
+ * execute(
+ *   createCollectionRequest(data)
+ * )(state)
+ * @constructor
+ * @param {object} data - Payload data for the collection request
+ * @returns {Operation}
+ */
+export function createCollectionRequest(data: object): Operation;
+export class createCollectionRequest {
+    /**
+     * Create a collection request
+     * @example
+     * execute(
+     *   createCollectionRequest(data)
+     * )(state)
+     * @constructor
+     * @param {object} data - Payload data for the collection request
+     * @returns {Operation}
+     */
+    constructor(data: object);
+}
+export { fn, field, fields, sourceValue, merge, dataPath, dataValue, lastReferenceValue } from "@openfn/language-common";

package/types/Client.d.ts

@@ -0,0 +1,5 @@
+export function post({ apiToken, body, url }: {
+    apiToken: any;
+    body: any;
+    url: any;
+}): Promise<any>;

package/types/index.d.ts

@@ -1,121 +1,3 @@
-/** @module Adaptor */
-/**
- * Execute a sequence of operations.
- * Wraps `language-common/execute`, and prepends initial state for beyonic.
- * @example
- * execute(
- *   create('foo'),
- *   delete('bar')
- * )(state)
- * @constructor
- * @param {Operations} operations - Operations to be performed.
- * @returns {Operation}
- */
-declare function execute(...operations: Operations): Operation;
-declare class execute {
-    /** @module Adaptor */
-    /**
-     * Execute a sequence of operations.
-     * Wraps `language-common/execute`, and prepends initial state for beyonic.
-     * @example
-     * execute(
-     *   create('foo'),
-     *   delete('bar')
-     * )(state)
-     * @constructor
-     * @param {Operations} operations - Operations to be performed.
-     * @returns {Operation}
-     */
-    constructor(...operations: Operations);
-}
-/**
- * Create a payment
- * @example
- * execute(
- *   createPayment(data)
- * )(state)
- * @constructor
- * @param {object} data - Payload data for the payment
- * @returns {Operation}
- */
-declare function createPayment(data: object): Operation;
-declare class createPayment {
-    /**
-     * Create a payment
-     * @example
-     * execute(
-     *   createPayment(data)
-     * )(state)
-     * @constructor
-     * @param {object} data - Payload data for the payment
-     * @returns {Operation}
-     */
-    constructor(data: object);
-}
-/**
- * Create a contact
- * @example
- * execute(
- *   createContact(data)
- * )(state)
- * @constructor
- * @param {object} data - Payload data for the contact
- * @returns {Operation}
- */
-declare function createContact(data: object): Operation;
-declare class createContact {
-    /**
-     * Create a contact
-     * @example
-     * execute(
-     *   createContact(data)
-     * )(state)
-     * @constructor
-     * @param {object} data - Payload data for the contact
-     * @returns {Operation}
-     */
-    constructor(data: object);
-}
-/**
- * Create a collection request
- * @example
- * execute(
- *   createCollectionRequest(data)
- * )(state)
- * @constructor
- * @param {object} data - Payload data for the collection request
- * @returns {Operation}
- */
-declare function createCollectionRequest(data: object): Operation;
-declare class createCollectionRequest {
-    /**
-     * Create a collection request
-     * @example
-     * execute(
-     *   createCollectionRequest(data)
-     * )(state)
-     * @constructor
-     * @param {object} data - Payload data for the collection request
-     * @returns {Operation}
-     */
-    constructor(data: object);
-}
-
-type Adaptor_execute = execute;
-declare const Adaptor_execute: typeof execute;
-type Adaptor_createPayment = createPayment;
-declare const Adaptor_createPayment: typeof createPayment;
-type Adaptor_createContact = createContact;
-declare const Adaptor_createContact: typeof createContact;
-type Adaptor_createCollectionRequest = createCollectionRequest;
-declare const Adaptor_createCollectionRequest: typeof createCollectionRequest;
-declare namespace Adaptor {
-  export {
-    Adaptor_execute as execute,
-    Adaptor_createPayment as createPayment,
-    Adaptor_createContact as createContact,
-    Adaptor_createCollectionRequest as createCollectionRequest,
-  };
-}
-
-export { Adaptor, Adaptor as default };
+export default Adaptor;
+export * from "./Adaptor";
+import * as Adaptor from "./Adaptor";