@openfn/cli 0.1.0 → 0.2.1

package/dist/index.js

@@ -11,7 +11,9 @@ import { fork } from "node:child_process";
 import process2 from "node:process";
 function spawn_default(basePath, opts2) {
   const execArgv = [
+    // Suppress experimental argument warnings
     "--no-warnings",
+    // Allows us to load an ESM module from a text string
     "--experimental-vm-modules"
   ];
   const dirname = path.dirname(url.fileURLToPath(import.meta.url));
@@ -100,6 +102,16 @@ var configPath = {
     default: "./.config.json"
   }
 };
+var describe = {
+  name: "describe",
+  yargs: {
+    boolean: true,
+    description: "Downloads the project yaml from the specified instance"
+  },
+  ensure: (opts2) => {
+    setDefaultValue(opts2, "describe", true);
+  }
+};
 var expandAdaptors = {
   name: "no-expand-adaptors",
   yargs: {
@@ -362,7 +374,7 @@ var compileCommand = {
 var command_default = compileCommand;
 
 // src/deploy/command.ts
-var options2 = [statePath, projectPath, configPath, confirm];
+var options2 = [statePath, projectPath, configPath, confirm, describe];
 var deployCommand = {
   command: "deploy",
   desc: "Deploy a project's config to a remote Lightning instance",
@@ -376,7 +388,9 @@ var command_default2 = deployCommand;
 // src/docgen/command.ts
 var docgenCommand = {
   command: "docgen <specifier>",
+  // Hide this command as it's not really for public usage
   desc: false,
+  // 'Generate documentation into the repo. Specifier must include a version number.'
   handler: (argv) => {
     argv.command = "docgen";
   },
@@ -469,6 +483,18 @@ var command_default6 = {
   )
 };
 
+// src/pull/command.ts
+var options5 = [statePath, projectPath, configPath];
+var pullCommand = {
+  command: "pull",
+  desc: "Pull aproject's state and spec from a Lightning Instance to the local directory",
+  builder: (yargs2) => {
+    return build(options5, yargs2).example("pull", "Pull an updated copy of a project spec and state from a Lightning Instance");
+  },
+  handler: ensure("pull", options5)
+};
+var command_default7 = pullCommand;
+
 // src/repo/command.ts
 var repo = {
   command: "repo [subcommand]",
@@ -525,17 +551,17 @@ var list = {
 };
 
 // src/test/command.ts
-var options5 = [stateStdin];
-var command_default7 = {
+var options6 = [stateStdin];
+var command_default8 = {
   command: "test",
   desc: "Compiles and runs a test job, printing the result to stdout",
-  handler: ensure("test", options5),
-  builder: (yargs2) => build(options5, yargs2).example("test", "Run the test script")
+  handler: ensure("test", options6),
+  builder: (yargs2) => build(options6, yargs2).example("test", "Run the test script")
 };
 
 // src/cli.ts
 var y = yargs(hideBin(process.argv));
-var cmd = y.command(command_default5).command(command_default).command(command_default2).command(install).command(repo).command(command_default7).command(command_default4).command(command_default6).command(command_default3).option("log", {
+var cmd = y.command(command_default5).command(command_default).command(command_default2).command(install).command(repo).command(command_default8).command(command_default4).command(command_default6).command(command_default3).command(command_default7).option("log", {
   alias: ["l"],
   description: "Set the default log level to none, default, info or debug",
   array: true

package/dist/package-JMR2GBIW.js

@@ -0,0 +1,98 @@
+// package.json
+var name = "@openfn/cli";
+var version = "0.2.1";
+var description = "CLI devtools for the openfn toolchain.";
+var engines = {
+  node: ">=18",
+  pnpm: ">=7"
+};
+var scripts = {
+  test: "pnpm ava",
+  "test:watch": "pnpm ava -w",
+  "test:types": "pnpm tsc --noEmit --project tsconfig.json",
+  build: "tsup --config ./tsup.config.js",
+  "build:watch": "pnpm build --watch",
+  openfn: "node --no-warnings dist/index.js",
+  pack: "pnpm pack --pack-destination ../../dist"
+};
+var exports = {
+  ".": {
+    import: {
+      types: "./dist/index.d.ts",
+      default: "./dist/index.js"
+    }
+  }
+};
+var type = "module";
+var bin = {
+  openfn: "dist/index.js"
+};
+var module = "dist/index.js";
+var types = "dist/index.d.ts";
+var keywords = [];
+var author = "Open Function Group <admin@openfn.org>";
+var license = "ISC";
+var devDependencies = {
+  "@openfn/language-common": "2.0.0-rc3",
+  "@types/mock-fs": "^4.13.1",
+  "@types/node": "^17.0.45",
+  "@types/yargs": "^17.0.24",
+  ava: "5.1.0",
+  "mock-fs": "^5.1.4",
+  "ts-node": "^10.9.1",
+  tslib: "^2.4.0",
+  tsup: "^7.1.0",
+  typescript: "^4.7.4"
+};
+var dependencies = {
+  "@openfn/compiler": "workspace:*",
+  "@openfn/deploy": "workspace:*",
+  "@openfn/describe-package": "workspace:*",
+  "@openfn/logger": "workspace:*",
+  "@openfn/runtime": "workspace:*",
+  figures: "^5.0.0",
+  rimraf: "^3.0.2",
+  treeify: "^1.1.0",
+  yargs: "^17.7.2"
+};
+var files = [
+  "dist",
+  "README.md"
+];
+var package_default = {
+  name,
+  version,
+  description,
+  engines,
+  scripts,
+  exports,
+  type,
+  bin,
+  module,
+  types,
+  keywords,
+  author,
+  license,
+  devDependencies,
+  dependencies,
+  files
+};
+export {
+  author,
+  bin,
+  package_default as default,
+  dependencies,
+  description,
+  devDependencies,
+  engines,
+  exports,
+  files,
+  keywords,
+  license,
+  module,
+  name,
+  scripts,
+  type,
+  types,
+  version
+};

package/dist/process/runner.d.ts

@@ -1 +1,2 @@
 
+export { }

package/dist/process/runner.js

@@ -39,8 +39,8 @@ var createNullLogger = () => createLogger(void 0, { log: { default: "none" } });
 var AbortError = class extends Error {
   constructor(reason) {
     super(reason);
-    this.handled = true;
   }
+  handled = true;
 };
 var abort_default = (logger, reason, error, help) => {
   const e = new AbortError(reason);
@@ -65,7 +65,9 @@ var execute_default = async (input, state, opts, logger) => {
       timeout: opts.timeout,
       immutableState: opts.immutable,
       logger: logger_default(RUNTIME, opts),
+      // TODO log types are flaky right now
       jobLogger: logger_default(JOB, opts),
+      // ditto
       linker: {
         repo: opts.repoDir,
         modules: parseAdaptors(opts)
@@ -78,13 +80,13 @@ var execute_default = async (input, state, opts, logger) => {
 };
 function parseAdaptors(opts) {
   const extractInfo = (specifier) => {
-    const [module, path7] = specifier.split("=");
+    const [module, path8] = specifier.split("=");
     const { name, version } = getNameAndVersion(module);
     const info = {
       name
     };
-    if (path7) {
-      info.path = path7;
+    if (path8) {
+      info.path = path8;
     }
     if (version) {
       info.version = version;
@@ -286,10 +288,10 @@ var stripVersionSpecifier = (specifier) => {
   return specifier;
 };
 var resolveSpecifierPath = async (pattern, repoDir, log) => {
-  const [specifier, path7] = pattern.split("=");
-  if (path7) {
-    log.debug(`Resolved ${specifier} to path: ${path7}`);
-    return path7;
+  const [specifier, path8] = pattern.split("=");
+  if (path8) {
+    log.debug(`Resolved ${specifier} to path: ${path8}`);
+    return path8;
   }
   const repoPath = await getModulePath(specifier, repoDir, log);
   if (repoPath) {
@@ -306,16 +308,16 @@ var loadTransformOptions = async (opts, log) => {
     const [pattern] = opts.adaptors;
     const [specifier] = pattern.split("=");
     log.debug(`Attempting to preload types for ${specifier}`);
-    const path7 = await resolveSpecifierPath(pattern, opts.repoDir, log);
-    if (path7) {
+    const path8 = await resolveSpecifierPath(pattern, opts.repoDir, log);
+    if (path8) {
       try {
         exports = await preloadAdaptorExports(
-          path7,
+          path8,
           opts.useAdaptorsMonorepo,
           log
         );
       } catch (e) {
-        log.error(`Failed to load adaptor typedefs from path ${path7}`);
+        log.error(`Failed to load adaptor typedefs from path ${path8}`);
         log.error(e);
       }
     }
@@ -566,7 +568,7 @@ var map_adaptors_to_monorepo_default = mapAdaptorsToMonorepo;
 
 // src/execute/handler.ts
 var executeHandler = async (options, logger) => {
-  const start = new Date().getTime();
+  const start = (/* @__PURE__ */ new Date()).getTime();
   await validate_adaptors_default(options, logger);
   let input = await load_input_default(options, logger);
   if (options.workflow) {
@@ -597,7 +599,7 @@ var executeHandler = async (options, logger) => {
   try {
     const result = await execute_default(input, state, options, logger);
     await serialize_output_default(options, result, logger);
-    const duration = printDuration(new Date().getTime() - start);
+    const duration = printDuration((/* @__PURE__ */ new Date()).getTime() - start);
     if (result.errors) {
       logger.warn(
         `Errors reported in ${Object.keys(result.errors).length} jobs`
@@ -610,7 +612,7 @@ var executeHandler = async (options, logger) => {
       logger.error("Unexpected error in execution");
       logger.error(err);
     }
-    const duration = printDuration(new Date().getTime() - start);
+    const duration = printDuration((/* @__PURE__ */ new Date()).getTime() - start);
     logger.always(`Workflow failed in ${duration}.`);
     process.exitCode = 1;
   }
@@ -754,20 +756,20 @@ var RETRY_COUNT = 20;
 var TIMEOUT_MS = 1e3 * 60;
 var actualDocGen = (specifier) => describePackage(specifier, {});
 var ensurePath = (filePath) => mkdirSync(path3.dirname(filePath), { recursive: true });
-var generatePlaceholder = (path7) => {
-  writeFileSync(path7, `{ "loading": true, "timestamp": ${Date.now()}}`);
+var generatePlaceholder = (path8) => {
+  writeFileSync(path8, `{ "loading": true, "timestamp": ${Date.now()}}`);
 };
 var finish = (logger, resultPath) => {
   logger.success("Done! Docs can be found at:\n");
   logger.print(`  ${path3.resolve(resultPath)}`);
 };
-var generateDocs = async (specifier, path7, docgen, logger) => {
+var generateDocs = async (specifier, path8, docgen, logger) => {
   const result = await docgen(specifier);
-  await writeFile3(path7, JSON.stringify(result, null, 2));
-  finish(logger, path7);
-  return path7;
+  await writeFile3(path8, JSON.stringify(result, null, 2));
+  finish(logger, path8);
+  return path8;
 };
-var waitForDocs = async (docs, path7, logger, retryDuration = RETRY_DURATION) => {
+var waitForDocs = async (docs, path8, logger, retryDuration = RETRY_DURATION) => {
   try {
     if (docs.hasOwnProperty("loading")) {
       logger.info("Docs are being loaded by another process. Waiting.");
@@ -779,19 +781,19 @@ var waitForDocs = async (docs, path7, logger, retryDuration = RETRY_DURATION) =>
             clearInterval(i);
             reject(new Error("Timed out waiting for docs to load"));
           }
-          const updated = JSON.parse(readFileSync(path7, "utf8"));
+          const updated = JSON.parse(readFileSync(path8, "utf8"));
           if (!updated.hasOwnProperty("loading")) {
             logger.info("Docs found!");
             clearInterval(i);
-            resolve(path7);
+            resolve(path8);
           }
           count++;
         }, retryDuration);
       });
     } else {
-      logger.info(`Docs already written to cache at ${path7}`);
-      finish(logger, path7);
-      return path7;
+      logger.info(`Docs already written to cache at ${path8}`);
+      finish(logger, path8);
+      return path8;
     }
   } catch (e) {
     logger.error("Existing doc JSON corrupt. Aborting");
@@ -808,28 +810,28 @@ var docgenHandler = (options, logger, docgen = actualDocGen, retryDuration = RET
     process.exit(9);
   }
   logger.success(`Generating docs for ${specifier}`);
-  const path7 = `${repoDir}/docs/${specifier}.json`;
-  ensurePath(path7);
+  const path8 = `${repoDir}/docs/${specifier}.json`;
+  ensurePath(path8);
   const handleError = () => {
     logger.info("Removing placeholder");
-    rmSync(path7);
+    rmSync(path8);
   };
   try {
-    const existing = readFileSync(path7, "utf8");
+    const existing = readFileSync(path8, "utf8");
     const json = JSON.parse(existing);
     if (json && json.timeout && Date.now() - json.timeout >= TIMEOUT_MS) {
       logger.info(`Expired placeholder found. Removing.`);
-      rmSync(path7);
+      rmSync(path8);
       throw new Error("TIMEOUT");
     }
-    return waitForDocs(json, path7, logger, retryDuration);
+    return waitForDocs(json, path8, logger, retryDuration);
   } catch (e) {
     if (e.message !== "TIMEOUT") {
-      logger.info(`Docs JSON not found at ${path7}`);
+      logger.info(`Docs JSON not found at ${path8}`);
     }
     logger.debug("Generating placeholder");
-    generatePlaceholder(path7);
-    return generateDocs(specifier, path7, docgen, logger).catch((e2) => {
+    generatePlaceholder(path8);
+    return generateDocs(specifier, path8, docgen, logger).catch((e2) => {
       logger.error("Error generating documentation");
       logger.error(e2);
       handleError();
@@ -878,16 +880,17 @@ var docsHandler = async (options, logger) => {
     logger.success(`Showing docs for ${adaptorName} v${version}`);
   }
   logger.info("Generating/loading documentation...");
-  const path7 = await handler_default5(
+  const path8 = await handler_default5(
     {
       specifier: `${name}@${version}`,
       repoDir
     },
+    // TODO I'm not sure how to handle logging here - we ought to feedback SOMETHING though
     createNullLogger()
   );
   let didError = false;
-  if (path7) {
-    const source = await readFile2(path7, "utf8");
+  if (path8) {
+    const source = await readFile2(path8, "utf8");
     const data = JSON.parse(source);
     let desc;
     if (operation) {
@@ -958,7 +961,7 @@ var cache_default = { get, set, generateKey, getPath, sortKeys };
 // src/metadata/handler.ts
 import { getModuleEntryPoint } from "@openfn/runtime";
 var decorateMetadata = (metadata) => {
-  metadata.created = new Date().toISOString();
+  metadata.created = (/* @__PURE__ */ new Date()).toISOString();
 };
 var getAdaptorPath = async (adaptor, logger, repoDir) => {
   let adaptorPath;
@@ -1033,10 +1036,50 @@ var metadataHandler = async (options, logger) => {
 };
 var handler_default7 = metadataHandler;
 
+// src/pull/handler.ts
+import path5 from "path";
+import fs3 from "node:fs/promises";
+import {
+  getProject,
+  getConfig as getConfig2,
+  getState
+} from "@openfn/deploy";
+async function pullHandler(options, logger) {
+  try {
+    const config = mergeOverrides2(await getConfig2(options.configPath), options);
+    logger.always("Downloading project yaml and  state from instance");
+    const state = await getState(config.statePath);
+    const { data: new_state } = await getProject(config, state.id);
+    const url = new URL(`/download/yaml?id=${state.id}`, config.endpoint);
+    const res = await fetch(url);
+    await fs3.writeFile(path5.resolve(config.specPath), res.body);
+    await fs3.writeFile(path5.resolve(config.statePath), new_state);
+    logger.success("Project pulled successfully");
+    process.exitCode = 0;
+    return true;
+  } catch (error) {
+    throw error;
+  }
+}
+function mergeOverrides2(config, options) {
+  return {
+    ...config,
+    apiKey: pickFirst2(process.env["OPENFN_API_KEY"], config.apiKey),
+    endpoint: pickFirst2(process.env["OPENFN_ENDPOINT"], config.endpoint),
+    configPath: options.configPath,
+    requireConfirmation: pickFirst2(options.confirm, config.requireConfirmation)
+  };
+}
+function pickFirst2(...args) {
+  return args.find((arg) => arg !== void 0 && arg !== null);
+}
+var handler_default8 = pullHandler;
+
 // src/util/ensure-opts.ts
-import path5 from "node:path";
+import path6 from "node:path";
 var defaultLoggerOptions = {
   default: "default",
+  //  TODO fix to lower case
   job: "debug"
 };
 var ERROR_MESSAGE_LOG_LEVEL = "Unknown log level. Valid levels are none, debug, info and default.";
@@ -1086,6 +1129,7 @@ var ensureLogOpts = (opts) => {
 function ensureOpts(basePath = ".", opts) {
   const newOpts = {
     adaptor: opts.adaptor,
+    // only applies to install (a bit messy) (now applies to docs too)
     adaptors: opts.adaptors || [],
     autoinstall: opts.autoinstall,
     command: opts.command,
@@ -1093,6 +1137,7 @@ function ensureOpts(basePath = ".", opts) {
     force: opts.force || false,
     immutable: opts.immutable || false,
     log: opts.log,
+    // TMP this will be overwritten later
     logJson: typeof opts.logJson == "boolean" ? opts.logJson : Boolean(process.env.OPENFN_LOG_JSON),
     compile: Boolean(opts.compile),
     operation: opts.operation,
@@ -1112,7 +1157,7 @@ function ensureOpts(basePath = ".", opts) {
   }
   let baseDir = basePath;
   if (basePath.endsWith(".js")) {
-    baseDir = path5.dirname(basePath);
+    baseDir = path6.dirname(basePath);
     set2("jobPath", basePath);
   } else {
     set2("jobPath", `${baseDir}/job.js`);
@@ -1130,7 +1175,7 @@ function ensureOpts(basePath = ".", opts) {
 
 // src/util/print-versions.ts
 import { readFileSync as readFileSync3 } from "node:fs";
-import path6 from "node:path";
+import path7 from "node:path";
 import { getNameAndVersion as getNameAndVersion6 } from "@openfn/runtime";
 import { mainSymbols } from "figures";
 var NODE = "node.js";
@@ -1140,7 +1185,7 @@ var COMPILER2 = "compiler";
 var { triangleRightSmall: t } = mainSymbols;
 var loadVersionFromPath = (adaptorPath) => {
   try {
-    const pkg = JSON.parse(readFileSync3(path6.resolve(adaptorPath, "package.json"), "utf8"));
+    const pkg = JSON.parse(readFileSync3(path7.resolve(adaptorPath, "package.json"), "utf8"));
     return pkg.version;
   } catch (e) {
     return "unknown";
@@ -1173,7 +1218,7 @@ var printVersions = async (logger, options = {}) => {
     adaptorName
   ].map((s) => s.length));
   const prefix = (str) => `         ${t} ${str.padEnd(longest + 4, " ")}`;
-  const pkg = await import("../../package.json", { assert: { type: "json" } });
+  const pkg = await import("../package-JMR2GBIW.js");
   const { version, dependencies } = pkg.default;
   const compilerVersion = dependencies["@openfn/compiler"];
   const runtimeVersion = dependencies["@openfn/runtime"];
@@ -1212,13 +1257,20 @@ var handlers = {
   docgen: handler_default5,
   docs: handler_default6,
   metadata: handler_default7,
+  pull: handler_default8,
   ["repo-clean"]: clean,
   ["repo-install"]: install,
   ["repo-pwd"]: pwd,
   ["repo-list"]: list,
   version: async (opts, logger) => print_versions_default(logger, opts)
 };
-var maybeEnsureOpts = (basePath, options) => /(^(deploy|execute|compile|test)$)|(repo-)/.test(options.command) ? ensureLogOpts(options) : ensureOpts(basePath, options);
+var maybeEnsureOpts = (basePath, options) => (
+  // If the command is compile or execute, just return the opts (yargs will do all the validation)
+  /(^(deploy|execute|compile|test)$)|(repo-)/.test(options.command) ? ensureLogOpts(options) : (
+    // Otherwise  older commands still need to go through ensure opts
+    ensureOpts(basePath, options)
+  )
+);
 var parse = async (basePath, options, log) => {
   const opts = maybeEnsureOpts(basePath, options);
   const logger = log || logger_default(CLI, opts);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/cli",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "CLI devtools for the openfn toolchain.",
   "engines": {
     "node": ">=18",
@@ -27,24 +27,24 @@
     "@openfn/language-common": "2.0.0-rc3",
     "@types/mock-fs": "^4.13.1",
     "@types/node": "^17.0.45",
-    "@types/yargs": "^17.0.12",
+    "@types/yargs": "^17.0.24",
     "ava": "5.1.0",
     "mock-fs": "^5.1.4",
     "ts-node": "^10.9.1",
     "tslib": "^2.4.0",
-    "tsup": "^6.2.3",
+    "tsup": "^7.1.0",
     "typescript": "^4.7.4"
   },
   "dependencies": {
     "figures": "^5.0.0",
     "rimraf": "^3.0.2",
     "treeify": "^1.1.0",
-    "yargs": "^17.5.1",
-    "@openfn/deploy": "0.1.0",
-    "@openfn/runtime": "0.0.26",
-    "@openfn/logger": "0.0.13",
-    "@openfn/describe-package": "0.0.16",
-    "@openfn/compiler": "0.0.32"
+    "yargs": "^17.7.2",
+    "@openfn/deploy": "0.2.1",
+    "@openfn/describe-package": "0.0.17",
+    "@openfn/logger": "0.0.14",
+    "@openfn/runtime": "0.0.27",
+    "@openfn/compiler": "0.0.33"
   },
   "files": [
     "dist",