@openfn/cli 0.0.22 → 0.0.24

package/dist/index.js

@@ -8,8 +8,7 @@ import process2 from "node:process";
 function spawn_default(basePath, opts2) {
   const execArgv = [
     "--no-warnings",
-    "--experimental-vm-modules",
-    "--experimental-specifier-resolution=node"
+    "--experimental-vm-modules"
   ];
   const dirname = path.dirname(url.fileURLToPath(import.meta.url));
   const child = fork(`${dirname}/process/runner.js`, [], { execArgv });
@@ -106,6 +105,9 @@ var executeCommand = {
     }).option("state-stdin", {
       alias: "S",
       description: "Read state from stdin (instead of a file)"
+    }).option("timeout", {
+      alias: "-t",
+      description: "Set the timeout duration in MS"
     }).option("no-compile", {
       boolean: true,
       description: "Skip compilation"
@@ -179,7 +181,7 @@ var command_default3 = {
 // src/docgen/command.ts
 var docgenCommand = {
   command: "docgen <specifier>",
-  desc: "Generate documentation into the repo. Specifier must include a version number.",
+  desc: false,
   handler: (argv) => {
     argv.command = "docgen";
   },
@@ -191,7 +193,7 @@ var command_default4 = docgenCommand;
 
 // src/docs/command.ts
 var command_default5 = {
-  command: "docs [adaptor] [operation]",
+  command: "docs <adaptor> [operation]",
   desc: "Print help for an adaptor function. You can use short-hand for adaptor names (ie, common instead of @openfn/language-common)",
   handler: (argv) => {
     argv.command = "docs";
@@ -207,7 +209,12 @@ var cmd = yargs(hideBin(process.argv)).command(command_default).command(command_
 }).example("openfn execute help", "Show documentation for the execute command").example(
   "openfn docs @openfn/language-common each",
   "Get more help on the common.each command"
-).alias("v", "version").help();
+).command({
+  command: "version",
+  handler: (argv) => {
+    argv.command = "version";
+  }
+}).help();
 
 // src/index.ts
 var opts = cmd.parse();

package/dist/process/runner.js

@@ -39,6 +39,9 @@ var componentShorthands = {
 var isValidComponent = (v) => /^(cli|runtime|compiler|job|default)$/i.test(v);
 var ensureLogOpts = (opts) => {
   const components = {};
+  if (opts.command === "version" || opts.command === "test" && !opts.log) {
+    return { default: "info" };
+  }
   if (opts.log) {
     opts.log.forEach((l) => {
       let component = "";
@@ -83,6 +86,7 @@ function ensureOpts(basePath = ".", opts) {
     operation: opts.operation,
     packages: opts.packages,
     stateStdin: opts.stateStdin,
+    timeout: opts.timeout,
     specifier: opts.specifier,
     strictOutput: opts.strictOutput ?? true,
     immutable: opts.immutable || false
@@ -146,6 +150,7 @@ var load_state_default = async (opts, log) => {
 import run, { getNameAndVersion } from "@openfn/runtime";
 var execute_default = (code, state, opts) => {
   return run(code, state, {
+    timeout: opts.timeout,
     immutableState: opts.immutable,
     logger: logger_default(RUNTIME, opts),
     jobLogger: logger_default(JOB, opts),
@@ -216,11 +221,10 @@ var resolveSpecifierPath = async (pattern, repoDir, log) => {
   return null;
 };
 var loadTransformOptions = async (opts, log) => {
-  var _a;
   const options = {
     logger: log
   };
-  if ((_a = opts.adaptors) == null ? void 0 : _a.length) {
+  if (opts.adaptors?.length) {
     let exports;
     const [pattern] = opts.adaptors;
     const [specifier] = pattern.split("=");
@@ -290,7 +294,7 @@ import { install as rtInstall, loadRepoPkg } from "@openfn/runtime";
 
 // src/util/expand-adaptors.ts
 var nullLogger = createNullLogger();
-var expand_adaptors_default = (names, log = nullLogger) => names == null ? void 0 : names.map((name) => {
+var expand_adaptors_default = (names, log = nullLogger) => names?.map((name) => {
   if (name.startsWith("@openfn/language-")) {
     return name;
   }
@@ -368,9 +372,8 @@ var list = async (options, logger) => {
 
 // src/execute/handler.ts
 var getAutoinstallTargets = (options) => {
-  var _a;
   if (options.autoinstall && options.adaptors) {
-    return (_a = options.adaptors) == null ? void 0 : _a.filter((a) => !/=/.test(a));
+    return options.adaptors?.filter((a) => !/=/.test(a));
   }
   return [];
 };
@@ -531,13 +534,19 @@ var handler_default4 = docgenHandler;
 // src/docs/handler.ts
 import { readFile } from "node:fs/promises";
 import { getNameAndVersion as getNameAndVersion3, getLatestVersion } from "@openfn/runtime";
-var describe = (adaptorName, fn) => `## ${fn.name}(${fn.parameters.map(({ name }) => name).join(",")})
+var describeFn = (adaptorName, fn) => `## ${fn.name}(${fn.parameters.map(({ name }) => name).join(",")})
 
 ${fn.description}
 
 ### Usage Examples
 
-${fn.examples.length ? fn.examples.map((eg) => eg).join("\n\n") : "None"}
+${fn.examples.length ? fn.examples.map(({ code, caption }) => {
+  if (caption) {
+    return `${caption}:
+${code}`;
+  }
+  return code;
+}).join("\n\n") : "None"}
 
 ### API Reference
 
@@ -546,13 +555,17 @@ https://docs.openfn.org/adaptors/packages/${adaptorName.replace(
   ""
 )}-docs#${fn.name}
 `;
+var describeLib = (adaptorName, data) => `## ${adaptorName} ${data.version}
+
+${data.functions.map((fn) => `  ${fn.name}(${fn.parameters.map((p) => p.name).join(", ")})`).sort().join("\n")}
+`;
 var docsHandler = async (options, logger) => {
   const { adaptor, operation, repoDir } = options;
   const [adaptorName] = expand_adaptors_default([adaptor], logger);
   let { name, version } = getNameAndVersion3(adaptorName);
   if (!version) {
     logger.info("No version number provided, looking for latest...");
-    version = await getLatestVersion(version);
+    version = await getLatestVersion(name);
     logger.info("Found ", version);
     logger.success(`Showing docs for ${adaptorName} v${version}`);
   }
@@ -567,11 +580,17 @@ var docsHandler = async (options, logger) => {
   if (path3) {
     const source = await readFile(path3, "utf8");
     const data = JSON.parse(source);
-    const fn = data.functions.find(({ name: name2 }) => name2 === operation);
-    logger.debug("Operation schema:", fn);
-    logger.success(`Documentation for ${name}.${operation} v${version}:
+    let desc;
+    if (operation) {
+      const fn = data.functions.find(({ name: name2 }) => name2 === operation);
+      logger.debug("Operation schema:", fn);
+      logger.success(`Documentation for ${name}.${operation} v${version}:
 `);
-    const desc = describe(name, fn);
+      desc = describeFn(name, fn);
+    } else {
+      logger.debug("No operation provided, listing available operations");
+      desc = describeLib(name, data);
+    }
     logger.print(desc);
     logger.success("Done!");
   } else {
@@ -580,6 +599,22 @@ var docsHandler = async (options, logger) => {
 };
 var handler_default5 = docsHandler;
 
+// src/util/print-versions.ts
+import { mainSymbols } from "figures";
+var { triangleRightSmall: t } = mainSymbols;
+var printVersions = async (logger) => {
+  const pkg = await import("../../package.json", { assert: { type: "json" } });
+  const { version, dependencies } = pkg.default;
+  const compilerVersion = dependencies["@openfn/compiler"];
+  const runtimeVersion = dependencies["@openfn/runtime"];
+  logger.info(`Versions:
+        ${t} Node.js   ${process.version.substring(1)}
+        ${t} cli       ${version}
+        ${t} runtime   ${runtimeVersion}
+        ${t} compiler  ${compilerVersion}`);
+};
+var print_versions_default = printVersions;
+
 // src/commands.ts
 var handlers = {
   execute: handler_default,
@@ -590,15 +625,19 @@ var handlers = {
   ["repo-clean"]: clean,
   ["repo-install"]: install,
   ["repo-pwd"]: pwd,
-  ["repo-list"]: list
+  ["repo-list"]: list,
+  version: async (_opts, logger) => print_versions_default(logger)
 };
 var parse = async (basePath, options, log) => {
   const opts = ensureOpts(basePath, options);
   const logger = log || logger_default(CLI, opts);
+  if (opts.command === "execute" || opts.command === "test") {
+    await print_versions_default(logger);
+  }
   if (opts.adaptors && opts.expand) {
     opts.adaptors = expand_adaptors_default(opts.adaptors, logger);
   }
-  if (opts.command == "test" && !opts.repoDir) {
+  if (/^(test|version)$/.test(opts.command) && !opts.repoDir) {
     logger.warn(
       "WARNING: no repo module dir found! Using the default (/tmp/repo)"
     );

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@openfn/cli",
-  "version": "0.0.22",
+  "version": "0.0.24",
   "description": "CLI devtools for the openfn toolchain.",
   "engines": {
-    "node": ">=16",
+    "node": ">=18",
     "pnpm": ">=7"
   },
   "exports": {
@@ -36,11 +36,12 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@openfn/compiler": "0.0.20",
-    "@openfn/describe-package": "0.0.13",
+    "@openfn/compiler": "0.0.22",
+    "@openfn/describe-package": "0.0.14",
     "@openfn/logger": "0.0.8",
-    "@openfn/runtime": "0.0.13",
+    "@openfn/runtime": "0.0.14",
     "fast-safe-stringify": "^2.1.1",
+    "figures": "^5.0.0",
     "rimraf": "^3.0.2",
     "treeify": "^1.1.0",
     "yargs": "^17.5.1"