@openfn/project 0.9.1 → 0.9.2

package/dist/index.d.ts

@@ -1,18 +1,8 @@
 import * as l from '@openfn/lexicon';
 import l__default, { WorkspaceConfig, UUID } from '@openfn/lexicon';
+import { Logger } from '@openfn/logger';
 import { Provisioner } from '@openfn/lexicon/lightning';
 
-type SerializedProject = Omit<Partial<l.Project>, 'workflows'> & {
-    version: number;
-    workflows: SerializedWorkflow[];
-};
-type SerializedWorkflow = {
-    id: string;
-    name: string;
-    steps: l.Step[];
-    openfn?: l.ProjectMeta;
-};
-
 type WithMeta<T> = T & {
     openfn?: l.NodeMeta;
 };
@@ -53,6 +43,17 @@ type FromFsConfig = {
     root: string;
 };
 
+type SerializedProject = Omit<Partial<l.Project>, 'workflows'> & {
+    version: number;
+    workflows: SerializedWorkflow[];
+};
+type SerializedWorkflow = {
+    id: string;
+    name: string;
+    steps: WithMeta<l.Step[]>;
+    openfn?: l.ProjectMeta;
+};
+
 type MergeProjectOptions = {
     workflowMappings: Record<string, string>;
     removeUnmapped: boolean;
@@ -65,7 +66,8 @@ declare class Workspace {
     private projects;
     private projectPaths;
     private isValid;
-    constructor(workspacePath: string);
+    private logger;
+    constructor(workspacePath: string, logger?: Logger);
     loadProject(): void;
     list(): Project[];
     /** Get a project by its id or UUID */
@@ -109,7 +111,9 @@ declare class Project {
     static merge(source: Project, target: Project, options?: Partial<MergeProjectOptions>): Project;
     constructor(data: Partial<l__default.Project>, config?: Partial<l__default.WorkspaceConfig>);
     setConfig(config: Partial<WorkspaceConfig>): void;
-    serialize(type?: 'project' | 'fs' | 'state', options?: any): string | Record<string, string> | Provisioner.Project_v1 | SerializedProject;
+    serialize(type: 'project', options?: any): SerializedProject | string;
+    serialize(type: 'state', options?: any): Provisioner.Project | string;
+    serialize(type: 'fs', options?: any): Record<string, string>;
     getWorkflow(idOrName: string): Workflow | undefined;
     getIdentifier(): string;
     getUUID(workflow: string | Workflow, stepId: string, otherStep?: string): any;
@@ -117,6 +121,7 @@ declare class Project {
      * Returns a map of ids:uuids for everything in the project
      */
     getUUIDMap(): UUIDMap;
+    canMergeInto(target: Project): boolean;
 }
 
 declare function yamlToJson(y: string): any;

package/dist/index.js

@@ -105,7 +105,7 @@ var Workflow = class {
     };
     this.workflow = clone(workflow);
     this.workflow.history = workflow.history?.length ? workflow.history : [];
-    const { id, name, openfn, steps, ...options } = workflow;
+    const { id, name, openfn, steps, history, ...options } = workflow;
     if (!(id || name)) {
       throw new Error("A Workflow MUST have a name or id");
     }
@@ -151,7 +151,7 @@ var Workflow = class {
     Object.assign(item, props);
     return this;
   }
-  // Get properties on any step or edge by id
+  // Get properties on any step or edge by id or uuid
   get(id) {
     const item = this.index.edges[id] || this.index.steps[id];
     if (!item) {
@@ -555,13 +555,32 @@ var to_project_default = (project, options = {}) => {
       description: project.description,
       collections: project.collections,
       credentials: project.credentials,
-      openfn: project.openfn,
+      openfn: omitBy2(project.openfn, isNil3),
       meta: project.meta,
       options: omitBy2(project.options, isNil3),
-      //workflows: project.workflows.map(mapWorkflow) as SerializedWorkflow[],
-      workflows: project.workflows.map(
-        (w) => w.toJSON()
-      )
+      workflows: project.workflows.map((w) => {
+        const obj = w.toJSON();
+        if (obj.openfn) {
+          obj.openfn = omitBy2(obj.openfn, isNil3);
+        }
+        if (obj.steps) {
+          obj.steps = obj.steps.sort((a, b) => {
+            return a.id < b.id ? -1 : a.id > b.id ? 1 : 0;
+          });
+          obj.steps.forEach((s) => {
+            s.openfn = omitBy2(s.openfn, isNil3);
+            if (s.next && typeof s.next !== "string") {
+              for (const id in s.next) {
+                const edge = s.next[id];
+                if (edge.openfn) {
+                  edge.openfn = omitBy2(edge.openfn, isNil3);
+                }
+              }
+            }
+          });
+        }
+        return obj;
+      })
     },
     isNil3
   );
@@ -636,10 +655,11 @@ var mapTriggerEdgeCondition = (edge) => {
   return e;
 };
 var mapWorkflow2 = (workflow) => {
-  const { jobs, edges, triggers, name, ...remoteProps } = workflow;
+  const { jobs, edges, triggers, name, version_history, ...remoteProps } = workflow;
   const mapped = {
     name: workflow.name,
     steps: [],
+    history: workflow.version_history ?? [],
     openfn: renameKeys(remoteProps, { id: "uuid" })
   };
   if (workflow.name) {
@@ -777,12 +797,12 @@ var parseProject = async (options) => {
     try {
       const wf = fileType === "yaml" ? yamlToJson(candidate) : JSON.parse(candidate);
       if (wf.id && Array.isArray(wf.steps)) {
-        const wfState = (state && state.getWorkflow(wf.id)) ?? {};
-        wf.openfn = {
-          uuid: wfState.openfn?.uuid ?? null
-          // TODO do we need to transfer more stuff? Options maybe?
-        };
+        const wfState = state?.getWorkflow(wf.id);
+        wf.openfn = Object.assign({}, wfState?.openfn, {
+          uuid: wfState?.openfn?.uuid ?? null
+        });
         for (const step of wf.steps) {
+          const stateStep = wfState?.get(step.id);
           if (step.expression && step.expression.endsWith(".js")) {
             const dir = path2.dirname(filePath);
             const exprPath = path2.join(dir, step.expression);
@@ -793,15 +813,14 @@ var parseProject = async (options) => {
               console.error(`Error loading expression from ${exprPath}`);
             }
           }
-          const uuid = state?.getUUID(wf.id, step.id) ?? null;
-          step.openfn = { uuid };
+          step.openfn = Object.assign({}, stateStep?.openfn);
           for (const target in step.next || {}) {
             if (typeof step.next[target] === "boolean") {
               const bool = step.next[target];
               step.next[target] = { condition: bool };
             }
-            const uuid2 = state?.getUUID(wf.id, step.id, target) ?? null;
-            step.next[target].openfn = { uuid: uuid2 };
+            const uuid = state?.getUUID(wf.id, step.id, target) ?? null;
+            step.next[target].openfn = { uuid };
           }
         }
         proj.workflows.push(wf);
@@ -1339,10 +1358,25 @@ var Project = class {
     }
     return result;
   }
+  canMergeInto(target) {
+    const potentialConflicts = {};
+    for (const sourceWorkflow of this.workflows) {
+      const targetId = sourceWorkflow.id;
+      const targetWorkflow = target.getWorkflow(targetId);
+      if (targetWorkflow && !sourceWorkflow.canMergeInto(targetWorkflow)) {
+        potentialConflicts[sourceWorkflow.id] = targetWorkflow?.id;
+      }
+    }
+    if (Object.keys(potentialConflicts).length) {
+      return false;
+    }
+    return true;
+  }
 };
 var Project_default = Project;
 
 // src/Workspace.ts
+import createLogger from "@openfn/logger";
 import path3 from "node:path";
 import fs3 from "node:fs";
 
@@ -1369,20 +1403,23 @@ var Workspace = class {
   projects = [];
   projectPaths = /* @__PURE__ */ new Map();
   isValid = false;
-  constructor(workspacePath) {
-    let context;
+  logger;
+  constructor(workspacePath, logger) {
+    this.logger = logger ?? createLogger("Workspace", { level: "info" });
+    let context = { workspace: void 0, project: void 0 };
     try {
       const { type, content } = findWorkspaceFile(workspacePath);
       context = loadWorkspaceFile(content, type);
       this.isValid = true;
     } catch (e) {
-      console.error(e);
-      return;
+      this.logger.warn(
+        `Could not find openfn.yaml at ${workspacePath}. Using default values.`
+      );
     }
     this.config = buildConfig(context.workspace);
     this.activeProject = context.project;
     const projectsPath = path3.join(workspacePath, this.config.dirs.projects);
-    if (this.isValid && pathExists(projectsPath, "directory")) {
+    if (pathExists(projectsPath, "directory")) {
       const ext = `.${this.config.formats.project}`;
       const stateFiles = fs3.readdirSync(projectsPath).filter(
         (fileName) => path3.extname(fileName) === ext && path3.parse(fileName).name !== "openfn"
@@ -1401,6 +1438,10 @@ var Workspace = class {
           console.warn(e);
         }
       }).filter((s) => s);
+    } else {
+      this.logger.warn(
+        `No projects found: directory at ${projectsPath} does not exist`
+      );
     }
   }
   // TODO

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/project",
-  "version": "0.9.1",
+  "version": "0.9.2",
   "description": "Read, serialize, replicate and sync OpenFn projects",
   "type": "module",
   "exports": {
@@ -34,7 +34,7 @@
     "lodash-es": "^4.17.21",
     "ohm-js": "^17.2.1",
     "yaml": "^2.2.2",
-    "@openfn/lexicon": "^1.2.7",
+    "@openfn/lexicon": "^1.3.0",
     "@openfn/logger": "1.1.0"
   },
   "files": [