@openfn/project 0.3.0 → 0.4.0

package/dist/index.d.ts

@@ -18,9 +18,8 @@ declare class Workflow {
     name: string;
     id: string;
     openfn: OpenfnMeta;
-    steps: WithMeta<l.Job | l.Trigger>[];
     constructor(workflow: l.Workflow);
-    get steps(): (l.Job | l.Trigger)[];
+    get steps(): WithMeta<l.Job | l.Trigger>[];
     set(id: string, props: Parital<l.Job, l.Edge>): this;
     get(id: any): WithMeta<l.Step | l.Trigger | l.Edge>;
     meta(id: any): OpenfnMeta;
@@ -111,4 +110,16 @@ declare class Workspace {
 declare function yamlToJson(y: string): any;
 declare function jsonToYaml(json: string | JSONObject): string;
 
-export { Workspace, Project as default, jsonToYaml, yamlToJson };
+type GenerateWorkflowOptions = {
+    name: string;
+    uuidSeed: number;
+    openfnUuid: boolean;
+};
+/**
+ * Generate a Workflow from a simple text based representation
+ * The def array contains strings of pairs of nodes
+ * eg, ['a-b', 'b-c']
+ */
+declare function generateWorkflow(def: string[], options?: Partial<GenerateWorkflowOptions>): Workflow;
+
+export { Workspace, Project as default, generateWorkflow as generate, jsonToYaml, yamlToJson };

package/dist/index.js

@@ -13,7 +13,6 @@ var Workflow = class {
   name;
   id;
   openfn;
-  steps;
   constructor(workflow) {
     this.index = {
       steps: {},
@@ -944,6 +943,7 @@ function merge(source, target, options) {
 }
 
 // src/Project.ts
+var maybeCreateWorkflow = (wf) => wf instanceof Workflow_default ? wf : new Workflow_default(wf);
 var setConfigDefaults = (config = {}) => ({
   workflowRoot: config.workflowRoot ?? "workflows",
   formats: {
@@ -1008,7 +1008,7 @@ var Project = class {
     this.description = data.description;
     this.openfn = data.openfn;
     this.options = data.options;
-    this.workflows = data.workflows?.map((w) => new Workflow_default(w)) ?? [];
+    this.workflows = data.workflows?.map(maybeCreateWorkflow) ?? [];
     this.collections = data.collections;
     this.credentials = data.credentials;
     this.meta = data.meta;
@@ -1112,11 +1112,75 @@ var Workspace = class {
   }
 };
 
+// src/gen/workflow-generator.ts
+import { randomUUID as randomUUID2 } from "node:crypto";
+
+// src/util/slugify.ts
+function slugify2(text) {
+  return text.replace(/\W/g, " ").trim().replace(/\s+/g, "-").toLowerCase();
+}
+
+// src/gen/workflow-generator.ts
+function gen(def, name = "workflow", uuidSeed, openfnUuid) {
+  const ids = /* @__PURE__ */ new Map();
+  const nodes = {};
+  for (const conn of def) {
+    const [from, to] = conn.split("-");
+    if (nodes[from]) {
+      if (to) {
+        if (!nodes[from].next?.[to]) {
+          nodes[from].next ??= {};
+          nodes[from].next[to] = edge(`${from}-${to}`);
+        }
+      }
+    } else {
+      let props;
+      if (to) {
+        props = { next: { [to]: edge(`${from}-${to}`) } };
+      }
+      nodes[from] = node(from, props);
+    }
+    if (to && !nodes[to]) {
+      nodes[to] = node(to);
+    }
+  }
+  return {
+    name,
+    id: slugify2(name),
+    steps: Object.values(nodes),
+    ...openfnUuid ? { openfn: { uuid: randomUUID2() } } : {}
+  };
+  function node(id, props = {}) {
+    return {
+      id,
+      ...props,
+      openfn: { uuid: uuid(id) }
+    };
+  }
+  function edge(id, props = {}) {
+    return {
+      ...props,
+      openfn: { uuid: uuid(id) }
+    };
+  }
+  function uuid(id) {
+    const muuid = !isNaN(uuidSeed) ? ++uuidSeed : randomUUID2();
+    ids.set(id, muuid);
+    return muuid;
+  }
+}
+function generateWorkflow(def, options = {}) {
+  const { name, uuidSeed, openfnUuid } = options;
+  const wf = gen(def, name, uuidSeed, openfnUuid);
+  return new Workflow_default(wf);
+}
+
 // src/index.ts
 var src_default = Project;
 export {
   Workspace,
   src_default as default,
+  generateWorkflow as generate,
   jsonToYaml,
   yamlToJson
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/project",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Read, serialize, replicate and sync OpenFn projects",
   "type": "module",
   "exports": {