@openfn/cli 0.0.23 → 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";

package/dist/process/runner.js

@@ -86,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
@@ -149,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),
@@ -532,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
 
@@ -547,6 +555,10 @@ 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);
@@ -568,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 {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/cli",
-  "version": "0.0.23",
+  "version": "0.0.24",
   "description": "CLI devtools for the openfn toolchain.",
   "engines": {
     "node": ">=18",
@@ -36,10 +36,10 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@openfn/compiler": "0.0.21",
-    "@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",