@openfn/cli 1.28.0 → 1.28.1

package/dist/index.js

@@ -1255,31 +1255,65 @@ var command2 = {
 var version_default = command2;
 
 // src/projects/merge.ts
-import Project3, { Workspace as Workspace5 } from "@openfn/project";
+import Project4, { Workspace as Workspace6 } from "@openfn/project";
 
 // src/projects/checkout.ts
-import Project2, { Workspace as Workspace4 } from "@openfn/project";
+import Project3, { Workspace as Workspace5 } from "@openfn/project";
 import { rimraf as rimraf2 } from "rimraf";
 
 // src/projects/util.ts
 import { rimraf } from "rimraf";
-import { versionsEqual } from "@openfn/project";
+import { versionsEqual as versionsEqual2 } from "@openfn/project";
 
-// src/projects/checkout.ts
-var options11 = [log, workspace, clean, force];
+// src/projects/deploy.ts
+import Project2, { versionsEqual, Workspace as Workspace3 } from "@openfn/project";
+import c2 from "chalk";
+var options11 = [
+  env2,
+  workspace,
+  dryRun2,
+  newProject,
+  name,
+  alias,
+  apiKey,
+  endpoint,
+  log,
+  logJson,
+  snapshots,
+  force,
+  confirm
+];
 var command3 = {
+  command: "deploy [project]",
+  aliases: "push",
+  describe: `Deploy the checked out project to a Lightning Instance`,
+  builder: (yargs2) => build(options11, yargs2).positional("project", {
+    describe: "The UUID, local id or local alias of the project to deploy to"
+  }).example(
+    "deploy",
+    "Deploy the checked-out project its connected remote instance"
+  ).example(
+    "deploy staging",
+    'Deploy the checkout-out project to the remote project with alias "staging"'
+  ),
+  handler: ensure("project-deploy", options11)
+};
+
+// src/projects/checkout.ts
+var options12 = [log, workspace, clean, force];
+var command4 = {
   command: "checkout <project>",
   describe: "Switch to a different OpenFn project in the same workspace",
-  handler: ensure("project-checkout", options11),
-  builder: (yargs2) => build(options11, yargs2).positional("project", {
+  handler: ensure("project-checkout", options12),
+  builder: (yargs2) => build(options12, yargs2).positional("project", {
     describe: "The id, alias or UUID of the project to checkout",
     demandOption: true
   })
 };
-var checkout_default = command3;
+var checkout_default = command4;
 
 // src/projects/merge.ts
-var options12 = [
+var options13 = [
   removeUnmapped,
   workflowMappings,
   workspace,
@@ -1304,17 +1338,17 @@ var options12 = [
     description: "Force a merge even when workflows are incompatible"
   })
 ];
-var command4 = {
+var command5 = {
   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)
+  describe: "Merges the currently checked-out project into the target project, and checks out the result. Does not update the remote project or local project.yaml file",
+  handler: ensure("project-merge", options13),
+  builder: (yargs2) => build(options13, yargs2)
 };
-var merge_default = command4;
+var merge_default = command5;
 
 // src/projects/fetch.ts
-import Project4, { Workspace as Workspace6 } from "@openfn/project";
-var options13 = [
+import Project5, { Workspace as Workspace7 } from "@openfn/project";
+var options14 = [
   alias,
   apiKey,
   endpoint,
@@ -1330,22 +1364,22 @@ var options13 = [
   workspace,
   format
 ];
-var command5 = {
+var command6 = {
   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", {
+  builder: (yargs2) => build(options14, 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"
   ),
-  handler: ensure("project-fetch", options13)
+  handler: ensure("project-fetch", options14)
 };
-var fetch_default = command5;
+var fetch_default = command6;
 
 // src/projects/pull.ts
-import { Workspace as Workspace7 } from "@openfn/project";
-var options14 = [
+import { Workspace as Workspace8 } from "@openfn/project";
+var options15 = [
   alias,
   env2,
   workspace,
@@ -1360,47 +1394,16 @@ var options14 = [
   path2,
   force
 ];
-var command6 = {
+var command7 = {
   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", {
+  builder: (yargs2) => build(options15, 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/deploy.ts
-import Project5, { versionsEqual as versionsEqual2, Workspace as Workspace8 } from "@openfn/project";
-import c2 from "chalk";
-var options15 = [
-  env2,
-  workspace,
-  dryRun2,
-  newProject,
-  name,
-  alias,
-  apiKey,
-  endpoint,
-  log,
-  logJson,
-  snapshots,
-  force,
-  confirm
-];
-var command7 = {
-  command: "deploy",
-  aliases: "push",
-  describe: `Deploy the checked out project to a Lightning Instance`,
-  builder: (yargs2) => build(options15, yargs2).positional("project", {
-    describe: "The UUID, local id or local alias of the project to deploy to"
-  }).example(
-    "deploy",
-    "Deploy the checkout project to the connected instance"
-  ),
-  handler: ensure("project-deploy", options15)
+  handler: ensure("project-pull", options15)
 };
 
 // src/projects/command.ts
@@ -1410,7 +1413,7 @@ var projectsCommand = {
   describe: "Sync and manage an OpenFn project",
   handler: () => {
   },
-  builder: (yargs2) => yargs2.command(command6).command(command7).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(command7).command(command3).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(

package/dist/process/runner.js

@@ -2072,7 +2072,7 @@ var loadAppAuthConfig = (options8, logger) => {
   const { OPENFN_API_KEY, OPENFN_ENDPOINT } = process.env;
   const config2 = {
     apiKey: options8.apiKey,
-    endpoint: options8.endpoint ?? "https://app.openfn.org"
+    endpoint: options8.endpoint ?? DEFAULT_ENDPOINT
   };
   if (!options8.apiKey && OPENFN_API_KEY) {
     logger.info("Using OPENFN_API_KEY environment variable");
@@ -2304,6 +2304,7 @@ var override = (command8, yargs) => {
 };
 
 // src/projects/deploy.ts
+var DEFAULT_ENDPOINT = "https://app.openfn.org";
 var options = [
   env,
   workspace,
@@ -2321,14 +2322,17 @@ var options = [
 ];
 var printProjectName = (project) => `${project.id} (${project.openfn?.uuid || "<no UUID>"})`;
 var command = {
-  command: "deploy",
+  command: "deploy [project]",
   aliases: "push",
   describe: `Deploy the checked out project to a Lightning Instance`,
   builder: (yargs) => build(options, yargs).positional("project", {
     describe: "The UUID, local id or local alias of the project to deploy to"
   }).example(
     "deploy",
-    "Deploy the checkout project to the connected instance"
+    "Deploy the checked-out project its connected remote instance"
+  ).example(
+    "deploy staging",
+    'Deploy the checkout-out project to the remote project with alias "staging"'
   ),
   handler: ensure("project-deploy", options)
 };
@@ -2340,41 +2344,36 @@ var hasRemoteDiverged = (local, remote, workflows = []) => {
     if (wf.id in refs) {
       const forkedVersion = refs[wf.id];
       const remoteVersion = remote.getWorkflow(wf.id)?.history.at(-1);
-      if (!versionsEqual2(forkedVersion, remoteVersion)) {
-        diverged ??= [];
-        diverged.push(wf.id);
+      if (remoteVersion) {
+        if (!versionsEqual2(forkedVersion, remoteVersion)) {
+          diverged ??= [];
+          diverged.push(wf.id);
+        }
       }
     } else {
     }
   }
   return diverged;
 };
-var syncProjects = async (options8, config2, ws, localProject, logger) => {
-  logger.info("Attempting to load checked-out project from workspace");
+var syncProjects = async (options8, config2, ws, localProject, trackedProject, logger) => {
   let remoteProject;
   try {
+    logger.info("Fetching remote target ", printProjectName(trackedProject));
+    const endpoint2 = trackedProject.openfn?.endpoint ?? config2.endpoint;
     const { data } = await fetchProject(
-      config2.endpoint,
+      endpoint2,
       config2.apiKey,
-      localProject.uuid ?? localProject.id,
+      trackedProject.uuid,
       logger
     );
     remoteProject = await Project.from("state", data, {
-      endpoint: config2.endpoint
+      endpoint: endpoint2
     });
-    logger.success("Downloaded latest version of project at ", config2.endpoint);
+    logger.success("Downloaded latest version of project at ", endpoint2);
   } catch (e) {
     console.log(e);
     throw e;
   }
-  if (!options8.force && localProject.uuid !== remoteProject.uuid) {
-    logger.error(`UUID conflict!
-
-Your local project (${localProject.uuid}) has a different UUID to the remote project (${remoteProject.uuid}).
-
-Pass --force to override this error and deploy anyway.`);
-    process.exit(1);
-  }
   const locallyChangedWorkflows = await findLocallyChangedWorkflows(
     ws,
     localProject
@@ -2389,9 +2388,7 @@ Pass --force to override this error and deploy anyway.`);
     logger.success("Nothing to deploy");
     process.exit(0);
   }
-  const skipVersionTest = remoteProject.workflows.find(
-    (wf) => wf.history.length === 0
-  );
+  const skipVersionTest = options8.force || remoteProject.workflows.find((wf) => wf.history.length === 0);
   if (skipVersionTest) {
     logger.warn(
       "Skipping compatibility check as no local version history detected"
@@ -2427,7 +2424,9 @@ Pass --force to override this error and deploy anyway.`);
   }
   logger.info("Merging changes into remote project");
   const merged = Project.merge(localProject, remoteProject, {
-    mode: "replace",
+    // If pushing the same project, we use a replace strategy
+    // Otherwise, use the sandbox strategy to preserve UUIDs
+    mode: localProject.uuid === remoteProject.uuid ? "replace" : "sandbox",
     force: true,
     onlyUpdated: true
   });
@@ -2446,35 +2445,47 @@ async function handler(options8, logger) {
     alias: alias2,
     name: options8.name
   });
+  const tracker = ws.get(options8.project ?? localProject.uuid);
+  if (!tracker) {
+    console.log(
+      `ERROR: Failed to find tracked remote project ${options8.project ?? localProject.uuid} locally`
+    );
+    console.log("To deploy a new project, add --new to the command");
+    console.log(
+      "You may need to fetch the project before you can safely deploy"
+    );
+    throw new Error("Failed to find remote project locally");
+  }
+  let endpoint2 = tracker.openfn?.endpoint ?? "";
   if (options8.new) {
+    endpoint2 = config2.endpoint ?? localProject.openfn?.endpoint ?? DEFAULT_ENDPOINT;
     localProject.openfn = {
       endpoint: config2.endpoint
     };
   }
   localProject.credentials = localProject.buildCredentialMap();
-  logger.success(`Loaded local project ${printProjectName(localProject)}`);
-  const merged = options8.new ? localProject : await syncProjects(options8, config2, ws, localProject, logger);
+  logger.success(
+    `Loaded checked-out project ${printProjectName(localProject)}`
+  );
+  const merged = options8.new ? localProject : await syncProjects(options8, config2, ws, localProject, tracker, logger);
   const state = merged.serialize("state", {
     format: "json"
   });
   logger.debug("Provisioner state ready to upload:");
   logger.debug(JSON.stringify(state, null, 2));
   logger.debug();
-  config2.endpoint ??= localProject.openfn?.endpoint;
   if (options8.dryRun) {
     logger.always("dryRun option set: skipping upload step");
   } else {
     if (options8.confirm) {
-      if (!await logger.confirm(
-        `Ready to deploy changes to ${config2.endpoint}?`
-      )) {
+      if (!await logger.confirm(`Ready to deploy changes to ${endpoint2}?`)) {
         logger.always("Cancelled deployment");
         return false;
       }
     }
     logger.info("Sending project to app...");
     const { data: result } = await deployProject(
-      config2.endpoint,
+      endpoint2,
       config2.apiKey,
       state,
       logger
@@ -2483,7 +2494,7 @@ async function handler(options8, logger) {
       "state",
       result,
       {
-        endpoint: config2.endpoint,
+        endpoint: endpoint2,
         alias: alias2
       },
       merged.config
@@ -2497,7 +2508,7 @@ async function handler(options8, logger) {
     const finalOutputPath = getSerializePath(localProject, options8.workspace);
     const fullFinalPath = await serialize(finalProject, finalOutputPath);
     logger.debug("Updated local project at ", fullFinalPath);
-    logger.success("Updated project  at", config2.endpoint);
+    logger.success("Updated project  at", endpoint2);
   }
 }
 var reportDiff = (local, remote, locallyChangedWorkflows, logger) => {
@@ -3592,7 +3603,7 @@ var options7 = [
 ];
 var command7 = {
   command: "merge <project>",
-  describe: "Merges the specified project (by UUID, id or alias) into the currently checked out project",
+  describe: "Merges the currently checked-out project into the target project, and checks out the result. Does not update the remote project or local project.yaml file",
   handler: ensure("project-merge", options7),
   builder: (yargs) => build(options7, yargs)
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/cli",
-  "version": "1.28.0",
+  "version": "1.28.1",
   "description": "CLI devtools for the OpenFn toolchain",
   "engines": {
     "node": ">=18",
@@ -53,10 +53,10 @@
     "@openfn/compiler": "1.2.2",
     "@openfn/deploy": "0.11.5",
     "@openfn/describe-package": "0.1.5",
-    "@openfn/lexicon": "^1.4.1",
     "@openfn/logger": "1.1.1",
-    "@openfn/project": "^0.14.0",
-    "@openfn/runtime": "1.8.4"
+    "@openfn/project": "^0.14.1",
+    "@openfn/runtime": "1.8.4",
+    "@openfn/lexicon": "^1.4.1"
   },
   "files": [
     "dist",