@openfn/cli 1.19.0 → 1.20.1

package/dist/index.js

@@ -236,14 +236,6 @@ var apolloUrl = {
     });
   }
 };
-var json = {
-  name: "json",
-  yargs: {
-    boolean: true,
-    description: "Output the result as a json object",
-    default: false
-  }
-};
 var beta = {
   name: "beta",
   yargs: {
@@ -601,6 +593,21 @@ var workflowMappings = {
     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";
@@ -616,15 +623,16 @@ function build(opts2, yargs2) {
     yargs2
   );
 }
-var ensure = (command, opts2) => (yargs2) => {
-  yargs2.command = command;
+var ensure = (command6, opts2) => (yargs2) => {
+  yargs2.command = command6;
   opts2.filter((opt) => opt.ensure).forEach((opt) => {
     try {
       opt.ensure(yargs2);
     } catch (e) {
+      console.log(e);
       console.error(
         c.red(`
-Error parsing command arguments: ${command}.${opt.name}
+Error parsing command arguments: ${command6}.${opt.name}
 `)
       );
       console.error(c.red("Aborting"));
@@ -633,11 +641,11 @@ Error parsing command arguments: ${command}.${opt.name}
     }
   });
 };
-var override = (command, yargs2) => {
+var override = (command6, yargs2) => {
   return {
-    ...command,
+    ...command6,
     yargs: {
-      ...command.yargs || {},
+      ...command6.yargs || {},
       ...yargs2
     }
   };
@@ -718,9 +726,10 @@ var token = {
     description: "Lightning Personal Access Token (PAT)"
   }
 };
-var lightningUrl = {
-  name: "lightning",
+var endpoint2 = {
+  name: "endpoint",
   yargs: {
+    alias: ["e", "lightning"],
     description: "URL to OpenFn server. Defaults to OPENFN_ENDPOINT or https://app.openfn.org"
   }
 };
@@ -773,7 +782,7 @@ var getOptions = [
   collectionName,
   key,
   token,
-  lightningUrl,
+  endpoint2,
   pageSize,
   limit,
   pretty,
@@ -809,7 +818,7 @@ var removeOptions = [
   collectionName,
   key,
   token,
-  lightningUrl,
+  endpoint2,
   dryRun,
   createdBefore,
   createdAfter,
@@ -844,7 +853,7 @@ var setOptions = [
     demand: false
   }),
   token,
-  lightningUrl,
+  endpoint2,
   value,
   items,
   override(log, {
@@ -1037,7 +1046,11 @@ var options7 = [
   projectPath,
   snapshots,
   statePath,
-  path2
+  path2,
+  // These are hidden commands used only by beta
+  // The need to be declared here to be initialised and defaulted properly
+  override(force, { hidden: true }),
+  override(workspace, { hidden: true })
 ];
 var pullCommand = {
   command: "pull [projectId]",
@@ -1120,34 +1133,51 @@ var command_default10 = {
   builder: (yargs2) => build(options8, yargs2).example("test", "Run the test script")
 };
 
-// src/projects/command.ts
-var options9 = [projectPath];
-var projectsCommand = {
-  command: "projects [project-path]",
+// src/projects/list.ts
+import { Workspace } from "@openfn/project";
+var options9 = [log, workspace];
+var command = {
+  command: "list [project-path]",
   describe: "List all the openfn projects available in the current directory",
-  aliases: ["project"],
-  handler: ensure("projects", options9),
+  aliases: ["project", "$0"],
+  handler: ensure("project-list", options9),
   builder: (yargs2) => build(options9, yargs2)
 };
-var command_default11 = projectsCommand;
+var list_default = command;
 
-// src/checkout/command.ts
-var options10 = [projectId, projectPath, log];
-var checkoutCommand = {
-  command: "checkout <project-id>",
-  describe: "Switch to a different openfn project in the same workspace",
-  handler: ensure("checkout", options10),
+// src/projects/version.ts
+import { Workspace as Workspace2 } from "@openfn/project";
+var options10 = [workflow, workspace, workflowMappings];
+var command2 = {
+  command: "version [workflow]",
+  describe: "Returns the version hash of a given workflow in a workspace",
+  handler: ensure("project-version", options10),
   builder: (yargs2) => build(options10, yargs2)
 };
-var command_default12 = checkoutCommand;
+var version_default = command2;
+
+// src/projects/merge.ts
+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 command3 = {
+  command: "checkout <project-id>",
+  describe: "Switch to a different OpenFn project in the same workspace",
+  handler: ensure("project-checkout", options11),
+  builder: (yargs2) => build(options11, yargs2)
+};
+var checkout_default = command3;
 
-// src/merge/command.ts
-var options11 = [
+// src/projects/merge.ts
+var options12 = [
   projectId,
-  projectPath,
   removeUnmapped,
   workflowMappings,
   log,
+  workspace,
   // custom output because we don't want defaults or anything
   {
     name: "output-path",
@@ -1167,23 +1197,63 @@ var options11 = [
     description: "Force a merge even when workflows are incompatible"
   })
 ];
-var mergeCommand = {
+var command4 = {
   command: "merge <project-id>",
-  describe: "Merges the specified project into the checked out project",
-  handler: ensure("merge", options11),
-  builder: (yargs2) => build(options11, yargs2)
+  describe: "Merges the specified project into the currently checked out project",
+  handler: ensure("project-merge", options12),
+  builder: (yargs2) => build(options12, yargs2)
 };
-var command_default13 = mergeCommand;
+var merge_default = command4;
 
-// src/version/command.ts
-var options12 = [workflow, 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)
+// src/projects/fetch.ts
+import Project4, { Workspace as Workspace5 } from "@openfn/project";
+var options13 = [
+  apikey,
+  configPath,
+  endpoint,
+  env2,
+  log,
+  override(outputPath, {
+    description: "Path to output the fetched project to"
+  }),
+  logJson,
+  workspace,
+  snapshots,
+  statePath,
+  override(force, {
+    description: "Overwrite local file contents with the fetched contents"
+  })
+];
+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
+  }).example(
+    "fetch 57862287-23e6-4650-8d79-e1dd88b24b1c",
+    "Fetch an updated copy of a the above spec and state from a Lightning Instance"
+  ),
+  handler: ensure("project-fetch", options13)
+};
+var fetch_default = command5;
+
+// src/projects/command.ts
+var projectsCommand = {
+  command: "project [subcommand]",
+  aliases: ["projects"],
+  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(
+    "project checkout staging",
+    "Checkout the project with id staging"
+  ).example(
+    "project merge staging",
+    "Merge staging into the checkout-out branch"
+  )
 };
-var command_default14 = workflowVersionCommand;
+var command_default11 = projectsCommand;
 
 // src/cli.ts
 var env3 = env_default();
@@ -1191,7 +1261,7 @@ if (env3) {
   process.env.$DOT_ENV_OVERRIDES = Object.keys(env3).join(",");
 }
 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(command_default14).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(checkout_default).command(merge_default).command(fetch_default).command({
   command: "version",
   describe: "Show the currently installed version of the CLI, compiler and runtime.",
   handler: (argv) => {