@openfn/project 0.5.1 → 0.6.0

package/dist/index.d.ts

@@ -32,6 +32,7 @@ declare class Workflow {
     getUUID(id: any): string;
     toJSON(): JSON.Object;
     getUUIDMap(): Record<string, string>;
+    getVersionHash(): string;
 }
 
 type FromFsConfig = {
@@ -95,7 +96,7 @@ declare class Project {
     constructor(data: l.Project, repoConfig?: RepoOptions);
     serialize(type?: 'json' | 'yaml' | 'fs' | 'state', options?: any): any;
     getVersionHash(): void;
-    getWorkflow(id: string): Workflow | undefined;
+    getWorkflow(idOrName: string): Workflow | undefined;
     getIdentifier(): string;
     compare(proj: Project): void;
     getUUID(workflow: string | Workflow, stepId: string, otherStep?: string): any;

package/dist/index.js

@@ -9,6 +9,74 @@ function slugify(text) {
   return text?.replace(/\W/g, " ").trim().replace(/\s+/g, "-").toLowerCase();
 }
 
+// src/util/version.ts
+import crypto from "node:crypto";
+var SHORT_HASH_LENGTH = 12;
+function isDefined(v) {
+  return v !== void 0 && v !== null;
+}
+var generateHash = (workflow, source = "cli") => {
+  const parts = [];
+  const wfKeys = ["name", "credentials"].sort();
+  const stepKeys = [
+    "name",
+    "adaptors",
+    "adaptor",
+    // there's ao adaptor & adaptors key in steps somehow.
+    "expression",
+    "configuration",
+    // assumes a string credential id
+    "expression"
+    // TODO need to model trigger types in this, which I think are currently ignored
+  ].sort();
+  const edgeKeys = [
+    "condition",
+    "label",
+    "disabled"
+    // This feels more like an option - should be excluded?
+  ].sort();
+  wfKeys.forEach((key) => {
+    if (isDefined(workflow[key])) {
+      parts.push(key, serializeValue(workflow[key]));
+    }
+  });
+  const steps = (workflow.steps || []).slice().sort((a, b) => {
+    const aName = a.name ?? "";
+    const bName = b.name ?? "";
+    return aName.localeCompare(bName);
+  });
+  for (const step of steps) {
+    stepKeys.forEach((key) => {
+      if (isDefined(step[key])) {
+        parts.push(key, serializeValue(step[key]));
+      }
+    });
+    if (step.next && Array.isArray(step.next)) {
+      const edges = step.next.slice().sort((a, b) => {
+        const aLabel = a.label || "";
+        const bLabel = b.label || "";
+        return aLabel.localeCompare(bLabel);
+      });
+      for (const edge of edges) {
+        edgeKeys.forEach((key) => {
+          if (isDefined(edge[key])) {
+            parts.push(key, serializeValue(edge[key]));
+          }
+        });
+      }
+    }
+  }
+  const str = parts.join("");
+  const hash = crypto.createHash("sha256").update(str).digest("hex");
+  return `${source}:${hash.substring(0, SHORT_HASH_LENGTH)}`;
+};
+function serializeValue(val) {
+  if (typeof val === "object") {
+    return JSON.stringify(val);
+  }
+  return String(val);
+}
+
 // src/Workflow.ts
 var clone = (obj) => JSON.parse(JSON.stringify(obj));
 var Workflow = class {
@@ -138,6 +206,9 @@ var Workflow = class {
   getUUIDMap() {
     return this.index.uuid;
   }
+  getVersionHash() {
+    return generateHash(this);
+  }
 };
 var Workflow_default = Workflow;
 
@@ -1031,7 +1102,7 @@ var Project = class {
   // collections for the project
   // TODO to be well typed
   collections;
-  static from(type, data, options) {
+  static from(type, data, options = {}) {
     if (type === "state") {
       return from_app_state_default(data, options);
     } else if (type === "fs") {
@@ -1079,8 +1150,8 @@ var Project = class {
   // what else might we need?
   // get workflow by name or id
   // this is fuzzy, but is that wrong?
-  getWorkflow(id) {
-    return this.workflows.find((wf) => wf.id == id);
+  getWorkflow(idOrName) {
+    return this.workflows.find((wf) => wf.id == idOrName) || this.workflows.find((wf) => wf.name === idOrName);
   }
   // it's the name of the project.yaml file
   // qualified name? Remote name? App name?

package/package.json

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