@openfn/cli 1.18.5 → 1.19.0

package/dist/index.js

@@ -32,6 +32,18 @@ function spawn_default(opts2) {
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 
+// src/env.ts
+import { config } from "dotenv";
+import { expand } from "dotenv-expand";
+var env;
+var env_default = (path3) => {
+  env = expand(config({ path: path3, override: true, debug: false, quiet: true }));
+  if (env.error) {
+    return null;
+  }
+  return env.parsed;
+};
+
 // src/options.ts
 import nodePath from "node:path";
 
@@ -39,7 +51,7 @@ import nodePath from "node:path";
 var DEFAULT_REPO_DIR = "/tmp/openfn/repo";
 
 // src/util/expand-adaptors.ts
-var expand = (name) => {
+var expand2 = (name) => {
   if (typeof name === "string") {
     const [left] = name.split("=");
     if (left.match("/") || left.endsWith(".js")) {
@@ -51,13 +63,13 @@ var expand = (name) => {
 };
 var expand_adaptors_default = (input) => {
   if (Array.isArray(input)) {
-    return input?.map(expand);
+    return input?.map(expand2);
   }
   const plan = input;
   Object.values(plan.workflow.steps).forEach((step) => {
     const job = step;
     if (job.adaptors) {
-      job.adaptors = job.adaptors.map(expand);
+      job.adaptors = job.adaptors.map(expand2);
     }
   });
   return plan;
@@ -307,7 +319,7 @@ var endpoint = {
     description: "[beta only] URL to Lightning endpoint"
   }
 };
-var env = {
+var env2 = {
   name: "env",
   yargs: {
     description: "[beta only] Environment name (eg staging, prod, branch)"
@@ -1016,7 +1028,7 @@ var options7 = [
   beta,
   configPath,
   endpoint,
-  env,
+  env2,
   log,
   override(path2, {
     description: "path to output the project to"
@@ -1174,6 +1186,10 @@ var workflowVersionCommand = {
 var command_default14 = workflowVersionCommand;
 
 // src/cli.ts
+var env3 = env_default();
+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({
   command: "version",

package/dist/process/runner.js

@@ -1609,21 +1609,22 @@ import { deployProject } from "@openfn/deploy";
 async function handler(options, logger) {
   const { OPENFN_API_KEY } = process.env;
   const { endpoint } = options;
-  const config = {
+  const config2 = {
     apiKey: options.apiKey
   };
   if (!options.apiKey && OPENFN_API_KEY) {
     logger.info("Using OPENFN_API_KEY environment variable");
-    config.apiKey = OPENFN_API_KEY;
+    config2.apiKey = OPENFN_API_KEY;
   }
   const project = await Project2.from("fs", { root: options.path || "." });
+  console.log({ openfn: project.openfn });
   const state = project.serialize("state", { format: "json" });
   logger.debug("Converted local project to app state:");
   logger.debug(JSON.stringify(state, null, 2));
-  config.endpoint = endpoint || project.openfn?.endpoint;
+  config2.endpoint = endpoint || project.openfn?.endpoint;
   logger.info("Sending project to app...");
-  await deployProject(config, state);
-  logger.success("Updated project at", config.endpoint);
+  await deployProject(config2, state);
+  logger.success("Updated project at", config2.endpoint);
 }
 
 // src/deploy/handler.ts
@@ -1633,23 +1634,23 @@ async function deployHandler(options, logger, deployFn = actualDeploy) {
     return handler(options, logger);
   }
   try {
-    const config = mergeOverrides(await getConfig(options.configPath), options);
-    logger.debug("Deploying with config", JSON.stringify(config, null, 2));
+    const config2 = mergeOverrides(await getConfig(options.configPath), options);
+    logger.debug("Deploying with config", JSON.stringify(config2, null, 2));
     if (options.confirm === false) {
-      config.requireConfirmation = options.confirm;
+      config2.requireConfirmation = options.confirm;
     }
     if (process.env["OPENFN_API_KEY"]) {
       logger.info("Using OPENFN_API_KEY environment variable");
-      config.apiKey = process.env["OPENFN_API_KEY"];
+      config2.apiKey = process.env["OPENFN_API_KEY"];
     }
     if (process.env["OPENFN_ENDPOINT"]) {
       logger.info("Using OPENFN_ENDPOINT environment variable");
-      config.endpoint = process.env["OPENFN_ENDPOINT"];
+      config2.endpoint = process.env["OPENFN_ENDPOINT"];
     }
-    logger.debug("Deploying with config", config);
+    logger.debug("Deploying with config", config2);
     logger.info(`Deploying`);
-    validateConfig(config);
-    const isOk = await deployFn(config, logger);
+    validateConfig(config2);
+    const isOk = await deployFn(config2, logger);
     process.exitCode = isOk ? 0 : 1;
     return isOk;
   } catch (error) {
@@ -1661,15 +1662,15 @@ async function deployHandler(options, logger, deployFn = actualDeploy) {
     throw error;
   }
 }
-function mergeOverrides(config, options) {
+function mergeOverrides(config2, options) {
   return {
-    ...config,
-    apiKey: pickFirst(process.env["OPENFN_API_KEY"], config.apiKey),
-    endpoint: pickFirst(process.env["OPENFN_ENDPOINT"], config.endpoint),
-    statePath: pickFirst(options.statePath, config.statePath),
-    specPath: pickFirst(options.projectPath, config.specPath),
+    ...config2,
+    apiKey: pickFirst(process.env["OPENFN_API_KEY"], config2.apiKey),
+    endpoint: pickFirst(process.env["OPENFN_ENDPOINT"], config2.endpoint),
+    statePath: pickFirst(options.statePath, config2.statePath),
+    specPath: pickFirst(options.projectPath, config2.specPath),
     configPath: options.configPath,
-    requireConfirmation: pickFirst(options.confirm, config.requireConfirmation)
+    requireConfirmation: pickFirst(options.confirm, config2.requireConfirmation)
   };
 }
 function pickFirst(...args) {
@@ -1894,8 +1895,8 @@ var sortKeys = (obj) => {
   });
   return newObj;
 };
-var generateKey = (config, adaptor) => {
-  const sorted = sortKeys(config);
+var generateKey = (config2, adaptor) => {
+  const sorted = sortKeys(config2);
   const key = `${JSON.stringify(sorted)}-${adaptor}`;
   return createHash("sha256").update(key).digest("hex");
 };
@@ -2021,8 +2022,8 @@ var metadataHandler = async (options, logger) => {
   const state = await load_state_default({}, options, logger);
   logger.success(`Generating metadata`);
   logger.info("config:", state);
-  const config = state.configuration;
-  if (!config || Object.keys(config).length === 0) {
+  const config2 = state.configuration;
+  if (!config2 || Object.keys(config2).length === 0) {
     logger.error("ERROR: Invalid configuration passed");
     process.exit(1);
   }
@@ -2030,7 +2031,7 @@ var metadataHandler = async (options, logger) => {
     logger.success("Done!");
     logger.print(getCachePath2(repoDir, id));
   };
-  const id = generateKey(config, adaptor);
+  const id = generateKey(config2, adaptor);
   if (!options.force) {
     logger.debug("config hash: ", id);
     const cached = await get2(repoDir, id);
@@ -2056,7 +2057,7 @@ var metadataHandler = async (options, logger) => {
     const mod = await import(adaptorPath);
     if (mod.metadata && typeof mod.metadata === "function") {
       logger.info("Metadata function found. Generating metadata...");
-      const result = await mod.metadata(config);
+      const result = await mod.metadata(config2);
       decorateMetadata(result);
       await set2(
         repoDir,
@@ -2102,12 +2103,12 @@ import {
 } from "@openfn/deploy";
 
 // src/pull/beta.ts
-import { confirm } from "@inquirer/prompts";
-import path9 from "path";
+import path9 from "node:path";
 import fs4 from "node:fs/promises";
+import { rimraf } from "rimraf";
+import { confirm } from "@inquirer/prompts";
 import { getProject } from "@openfn/deploy";
 import Project3, { Workspace } from "@openfn/project";
-import { rimraf } from "rimraf";
 async function handler2(options, logger) {
   const { OPENFN_API_KEY, OPENFN_ENDPOINT } = process.env;
   const cfg = {
@@ -2124,7 +2125,7 @@ async function handler2(options, logger) {
   }
   const outputRoot = path9.resolve(options.path || ".");
   const workspace = new Workspace(outputRoot);
-  const config = workspace.getConfig();
+  const config2 = workspace.getConfig();
   const { data } = await getProject(cfg, options.projectId);
   const name = options.env || "project";
   const project = await Project3.from(
@@ -2133,13 +2134,16 @@ async function handler2(options, logger) {
     {
       endpoint: cfg.endpoint,
       env: name,
+      // TODO this is NOT an openfn metadata key
+      // (it should not be sent back to lighting)
+      // should add it to the local or meta objects instead
       fetched_at: (/* @__PURE__ */ new Date()).toISOString()
     },
-    config
+    config2
   );
   const projectFileName = project.getIdentifier();
   await fs4.mkdir(`${outputRoot}/.projects`, { recursive: true });
-  let stateOutputPath = `${outputRoot}/.projects/${projectFileName}`;
+  const stateOutputPath = `${outputRoot}/.projects/${projectFileName}`;
   const workflowsRoot = path9.resolve(
     outputRoot,
     project.config.dirs.workflows ?? "workflows"
@@ -2147,7 +2151,7 @@ async function handler2(options, logger) {
   if (!await confirm({
     message: `This will remove all files in ${path9.resolve(
       workflowsRoot
-    )} and rebuild the workflow. Are you sure you wish to proceed?
+    )}. Are you sure you wish to proceed?
 `,
     default: true
   })) {
@@ -2155,13 +2159,13 @@ async function handler2(options, logger) {
     return false;
   }
   await rimraf(workflowsRoot);
-  const state = project?.serialize("state");
-  if (project.config.formats.project === "yaml") {
-    await fs4.writeFile(`${stateOutputPath}.yaml`, state);
+  const projFile = project?.serialize("project");
+  if (typeof projFile === "string") {
+    await fs4.writeFile(`${stateOutputPath}.yaml`, projFile);
   } else {
     await fs4.writeFile(
       `${stateOutputPath}.json`,
-      JSON.stringify(state, null, 2)
+      JSON.stringify(projFile, null, 2)
     );
   }
   logger.success(`Saved project file to ${stateOutputPath}`);
@@ -2185,20 +2189,20 @@ async function pullHandler(options, logger) {
     return handler2(options, logger);
   }
   try {
-    const config = mergeOverrides2(await getConfig2(options.configPath), options);
+    const config2 = mergeOverrides2(await getConfig2(options.configPath), options);
     if (process.env["OPENFN_API_KEY"]) {
       logger.info("Using OPENFN_API_KEY environment variable");
-      config.apiKey = process.env["OPENFN_API_KEY"];
+      config2.apiKey = process.env["OPENFN_API_KEY"];
     }
     if (process.env["OPENFN_ENDPOINT"]) {
       logger.info("Using OPENFN_ENDPOINT environment variable");
-      config.endpoint = process.env["OPENFN_ENDPOINT"];
+      config2.endpoint = process.env["OPENFN_ENDPOINT"];
     }
     logger.always(
       "Downloading existing project state (as JSON) from the server."
     );
     const { data: project } = await getProject2(
-      config,
+      config2,
       options.projectId,
       options.snapshots
     );
@@ -2219,12 +2223,12 @@ async function pullHandler(options, logger) {
     );
     const url2 = new URL(
       `api/provision/yaml?${queryParams.toString()}`,
-      config.endpoint
+      config2.endpoint
     );
     logger.debug("Fetching project spec from", url2);
     const res = await fetch(url2, {
       headers: {
-        Authorization: `Bearer ${config.apiKey}`,
+        Authorization: `Bearer ${config2.apiKey}`,
         Accept: "application/json"
       }
     });
@@ -2236,16 +2240,16 @@ async function pullHandler(options, logger) {
       process.exitCode = 1;
       process.exit(1);
     }
-    const resolvedPath = path10.resolve(config.specPath);
+    const resolvedPath = path10.resolve(config2.specPath);
     logger.debug("reading spec from", resolvedPath);
     const updatedSpec = await syncRemoteSpec(
       await res.text(),
       state,
-      config,
+      config2,
       logger
     );
     await fs5.writeFile(
-      path10.resolve(config.statePath),
+      path10.resolve(config2.statePath),
       JSON.stringify(state, null, 2)
     );
     await fs5.writeFile(resolvedPath, updatedSpec);
@@ -2263,13 +2267,13 @@ async function pullHandler(options, logger) {
     throw error;
   }
 }
-function mergeOverrides2(config, options) {
+function mergeOverrides2(config2, options) {
   return {
-    ...config,
-    apiKey: pickFirst2(process.env["OPENFN_API_KEY"], config.apiKey),
-    endpoint: pickFirst2(process.env["OPENFN_ENDPOINT"], config.endpoint),
+    ...config2,
+    apiKey: pickFirst2(process.env["OPENFN_API_KEY"], config2.apiKey),
+    endpoint: pickFirst2(process.env["OPENFN_ENDPOINT"], config2.endpoint),
     configPath: options.configPath,
-    requireConfirmation: pickFirst2(options.confirm, config.requireConfirmation)
+    requireConfirmation: pickFirst2(options.confirm, config2.requireConfirmation)
   };
 }
 function pickFirst2(...args) {
@@ -2353,12 +2357,12 @@ var checkoutHandler = async (options, logger) => {
     logger.error("Command was run in an invalid openfn workspace");
     return;
   }
-  const { project: _, ...config } = workspace.getConfig();
+  const { project: _, ...config2 } = workspace.getConfig();
   let switchProject;
   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, config2);
   } else {
     switchProject = workspace.get(options.projectId);
   }
@@ -2367,7 +2371,7 @@ var checkoutHandler = async (options, logger) => {
       `Project with id ${options.projectId} not found in the workspace`
     );
   }
-  await rimraf2(path13.join(commandPath, config.workflowRoot ?? "workflows"));
+  await rimraf2(path13.join(commandPath, config2.workflowRoot ?? "workflows"));
   const files = switchProject.serialize("fs");
   for (const f in files) {
     if (files[f]) {
@@ -2559,6 +2563,25 @@ ${prefix(name)}${version2}`;
 };
 var print_versions_default = printVersions;
 
+// src/env.ts
+import { config } from "dotenv";
+import { expand as expand2 } from "dotenv-expand";
+var env;
+var report = (logger) => {
+  let envs = [];
+  if (process.env.$DOT_ENV_OVERRIDES) {
+    envs = process.env.$DOT_ENV_OVERRIDES.split(",").map((s) => s.trim());
+  } else {
+    envs = Object.keys(env?.parsed ?? {});
+  }
+  if (envs.length) {
+    logger?.always(`Imported ${envs.length} env vars from .env file`);
+    logger?.debug("Envs set from .env: ", envs.join(", "));
+  } else if (env && env.error) {
+    logger?.debug(".env not found");
+  }
+};
+
 // src/commands.ts
 var handlers = {
   apollo: handler_default,
@@ -2588,6 +2611,7 @@ var parse = async (options, log) => {
   if (options.command === "execute" || options.command === "test") {
     await print_versions_default(logger, options);
   }
+  report(logger);
   const { monorepoPath } = options;
   if (monorepoPath) {
     if (monorepoPath === "ERR") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/cli",
-  "version": "1.18.5",
+  "version": "1.19.0",
   "description": "CLI devtools for the OpenFn toolchain",
   "engines": {
     "node": ">=18",
@@ -41,19 +41,21 @@
   "dependencies": {
     "@inquirer/prompts": "^1.2.3",
     "chalk": "^5.6.2",
+    "dotenv": "^17.2.3",
+    "dotenv-expand": "^12.0.3",
     "figures": "^5.0.0",
     "rimraf": "^6.0.1",
     "treeify": "^1.1.0",
     "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.6",
-    "@openfn/deploy": "0.11.3",
-    "@openfn/compiler": "1.1.5",
-    "@openfn/project": "^0.9.0",
-    "@openfn/logger": "1.0.6",
-    "@openfn/runtime": "1.7.5"
+    "@openfn/lexicon": "^1.2.7",
+    "@openfn/logger": "1.1.0",
+    "@openfn/project": "^0.9.1",
+    "@openfn/runtime": "1.7.6"
   },
   "files": [
     "dist",