@openfn/cli 1.3.0 → 1.3.2

package/dist/process/runner.js

@@ -909,6 +909,56 @@ var fuzzy_match_step_default = (plan, stepPattern) => {
   }
 };
 
+// src/util/validate-plan.ts
+var assertWorkflowStructure = (plan, logger) => {
+  const { workflow, options } = plan;
+  if (!workflow || typeof workflow !== "object") {
+    throw new Error(`Missing or invalid "workflow" key in execution plan`);
+  }
+  if (!Array.isArray(workflow.steps)) {
+    throw new Error("The workflow.steps key must be an array");
+  }
+  if (workflow.steps.length === 0) {
+    logger.warn("The workflow.steps array is empty");
+  }
+  workflow.steps.forEach((step, index) => {
+    assertStepStructure(step, index);
+  });
+  assertOptionsStructure(options, logger);
+};
+var assertStepStructure = (step, index) => {
+  const allowedKeys = [
+    "id",
+    "name",
+    "next",
+    "previous",
+    "adaptor",
+    "expression",
+    "state",
+    "configuration",
+    "linker"
+  ];
+  for (const key in step) {
+    if (!allowedKeys.includes(key)) {
+      throw new Error(`Invalid key "${key}" in step ${step.id || index}`);
+    }
+  }
+  if ("adaptor" in step && !("expression" in step)) {
+    throw new Error(
+      `Step ${step.id ?? index} with an adaptor must also have an expression`
+    );
+  }
+};
+var assertOptionsStructure = (options = {}, logger) => {
+  const allowedKeys = ["timeout", "stepTimeout", "start", "end", "sanitize"];
+  for (const key in options) {
+    if (!allowedKeys.includes(key)) {
+      logger.warn(`Unrecognized option "${key}" in options object`);
+    }
+  }
+};
+var validate_plan_default = assertWorkflowStructure;
+
 // src/execute/handler.ts
 var matchStep = (plan, stepPattern, stepName, logger) => {
   try {
@@ -934,6 +984,7 @@ var executeHandler = async (options, logger) => {
   assert_path_default(options.path);
   await validate_adaptors_default(options, logger);
   let plan = await load_plan_default(options, logger);
+  validate_plan_default(plan, logger);
   if (options.cacheSteps) {
     await clearCache(plan, options, logger);
   }
@@ -1086,7 +1137,12 @@ var testHandler = async (options, logger) => {
   }
   const state = await load_state_default(plan, opts, createNullLogger());
   const compiledPlan = await compile_default(plan, opts, logger);
-  const result = await execute_default(compiledPlan, state, opts, logger);
+  const result = await execute_default(
+    compiledPlan,
+    state,
+    opts,
+    logger
+  );
   logger.success(`Result: ${result.data.answer}`);
   return result;
 };
@@ -1245,7 +1301,9 @@ import { readFile as readFile3 } from "node:fs/promises";
 import c from "chalk";
 import { getNameAndVersion as getNameAndVersion4, getLatestVersion } from "@openfn/runtime";
 var describeFn = (adaptorName, fn) => [
-  c.green(`## ${fn.name}(${fn.parameters.map(({ name }) => name).join(",")})`),
+  c.green(
+    `## ${fn.name}(${fn.parameters.map(({ name }) => name).join(",")})`
+  ),
   `${fn.description}`,
   c.green("### Usage Examples"),
   fn.examples.length ? fn.examples.map(({ code, caption }) => {
@@ -1264,7 +1322,9 @@ ${code}`;
 ].join("\n\n");
 var describeLib = (adaptorName, data) => c.green(`## ${adaptorName} ${data.version}`) + `
 
-${data.functions.map((fn) => `  ${c.yellow(fn.name)} (${fn.parameters.map((p) => p.name).join(", ")})`).sort().join("\n")}
+${data.functions.map(
+  (fn) => `  ${c.yellow(fn.name)} (${fn.parameters.map((p) => p.name).join(", ")})`
+).sort().join("\n")}
 `;
 var docsHandler = async (options, logger) => {
   const { adaptor, operation, repoDir } = options;
@@ -1457,7 +1517,9 @@ async function pullHandler(options, logger) {
   try {
     assert_path_default(options.projectId);
     const config = mergeOverrides2(await getConfig2(options.configPath), options);
-    logger.always("Downloading existing project state (as JSON) from the server.");
+    logger.always(
+      "Downloading existing project state (as JSON) from the server."
+    );
     const { data: project } = await getProject(config, options.projectId);
     if (!project) {
       logger.error("ERROR: Project not found.");
@@ -1472,9 +1534,7 @@ async function pullHandler(options, logger) {
       path7.resolve(config.statePath),
       JSON.stringify(state, null, 2)
     );
-    logger.always(
-      "Downloading the project spec (as YAML) from the server."
-    );
+    logger.always("Downloading the project spec (as YAML) from the server.");
     const url2 = new URL(
       `api/provision/yaml?id=${options.projectId}`,
       config.endpoint

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/cli",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "CLI devtools for the openfn toolchain.",
   "engines": {
     "node": ">=18",
@@ -47,11 +47,11 @@
     "treeify": "^1.1.0",
     "ws": "^8.14.1",
     "yargs": "^17.7.2",
-    "@openfn/describe-package": "0.0.19",
     "@openfn/compiler": "0.1.2",
-    "@openfn/logger": "1.0.1",
     "@openfn/deploy": "0.4.6",
-    "@openfn/runtime": "1.1.3"
+    "@openfn/logger": "1.0.1",
+    "@openfn/describe-package": "0.0.19",
+    "@openfn/runtime": "1.2.0"
   },
   "files": [
     "dist",