@openfn/cli 1.12.0 → 1.13.0

package/README.md

@@ -317,6 +317,7 @@ A workflow has a structure like this:
 {
   "workflow": {
     "name": "my-workflow", // human readable name used in logging
+    "globals": "./common-funcs.js", // code or path to functions that can be accessed in any step. globally scoped
     "steps": [
       {
         "name": "a", // human readable name used in logging

package/dist/process/runner.js

@@ -390,7 +390,10 @@ var list = async (options, logger) => {
 };
 
 // src/compile/compile.ts
-import compile, { preloadAdaptorExports } from "@openfn/compiler";
+import compile, {
+  preloadAdaptorExports,
+  getExports
+} from "@openfn/compiler";
 import { getModulePath } from "@openfn/runtime";
 
 // src/util/abort.ts
@@ -459,11 +462,13 @@ var compileJob = async (job, opts, log, jobName) => {
   }
 };
 var compileWorkflow = async (plan, opts, log) => {
+  let globalsIgnoreList = getExports(plan.workflow.globals);
   for (const step of plan.workflow.steps) {
     const job = step;
     const jobOpts = {
       ...opts,
-      adaptors: job.adaptors ?? opts.adaptors
+      adaptors: job.adaptors ?? opts.adaptors,
+      ignoreImports: globalsIgnoreList
     };
     if (job.expression) {
       const { code, map } = await compileJob(
@@ -822,7 +827,8 @@ var loadExpression = async (options, logger) => {
     const plan = {
       workflow: {
         name,
-        steps: [step]
+        steps: [step],
+        globals: options.globals
       },
       options: wfOptions
     };
@@ -854,7 +860,8 @@ var loadOldWorkflow = async (workflow, options, logger, defaultName = "") => {
   logger.warn(final);
   return final;
 };
-var fetchFile = async (jobId, rootDir = "", filePath, log) => {
+var fetchFile = async (fileInfo, log) => {
+  const { rootDir = "", filePath, name } = fileInfo;
   try {
     const fullPath = filePath.startsWith("~") ? filePath : path4.resolve(rootDir, filePath);
     const result = await fs3.readFile(fullPath, "utf8");
@@ -863,7 +870,7 @@ var fetchFile = async (jobId, rootDir = "", filePath, log) => {
   } catch (e) {
     abort_default(
       log,
-      `File not found for job ${jobId}: ${filePath}`,
+      `File not found for ${name}: ${filePath}`,
       void 0,
       `This workflow references a file which cannot be found at ${filePath}
 
@@ -872,6 +879,19 @@ Paths inside the workflow are relative to the workflow.json`
     return ".";
   }
 };
+var importGlobals = async (plan, rootDir, log) => {
+  const fnStr = plan.workflow?.globals;
+  if (fnStr) {
+    if (isPath(fnStr)) {
+      plan.workflow.globals = await fetchFile(
+        { name: "globals", rootDir, filePath: fnStr },
+        log
+      );
+    } else {
+      plan.workflow.globals = fnStr;
+    }
+  }
+};
 var importExpressions = async (plan, rootDir, log) => {
   let idx = 0;
   for (const step of plan.workflow.steps) {
@@ -885,26 +905,32 @@ var importExpressions = async (plan, rootDir, log) => {
     const stateStr = typeof job.state === "string" && job.state?.trim();
     if (expressionStr && isPath(expressionStr)) {
       job.expression = await fetchFile(
-        job.id || `${idx}`,
-        rootDir,
-        expressionStr,
+        {
+          name: `job ${job.id || idx}`,
+          rootDir,
+          filePath: expressionStr
+        },
         log
       );
     }
     if (configurationStr && isPath(configurationStr)) {
       const configString = await fetchFile(
-        job.id || `${idx}`,
-        rootDir,
-        configurationStr,
+        {
+          name: `job configuration ${job.id || idx}`,
+          rootDir,
+          filePath: configurationStr
+        },
         log
       );
       job.configuration = JSON.parse(configString);
     }
     if (stateStr && isPath(stateStr)) {
       const stateString = await fetchFile(
-        job.id || `${idx}`,
-        rootDir,
-        stateStr,
+        {
+          name: `job state ${job.id || idx}`,
+          rootDir,
+          filePath: stateStr
+        },
         log
       );
       job.state = JSON.parse(stateString);
@@ -929,6 +955,9 @@ var loadXPlan = async (plan, options, logger, defaultName = "") => {
     plan.workflow.name = defaultName;
   }
   ensureAdaptors(plan);
+  if (options.globals)
+    plan.workflow.globals = options.globals;
+  await importGlobals(plan, options.baseDir, logger);
   await importExpressions(plan, options.baseDir, logger);
   if (options.expandAdaptors) {
     expand_adaptors_default(plan);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/cli",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "CLI devtools for the openfn toolchain.",
   "engines": {
     "node": ">=18",
@@ -47,13 +47,13 @@
     "undici": "^7.1.0",
     "ws": "^8.18.0",
     "yargs": "^17.7.2",
-    "@openfn/compiler": "1.0.4",
+    "@openfn/compiler": "1.1.0",
     "@openfn/describe-package": "0.1.4",
-    "@openfn/deploy": "0.11.1",
+    "@openfn/deploy": "0.11.2",
     "@openfn/lexicon": "^1.2.2",
-    "@openfn/project": "^0.1.0",
     "@openfn/logger": "1.0.5",
-    "@openfn/runtime": "1.6.4"
+    "@openfn/project": "^0.1.0",
+    "@openfn/runtime": "1.7.0"
   },
   "files": [
     "dist",