@openfn/cli 1.26.0 → 1.28.0

package/dist/index.js

@@ -51,15 +51,15 @@ import nodePath from "node:path";
 var DEFAULT_REPO_DIR = "/tmp/openfn/repo";
 
 // src/util/expand-adaptors.ts
-var expand2 = (name) => {
-  if (typeof name === "string") {
-    const [left] = name.split("=");
+var expand2 = (name2) => {
+  if (typeof name2 === "string") {
+    const [left] = name2.split("=");
     if (left.match("/") || left.endsWith(".js")) {
-      return name;
+      return name2;
     }
-    return `@openfn/language-${name}`;
+    return `@openfn/language-${name2}`;
   }
-  return name;
+  return name2;
 };
 var expand_adaptors_default = (input) => {
   if (Array.isArray(input)) {
@@ -982,6 +982,21 @@ var workspace = {
     }
   }
 };
+var newProject = {
+  name: "new",
+  yargs: {
+    description: "Create a new project when deploying",
+    default: false,
+    boolean: true
+  }
+};
+var name = {
+  name: "name",
+  yargs: {
+    type: "string",
+    description: "When deploying a new project, set the name"
+  }
+};
 
 // src/deploy/command.ts
 var options3 = [
@@ -1364,6 +1379,9 @@ var options15 = [
   env2,
   workspace,
   dryRun2,
+  newProject,
+  name,
+  alias,
   apiKey,
   endpoint,
   log,

package/dist/process/runner.js

@@ -1,7 +1,7 @@
 var __defProp = Object.defineProperty;
 var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
+  for (var name2 in all)
+    __defProp(target, name2, { get: all[name2], enumerable: true });
 };
 
 // src/apollo/handler.ts
@@ -169,14 +169,14 @@ var namespaces = {
   [COMPILER]: "CMP",
   [JOB]: "JOB"
 };
-var createLogger2 = (name = "", options8) => {
+var createLogger2 = (name2 = "", options8) => {
   const logOptions = options8.log || {};
   let json = false;
-  let level = logOptions[name] || logOptions.default || "default";
+  let level = logOptions[name2] || logOptions.default || "default";
   if (options8.logJson) {
     json = true;
   }
-  return actualCreateLogger(namespaces[name] || name, {
+  return actualCreateLogger(namespaces[name2] || name2, {
     level,
     json,
     sanitize: options8.sanitize || "none",
@@ -277,9 +277,9 @@ var execute_default = async (plan, input, opts, logger) => {
 function parseAdaptors(plan) {
   const extractInfo = (specifier) => {
     const [module, path18] = specifier.split("=");
-    const { name, version } = getNameAndVersion(module);
+    const { name: name2, version } = getNameAndVersion(module);
     const info = {
-      name
+      name: name2
     };
     if (path18) {
       info.path = path18;
@@ -293,8 +293,8 @@ function parseAdaptors(plan) {
   Object.values(plan.workflow.steps).forEach((step) => {
     const job = step;
     job.adaptors?.forEach((adaptor) => {
-      const { name, ...maybeVersionAndPath } = extractInfo(adaptor);
-      adaptors[name] = maybeVersionAndPath;
+      const { name: name2, ...maybeVersionAndPath } = extractInfo(adaptor);
+      adaptors[name2] = maybeVersionAndPath;
     });
   });
   return adaptors;
@@ -410,12 +410,12 @@ var install = async (opts, log2 = defaultLogger) => {
   return [];
 };
 var removePackage = async (packageSpecifier, repoDir, logger) => {
-  const { name, version } = getNameAndVersion2(packageSpecifier);
+  const { name: name2, version } = getNameAndVersion2(packageSpecifier);
   if (!version) {
     logger.warn(`Cannot remove ${packageSpecifier}: no version specified`);
     return;
   }
-  const aliasedName = `${name}_${version}`;
+  const aliasedName = `${name2}_${version}`;
   logger.info(`Removing package ${aliasedName} from repo...`);
   try {
     await new Promise((resolve, reject) => {
@@ -461,11 +461,11 @@ var getDependencyList = async (options8, _logger) => {
   const result = {};
   if (pkg) {
     Object.keys(pkg.dependencies).forEach((key) => {
-      const [name, version] = key.split("_");
-      if (!result[name]) {
-        result[name] = [];
+      const [name2, version] = key.split("_");
+      if (!result[name2]) {
+        result[name2] = [];
       }
-      result[name].push(version);
+      result[name2].push(version);
     });
   }
   return result;
@@ -765,15 +765,15 @@ import { isPath } from "@openfn/compiler";
 import { Workspace, yamlToJson } from "@openfn/project";
 
 // src/util/expand-adaptors.ts
-var expand = (name) => {
-  if (typeof name === "string") {
-    const [left] = name.split("=");
+var expand = (name2) => {
+  if (typeof name2 === "string") {
+    const [left] = name2.split("=");
     if (left.match("/") || left.endsWith(".js")) {
-      return name;
+      return name2;
     }
-    return `@openfn/language-${name}`;
+    return `@openfn/language-${name2}`;
   }
-  return name;
+  return name2;
 };
 var expand_adaptors_default = (input) => {
   if (Array.isArray(input)) {
@@ -808,16 +808,16 @@ var updatePath = (adaptor, repoPath, log2) => {
   if (adaptor.match("=")) {
     return adaptor;
   }
-  const { name, version } = getNameAndVersion3(adaptor);
+  const { name: name2, version } = getNameAndVersion3(adaptor);
   if (version) {
     log2.warn(
       `Warning: Ignoring version specifier on ${adaptor} as loading from the adaptors monorepo`
     );
   }
-  const shortName = name.replace("@openfn/language-", "");
+  const shortName = name2.replace("@openfn/language-", "");
   const abspath = path3.resolve(repoPath, "packages", shortName);
-  log2.info(`Mapped adaptor ${name} to monorepo: ${abspath}`);
-  return `${name}=${abspath}`;
+  log2.info(`Mapped adaptor ${name2} to monorepo: ${abspath}`);
+  return `${name2}=${abspath}`;
 };
 var mapAdaptorsToMonorepo = (monorepoPath = "", input = [], log2) => {
   if (monorepoPath) {
@@ -858,10 +858,10 @@ var loadPlan = async (options8, logger) => {
     );
     const workspace2 = new Workspace(options8.workspace);
     const proj = await workspace2.getCheckedOutProject();
-    const name = workflowName || options8.workflow;
-    const workflow2 = proj?.getWorkflow(name);
+    const name2 = workflowName || options8.workflow;
+    const workflow2 = proj?.getWorkflow(name2);
     if (!workflow2) {
-      const e = new Error(`Could not find Workflow "${name}"`);
+      const e = new Error(`Could not find Workflow "${name2}"`);
       delete e.stack;
       throw e;
     }
@@ -870,7 +870,7 @@ var loadPlan = async (options8, logger) => {
     };
     options8.credentials ??= workspace2.getConfig().credentials;
     options8.collectionsEndpoint ??= proj.openfn?.endpoint;
-    options8.cachePath ??= workspace2.workflowsPath + `/${name}/${CACHE_DIR}`;
+    options8.cachePath ??= workspace2.workflowsPath + `/${name2}/${CACHE_DIR}`;
   }
   if (options8.path && /ya?ml$/.test(options8.path)) {
     const content = await fs3.readFile(path4.resolve(options8.path), "utf-8");
@@ -945,7 +945,7 @@ var loadExpression = async (options8, logger) => {
   logger.debug(`Loading expression from ${expressionPath}`);
   try {
     const expression = await fs3.readFile(expressionPath, "utf8");
-    const name = path4.parse(expressionPath).name;
+    const name2 = path4.parse(expressionPath).name;
     const step = {
       expression,
       // The adaptor should have been expanded nicely already, so we don't need intervene here
@@ -955,7 +955,7 @@ var loadExpression = async (options8, logger) => {
     maybeAssign(options8, wfOptions, ["timeout"]);
     const plan = {
       workflow: {
-        name,
+        name: name2,
         steps: [step],
         globals: options8.globals
       },
@@ -990,7 +990,7 @@ var loadOldWorkflow = async (workflow2, options8, logger, defaultName = "") => {
   return final;
 };
 var fetchFile = async (fileInfo, log2) => {
-  const { rootDir = "", filePath, name } = fileInfo;
+  const { rootDir = "", filePath, name: name2 } = fileInfo;
   try {
     const fullPath = resolve_path_default(filePath, rootDir);
     const result = await fs3.readFile(fullPath, "utf8");
@@ -999,7 +999,7 @@ var fetchFile = async (fileInfo, log2) => {
   } catch (e) {
     abort_default(
       log2,
-      `File not found for ${name}: ${filePath}`,
+      `File not found for ${name2}: ${filePath}`,
       void 0,
       `This workflow references a file which cannot be found at ${filePath}
 
@@ -2038,6 +2038,21 @@ var workspace = {
     }
   }
 };
+var newProject = {
+  name: "new",
+  yargs: {
+    description: "Create a new project when deploying",
+    default: false,
+    boolean: true
+  }
+};
+var name = {
+  name: "name",
+  yargs: {
+    type: "string",
+    description: "When deploying a new project, set the name"
+  }
+};
 
 // src/projects/util.ts
 import path9 from "node:path";
@@ -2057,7 +2072,7 @@ var loadAppAuthConfig = (options8, logger) => {
   const { OPENFN_API_KEY, OPENFN_ENDPOINT } = process.env;
   const config2 = {
     apiKey: options8.apiKey,
-    endpoint: options8.endpoint
+    endpoint: options8.endpoint ?? "https://app.openfn.org"
   };
   if (!options8.apiKey && OPENFN_API_KEY) {
     logger.info("Using OPENFN_API_KEY environment variable");
@@ -2067,6 +2082,11 @@ var loadAppAuthConfig = (options8, logger) => {
     logger.info("Using OPENFN_ENDPOINT environment variable");
     config2.endpoint = OPENFN_ENDPOINT;
   }
+  if (!config2.apiKey) {
+    throw new CLIError(
+      "OPENFN_API_KEY is required. Set it in .env, pass --api-key, or set the environment variable."
+    );
+  }
   return config2;
 };
 var ensureExt = (filePath, ext) => {
@@ -2101,6 +2121,11 @@ var serialize = async (project, outputPath2, formatOverride, dryRun2 = false) =>
   return finalPath;
 };
 var getLightningUrl = (endpoint2, path18 = "", snapshots2) => {
+  if (!endpoint2) {
+    throw new CLIError(
+      "OPENFN_ENDPOINT is required. Set it in .env, pass --endpoint, or set the environment variable.\nExample: OPENFN_ENDPOINT=https://app.openfn.org"
+    );
+  }
   const params = new URLSearchParams();
   snapshots2?.forEach((snapshot) => params.append("snapshots[]", snapshot));
   return new URL(`/api/provision/${path18}?${params.toString()}`, endpoint2);
@@ -2283,6 +2308,9 @@ var options = [
   env,
   workspace,
   dryRun,
+  newProject,
+  name,
+  alias,
   apiKey,
   endpoint,
   log,
@@ -2321,19 +2349,8 @@ var hasRemoteDiverged = (local, remote, workflows = []) => {
   }
   return diverged;
 };
-async function handler(options8, logger) {
-  logger.warn(
-    "WARNING: the project deploy command is in BETA and may not be stable. Use cautiously on production projects."
-  );
-  const config2 = loadAppAuthConfig(options8, logger);
+var syncProjects = async (options8, config2, ws, localProject, logger) => {
   logger.info("Attempting to load checked-out project from workspace");
-  const ws = new Workspace3(options8.workspace || ".");
-  const { alias: alias2 } = ws.getActiveProject();
-  const localProject = await Project.from("fs", {
-    root: options8.workspace || ".",
-    alias: alias2
-  });
-  logger.success(`Loaded local project ${printProjectName(localProject)}`);
   let remoteProject;
   try {
     const { data } = await fetchProject(
@@ -2356,7 +2373,7 @@ async function handler(options8, logger) {
 Your local project (${localProject.uuid}) has a different UUID to the remote project (${remoteProject.uuid}).
 
 Pass --force to override this error and deploy anyway.`);
-    return false;
+    process.exit(1);
   }
   const locallyChangedWorkflows = await findLocallyChangedWorkflows(
     ws,
@@ -2370,7 +2387,7 @@ Pass --force to override this error and deploy anyway.`);
   );
   if (!diffs.length) {
     logger.success("Nothing to deploy");
-    return;
+    process.exit(0);
   }
   const skipVersionTest = remoteProject.workflows.find(
     (wf) => wf.history.length === 0
@@ -2396,7 +2413,7 @@ Pass --force to override this error and deploy anyway.`);
   The remote project has been edited since the local project was branched. Changes may be lost.
 
   Pass --force to override this error and deploy anyway.`);
-        return;
+        process.exit(1);
       } else {
         logger.warn(
           "Remote project has diverged from local project! Pushing anyway as -f passed"
@@ -2414,11 +2431,35 @@ Pass --force to override this error and deploy anyway.`);
     force: true,
     onlyUpdated: true
   });
+  return merged;
+};
+async function handler(options8, logger) {
+  logger.warn(
+    "WARNING: the project deploy command is in BETA and may not be stable. Use cautiously on production projects."
+  );
+  const config2 = loadAppAuthConfig(options8, logger);
+  const ws = new Workspace3(options8.workspace || ".");
+  const active = ws.getActiveProject();
+  const alias2 = options8.alias ?? active?.alias;
+  const localProject = await Project.from("fs", {
+    root: options8.workspace || ".",
+    alias: alias2,
+    name: options8.name
+  });
+  if (options8.new) {
+    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);
   const state = merged.serialize("state", {
     format: "json"
   });
-  logger.debug("Converted merged local project to app state:");
+  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");
@@ -2442,7 +2483,8 @@ Pass --force to override this error and deploy anyway.`);
       "state",
       result,
       {
-        endpoint: config2.endpoint
+        endpoint: config2.endpoint,
+        alias: alias2
       },
       merged.config
     );
@@ -2646,7 +2688,7 @@ import c3 from "chalk";
 import { getNameAndVersion as getNameAndVersion5, getLatestVersion } from "@openfn/runtime";
 var describeFn = (adaptorName, fn) => [
   c3.green(
-    `## ${fn.name}(${fn.parameters.map(({ name }) => name).join(",")})`
+    `## ${fn.name}(${fn.parameters.map(({ name: name2 }) => name2).join(",")})`
   ),
   `${fn.description}`,
   c3.green("### Usage Examples"),
@@ -2674,17 +2716,17 @@ var docsHandler = async (options8, logger) => {
   const { adaptor, operation, repoDir } = options8;
   const adaptors = expand_adaptors_default([adaptor]);
   const [adaptorName] = adaptors;
-  let { name, version } = getNameAndVersion5(adaptorName);
+  let { name: name2, version } = getNameAndVersion5(adaptorName);
   if (!version) {
     logger.info("No version number provided, looking for latest...");
-    version = await getLatestVersion(name);
+    version = await getLatestVersion(name2);
     logger.info("Found ", version);
     logger.success(`Showing docs for ${adaptorName} v${version}`);
   }
   logger.info("Generating/loading documentation...");
   const path18 = await handler_default7(
     {
-      specifier: `${name}@${version}`,
+      specifier: `${name2}@${version}`,
       repoDir
     },
     // TODO I'm not sure how to handle logging here - we ought to feedback SOMETHING though
@@ -2696,24 +2738,24 @@ var docsHandler = async (options8, logger) => {
     const data = JSON.parse(source);
     let desc;
     if (operation) {
-      const fn = data.functions.find(({ name: name2 }) => name2 === operation);
+      const fn = data.functions.find(({ name: name3 }) => name3 === operation);
       if (fn) {
         logger.debug("Operation schema:", fn);
         logger.break();
-        desc = describeFn(name, fn);
+        desc = describeFn(name2, fn);
       } else {
-        logger.error(`Failed to find ${operation} in ${name}`);
+        logger.error(`Failed to find ${operation} in ${name2}`);
       }
     } else {
       logger.debug("No operation name provided");
       logger.always("Available functions:\n");
-      desc = describeLib(name, data);
+      desc = describeLib(name2, data);
     }
     logger.print(desc);
     if (!operation) {
       logger.always(`For more details on a specfic functions, use:
     
-    openfn docs ${name} <fn>
+    openfn docs ${name2} <fn>
 `);
     }
     if (didError) {
@@ -2803,14 +2845,14 @@ var compareVersions = (version1, version2) => {
   return v1.patch - v2.patch;
 };
 var isAdaptorUnsupported = async (adaptorSpecifier, repoDir) => {
-  const { name, version } = getNameAndVersion6(adaptorSpecifier);
+  const { name: name2, version } = getNameAndVersion6(adaptorSpecifier);
   if (!version)
     return false;
   const cache = await getUnsupportedCache(repoDir);
-  if (!cache || !cache[name]) {
+  if (!cache || !cache[name2]) {
     return false;
   }
-  const cached = cache[name];
+  const cached = cache[name2];
   const currentParsed = parseVersion(version);
   const cachedParsed = parseVersion(cached.lastCheckedVersion);
   if (currentParsed.major > cachedParsed.major || currentParsed.major === cachedParsed.major && currentParsed.minor > cachedParsed.minor) {
@@ -2819,7 +2861,7 @@ var isAdaptorUnsupported = async (adaptorSpecifier, repoDir) => {
   return true;
 };
 var markAdaptorAsUnsupported = async (adaptorSpecifier, repoDir) => {
-  const { name, version } = getNameAndVersion6(adaptorSpecifier);
+  const { name: name2, version } = getNameAndVersion6(adaptorSpecifier);
   if (!version)
     return;
   const cachePath = getUnsupportedCachePath(repoDir);
@@ -2830,9 +2872,9 @@ var markAdaptorAsUnsupported = async (adaptorSpecifier, repoDir) => {
   } catch (error) {
   }
   const parsed = parseVersion(version);
-  const existing = cache[name];
+  const existing = cache[name2];
   if (!existing || compareVersions(version, existing.lastCheckedVersion) > 0) {
-    cache[name] = {
+    cache[name2] = {
       lastCheckedVersion: version,
       majorMinor: parsed.majorMinor,
       timestamp: Date.now()
@@ -3674,8 +3716,8 @@ var printVersions = async (logger, options8 = {}, includeComponents = false) =>
       adaptorName = getNameAndVersion7(adaptor).name;
       adaptorVersion = "monorepo";
     } else {
-      const { name, version: version2 } = getNameAndVersion7(adaptor);
-      adaptorName = name;
+      const { name: name2, version: version2 } = getNameAndVersion7(adaptor);
+      adaptorName = name2;
       adaptorVersion = version2 || "latest";
     }
     adaptorList.push([adaptorName, adaptorVersion]);
@@ -3705,8 +3747,8 @@ var printVersions = async (logger, options8 = {}, includeComponents = false) =>
       output.versions.compiler = compilerVersion;
     }
     if (adaptorList.length) {
-      for (const [name, version2] of adaptorList) {
-        output.versions[name] = version2;
+      for (const [name2, version2] of adaptorList) {
+        output.versions[name2] = version2;
       }
     }
   } else {
@@ -3719,9 +3761,9 @@ ${prefix(RUNTIME2)}${runtimeVersion}
 ${prefix(COMPILER2)}${compilerVersion}`;
     }
     if (adaptorList.length) {
-      for (const [name, version2] of adaptorList) {
+      for (const [name2, version2] of adaptorList) {
         output += `
-${prefix(name)}${version2}`;
+${prefix(name2)}${version2}`;
       }
     }
   }

package/package.json

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