@openfn/cli 1.16.1 → 1.17.0

package/dist/index.js

@@ -224,6 +224,14 @@ var apolloUrl = {
     });
   }
 };
+var json = {
+  name: "json",
+  yargs: {
+    boolean: true,
+    description: "Output the result as a json object",
+    default: false
+  }
+};
 var beta = {
   name: "beta",
   yargs: {
@@ -1136,9 +1144,25 @@ var mergeCommand = {
 };
 var command_default13 = mergeCommand;
 
+// src/version/command.ts
+var options12 = [
+  workflow,
+  projectName,
+  projectPath,
+  workflowMappings,
+  json
+];
+var workflowVersionCommand = {
+  command: "project version [workflow]",
+  describe: "Returns the version has of a workflow",
+  handler: ensure("project", options12),
+  builder: (yargs2) => build(options12, yargs2)
+};
+var command_default14 = workflowVersionCommand;
+
 // src/cli.ts
 var y = yargs(hideBin(process.argv));
-var cmd = y.command(command_default7).command(command_default3).command(command_default2).command(command_default4).command(install).command(repo).command(command_default10).command(command_default6).command(command_default).command(command_default8).command(command_default5).command(command_default9).command(command_default11).command(command_default12).command(command_default13).command({
+var cmd = y.command(command_default7).command(command_default3).command(command_default2).command(command_default4).command(install).command(repo).command(command_default10).command(command_default6).command(command_default).command(command_default8).command(command_default5).command(command_default9).command(command_default11).command(command_default12).command(command_default13).command(command_default14).command({
   command: "version",
   describe: "Show the currently installed version of the CLI, compiler and runtime.",
   handler: (argv) => {

package/dist/process/runner.js

@@ -127,14 +127,14 @@ var callApollo = async (apolloBaseUrl, serviceName, payload, logger) => {
     });
   });
 };
-var loadPayload = async (logger, path15) => {
-  if (!path15) {
+var loadPayload = async (logger, path16) => {
+  if (!path16) {
     logger.warn("No JSON payload provided");
     logger.warn("Most apollo services require JSON to be uploaded");
     return {};
   }
-  if (path15.endsWith(".json")) {
-    const str = await readFile(path15, "utf8");
+  if (path16.endsWith(".json")) {
+    const str = await readFile(path16, "utf8");
     const json = JSON.parse(str);
     logger.debug("Loaded JSON payload");
     return json;
@@ -256,13 +256,13 @@ var execute_default = async (plan, input, opts, logger) => {
 };
 function parseAdaptors(plan) {
   const extractInfo = (specifier) => {
-    const [module, path15] = specifier.split("=");
+    const [module, path16] = specifier.split("=");
     const { name, version } = getNameAndVersion(module);
     const info = {
       name
     };
-    if (path15) {
-      info.path = path15;
+    if (path16) {
+      info.path = path16;
     }
     if (version) {
       info.version = version;
@@ -522,10 +522,10 @@ var stripVersionSpecifier = (specifier) => {
   return specifier;
 };
 var resolveSpecifierPath = async (pattern, repoDir, log) => {
-  const [specifier, path15] = pattern.split("=");
-  if (path15) {
-    log.debug(`Resolved ${specifier} to path: ${path15}`);
-    return path15;
+  const [specifier, path16] = pattern.split("=");
+  if (path16) {
+    log.debug(`Resolved ${specifier} to path: ${path16}`);
+    return path16;
   }
   const repoPath = await getModulePath(specifier, repoDir, log);
   if (repoPath) {
@@ -544,12 +544,12 @@ var loadTransformOptions = async (opts, log) => {
       let exports;
       const [specifier] = adaptorInput.split("=");
       log.debug(`Trying to preload types for ${specifier}`);
-      const path15 = await resolveSpecifierPath(adaptorInput, opts.repoDir, log);
-      if (path15) {
+      const path16 = await resolveSpecifierPath(adaptorInput, opts.repoDir, log);
+      if (path16) {
         try {
-          exports = await preloadAdaptorExports(path15, log);
+          exports = await preloadAdaptorExports(path16, log);
         } catch (e) {
-          log.error(`Failed to load adaptor typedefs from path ${path15}`);
+          log.error(`Failed to load adaptor typedefs from path ${path16}`);
           log.error(e);
         }
       }
@@ -1001,8 +1001,8 @@ var loadXPlan = async (plan, options, logger, defaultName = "") => {
 };
 
 // src/util/assert-path.ts
-var assert_path_default = (path15) => {
-  if (!path15) {
+var assert_path_default = (path16) => {
+  if (!path16) {
     console.error("ERROR: no path provided!");
     console.error("\nUsage:");
     console.error("  open path/to/job");
@@ -1688,20 +1688,20 @@ var RETRY_COUNT = 20;
 var TIMEOUT_MS = 1e3 * 60;
 var actualDocGen = (specifier) => describePackage(specifier, {});
 var ensurePath = (filePath) => mkdirSync(path7.dirname(filePath), { recursive: true });
-var generatePlaceholder = (path15) => {
-  writeFileSync(path15, `{ "loading": true, "timestamp": ${Date.now()}}`);
+var generatePlaceholder = (path16) => {
+  writeFileSync(path16, `{ "loading": true, "timestamp": ${Date.now()}}`);
 };
 var finish = (logger, resultPath) => {
   logger.success("Done! Docs can be found at:\n");
   logger.print(`  ${path7.resolve(resultPath)}`);
 };
-var generateDocs = async (specifier, path15, docgen, logger) => {
+var generateDocs = async (specifier, path16, docgen, logger) => {
   const result = await docgen(specifier);
-  await writeFile5(path15, JSON.stringify(result, null, 2));
-  finish(logger, path15);
-  return path15;
+  await writeFile5(path16, JSON.stringify(result, null, 2));
+  finish(logger, path16);
+  return path16;
 };
-var waitForDocs = async (docs, path15, logger, retryDuration = RETRY_DURATION) => {
+var waitForDocs = async (docs, path16, logger, retryDuration = RETRY_DURATION) => {
   try {
     if (docs.hasOwnProperty("loading")) {
       logger.info("Docs are being loaded by another process. Waiting.");
@@ -1713,19 +1713,19 @@ var waitForDocs = async (docs, path15, logger, retryDuration = RETRY_DURATION) =
             clearInterval(i);
             reject(new Error("Timed out waiting for docs to load"));
           }
-          const updated = JSON.parse(readFileSync(path15, "utf8"));
+          const updated = JSON.parse(readFileSync(path16, "utf8"));
           if (!updated.hasOwnProperty("loading")) {
             logger.info("Docs found!");
             clearInterval(i);
-            resolve(path15);
+            resolve(path16);
           }
           count++;
         }, retryDuration);
       });
     } else {
-      logger.info(`Docs already written to cache at ${path15}`);
-      finish(logger, path15);
-      return path15;
+      logger.info(`Docs already written to cache at ${path16}`);
+      finish(logger, path16);
+      return path16;
     }
   } catch (e) {
     logger.error("Existing doc JSON corrupt. Aborting");
@@ -1742,28 +1742,28 @@ var docgenHandler = (options, logger, docgen = actualDocGen, retryDuration = RET
     process.exit(9);
   }
   logger.success(`Generating docs for ${specifier}`);
-  const path15 = `${repoDir}/docs/${specifier}.json`;
-  ensurePath(path15);
+  const path16 = `${repoDir}/docs/${specifier}.json`;
+  ensurePath(path16);
   const handleError2 = () => {
     logger.info("Removing placeholder");
-    rmSync(path15);
+    rmSync(path16);
   };
   try {
-    const existing = readFileSync(path15, "utf8");
+    const existing = readFileSync(path16, "utf8");
     const json = JSON.parse(existing);
     if (json && json.timeout && Date.now() - json.timeout >= TIMEOUT_MS) {
       logger.info(`Expired placeholder found. Removing.`);
-      rmSync(path15);
+      rmSync(path16);
       throw new Error("TIMEOUT");
     }
-    return waitForDocs(json, path15, logger, retryDuration);
+    return waitForDocs(json, path16, logger, retryDuration);
   } catch (e) {
     if (e.message !== "TIMEOUT") {
-      logger.info(`Docs JSON not found at ${path15}`);
+      logger.info(`Docs JSON not found at ${path16}`);
     }
     logger.debug("Generating placeholder");
-    generatePlaceholder(path15);
-    return generateDocs(specifier, path15, docgen, logger).catch((e2) => {
+    generatePlaceholder(path16);
+    return generateDocs(specifier, path16, docgen, logger).catch((e2) => {
       logger.error("Error generating documentation");
       logger.error(e2);
       handleError2();
@@ -1814,7 +1814,7 @@ var docsHandler = async (options, logger) => {
     logger.success(`Showing docs for ${adaptorName} v${version}`);
   }
   logger.info("Generating/loading documentation...");
-  const path15 = await handler_default7(
+  const path16 = await handler_default7(
     {
       specifier: `${name}@${version}`,
       repoDir
@@ -1823,8 +1823,8 @@ var docsHandler = async (options, logger) => {
     createNullLogger()
   );
   let didError = false;
-  if (path15) {
-    const source = await readFile4(path15, "utf8");
+  if (path16) {
+    const source = await readFile4(path16, "utf8");
     const data = JSON.parse(source);
     let desc;
     if (operation) {
@@ -2294,85 +2294,139 @@ ${project.workflows.map((w) => "    - " + w.name).join("\n")}`;
 }
 var handler_default11 = projectsHandler;
 
-// src/checkout/handler.ts
+// src/version/handler.ts
 import { Workspace as Workspace2 } from "@openfn/project";
 import path12 from "path";
+var workflowVersionHandler = async (options, logger) => {
+  const commandPath = path12.resolve(options.projectPath ?? ".");
+  const workspace = new Workspace2(commandPath);
+  if (!workspace.valid) {
+    logger.error("Command was run in an invalid openfn workspace");
+    return;
+  }
+  const output = /* @__PURE__ */ new Map();
+  const activeProject = workspace.getActiveProject();
+  if (options.workflow) {
+    const workflow = activeProject?.getWorkflow(options.workflow);
+    if (!workflow) {
+      logger.error(`No workflow found with id/name ${options.workflow}`);
+      return;
+    }
+    output.set(workflow.name || workflow.id, workflow.getVersionHash());
+  } else {
+    for (const wf of activeProject?.workflows || []) {
+      output.set(wf.name || wf.id, wf.getVersionHash());
+    }
+  }
+  if (!output.size) {
+    logger.error("No workflow available");
+    return;
+  }
+  let final;
+  if (options.json) {
+    final = JSON.stringify(Object.fromEntries(output), void 0, 2);
+  } else {
+    final = Array.from(output.entries()).map(([key, value]) => key + "\n" + value).join("\n\n");
+  }
+  logger.success(`Workflow(s) and their hashes
+
+${final}`);
+};
+var handler_default12 = workflowVersionHandler;
+
+// src/checkout/handler.ts
+import Project5, { Workspace as Workspace3 } from "@openfn/project";
+import path13 from "path";
 import fs6 from "fs";
 import { rimraf as rimraf2 } from "rimraf";
 var checkoutHandler = async (options, logger) => {
-  const commandPath = path12.resolve(options.projectPath ?? ".");
-  const workspace = new Workspace2(commandPath);
+  const commandPath = path13.resolve(options.projectPath ?? ".");
+  const workspace = new Workspace3(commandPath);
   if (!workspace.valid) {
     logger.error("Command was run in an invalid openfn workspace");
     return;
   }
-  const switchProject = workspace.get(options.projectName);
+  const { project: _, ...config } = workspace.getConfig() ?? {};
+  let switchProject;
+  if (/\.(yaml|json)$/.test(options.projectName)) {
+    const filePath = path13.join(commandPath, options.projectName);
+    logger.debug("Loading project from path ", filePath);
+    switchProject = await Project5.from("path", filePath, {
+      config
+    });
+  } else {
+    switchProject = workspace.get(options.projectName);
+  }
   if (!switchProject) {
     logger.error(
       `Project with id/name ${options.projectName} not found in the workspace`
     );
     return;
   }
-  const config = workspace.getConfig();
-  await rimraf2(path12.join(commandPath, config?.workflowRoot || "workflows"));
+  await rimraf2(path13.join(commandPath, config.workflowRoot ?? "workflows"));
   const files = switchProject.serialize("fs");
   for (const f in files) {
     if (files[f]) {
-      fs6.mkdirSync(path12.join(commandPath, path12.dirname(f)), {
+      fs6.mkdirSync(path13.join(commandPath, path13.dirname(f)), {
         recursive: true
       });
-      fs6.writeFileSync(path12.join(commandPath, f), files[f]);
+      fs6.writeFileSync(path13.join(commandPath, f), files[f]);
     } else {
       logger.warn("WARNING! No content for file", f);
     }
   }
   logger.success(`Expanded project to ${commandPath}`);
 };
-var handler_default12 = checkoutHandler;
+var handler_default13 = checkoutHandler;
 
 // src/merge/handler.ts
-import Project5, { Workspace as Workspace3 } from "@openfn/project";
-import path13 from "path";
+import Project6, { Workspace as Workspace4 } from "@openfn/project";
+import path14 from "path";
 import { promises as fs7 } from "fs";
 var mergeHandler = async (options, logger) => {
-  const commandPath = path13.resolve(options.projectPath ?? ".");
-  const workspace = new Workspace3(commandPath);
+  const commandPath = path14.resolve(options.projectPath ?? ".");
+  const workspace = new Workspace4(commandPath);
   if (!workspace.valid) {
     logger.error("Command was run in an invalid openfn workspace");
     return;
   }
-  const checkedProject = workspace.getActiveProject();
-  if (!checkedProject) {
+  const targetProject = workspace.getActiveProject();
+  if (!targetProject) {
     logger.error(`No project currently checked out`);
     return;
   }
-  const mProject = workspace.get(options.projectName);
-  if (!mProject) {
-    logger.error(
-      `Project with id/name ${options.projectName} not found in the workspace`
-    );
+  let sourceProject;
+  if (/\.(yaml|json)$/.test(options.projectName)) {
+    const filePath = path14.join(commandPath, options.projectName);
+    logger.debug("Loading source project from path ", filePath);
+    sourceProject = await Project6.from("path", filePath);
+  } else {
+    sourceProject = workspace.get(options.projectName);
+  }
+  if (!sourceProject) {
+    logger.error(`Project "${options.projectName}" not found in the workspace`);
     return;
   }
-  if (checkedProject.name === mProject.name) {
+  if (targetProject.name === sourceProject.name) {
     logger.error("Merging into the same project not allowed");
     return;
   }
-  if (!checkedProject.name) {
+  if (!targetProject.name) {
     logger.error("The checked out project has no name/id");
     return;
   }
-  const finalPath = workspace.getProjectPath(checkedProject.name);
+  const finalPath = workspace.getProjectPath(targetProject.name);
   if (!finalPath) {
     logger.error("Path to checked out project not found.");
     return;
   }
-  const final = Project5.merge(mProject, checkedProject, {
+  const final = Project6.merge(sourceProject, targetProject, {
     removeUnmapped: options.removeUnmapped,
     workflowMappings: options.workflowMappings
   });
   const yaml = final.serialize("state", { format: "yaml" });
   await fs7.writeFile(finalPath, yaml);
-  await handler_default12(
+  await handler_default13(
     {
       command: "checkout",
       projectPath: commandPath,
@@ -2381,14 +2435,14 @@ var mergeHandler = async (options, logger) => {
     logger
   );
   logger.success(
-    `Project ${mProject.name} has been merged into Project ${checkedProject.name} successfully`
+    `Project ${sourceProject.name} has been merged into Project ${targetProject.name} successfully`
   );
 };
-var handler_default13 = mergeHandler;
+var handler_default14 = mergeHandler;
 
 // src/util/print-versions.ts
 import { readFileSync as readFileSync2 } from "node:fs";
-import path14 from "node:path";
+import path15 from "node:path";
 import url from "node:url";
 import { getNameAndVersion as getNameAndVersion7 } from "@openfn/runtime";
 import { mainSymbols } from "figures";
@@ -2400,7 +2454,7 @@ var { triangleRightSmall: t } = mainSymbols;
 var loadVersionFromPath = (adaptorPath) => {
   try {
     const pkg = JSON.parse(
-      readFileSync2(path14.resolve(adaptorPath, "package.json"), "utf8")
+      readFileSync2(path15.resolve(adaptorPath, "package.json"), "utf8")
     );
     return pkg.version;
   } catch (e) {
@@ -2435,7 +2489,7 @@ var printVersions = async (logger, options = {}, includeComponents = false) => {
     ...[NODE, CLI2, RUNTIME2, COMPILER2, longestAdaptorName].map((s) => s.length)
   );
   const prefix = (str) => `         ${t} ${str.padEnd(longest + 4, " ")}`;
-  const dirname3 = path14.dirname(url.fileURLToPath(import.meta.url));
+  const dirname3 = path15.dirname(url.fileURLToPath(import.meta.url));
   const pkg = JSON.parse(readFileSync2(`${dirname3}/../../package.json`, "utf8"));
   const { version, dependencies } = pkg;
   const compilerVersion = dependencies["@openfn/compiler"];
@@ -2489,8 +2543,9 @@ var handlers = {
   metadata: handler_default9,
   pull: handler_default10,
   projects: handler_default11,
-  checkout: handler_default12,
-  merge: handler_default13,
+  checkout: handler_default13,
+  merge: handler_default14,
+  project: handler_default12,
   ["collections-get"]: handler_default4.get,
   ["collections-set"]: handler_default4.set,
   ["collections-remove"]: handler_default4.remove,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/cli",
-  "version": "1.16.1",
+  "version": "1.17.0",
   "description": "CLI devtools for the OpenFn toolchain",
   "engines": {
     "node": ">=18",
@@ -49,11 +49,11 @@
     "yargs": "^17.7.2",
     "@openfn/compiler": "1.1.5",
     "@openfn/deploy": "0.11.3",
-    "@openfn/lexicon": "^1.2.3",
+    "@openfn/lexicon": "^1.2.4",
+    "@openfn/logger": "1.0.6",
+    "@openfn/project": "^0.6.0",
     "@openfn/describe-package": "0.1.5",
-    "@openfn/project": "^0.5.0",
-    "@openfn/runtime": "1.7.3",
-    "@openfn/logger": "1.0.6"
+    "@openfn/runtime": "1.7.3"
   },
   "files": [
     "dist",