@openfn/project 0.2.0 → 0.3.1

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;
@@ -34,6 +33,10 @@ declare class Workflow {
     toJSON(): JSON.Object;
 }
 
+type FromFsConfig = {
+    root: string;
+};
+
 type MergeProjectOptions = Partial<{
     workflowMappings: Record<string, string>;
     removeUnmapped: boolean;
@@ -41,6 +44,22 @@ type MergeProjectOptions = Partial<{
 }>;
 
 type FileFormats = 'yaml' | 'json';
+interface OpenfnConfig {
+    name: string;
+    workflowRoot: string;
+    formats: {
+        openfn: FileFormats;
+        project: FileFormats;
+        workflow: FileFormats;
+    };
+    project: {
+        projectId: string;
+        endpoint: string;
+        env: string;
+        inserted_at: string;
+        updated_at: string;
+    };
+}
 type RepoOptions = {
     /**default workflow root when serializing to fs (relative to openfn.yaml) */
     workflowRoot?: string;
@@ -62,9 +81,7 @@ declare class Project {
     repo?: Required<RepoOptions>;
     collections: any;
     static from(type: 'state', data: any, options: Partial<l.ProjectConfig>): Project;
-    static from(type: 'fs', options: {
-        root: string;
-    }): Project;
+    static from(type: 'fs', options: FromFsConfig): Project;
     static from(type: 'path', data: any): Project;
     static diff(a: Project, b: Project): void;
     static merge(source: Project, target: Project, options: MergeProjectOptions): Project;
@@ -77,7 +94,20 @@ declare class Project {
     getUUID(workflow: string | Workflow, stepId: string, otherStep?: string): any;
 }
 
+declare class Workspace {
+    private config?;
+    private projects;
+    private isValid;
+    constructor(workspacePath: string);
+    list(): Project[];
+    get(id: string): Project | undefined;
+    getActiveProject(): Project | undefined;
+    getConfig(): OpenfnConfig | undefined;
+    get activeProjectId(): string | undefined;
+    get valid(): boolean;
+}
+
 declare function yamlToJson(y: string): any;
 declare function jsonToYaml(json: string | JSONObject): string;
 
-export { Project as default, jsonToYaml, yamlToJson };
+export { Workspace, Project as default, jsonToYaml, yamlToJson };

package/dist/index.js

@@ -13,7 +13,6 @@ var Workflow = class {
   name;
   id;
   openfn;
-  steps;
   constructor(workflow) {
     this.index = {
       steps: {},
@@ -263,16 +262,16 @@ import nodepath from "path";
 var stringify = (json) => JSON.stringify(json, null, 2);
 function to_fs_default(project) {
   const files = {};
-  const { path: path2, content } = extractRepoConfig(project);
-  files[path2] = content;
+  const { path: path3, content } = extractRepoConfig(project);
+  files[path3] = content;
   for (const wf of project.workflows) {
-    const { path: path3, content: content2 } = extractWorkflow(project, wf.id);
-    files[path3] = content2;
+    const { path: path4, content: content2 } = extractWorkflow(project, wf.id);
+    files[path4] = content2;
     for (const s of wf.steps) {
       const result = extractStep(project, wf.id, s.id);
       if (result) {
-        const { path: path4, content: content3 } = result;
-        files[path4] = content3;
+        const { path: path5, content: content3 } = result;
+        files[path5] = content3;
       }
     }
   }
@@ -285,7 +284,7 @@ var extractWorkflow = (project, workflowId2) => {
     throw new Error(`workflow not found: ${workflowId2}`);
   }
   const root = project.repo?.workflowRoot ?? "workflows/";
-  const path2 = nodepath.join(root, workflow.id, workflow.id);
+  const path3 = nodepath.join(root, workflow.id, workflow.id);
   const wf = {
     id: workflow.id,
     name: workflow.name,
@@ -300,7 +299,7 @@ var extractWorkflow = (project, workflowId2) => {
       return mapped;
     })
   };
-  return handleOutput(wf, path2, format);
+  return handleOutput(wf, path3, format);
 };
 var extractStep = (project, workflowId2, stepId) => {
   const workflow = project.getWorkflow(workflowId2);
@@ -313,9 +312,9 @@ var extractStep = (project, workflowId2, stepId) => {
   }
   if (step.expression) {
     const root = project.config?.workflowRoot ?? "workflows/";
-    const path2 = nodepath.join(root, `${workflow.id}/${step.id}.js`);
+    const path3 = nodepath.join(root, `${workflow.id}/${step.id}.js`);
     const content = step.expression;
-    return { path: path2, content };
+    return { path: path3, content };
   }
 };
 var extractRepoConfig = (project) => {
@@ -328,7 +327,7 @@ var extractRepoConfig = (project) => {
   return handleOutput(config, "openfn", format);
 };
 var handleOutput = (data, filePath, format) => {
-  const path2 = `${filePath}.${format}`;
+  const path3 = `${filePath}.${format}`;
   let content;
   if (format === "json") {
     content = stringify(data, null, 2);
@@ -337,7 +336,7 @@ var handleOutput = (data, filePath, format) => {
   } else {
     throw new Error(`Unrecognised format: ${format}`);
   }
-  return { path: path2, content };
+  return { path: path3, content };
 };
 
 // src/parse/from-app-state.ts
@@ -984,8 +983,7 @@ var Project = class {
   static from(type, data, options) {
     if (type === "state") {
       return from_app_state_default(data, options);
-    }
-    if (type === "fs") {
+    } else if (type === "fs") {
       return parseProject(data, options);
     }
     throw new Error(`Didn't recognize type ${type}`);
@@ -1050,9 +1048,73 @@ var Project = class {
   }
 };
 
+// src/util/path-exists.ts
+import fs2 from "fs";
+function pathExists(fpath, type) {
+  try {
+    const stat = fs2.statSync(fpath);
+    if (type === "file" && stat.isFile())
+      return true;
+    else if (type === "directory" && stat.isDirectory())
+      return true;
+    return false;
+  } catch (e) {
+    return false;
+  }
+}
+
+// src/Workspace.ts
+import path2 from "path";
+import fs3 from "fs";
+var PROJECTS_DIRECTORY = ".projects";
+var OPENFN_YAML_FILE = "openfn.yaml";
+var PROJECT_EXTENSIONS = [".yaml", ".yml"];
+var Workspace = class {
+  config;
+  projects = [];
+  isValid = false;
+  constructor(workspacePath) {
+    const projectsPath = path2.join(workspacePath, PROJECTS_DIRECTORY);
+    const openfnYamlPath = path2.join(workspacePath, OPENFN_YAML_FILE);
+    if (pathExists(openfnYamlPath, "file")) {
+      this.isValid = true;
+      const data = fs3.readFileSync(openfnYamlPath, "utf-8");
+      this.config = yamlToJson(data);
+    }
+    if (this.isValid && pathExists(projectsPath, "directory")) {
+      const stateFiles = fs3.readdirSync(projectsPath).filter(
+        (fileName) => PROJECT_EXTENSIONS.includes(path2.extname(fileName))
+      );
+      this.projects = stateFiles.map((file) => {
+        const data = fs3.readFileSync(path2.join(projectsPath, file), "utf-8");
+        return from_app_state_default(data, { format: "yaml" });
+      });
+    }
+  }
+  list() {
+    return this.projects;
+  }
+  get(id) {
+    return this.projects.find((p) => p.name === id);
+  }
+  getActiveProject() {
+    return this.projects.find((p) => p.name === this.config?.name);
+  }
+  getConfig() {
+    return this.config;
+  }
+  get activeProjectId() {
+    return this.config?.name;
+  }
+  get valid() {
+    return this.isValid;
+  }
+};
+
 // src/index.ts
 var src_default = Project;
 export {
+  Workspace,
   src_default as default,
   jsonToYaml,
   yamlToJson

package/package.json

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