@openfn/cli 1.21.0 → 1.23.0

package/dist/index.js

@@ -147,6 +147,7 @@ var ensureLogOpts = (opts2) => {
 var ensure_log_opts_default = ensureLogOpts;
 
 // src/options.ts
+import { existsSync } from "node:fs";
 var setDefaultValue = (opts2, key2, value2) => {
   const v = opts2[key2];
   if (isNaN(v) && !v) {
@@ -284,6 +285,19 @@ var credentials = {
   yargs: {
     alias: ["creds"],
     description: "A path which points to a credential map"
+  },
+  ensure(opts2) {
+    if (opts2.credentials) {
+      const mapPath = nodePath.resolve(
+        opts2.workspace ?? "",
+        opts2.credentials
+      );
+      if (!existsSync(mapPath)) {
+        const e = new Error("Credential map not found at " + mapPath);
+        delete e.stack;
+        throw e;
+      }
+    }
   }
 };
 var describe = {
@@ -363,13 +377,12 @@ var inputPath = {
   },
   ensure: (opts2) => {
     const { path: basePath } = opts2;
-    if (basePath?.endsWith(".json")) {
+    if (basePath?.match(/.(json|ya?ml)$/)) {
       opts2.planPath = basePath;
     } else if (basePath?.endsWith(".js")) {
       opts2.expressionPath = basePath;
-    } else {
-      const base = getBaseDir(opts2);
-      setDefaultValue(opts2, "expressionPath", nodePath.join(base, "job.js"));
+    } else if (!opts2.expressionPath) {
+      opts2.workflowName = basePath;
     }
   }
 };
@@ -902,6 +915,7 @@ var env2 = {
 var alias = {
   name: "alias",
   yargs: {
+    alias: ["env"],
     description: "Environment name (eg staging, prod, branch)"
   }
 };
@@ -923,7 +937,7 @@ var workflowMappings = {
 var outputPath2 = {
   name: "output-path",
   yargs: {
-    alias: ["output"],
+    alias: ["o", "output"],
     type: "string",
     description: "Path to output the fetched project to"
   }
@@ -1021,7 +1035,8 @@ var options5 = [
   stateStdin,
   timeout,
   trace,
-  useAdaptorsMonorepo
+  useAdaptorsMonorepo,
+  workspace
 ];
 var executeCommand = {
   command: "execute <path> [workflow]",

package/dist/process/runner.js

@@ -332,20 +332,34 @@ var getAutoinstallTargets = (plan) => {
 var get_autoinstall_targets_default = getAutoinstallTargets;
 
 // src/execute/apply-credential-map.ts
+var CREDENTIALS_KEY = "$CREDENTIALS$";
 var applyCredentialMap = (plan, map = {}, logger) => {
   const stepsWithCredentialIds = plan.workflow.steps.filter(
-    (step) => typeof step.configuration === "string" && !step.configuration.endsWith(".json")
+    (step) => typeof step.configuration === "string" && !step.configuration.endsWith(".json") || step.configuration?.[CREDENTIALS_KEY]
   );
   const unmapped = {};
   for (const step of stepsWithCredentialIds) {
-    if (map[step.configuration]) {
-      logger?.debug(
-        `Applying credential ${step.configuration} to "${step.name ?? step.id}"`
-      );
-      step.configuration = map[step.configuration];
+    if (typeof step.configuration === "string") {
+      const configId = step.configuration;
+      if (configId in map) {
+        step.configuration = map[configId];
+      } else {
+        unmapped[configId] = true;
+        delete step.configuration;
+      }
     } else {
-      unmapped[step.configuration] = true;
-      delete step.configuration;
+      const configId = step.configuration[CREDENTIALS_KEY];
+      delete step.configuration[CREDENTIALS_KEY];
+      if (configId in map) {
+        Object.assign(step.configuration, map[configId]);
+      } else {
+        unmapped[configId] = true;
+      }
+      if (!(configId in unmapped)) {
+        logger?.debug(
+          `Applied credential ${configId} to "${step.name ?? step.id}"`
+        );
+      }
     }
   }
   if (Object.keys(unmapped).length) {
@@ -711,16 +725,15 @@ var validateAdaptors = async (options7, logger) => {
   if (options7.skipAdaptorValidation) {
     return;
   }
-  const isPlan = options7.planPath || options7.workflowPath || options7.workflow;
   const hasDeclaredAdaptors = options7.adaptors && options7.adaptors.length > 0;
-  if (isPlan && hasDeclaredAdaptors) {
+  if (!options7.expressionPath && hasDeclaredAdaptors) {
     logger.error("ERROR: adaptor and workflow provided");
     logger.error(
       "This is probably not what you meant to do. A workflow should declare an adaptor for each job."
     );
     throw new Error("adaptor and workflow provided");
   }
-  if (!isPlan && !hasDeclaredAdaptors) {
+  if (options7.expressionPath && !hasDeclaredAdaptors) {
     logger.warn("WARNING: No adaptor provided!");
     logger.warn(
       "This job will probably fail. Pass an adaptor with the -a flag, eg:"
@@ -736,7 +749,7 @@ var validate_adaptors_default = validateAdaptors;
 import fs3 from "node:fs/promises";
 import path4, { dirname as dirname2 } from "node:path";
 import { isPath } from "@openfn/compiler";
-import Project, { yamlToJson } from "@openfn/project";
+import { Workspace, yamlToJson } from "@openfn/project";
 
 // src/util/expand-adaptors.ts
 var expand = (name) => {
@@ -823,47 +836,60 @@ var resolve_path_default = (path17, root) => {
 
 // src/util/load-plan.ts
 var loadPlan = async (options7, logger) => {
-  const { workflowPath, planPath, expressionPath } = options7;
+  const { workflowPath, planPath, expressionPath, workflowName } = options7;
+  let workflowObj;
+  if (workflowName || options7.workflow) {
+    logger.debug(
+      "Loading workflow from active project in workspace at ",
+      options7.workspace
+    );
+    const workspace2 = new Workspace(options7.workspace);
+    const proj = await workspace2.getCheckedOutProject();
+    const name = workflowName || options7.workflow;
+    const workflow2 = proj?.getWorkflow(name);
+    if (!workflow2) {
+      const e = new Error(`Could not find Workflow "${name}"`);
+      delete e.stack;
+      throw e;
+    }
+    workflowObj = {
+      workflow: workflow2.toJSON()
+    };
+    options7.credentials ??= workspace2.getConfig().credentials;
+    options7.collectionsEndpoint ??= proj.openfn?.endpoint;
+  }
   if (options7.path && /ya?ml$/.test(options7.path)) {
     const content = await fs3.readFile(path4.resolve(options7.path), "utf-8");
-    const workflow2 = yamlToJson(content);
     options7.baseDir = dirname2(options7.path);
-    return loadXPlan({ workflow: workflow2 }, options7, logger);
-  }
-  if (options7.path && options7.workflow) {
-    options7.baseDir = options7.path;
-    return fromProject(options7.path, options7.workflow, options7, logger);
-  }
-  if (!expressionPath && !workflowPath && !/\.(js|json|yaml)+$/.test(options7.path || "") && !options7.workflow) {
-    const workflow2 = options7.path;
-    return fromProject(path4.resolve("."), workflow2, options7, logger);
+    workflowObj = yamlToJson(content);
+    const { options: o, ...rest } = workflowObj;
+    if (!workflowObj.workflow && workflowObj.options) {
+      workflowObj = { workflow: rest, options: o };
+    }
   }
-  if (expressionPath) {
+  if (!workflowObj && expressionPath) {
     return loadExpression(options7, logger);
   }
   const jsonPath = planPath || workflowPath;
-  if (!options7.baseDir) {
+  if (jsonPath && !options7.baseDir) {
     options7.baseDir = path4.dirname(jsonPath);
   }
-  const json = await loadJson(jsonPath, logger);
-  const defaultName = path4.parse(jsonPath).name;
-  if (json.workflow) {
-    return loadXPlan(json, options7, logger, defaultName);
+  workflowObj = workflowObj ?? await loadJson(jsonPath, logger);
+  const defaultName = workflowObj.name || path4.parse(jsonPath ?? "").name;
+  if (workflowObj.jobs) {
+    return loadOldWorkflow(workflowObj, options7, logger, defaultName);
+  } else if (workflowObj.workflow) {
+    return loadXPlan(
+      workflowObj,
+      Object.assign({}, workflowObj.options, options7),
+      logger,
+      defaultName
+    );
   } else {
-    return loadOldWorkflow(json, options7, logger, defaultName);
+    return loadXPlan({ workflow: workflowObj }, options7, logger, defaultName);
   }
 };
 var load_plan_default = loadPlan;
-var fromProject = async (rootDir, workflowName, options7, logger) => {
-  logger.debug("Loading Repo from ", path4.resolve(rootDir));
-  const project = await Project.from("fs", { root: rootDir });
-  logger.debug("Loading workflow ", workflowName);
-  const workflow2 = project.getWorkflow(workflowName);
-  if (!workflow2) {
-    throw new Error(`Workflow "${workflowName}" not found`);
-  }
-  return loadXPlan({ workflow: workflow2 }, options7, logger);
-};
 var loadJson = async (workflowPath, logger) => {
   let text;
   try {
@@ -1034,11 +1060,12 @@ var ensureAdaptors = (plan) => {
   });
 };
 var ensureCollections = (plan, {
-  endpoint: endpoint2 = "https://app.openfn.org",
+  endpoint: endpoint2,
   version = "latest",
   apiKey: apiKey2 = "null"
 } = {}, logger) => {
   let collectionsFound = false;
+  endpoint2 ??= plan.options?.collectionsEndpoint ?? "https://app.openfn.org";
   Object.values(plan.workflow.steps).filter((step) => step.expression?.match(/(collections\.)/)).forEach((step) => {
     const job = step;
     if (!job.adaptors?.find(
@@ -1049,6 +1076,11 @@ var ensureCollections = (plan, {
       job.adaptors.push(
         `@openfn/language-collections@${version || "latest"}`
       );
+      if (typeof job.configuration === "string") {
+        job.configuration = {
+          [CREDENTIALS_KEY]: job.configuration
+        };
+      }
       job.configuration = Object.assign({}, job.configuration, {
         collections_endpoint: `${endpoint2}/collections`,
         collections_token: apiKey2
@@ -1239,7 +1271,7 @@ var loadAndApplyCredentialMap = async (plan, options7, logger) => {
   if (options7.credentials) {
     try {
       const credsRaw = await readFile3(
-        path5.resolve(options7.credentials),
+        path5.resolve(options7.workspace, options7.credentials),
         "utf8"
       );
       if (options7.credentials.endsWith(".json")) {
@@ -1247,13 +1279,16 @@ var loadAndApplyCredentialMap = async (plan, options7, logger) => {
       } else {
         creds = yamlToJson2(credsRaw);
       }
+      logger.info("Credential map loaded ");
     } catch (e) {
-      logger.error("Error processing credential map:");
-      logger.error(e);
-      process.exitCode = 1;
-      return;
+      if (e?.message?.match(/ENOENT/)) {
+        logger.debug("Credential map not found at", options7.credentials);
+      } else {
+        logger.error("Error processing credential map:");
+        process.exitCode = 1;
+        throw e;
+      }
     }
-    logger.info("Credential map loaded ");
   }
   return apply_credential_map_default(plan, creds, logger);
 };
@@ -1726,7 +1761,7 @@ import {
 } from "@openfn/deploy";
 
 // src/deploy/beta.ts
-import Project2 from "@openfn/project";
+import Project from "@openfn/project";
 import { deployProject } from "@openfn/deploy";
 
 // src/projects/util.ts
@@ -1834,7 +1869,7 @@ var DeployError = class extends Error {
 // src/deploy/beta.ts
 async function handler(options7, logger) {
   const config2 = loadAppAuthConfig(options7, logger);
-  const project = await Project2.from("fs", {
+  const project = await Project.from("fs", {
     root: options7.workspace || "."
   });
   const state = project.serialize("state", { format: "json" });
@@ -2369,7 +2404,7 @@ var override = (command7, yargs) => {
 
 // src/projects/fetch.ts
 import path12 from "node:path";
-import Project3, { Workspace } from "@openfn/project";
+import Project2, { Workspace as Workspace2 } from "@openfn/project";
 
 // src/util/ensure-log-opts.ts
 var defaultLoggerOptions = {
@@ -2547,6 +2582,7 @@ var env = {
 var alias = {
   name: "alias",
   yargs: {
+    alias: ["env"],
     description: "Environment name (eg staging, prod, branch)"
   }
 };
@@ -2568,7 +2604,7 @@ var workflowMappings = {
 var outputPath = {
   name: "output-path",
   yargs: {
-    alias: ["output"],
+    alias: ["o", "output"],
     type: "string",
     description: "Path to output the fetched project to"
   }
@@ -2620,7 +2656,7 @@ var printProjectName = (project) => `${project.qname} (${project.id})`;
 var handler2 = async (options7, logger) => {
   const workspacePath = options7.workspace ?? process.cwd();
   logger.debug("Using workspace at", workspacePath);
-  const workspace2 = new Workspace(workspacePath, logger, false);
+  const workspace2 = new Workspace2(workspacePath, logger, false);
   const { outputPath: outputPath2 } = options7;
   const localTargetProject = await resolveOutputProject(
     workspace2,
@@ -2654,7 +2690,7 @@ async function resolveOutputProject(workspace2, options7, logger) {
   logger.debug("Checking for local copy of project...");
   if (options7.outputPath) {
     try {
-      const customProject = await Project3.from("path", options7.outputPath);
+      const customProject = await Project2.from("path", options7.outputPath);
       logger.debug(
         `Found existing local project ${printProjectName(customProject)} at`,
         options7.outputPath
@@ -2710,7 +2746,7 @@ async function fetchRemoteProject(workspace2, options7, logger) {
     projectUUID,
     logger
   );
-  const project = await Project3.from(
+  const project = await Project2.from(
     "state",
     data,
     {
@@ -2766,7 +2802,7 @@ To ignore this error and override the local file, pass --force (-f)
 }
 
 // src/projects/checkout.ts
-import Project4, { Workspace as Workspace2 } from "@openfn/project";
+import Project3, { Workspace as Workspace3 } from "@openfn/project";
 import path13 from "path";
 import fs4 from "fs";
 import { rimraf } from "rimraf";
@@ -2783,13 +2819,13 @@ var command2 = {
 var handler3 = async (options7, logger) => {
   const projectIdentifier = options7.project;
   const workspacePath = options7.workspace ?? process.cwd();
-  const workspace2 = new Workspace2(workspacePath, logger);
+  const workspace2 = new Workspace3(workspacePath, logger);
   const { project: _, ...config2 } = workspace2.getConfig();
   let switchProject;
   if (/\.(yaml|json)$/.test(projectIdentifier)) {
     const filePath = projectIdentifier.startsWith("/") ? projectIdentifier : path13.join(workspacePath, projectIdentifier);
     logger.debug("Loading project from path ", filePath);
-    switchProject = await Project4.from("path", filePath, config2);
+    switchProject = await Project3.from("path", filePath, config2);
   } else {
     switchProject = workspace2.get(projectIdentifier);
   }
@@ -2852,6 +2888,7 @@ var pull_default = handler4;
 // src/pull/handler.ts
 async function pullHandler(options7, logger) {
   if (options7.beta) {
+    options7.project = options7.projectId;
     return pull_default(options7, logger);
   }
   try {
@@ -2959,7 +2996,7 @@ __export(handler_exports, {
 });
 
 // src/projects/list.ts
-import { Workspace as Workspace3 } from "@openfn/project";
+import { Workspace as Workspace4 } from "@openfn/project";
 var options4 = [log, workspace];
 var command4 = {
   command: "list [project-path]",
@@ -2972,7 +3009,7 @@ var handler5 = async (options7, logger) => {
   logger.info("Searching for projects in workspace at:");
   logger.info(" ", options7.workspace);
   logger.break();
-  const workspace2 = new Workspace3(options7.workspace);
+  const workspace2 = new Workspace4(options7.workspace);
   if (!workspace2.valid) {
     throw new Error("No OpenFn projects found");
   }
@@ -2990,7 +3027,7 @@ ${project.workflows.map((w) => "    - " + w.id).join("\n")}`;
 }
 
 // src/projects/version.ts
-import { Workspace as Workspace4 } from "@openfn/project";
+import { Workspace as Workspace5 } from "@openfn/project";
 var options5 = [workflow, workspace, workflowMappings];
 var command5 = {
   command: "version [workflow]",
@@ -2999,7 +3036,7 @@ var command5 = {
   builder: (yargs) => build(options5, yargs)
 };
 var handler6 = async (options7, logger) => {
-  const workspace2 = new Workspace4(options7.workspace);
+  const workspace2 = new Workspace5(options7.workspace);
   if (!workspace2.valid) {
     logger.error("Command was run in an invalid openfn workspace");
     return;
@@ -3034,7 +3071,7 @@ ${final}`);
 };
 
 // src/projects/merge.ts
-import Project6, { Workspace as Workspace5 } from "@openfn/project";
+import Project5, { Workspace as Workspace6 } from "@openfn/project";
 import path15 from "node:path";
 import fs6 from "node:fs/promises";
 var options6 = [
@@ -3070,7 +3107,7 @@ var command6 = {
 };
 var handler7 = async (options7, logger) => {
   const workspacePath = options7.workspace;
-  const workspace2 = new Workspace5(workspacePath);
+  const workspace2 = new Workspace6(workspacePath);
   if (!workspace2.valid) {
     logger.error("Command was run in an invalid openfn workspace");
     return;
@@ -3079,7 +3116,7 @@ var handler7 = async (options7, logger) => {
   if (options7.base) {
     const basePath = path15.resolve(options7.base);
     logger.debug("Loading target project from path", basePath);
-    targetProject = await Project6.from("path", basePath);
+    targetProject = await Project5.from("path", basePath);
   } else {
     targetProject = workspace2.getActiveProject();
     if (!targetProject) {
@@ -3093,7 +3130,7 @@ var handler7 = async (options7, logger) => {
   if (/\.(ya?ml|json)$/.test(sourceProjectIdentifier)) {
     const filePath = path15.join(workspacePath, sourceProjectIdentifier);
     logger.debug("Loading source project from path ", filePath);
-    sourceProject = await Project6.from("path", filePath);
+    sourceProject = await Project5.from("path", filePath);
   } else {
     logger.debug(
       `Loading source project from workspace ${sourceProjectIdentifier}`
@@ -3119,7 +3156,7 @@ var handler7 = async (options7, logger) => {
     logger.error("Path to checked out project not found.");
     return;
   }
-  const final = Project6.merge(sourceProject, targetProject, {
+  const final = Project5.merge(sourceProject, targetProject, {
     removeUnmapped: options7.removeUnmapped,
     workflowMappings: options7.workflowMappings,
     force: options7.force

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/cli",
-  "version": "1.21.0",
+  "version": "1.23.0",
   "description": "CLI devtools for the OpenFn toolchain",
   "engines": {
     "node": ">=18",
@@ -50,12 +50,12 @@
     "ws": "^8.18.3",
     "yargs": "^17.7.2",
     "@openfn/compiler": "1.2.2",
-    "@openfn/describe-package": "0.1.5",
     "@openfn/deploy": "0.11.5",
-    "@openfn/project": "^0.10.0",
     "@openfn/lexicon": "^1.3.0",
-    "@openfn/runtime": "1.7.7",
-    "@openfn/logger": "1.1.1"
+    "@openfn/logger": "1.1.1",
+    "@openfn/describe-package": "0.1.5",
+    "@openfn/project": "^0.11.0",
+    "@openfn/runtime": "1.8.1"
   },
   "files": [
     "dist",