@openfn/cli 1.20.2 → 1.21.0

package/dist/index.js

@@ -146,29 +146,6 @@ var ensureLogOpts = (opts2) => {
 };
 var ensure_log_opts_default = ensureLogOpts;
 
-// src/util/get-cli-option-object.ts
-function getCLIOptionObject(arg) {
-  if (isObject(arg)) {
-    return arg;
-  } else if (typeof arg === "string") {
-    try {
-      const p = JSON.parse(arg);
-      if (isObject(p))
-        return p;
-    } catch (e) {
-    }
-    return Object.fromEntries(
-      arg.split(",").map((pair) => {
-        const [k, v] = pair.split("=");
-        return [k.trim(), v.trim()];
-      })
-    );
-  }
-}
-function isObject(arg) {
-  return typeof arg === "object" && arg !== null && !Array.isArray(arg);
-}
-
 // src/options.ts
 var setDefaultValue = (opts2, key2, value2) => {
   const v = opts2[key2];
@@ -206,11 +183,16 @@ var autoinstall = {
     default: true
   }
 };
-var apikey = {
+var apiKey = {
   name: "apikey",
   yargs: {
-    alias: ["key", "pat", "token"],
-    description: "[beta only] API Key, Personal Access Token (Pat), or other access token"
+    alias: ["pat", "token", "api-key"],
+    description: "API Key, Personal Access Token (PAT), or other access token from Lightning"
+  },
+  ensure: (opts2) => {
+    if (!opts2.apikey) {
+      opts2.apiKey = process.env.OPENFN_API_KEY;
+    }
   }
 };
 var apolloUrl = {
@@ -284,6 +266,26 @@ var configPath = {
     default: "./.config.json"
   }
 };
+var collectionsVersion = {
+  name: "collections-version",
+  yargs: {
+    description: "The version of the collections adaptor to use. Defaults to latest. Use OPENFN_COLLECTIONS_VERSION env."
+  }
+};
+var collectionsEndpoint = {
+  name: "collections-endpoint",
+  yargs: {
+    alias: ["endpoint"],
+    description: "The Lightning server to use for collections. Will use the project endpoint if available. Use OPENFN_COLLECTIONS_ENDPOINT env."
+  }
+};
+var credentials = {
+  name: "credentials",
+  yargs: {
+    alias: ["creds"],
+    description: "A path which points to a credential map"
+  }
+};
 var describe = {
   name: "describe",
   yargs: {
@@ -311,12 +313,6 @@ var endpoint = {
     description: "[beta only] URL to Lightning endpoint"
   }
 };
-var env2 = {
-  name: "env",
-  yargs: {
-    description: "[beta only] Environment name (eg staging, prod, branch)"
-  }
-};
 var force = {
   name: "force",
   yargs: {
@@ -360,16 +356,6 @@ var getBaseDir = (opts2) => {
   }
   return basePath;
 };
-var projectId = {
-  name: "project-id",
-  yargs: {
-    description: "The id or UUID of an openfn project",
-    string: true
-  },
-  ensure: (opts2) => {
-    return opts2.projectName;
-  }
-};
 var inputPath = {
   name: "input-path",
   yargs: {
@@ -578,36 +564,6 @@ var workflow = {
     description: "Name of the workflow to execute"
   }
 };
-var removeUnmapped = {
-  name: "remove-unmapped",
-  yargs: {
-    boolean: true,
-    description: "Removes all workflows that didn't get mapped from the final project after merge"
-  }
-};
-var workflowMappings = {
-  name: "workflow-mappings",
-  yargs: {
-    type: "string",
-    coerce: getCLIOptionObject,
-    description: "A manual object mapping of which workflows in source and target should be matched for a merge."
-  }
-};
-var workspace = {
-  name: "workspace",
-  yargs: {
-    alias: ["w"],
-    description: "Path to the project workspace (ie, path to openfn.yaml)"
-  },
-  ensure: (opts2) => {
-    const ws = opts2.workspace ?? process.env.OPENFN_WORKSPACE;
-    if (!ws) {
-      opts2.workspace = process.cwd();
-    } else {
-      opts2.workspace = nodePath.resolve(ws);
-    }
-  }
-};
 
 // src/util/command-builders.ts
 import c from "chalk";
@@ -618,13 +574,17 @@ var expandYargs = (y2) => {
   return y2;
 };
 function build(opts2, yargs2) {
-  return opts2.reduce(
-    (_y, o) => yargs2.option(o.name, expandYargs(o.yargs)),
-    yargs2
-  );
+  return opts2.reduce((_y, o) => {
+    if (!o?.name) {
+      console.error(`ERROR: INVALID COMMAND OPTION PASSED`, o);
+      console.error("Check the options passed to the command builder");
+      throw new Error("Invalid command");
+    }
+    return yargs2.option(o.name, expandYargs(o.yargs));
+  }, yargs2);
 }
-var ensure = (command6, opts2) => (yargs2) => {
-  yargs2.command = command6;
+var ensure = (command7, opts2) => (yargs2) => {
+  yargs2.command = command7;
   opts2.filter((opt) => opt.ensure).forEach((opt) => {
     try {
       opt.ensure(yargs2);
@@ -632,7 +592,7 @@ var ensure = (command6, opts2) => (yargs2) => {
       console.log(e);
       console.error(
         c.red(`
-Error parsing command arguments: ${command6}.${opt.name}
+Error parsing command arguments: ${command7}.${opt.name}
 `)
       );
       console.error(c.red("Aborting"));
@@ -641,11 +601,11 @@ Error parsing command arguments: ${command6}.${opt.name}
     }
   });
 };
-var override = (command6, yargs2) => {
+var override = (command7, yargs2) => {
   return {
-    ...command6,
+    ...command7,
     yargs: {
-      ...command6.yargs || {},
+      ...command7.yargs || {},
       ...yargs2
     }
   };
@@ -719,13 +679,6 @@ var key = {
     }
   }
 };
-var token = {
-  name: "pat",
-  yargs: {
-    alias: ["token"],
-    description: "Lightning Personal Access Token (PAT)"
-  }
-};
 var endpoint2 = {
   name: "endpoint",
   yargs: {
@@ -781,7 +734,7 @@ var updatedAfter = {
 var getOptions = [
   collectionName,
   key,
-  token,
+  apiKey,
   endpoint2,
   pageSize,
   limit,
@@ -817,7 +770,7 @@ var dryRun = {
 var removeOptions = [
   collectionName,
   key,
-  token,
+  apiKey,
   endpoint2,
   dryRun,
   createdBefore,
@@ -852,7 +805,7 @@ var setOptions = [
   override(key, {
     demand: false
   }),
-  token,
+  apiKey,
   endpoint2,
   value,
   items,
@@ -908,6 +861,89 @@ var compileCommand = {
 };
 var command_default3 = compileCommand;
 
+// src/util/resolve-path.ts
+import nodepath from "node:path";
+import os from "node:os";
+var resolve_path_default = (path3, root) => {
+  return path3.startsWith("~") ? path3.replace(`~`, os.homedir) : nodepath.resolve(root ?? "", path3);
+};
+
+// src/util/get-cli-option-object.ts
+function getCLIOptionObject(arg) {
+  if (isObject(arg)) {
+    return arg;
+  } else if (typeof arg === "string") {
+    try {
+      const p = JSON.parse(arg);
+      if (isObject(p))
+        return p;
+    } catch (e) {
+    }
+    return Object.fromEntries(
+      arg.split(",").map((pair) => {
+        const [k, v] = pair.split("=");
+        return [k.trim(), v.trim()];
+      })
+    );
+  }
+}
+function isObject(arg) {
+  return typeof arg === "object" && arg !== null && !Array.isArray(arg);
+}
+
+// src/projects/options.ts
+var env2 = {
+  name: "env",
+  yargs: {
+    description: "Environment name (eg staging, prod, branch)",
+    hidden: true
+  }
+};
+var alias = {
+  name: "alias",
+  yargs: {
+    description: "Environment name (eg staging, prod, branch)"
+  }
+};
+var removeUnmapped = {
+  name: "remove-unmapped",
+  yargs: {
+    boolean: true,
+    description: "Removes all workflows that didn't get mapped from the final project after merge"
+  }
+};
+var workflowMappings = {
+  name: "workflow-mappings",
+  yargs: {
+    type: "string",
+    coerce: getCLIOptionObject,
+    description: "A manual object mapping of which workflows in source and target should be matched for a merge."
+  }
+};
+var outputPath2 = {
+  name: "output-path",
+  yargs: {
+    alias: ["output"],
+    type: "string",
+    description: "Path to output the fetched project to"
+  }
+};
+var workspace = {
+  name: "workspace",
+  yargs: {
+    alias: ["w"],
+    description: "Path to the project workspace (ie, path to openfn.yaml)"
+  },
+  ensure: (opts2) => {
+    const ws = opts2.workspace ?? process.env.OPENFN_WORKSPACE;
+    if (!ws) {
+      opts2.workspace = process.cwd();
+    } else {
+      opts2.workspace = resolve_path_default(ws);
+    }
+  }
+};
+
 // src/deploy/command.ts
 var options3 = [
   beta,
@@ -958,9 +994,16 @@ var command_default6 = docsCommand;
 var options5 = [
   expandAdaptors,
   adaptors,
+  override(apiKey, {
+    description: "API token for collections",
+    alias: ["collections-api-key", "collections-token", "pat"]
+  }),
   autoinstall,
   cacheSteps,
   compile,
+  credentials,
+  collectionsEndpoint,
+  collectionsVersion,
   end,
   ignoreImports,
   immutable,
@@ -1033,8 +1076,7 @@ var command_default8 = {
 
 // src/pull/command.ts
 var options7 = [
-  apikey,
-  beta,
+  apiKey,
   beta,
   configPath,
   endpoint,
@@ -1057,7 +1099,7 @@ var pullCommand = {
   command: "pull [projectId]",
   describe: `Pull a project's state and spec from a Lightning Instance to the local directory. Pass --beta to use the experimental new pull command. See https://github.com/OpenFn/kit/wiki/Pull-Deploy-Beta for docs`,
   builder: (yargs2) => build(options7, yargs2).positional("projectId", {
-    describe: "The id of the project that should be pulled shouled be a UUID",
+    describe: "The id of the project that should be pulled should be a UUID",
     demandOption: true
   }).example(
     "pull 57862287-23e6-4650-8d79-e1dd88b24b1c",
@@ -1163,24 +1205,27 @@ import Project3, { Workspace as Workspace4 } from "@openfn/project";
 // src/projects/checkout.ts
 import Project2, { Workspace as Workspace3 } from "@openfn/project";
 import { rimraf } from "rimraf";
-var options11 = [projectId, workspace, log];
+var options11 = [log, workspace];
 var command3 = {
-  command: "checkout <project-id>",
+  command: "checkout <project>",
   describe: "Switch to a different OpenFn project in the same workspace",
   handler: ensure("project-checkout", options11),
-  builder: (yargs2) => build(options11, yargs2)
+  builder: (yargs2) => build(options11, yargs2).positional("project", {
+    describe: "The id, alias or UUID of the project to chcekout",
+    demandOption: true
+  })
 };
 var checkout_default = command3;
 
 // src/projects/merge.ts
 var options12 = [
-  projectId,
   removeUnmapped,
   workflowMappings,
-  log,
   workspace,
+  log,
   // custom output because we don't want defaults or anything
   {
+    // TODO presumably if we do this we don't also checkout?
     name: "output-path",
     yargs: {
       alias: "o",
@@ -1199,8 +1244,8 @@ var options12 = [
   })
 ];
 var command4 = {
-  command: "merge <project-id>",
-  describe: "Merges the specified project into the currently checked out project",
+  command: "merge <project>",
+  describe: "Merges the specified project (by UUID, id or alias) into the currently checked out project",
   handler: ensure("project-merge", options12),
   builder: (yargs2) => build(options12, yargs2)
 };
@@ -1209,28 +1254,25 @@ var merge_default = command4;
 // src/projects/fetch.ts
 import Project4, { Workspace as Workspace5 } from "@openfn/project";
 var options13 = [
-  apikey,
-  configPath,
+  alias,
+  apiKey,
   endpoint,
-  env2,
   log,
-  override(outputPath, {
-    description: "Path to output the fetched project to"
-  }),
   logJson,
-  workspace,
   snapshots,
-  statePath,
+  // TODO need to add support for this
   override(force, {
     description: "Overwrite local file contents with the fetched contents"
-  })
+  }),
+  outputPath2,
+  env2,
+  workspace
 ];
 var command5 = {
-  command: "fetch [projectId]",
-  describe: `Fetch a project's state and spec from a Lightning Instance to the local state file without expanding to the filesystem.`,
-  builder: (yargs2) => build(options13, yargs2).positional("projectId", {
-    describe: "The id of the project that should be fetched, should be a UUID",
-    demandOption: true
+  command: "fetch [project]",
+  describe: `Download the latest version of a project from a lightning server (does not expand the project, use checkout)`,
+  builder: (yargs2) => build(options13, yargs2).positional("project", {
+    describe: "The id, alias or UUID of the project to fetch. If not set, will default to the active project"
   }).example(
     "fetch 57862287-23e6-4650-8d79-e1dd88b24b1c",
     "Fetch an updated copy of a the above spec and state from a Lightning Instance"
@@ -1239,6 +1281,35 @@ var command5 = {
 };
 var fetch_default = command5;
 
+// src/projects/pull.ts
+var options14 = [
+  alias,
+  env2,
+  workspace,
+  apiKey,
+  endpoint,
+  log,
+  override(path2, {
+    description: "path to output the project to"
+  }),
+  logJson,
+  projectPath,
+  snapshots,
+  path2,
+  force
+];
+var command6 = {
+  command: "pull [project]",
+  describe: `Pull a project from a Lightning Instance and expand to the file system (ie fetch + checkout)`,
+  builder: (yargs2) => build(options14, yargs2).positional("project", {
+    describe: "The UUID, local id or local alias of the project to pull"
+  }).example(
+    "pull 57862287-23e6-4650-8d79-e1dd88b24b1c",
+    "Pull project with a UUID from a lightning instance"
+  ),
+  handler: ensure("project-pull", options14)
+};
+
 // src/projects/command.ts
 var projectsCommand = {
   command: "project [subcommand]",
@@ -1246,7 +1317,7 @@ var projectsCommand = {
   describe: "Sync and manage an OpenFn project",
   handler: () => {
   },
-  builder: (yargs2) => yargs2.command(list_default).command(version_default).command(merge_default).command(checkout_default).command(fetch_default).example("project", "list all projects in the workspace").example("project list", "list all projects in the workspace").example(
+  builder: (yargs2) => yargs2.command(command6).command(list_default).command(version_default).command(merge_default).command(checkout_default).command(fetch_default).example("project", "list all projects in the workspace").example("project list", "list all projects in the workspace").example(
     "project checkout staging",
     "Checkout the project with id staging"
   ).example(