@openfn/cli 1.18.1 → 1.18.3

package/dist/index.js

@@ -356,10 +356,10 @@ var getBaseDir = (opts2) => {
   }
   return basePath;
 };
-var projectName = {
-  name: "project-name",
+var projectId = {
+  name: "project-id",
   yargs: {
-    description: "The name of an openfn project",
+    description: "The id or UUID of an openfn project",
     string: true
   },
   ensure: (opts2) => {
@@ -1120,9 +1120,9 @@ var projectsCommand = {
 var command_default11 = projectsCommand;
 
 // src/checkout/command.ts
-var options10 = [projectName, projectPath, log];
+var options10 = [projectId, projectPath, log];
 var checkoutCommand = {
-  command: "checkout <project-name>",
+  command: "checkout <project-id>",
   describe: "Switch to a different openfn project in the same workspace",
   handler: ensure("checkout", options10),
   builder: (yargs2) => build(options10, yargs2)
@@ -1131,17 +1131,32 @@ var command_default12 = checkoutCommand;
 
 // src/merge/command.ts
 var options11 = [
-  projectName,
+  projectId,
   projectPath,
   removeUnmapped,
   workflowMappings,
   log,
+  // custom output because we don't want defaults or anything
+  {
+    name: "output-path",
+    yargs: {
+      alias: "o",
+      description: "Optionally write the merged project file to a custom location"
+    }
+  },
+  {
+    name: "base",
+    yargs: {
+      alias: "target",
+      description: "Path to the base (target) state file to merge into (ie, what main should be)"
+    }
+  },
   override(force, {
     description: "Force a merge even when workflows are incompatible"
   })
 ];
 var mergeCommand = {
-  command: "merge [project-name]",
+  command: "merge <project-id>",
   describe: "Merges the specified project into the checked out project",
   handler: ensure("merge", options11),
   builder: (yargs2) => build(options11, yargs2)
@@ -1149,13 +1164,7 @@ var mergeCommand = {
 var command_default13 = mergeCommand;
 
 // src/version/command.ts
-var options12 = [
-  workflow,
-  projectName,
-  projectPath,
-  workflowMappings,
-  json
-];
+var options12 = [workflow, projectPath, workflowMappings, json];
 var workflowVersionCommand = {
   command: "project version [workflow]",
   describe: "Returns the version has of a workflow",

package/dist/process/runner.js

@@ -2127,12 +2127,16 @@ async function handler2(options, logger) {
   const config = workspace.getConfig();
   const { data } = await getProject(cfg, options.projectId);
   const name = options.env || "project";
-  const project = Project3.from("state", data, {
-    config,
-    endpoint: cfg.endpoint,
-    env: name,
-    fetched_at: (/* @__PURE__ */ new Date()).toISOString()
-  });
+  const project = await Project3.from(
+    "state",
+    data,
+    {
+      endpoint: cfg.endpoint,
+      env: name,
+      fetched_at: (/* @__PURE__ */ new Date()).toISOString()
+    },
+    config
+  );
   const projectFileName = project.getIdentifier();
   await fs4.mkdir(`${outputRoot}/.projects`, { recursive: true });
   let stateOutputPath = `${outputRoot}/.projects/${projectFileName}`;
@@ -2285,15 +2289,15 @@ var projectsHandler = async (options, logger) => {
   }
   logger.success(`Available openfn projects
 
-${workspace.list().map((p) => describeProject(p, p.name === workspace.activeProjectId)).join("\n\n")}
+${workspace.list().map((p) => describeProject(p, p.id === workspace.activeProjectId)).join("\n\n")}
     `);
 };
 function describeProject(project, active = false) {
-  const pId = project.openfn?.uuid;
-  return `${project.name} ${active ? "(active)" : ""}
-  ${pId || "<project-id>"}
+  const uuid = project.openfn?.uuid;
+  return `${project.id} ${active ? "(active)" : ""}
+  ${uuid || "<project-id>"}
   workflows:
-${project.workflows.map((w) => "    - " + w.name).join("\n")}`;
+${project.workflows.map((w) => "    - " + w.id).join("\n")}`;
 }
 var handler_default11 = projectsHandler;
 
@@ -2312,7 +2316,7 @@ var workflowVersionHandler = async (options, logger) => {
   if (options.workflow) {
     const workflow = activeProject?.getWorkflow(options.workflow);
     if (!workflow) {
-      logger.error(`No workflow found with id/name ${options.workflow}`);
+      logger.error(`No workflow found with id ${options.workflow}`);
       return;
     }
     output.set(workflow.name || workflow.id, workflow.getVersionHash());
@@ -2351,20 +2355,17 @@ var checkoutHandler = async (options, logger) => {
   }
   const { project: _, ...config } = workspace.getConfig();
   let switchProject;
-  if (/\.(yaml|json)$/.test(options.projectName)) {
-    const filePath = path13.join(commandPath, options.projectName);
+  if (/\.(yaml|json)$/.test(options.projectId)) {
+    const filePath = options.projectId.startsWith("/") ? options.projectId : path13.join(commandPath, options.projectId);
     logger.debug("Loading project from path ", filePath);
-    switchProject = await Project5.from("path", filePath, {
-      config
-    });
+    switchProject = await Project5.from("path", filePath, config);
   } else {
-    switchProject = workspace.get(options.projectName);
+    switchProject = workspace.get(options.projectId);
   }
   if (!switchProject) {
-    logger.error(
-      `Project with id/name ${options.projectName} not found in the workspace`
+    throw new Error(
+      `Project with id ${options.projectId} not found in the workspace`
     );
-    return;
   }
   await rimraf2(path13.join(commandPath, config.workflowRoot ?? "workflows"));
   const files = switchProject.serialize("fs");
@@ -2393,32 +2394,41 @@ var mergeHandler = async (options, logger) => {
     logger.error("Command was run in an invalid openfn workspace");
     return;
   }
-  const targetProject = workspace.getActiveProject();
-  if (!targetProject) {
-    logger.error(`No project currently checked out`);
-    return;
+  let targetProject;
+  if (options.base) {
+    const basePath = path14.resolve(options.base);
+    logger.debug("Loading target project from path", basePath);
+    targetProject = await Project6.from("path", basePath);
+  } else {
+    targetProject = workspace.getActiveProject();
+    if (!targetProject) {
+      logger.error(`No project currently checked out`);
+      return;
+    }
+    logger.debug(`Loading target project from workspace (${targetProject.id})`);
   }
   let sourceProject;
-  if (/\.(yaml|json)$/.test(options.projectName)) {
-    const filePath = path14.join(commandPath, options.projectName);
+  if (/\.(yaml|json)$/.test(options.projectId)) {
+    const filePath = path14.join(commandPath, options.projectId);
     logger.debug("Loading source project from path ", filePath);
     sourceProject = await Project6.from("path", filePath);
   } else {
-    sourceProject = workspace.get(options.projectName);
+    logger.debug(`Loading source project from workspace ${options.projectId}`);
+    sourceProject = workspace.get(options.projectId);
   }
   if (!sourceProject) {
-    logger.error(`Project "${options.projectName}" not found in the workspace`);
+    logger.error(`Project "${options.projectId}" not found in the workspace`);
     return;
   }
-  if (targetProject.name === sourceProject.name) {
+  if (targetProject.id === sourceProject.id) {
     logger.error("Merging into the same project not allowed");
     return;
   }
-  if (!targetProject.name) {
-    logger.error("The checked out project has no name/id");
+  if (!targetProject.id) {
+    logger.error("The checked out project has no id");
     return;
   }
-  const finalPath = workspace.getProjectPath(targetProject.name);
+  const finalPath = options.outputPath ?? workspace.getProjectPath(targetProject.id);
   if (!finalPath) {
     logger.error("Path to checked out project not found.");
     return;
@@ -2428,19 +2438,32 @@ var mergeHandler = async (options, logger) => {
     workflowMappings: options.workflowMappings,
     force: options.force
   });
-  const yaml = final.serialize("state", { format: "yaml" });
-  await fs7.writeFile(finalPath, yaml);
+  let outputFormat = workspace.config.formats.project;
+  if (options.outputPath?.endsWith(".json")) {
+    outputFormat = "json";
+  } else if (options.outputPath?.endsWith(".yaml")) {
+    outputFormat = "yaml";
+  }
+  let finalState = final.serialize("state", {
+    format: outputFormat
+  });
+  if (outputFormat === "json") {
+    finalState = JSON.stringify(finalState, null, 2);
+  }
+  await fs7.writeFile(finalPath, finalState);
+  logger.info(`Updated statefile at `, finalPath);
+  logger.info("Checking out merged project to filesystem");
   await handler_default13(
     {
       command: "checkout",
       projectPath: commandPath,
-      projectName: final.name || "",
+      projectId: options.outputPath ? finalPath : final.id,
       log: options.log
     },
     logger
   );
   logger.success(
-    `Project ${sourceProject.name} has been merged into Project ${targetProject.name} successfully`
+    `Project ${sourceProject.id} has been merged into Project ${targetProject.id} successfully`
   );
 };
 var handler_default14 = mergeHandler;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/cli",
-  "version": "1.18.1",
+  "version": "1.18.3",
   "description": "CLI devtools for the OpenFn toolchain",
   "engines": {
     "node": ">=18",
@@ -50,10 +50,10 @@
     "@openfn/compiler": "1.1.5",
     "@openfn/deploy": "0.11.3",
     "@openfn/describe-package": "0.1.5",
+    "@openfn/lexicon": "^1.2.6",
     "@openfn/logger": "1.0.6",
-    "@openfn/project": "^0.7.0",
-    "@openfn/lexicon": "^1.2.5",
-    "@openfn/runtime": "1.7.4"
+    "@openfn/project": "^0.7.2",
+    "@openfn/runtime": "1.7.5"
   },
   "files": [
     "dist",