@openfn/cli 0.1.0 → 0.2.0

package/dist/index.js

@@ -100,6 +100,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 +372,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",
@@ -469,6 +479,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 +547,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/process/runner.js

@@ -78,13 +78,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 +286,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 +306,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);
       }
     }
@@ -754,20 +754,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 +779,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 +808,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,7 +878,7 @@ 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
@@ -886,8 +886,8 @@ var docsHandler = async (options, logger) => {
     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) {
@@ -1033,8 +1033,47 @@ 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",
   job: "debug"
@@ -1112,7 +1151,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 +1169,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 +1179,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";
@@ -1212,6 +1251,7 @@ var handlers = {
   docgen: handler_default5,
   docs: handler_default6,
   metadata: handler_default7,
+  pull: handler_default8,
   ["repo-clean"]: clean,
   ["repo-install"]: install,
   ["repo-pwd"]: pwd,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/cli",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "CLI devtools for the openfn toolchain.",
   "engines": {
     "node": ">=18",
@@ -40,11 +40,11 @@
     "rimraf": "^3.0.2",
     "treeify": "^1.1.0",
     "yargs": "^17.5.1",
-    "@openfn/deploy": "0.1.0",
-    "@openfn/runtime": "0.0.26",
+    "@openfn/compiler": "0.0.32",
+    "@openfn/deploy": "0.2.0",
     "@openfn/logger": "0.0.13",
     "@openfn/describe-package": "0.0.16",
-    "@openfn/compiler": "0.0.32"
+    "@openfn/runtime": "0.0.26"
   },
   "files": [
     "dist",