@openfn/cli 1.14.0 → 1.15.0

package/dist/index.js

@@ -320,11 +320,21 @@ var ignoreImports = {
 };
 var getBaseDir = (opts2) => {
   const basePath = opts2.path ?? ".";
-  if (/\.(jso?n?)$/.test(basePath)) {
+  if (/\.(jso?n?|ya?ml)$/.test(basePath)) {
     return nodePath.dirname(basePath);
   }
   return basePath;
 };
+var projectName = {
+  name: "project-name",
+  yargs: {
+    description: "The name of an openfn project",
+    string: true
+  },
+  ensure: (opts2) => {
+    return opts2.projectName;
+  }
+};
 var inputPath = {
   name: "input-path",
   yargs: {
@@ -1063,9 +1073,19 @@ var projectsCommand = {
 };
 var command_default11 = projectsCommand;
 
+// src/checkout/command.ts
+var options10 = [projectName, projectPath];
+var checkoutCommand = {
+  command: "checkout <project-name>",
+  describe: "Switch to a different openfn project in the same workspace",
+  handler: ensure("checkout", options10),
+  builder: (yargs2) => build(options10, yargs2)
+};
+var command_default12 = checkoutCommand;
+
 // 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({
+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: "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, path13) => {
-  if (!path13) {
+var loadPayload = async (logger, path14) => {
+  if (!path14) {
     logger.warn("No JSON payload provided");
     logger.warn("Most apollo services require JSON to be uploaded");
     return {};
   }
-  if (path13.endsWith(".json")) {
-    const str = await readFile(path13, "utf8");
+  if (path14.endsWith(".json")) {
+    const str = await readFile(path14, "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, path13] = specifier.split("=");
+    const [module, path14] = specifier.split("=");
     const { name, version } = getNameAndVersion(module);
     const info = {
       name
     };
-    if (path13) {
-      info.path = path13;
+    if (path14) {
+      info.path = path14;
     }
     if (version) {
       info.version = version;
@@ -522,10 +522,10 @@ var stripVersionSpecifier = (specifier) => {
   return specifier;
 };
 var resolveSpecifierPath = async (pattern, repoDir, log) => {
-  const [specifier, path13] = pattern.split("=");
-  if (path13) {
-    log.debug(`Resolved ${specifier} to path: ${path13}`);
-    return path13;
+  const [specifier, path14] = pattern.split("=");
+  if (path14) {
+    log.debug(`Resolved ${specifier} to path: ${path14}`);
+    return path14;
   }
   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 path13 = await resolveSpecifierPath(adaptorInput, opts.repoDir, log);
-      if (path13) {
+      const path14 = await resolveSpecifierPath(adaptorInput, opts.repoDir, log);
+      if (path14) {
         try {
-          exports = await preloadAdaptorExports(path13, log);
+          exports = await preloadAdaptorExports(path14, log);
         } catch (e) {
-          log.error(`Failed to load adaptor typedefs from path ${path13}`);
+          log.error(`Failed to load adaptor typedefs from path ${path14}`);
           log.error(e);
         }
       }
@@ -1001,8 +1001,8 @@ var loadXPlan = async (plan, options, logger, defaultName = "") => {
 };
 
 // src/util/assert-path.ts
-var assert_path_default = (path13) => {
-  if (!path13) {
+var assert_path_default = (path14) => {
+  if (!path14) {
     console.error("ERROR: no path provided!");
     console.error("\nUsage:");
     console.error("  open path/to/job");
@@ -1056,6 +1056,7 @@ var assertWorkflowStructure = (plan, logger) => {
 var assertStepStructure = (step, index) => {
   const allowedKeys = [
     "id",
+    "type",
     "name",
     "next",
     "previous",
@@ -1687,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 = (path13) => {
-  writeFileSync(path13, `{ "loading": true, "timestamp": ${Date.now()}}`);
+var generatePlaceholder = (path14) => {
+  writeFileSync(path14, `{ "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, path13, docgen, logger) => {
+var generateDocs = async (specifier, path14, docgen, logger) => {
   const result = await docgen(specifier);
-  await writeFile5(path13, JSON.stringify(result, null, 2));
-  finish(logger, path13);
-  return path13;
+  await writeFile5(path14, JSON.stringify(result, null, 2));
+  finish(logger, path14);
+  return path14;
 };
-var waitForDocs = async (docs, path13, logger, retryDuration = RETRY_DURATION) => {
+var waitForDocs = async (docs, path14, logger, retryDuration = RETRY_DURATION) => {
   try {
     if (docs.hasOwnProperty("loading")) {
       logger.info("Docs are being loaded by another process. Waiting.");
@@ -1712,19 +1713,19 @@ var waitForDocs = async (docs, path13, logger, retryDuration = RETRY_DURATION) =
             clearInterval(i);
             reject(new Error("Timed out waiting for docs to load"));
           }
-          const updated = JSON.parse(readFileSync(path13, "utf8"));
+          const updated = JSON.parse(readFileSync(path14, "utf8"));
           if (!updated.hasOwnProperty("loading")) {
             logger.info("Docs found!");
             clearInterval(i);
-            resolve(path13);
+            resolve(path14);
           }
           count++;
         }, retryDuration);
       });
     } else {
-      logger.info(`Docs already written to cache at ${path13}`);
-      finish(logger, path13);
-      return path13;
+      logger.info(`Docs already written to cache at ${path14}`);
+      finish(logger, path14);
+      return path14;
     }
   } catch (e) {
     logger.error("Existing doc JSON corrupt. Aborting");
@@ -1741,28 +1742,28 @@ var docgenHandler = (options, logger, docgen = actualDocGen, retryDuration = RET
     process.exit(9);
   }
   logger.success(`Generating docs for ${specifier}`);
-  const path13 = `${repoDir}/docs/${specifier}.json`;
-  ensurePath(path13);
+  const path14 = `${repoDir}/docs/${specifier}.json`;
+  ensurePath(path14);
   const handleError2 = () => {
     logger.info("Removing placeholder");
-    rmSync(path13);
+    rmSync(path14);
   };
   try {
-    const existing = readFileSync(path13, "utf8");
+    const existing = readFileSync(path14, "utf8");
     const json = JSON.parse(existing);
     if (json && json.timeout && Date.now() - json.timeout >= TIMEOUT_MS) {
       logger.info(`Expired placeholder found. Removing.`);
-      rmSync(path13);
+      rmSync(path14);
       throw new Error("TIMEOUT");
     }
-    return waitForDocs(json, path13, logger, retryDuration);
+    return waitForDocs(json, path14, logger, retryDuration);
   } catch (e) {
     if (e.message !== "TIMEOUT") {
-      logger.info(`Docs JSON not found at ${path13}`);
+      logger.info(`Docs JSON not found at ${path14}`);
     }
     logger.debug("Generating placeholder");
-    generatePlaceholder(path13);
-    return generateDocs(specifier, path13, docgen, logger).catch((e2) => {
+    generatePlaceholder(path14);
+    return generateDocs(specifier, path14, docgen, logger).catch((e2) => {
       logger.error("Error generating documentation");
       logger.error(e2);
       handleError2();
@@ -1813,7 +1814,7 @@ var docsHandler = async (options, logger) => {
     logger.success(`Showing docs for ${adaptorName} v${version}`);
   }
   logger.info("Generating/loading documentation...");
-  const path13 = await handler_default7(
+  const path14 = await handler_default7(
     {
       specifier: `${name}@${version}`,
       repoDir
@@ -1822,8 +1823,8 @@ var docsHandler = async (options, logger) => {
     createNullLogger()
   );
   let didError = false;
-  if (path13) {
-    const source = await readFile4(path13, "utf8");
+  if (path14) {
+    const source = await readFile4(path14, "utf8");
     const data = JSON.parse(source);
     let desc;
     if (operation) {
@@ -2293,9 +2294,45 @@ ${project.workflows.map((w) => "    - " + w.name).join("\n")}`;
 }
 var handler_default11 = projectsHandler;
 
+// src/checkout/handler.ts
+import { Workspace as Workspace2 } from "@openfn/project";
+import path12 from "path";
+import fs6 from "fs";
+import { rimraf as rimraf2 } from "rimraf";
+var checkoutHandler = async (options, logger) => {
+  const commandPath = path12.resolve(process.cwd(), options.projectPath ?? ".");
+  const workspace = new Workspace2(commandPath);
+  if (!workspace.valid) {
+    logger.error("Command was run in an invalid openfn workspace");
+    return;
+  }
+  const switchProject = workspace.get(options.projectName);
+  if (!switchProject) {
+    logger.error(
+      `Project with id ${options.projectName} not found in the workspace`
+    );
+    return;
+  }
+  const config = workspace.getConfig();
+  await rimraf2(path12.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)), {
+        recursive: true
+      });
+      fs6.writeFileSync(path12.join(commandPath, f), files[f]);
+    } else {
+      logger.warn("WARNING! No content for file", f);
+    }
+  }
+  logger.success(`Expanded project to ${commandPath}`);
+};
+var handler_default12 = checkoutHandler;
+
 // src/util/print-versions.ts
 import { readFileSync as readFileSync2 } from "node:fs";
-import path12 from "node:path";
+import path13 from "node:path";
 import url from "node:url";
 import { getNameAndVersion as getNameAndVersion7 } from "@openfn/runtime";
 import { mainSymbols } from "figures";
@@ -2307,7 +2344,7 @@ var { triangleRightSmall: t } = mainSymbols;
 var loadVersionFromPath = (adaptorPath) => {
   try {
     const pkg = JSON.parse(
-      readFileSync2(path12.resolve(adaptorPath, "package.json"), "utf8")
+      readFileSync2(path13.resolve(adaptorPath, "package.json"), "utf8")
     );
     return pkg.version;
   } catch (e) {
@@ -2342,7 +2379,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 = path12.dirname(url.fileURLToPath(import.meta.url));
+  const dirname3 = path13.dirname(url.fileURLToPath(import.meta.url));
   const pkg = JSON.parse(readFileSync2(`${dirname3}/../../package.json`, "utf8"));
   const { version, dependencies } = pkg;
   const compilerVersion = dependencies["@openfn/compiler"];
@@ -2396,6 +2433,7 @@ var handlers = {
   metadata: handler_default9,
   pull: handler_default10,
   projects: handler_default11,
+  checkout: 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.14.0",
+  "version": "1.15.0",
   "description": "CLI devtools for the OpenFn toolchain",
   "engines": {
     "node": ">=18",
@@ -47,13 +47,13 @@
     "undici": "7.12.0",
     "ws": "^8.18.3",
     "yargs": "^17.7.2",
-    "@openfn/compiler": "1.1.2",
+    "@openfn/compiler": "1.1.3",
+    "@openfn/deploy": "0.11.3",
     "@openfn/describe-package": "0.1.5",
     "@openfn/lexicon": "^1.2.3",
     "@openfn/logger": "1.0.6",
-    "@openfn/deploy": "0.11.3",
-    "@openfn/project": "^0.3.0",
-    "@openfn/runtime": "1.7.2"
+    "@openfn/runtime": "1.7.2",
+    "@openfn/project": "^0.4.0"
   },
   "files": [
     "dist",