@openfn/cli 1.20.0 → 1.20.2

package/dist/index.js

@@ -629,6 +629,7 @@ var ensure = (command6, opts2) => (yargs2) => {
     try {
       opt.ensure(yargs2);
     } catch (e) {
+      console.log(e);
       console.error(
         c.red(`
 Error parsing command arguments: ${command6}.${opt.name}
@@ -725,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"
   }
 };
@@ -780,7 +782,7 @@ var getOptions = [
   collectionName,
   key,
   token,
-  lightningUrl,
+  endpoint2,
   pageSize,
   limit,
   pretty,
@@ -816,7 +818,7 @@ var removeOptions = [
   collectionName,
   key,
   token,
-  lightningUrl,
+  endpoint2,
   dryRun,
   createdBefore,
   createdAfter,
@@ -851,7 +853,7 @@ var setOptions = [
     demand: false
   }),
   token,
-  lightningUrl,
+  endpoint2,
   value,
   items,
   override(log, {
@@ -915,7 +917,8 @@ var options3 = [
   log,
   logJson,
   projectPath,
-  statePath
+  statePath,
+  override(workspace, { hidden: true })
 ];
 var deployCommand = {
   command: "deploy",

package/dist/process/runner.js

@@ -1344,7 +1344,7 @@ var request_default = async (method, options6, logger) => {
       logger.error(e);
       throwAbortableError(
         `CONNECTION_REFUSED: error connecting to server at ${base}`,
-        "Check you have passed the correct URL to --lightning or OPENFN_ENDPOINT"
+        "Check you have passed the correct URL to --endpoint or OPENFN_ENDPOINT"
       );
     }
   } while (cursor && count < limit);
@@ -1432,7 +1432,7 @@ var get = async (options6, logger) => {
   let result = await request_default(
     "GET",
     {
-      lightning: options6.lightning,
+      lightning: options6.endpoint,
       token: options6.token,
       pageSize: options6.pageSize,
       limit: options6.limit,
@@ -1492,7 +1492,7 @@ var set = async (options6, logger) => {
   const result = await request_default(
     "POST",
     {
-      lightning: options6.lightning,
+      lightning: options6.endpoint,
       token: options6.token,
       key: options6.key,
       collectionName: options6.collectionName,
@@ -1512,7 +1512,7 @@ var remove = async (options6, logger) => {
     let result = await request_default(
       "GET",
       {
-        lightning: options6.lightning,
+        lightning: options6.endpoint,
         token: options6.token,
         key: options6.key,
         collectionName: options6.collectionName
@@ -1527,7 +1527,7 @@ var remove = async (options6, logger) => {
     let result = await request_default(
       "DELETE",
       {
-        lightning: options6.lightning,
+        lightning: options6.endpoint,
         token: options6.token,
         key: options6.key,
         collectionName: options6.collectionName,
@@ -1603,7 +1603,7 @@ var handler_default5 = testHandler;
 
 // src/deploy/handler.ts
 import {
-  DeployError,
+  DeployError as DeployError2,
   deploy,
   getConfig,
   validateConfig
@@ -1612,22 +1612,120 @@ import {
 // src/deploy/beta.ts
 import Project2 from "@openfn/project";
 import { deployProject } from "@openfn/deploy";
-async function handler(options6, logger) {
-  const { OPENFN_API_KEY } = process.env;
-  const { endpoint: endpoint2 } = options6;
+
+// src/projects/util.ts
+import path7 from "node:path";
+import { mkdir as mkdir3, writeFile as writeFile5 } from "node:fs/promises";
+
+// src/errors.ts
+var CLIError = class extends Error {
+  constructor(message) {
+    super(message);
+  }
+};
+
+// src/projects/util.ts
+var loadAppAuthConfig = (options6, logger) => {
+  const { OPENFN_API_KEY, OPENFN_ENDPOINT } = process.env;
   const config2 = {
-    apiKey: options6.apiKey
+    apiKey: options6.apiKey,
+    endpoint: options6.endpoint
   };
   if (!options6.apiKey && OPENFN_API_KEY) {
     logger.info("Using OPENFN_API_KEY environment variable");
     config2.apiKey = OPENFN_API_KEY;
   }
-  const project = await Project2.from("fs", { root: options6.path || "." });
-  console.log({ openfn: project.openfn });
+  if (!options6.endpoint && OPENFN_ENDPOINT) {
+    logger.info("Using OPENFN_ENDPOINT environment variable");
+    config2.endpoint = OPENFN_ENDPOINT;
+  }
+  return config2;
+};
+var ensureExt = (filePath, ext) => {
+  if (!filePath.endsWith(ext)) {
+    return `${filePath}.${ext}`;
+  }
+  return filePath;
+};
+var serialize = async (project, outputPath2, formatOverride, dryRun = false) => {
+  const root = path7.dirname(outputPath2);
+  await mkdir3(root, { recursive: true });
+  const format = formatOverride ?? project.config?.formats.project;
+  const output = project?.serialize("project", { format });
+  const maybeWriteFile = (filePath, output2) => {
+    if (!dryRun) {
+      return writeFile5(filePath, output2);
+    }
+  };
+  let finalPath;
+  if (format === "yaml") {
+    finalPath = ensureExt(outputPath2, "yaml");
+    await maybeWriteFile(finalPath, output);
+  } else {
+    finalPath = ensureExt(outputPath2, "json");
+    await maybeWriteFile(finalPath, JSON.stringify(output, null, 2));
+  }
+  return finalPath;
+};
+var getLightningUrl = (config2, path15 = "", snapshots2) => {
+  const params = new URLSearchParams();
+  snapshots2?.forEach((snapshot) => params.append("snapshots[]", snapshot));
+  return new URL(
+    `/api/provision/${path15}?${params.toString()}`,
+    config2.endpoint
+  );
+};
+async function getProject(logger, config2, projectId2, snapshots2) {
+  const url2 = getLightningUrl(config2, projectId2, snapshots2);
+  logger.info(`Checking ${url2} for existing project`);
+  try {
+    const response = await fetch(url2, {
+      headers: {
+        Authorization: `Bearer ${config2.apiKey}`,
+        Accept: "application/json"
+      }
+    });
+    if (!response.ok) {
+      if (response.status === 401 || response.status === 403) {
+        throw new CLIError(
+          `Failed to authorize request with endpoint ${config2.endpoint}, got ${response.status} ${response.statusText}`
+        );
+      }
+      if (response.status === 404) {
+        throw new CLIError(`Project not found: ${projectId2}`);
+      }
+      throw new CLIError(
+        `Failed to fetch project ${projectId2}: ${response.statusText}`
+      );
+    }
+    logger.info("Project found");
+    return response.json();
+  } catch (error) {
+    handleCommonErrors(config2, error);
+    throw error;
+  }
+}
+function handleCommonErrors(config2, error) {
+  if (error.cause?.code === "ECONNREFUSED") {
+    throw new DeployError(
+      `Failed to connect to endpoint ${config2.endpoint}, got ECONNREFUSED.`
+    );
+  }
+}
+var DeployError = class extends Error {
+  constructor(message) {
+    super(message);
+  }
+};
+
+// src/deploy/beta.ts
+async function handler(options6, logger) {
+  const config2 = loadAppAuthConfig(options6, logger);
+  const project = await Project2.from("fs", { root: options6.workspace || "." });
   const state = project.serialize("state", { format: "json" });
   logger.debug("Converted local project to app state:");
   logger.debug(JSON.stringify(state, null, 2));
-  config2.endpoint = endpoint2 || project.openfn?.endpoint;
+  config2.endpoint ??= project.openfn?.endpoint;
   logger.info("Sending project to app...");
   await deployProject(config2, state);
   logger.success("Updated project at", config2.endpoint);
@@ -1660,7 +1758,7 @@ async function deployHandler(options6, logger, deployFn = actualDeploy) {
     process.exitCode = isOk ? 0 : 1;
     return isOk;
   } catch (error) {
-    if (error instanceof DeployError) {
+    if (error instanceof DeployError2) {
       logger.error(error.message);
       process.exitCode = 10;
       return false;
@@ -1685,26 +1783,26 @@ function pickFirst(...args) {
 var handler_default6 = deployHandler;
 
 // src/docgen/handler.ts
-import { writeFile as writeFile5 } from "node:fs/promises";
+import { writeFile as writeFile6 } from "node:fs/promises";
 import { readFileSync, writeFileSync, mkdirSync, rmSync } from "node:fs";
-import path7 from "node:path";
+import path8 from "node:path";
 import { describePackage } from "@openfn/describe-package";
 import { getNameAndVersion as getNameAndVersion4 } from "@openfn/runtime";
 var RETRY_DURATION = 500;
 var RETRY_COUNT = 20;
 var TIMEOUT_MS = 1e3 * 60;
 var actualDocGen = (specifier) => describePackage(specifier, {});
-var ensurePath = (filePath) => mkdirSync(path7.dirname(filePath), { recursive: true });
+var ensurePath = (filePath) => mkdirSync(path8.dirname(filePath), { recursive: true });
 var generatePlaceholder = (path15) => {
   writeFileSync(path15, `{ "loading": true, "timestamp": ${Date.now()}}`);
 };
 var finish = (logger, resultPath) => {
   logger.success("Done! Docs can be found at:\n");
-  logger.print(`  ${path7.resolve(resultPath)}`);
+  logger.print(`  ${path8.resolve(resultPath)}`);
 };
 var generateDocs = async (specifier, path15, docgen, logger) => {
   const result = await docgen(specifier);
-  await writeFile5(path15, JSON.stringify(result, null, 2));
+  await writeFile6(path15, JSON.stringify(result, null, 2));
   finish(logger, path15);
   return path15;
 };
@@ -1869,13 +1967,13 @@ var handler_default8 = docsHandler;
 // src/metadata/cache.ts
 import { getNameAndVersion as getNameAndVersion6 } from "@openfn/runtime";
 import { createHash } from "node:crypto";
-import { mkdir as mkdir3, readFile as readFile5, writeFile as writeFile6, readdir, rm } from "node:fs/promises";
-import path8 from "node:path";
+import { mkdir as mkdir4, readFile as readFile5, writeFile as writeFile7, readdir, rm } from "node:fs/promises";
+import path9 from "node:path";
 var UNSUPPORTED_FILE_NAME = "unsupported.json";
 var getCachePath2 = (repoDir, key) => {
-  const base = path8.join(repoDir, "meta");
+  const base = path9.join(repoDir, "meta");
   if (key) {
-    return path8.join(base, key.endsWith(".json") ? key : `${key}.json`);
+    return path9.join(base, key.endsWith(".json") ? key : `${key}.json`);
   }
   return base;
 };
@@ -1917,8 +2015,8 @@ var get2 = async (repoPath, key) => {
 };
 var set2 = async (repoPath, key, result) => {
   const p = getCachePath2(repoPath, key);
-  await mkdir3(path8.dirname(p), { recursive: true });
-  await writeFile6(p, JSON.stringify(result));
+  await mkdir4(path9.dirname(p), { recursive: true });
+  await writeFile7(p, JSON.stringify(result));
 };
 var getUnsupportedCachePath = (repoDir) => {
   return getCachePath2(repoDir, UNSUPPORTED_FILE_NAME);
@@ -1976,8 +2074,8 @@ var markAdaptorAsUnsupported = async (adaptorSpecifier, repoDir) => {
       majorMinor: parsed.majorMinor,
       timestamp: Date.now()
     };
-    await mkdir3(path8.dirname(cachePath), { recursive: true });
-    await writeFile6(cachePath, JSON.stringify(cache, null, 2));
+    await mkdir4(path9.dirname(cachePath), { recursive: true });
+    await writeFile7(cachePath, JSON.stringify(cache, null, 2));
   }
 };
 
@@ -2132,6 +2230,7 @@ var ensure = (command6, opts) => (yargs) => {
     try {
       opt.ensure(yargs);
     } catch (e) {
+      console.log(e);
       console.error(
         c2.red(`
 Error parsing command arguments: ${command6}.${opt.name}
@@ -2401,111 +2500,6 @@ var workspace = {
   }
 };
 
-// src/projects/util.ts
-import path9 from "node:path";
-import { mkdir as mkdir4, writeFile as writeFile7 } from "node:fs/promises";
-
-// src/errors.ts
-var CLIError = class extends Error {
-  constructor(message) {
-    super(message);
-  }
-};
-
-// src/projects/util.ts
-var loadAppAuthConfig = (options6, logger) => {
-  const { OPENFN_API_KEY, OPENFN_ENDPOINT } = process.env;
-  const config2 = {
-    apiKey: options6.apiKey,
-    endpoint: options6.endpoint
-  };
-  if (!options6.apiKey && OPENFN_API_KEY) {
-    logger.info("Using OPENFN_API_KEY environment variable");
-    config2.apiKey = OPENFN_API_KEY;
-  }
-  if (!options6.endpoint && OPENFN_ENDPOINT) {
-    logger.info("Using OPENFN_ENDPOINT environment variable");
-    config2.endpoint = OPENFN_ENDPOINT;
-  }
-  return config2;
-};
-var ensureExt = (filePath, ext) => {
-  if (!filePath.endsWith(ext)) {
-    return `${filePath}.${ext}`;
-  }
-  return filePath;
-};
-var serialize = async (project, outputPath2, formatOverride, dryRun = false) => {
-  const root = path9.dirname(outputPath2);
-  await mkdir4(root, { recursive: true });
-  const format = formatOverride ?? project.config?.formats.project;
-  const output = project?.serialize("project", { format });
-  const maybeWriteFile = (filePath, output2) => {
-    if (!dryRun) {
-      return writeFile7(filePath, output2);
-    }
-  };
-  let finalPath;
-  if (format === "yaml") {
-    finalPath = ensureExt(outputPath2, "yaml");
-    await maybeWriteFile(finalPath, output);
-  } else {
-    finalPath = ensureExt(outputPath2, "json");
-    await maybeWriteFile(finalPath, JSON.stringify(output, null, 2));
-  }
-  return finalPath;
-};
-var getLightningUrl = (config2, path15 = "", snapshots2) => {
-  const params = new URLSearchParams();
-  snapshots2?.forEach((snapshot) => params.append("snapshots[]", snapshot));
-  return new URL(
-    `/api/provision/${path15}?${params.toString()}`,
-    config2.endpoint
-  );
-};
-async function getProject(logger, config2, projectId2, snapshots2) {
-  const url2 = getLightningUrl(config2, projectId2, snapshots2);
-  logger.info(`Checking ${url2} for existing project`);
-  try {
-    const response = await fetch(url2, {
-      headers: {
-        Authorization: `Bearer ${config2.apiKey}`,
-        Accept: "application/json"
-      }
-    });
-    if (!response.ok) {
-      if (response.status === 401 || response.status === 403) {
-        throw new CLIError(
-          `Failed to authorize request with endpoint ${config2.endpoint}, got ${response.status} ${response.statusText}`
-        );
-      }
-      if (response.status === 404) {
-        throw new CLIError(`Project not found: ${projectId2}`);
-      }
-      throw new CLIError(
-        `Failed to fetch project ${projectId2}: ${response.statusText}`
-      );
-    }
-    logger.info("Project found");
-    return response.json();
-  } catch (error) {
-    handleCommonErrors(config2, error);
-    throw error;
-  }
-}
-function handleCommonErrors(config2, error) {
-  if (error.cause?.code === "ECONNREFUSED") {
-    throw new DeployError2(
-      `Failed to connect to endpoint ${config2.endpoint}, got ECONNREFUSED.`
-    );
-  }
-}
-var DeployError2 = class extends Error {
-  constructor(message) {
-    super(message);
-  }
-};
-
 // src/projects/fetch.ts
 var options = [
   apikey,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/cli",
-  "version": "1.20.0",
+  "version": "1.20.2",
   "description": "CLI devtools for the OpenFn toolchain",
   "engines": {
     "node": ">=18",
@@ -49,13 +49,13 @@
     "undici": "7.12.0",
     "ws": "^8.18.3",
     "yargs": "^17.7.2",
+    "@openfn/compiler": "1.2.1",
     "@openfn/deploy": "0.11.4",
-    "@openfn/describe-package": "0.1.5",
-    "@openfn/lexicon": "^1.2.7",
     "@openfn/logger": "1.1.0",
-    "@openfn/project": "^0.9.1",
+    "@openfn/describe-package": "0.1.5",
+    "@openfn/project": "^0.9.2",
     "@openfn/runtime": "1.7.6",
-    "@openfn/compiler": "1.2.1"
+    "@openfn/lexicon": "^1.3.0"
   },
   "files": [
     "dist",