@openfn/project 0.7.0 → 0.7.1

package/dist/index.d.ts

@@ -37,16 +37,16 @@ declare class Workflow {
     canMergeInto(target: Workflow): boolean;
 }
 
-type FileFormats$1 = 'yaml' | 'json';
+type FileFormats = 'yaml' | 'json';
 interface WorkspaceConfig {
     dirs: {
         workflows: string;
         projects: string;
     };
     formats: {
-        openfn: FileFormats$1;
-        project: FileFormats$1;
-        workflow: FileFormats$1;
+        openfn: FileFormats;
+        project: FileFormats;
+        workflow: FileFormats;
     };
 }
 
@@ -66,13 +66,14 @@ type MergeProjectOptions = Partial<{
 
 declare class Workspace {
     config?: WorkspaceConfig;
-    projectMeta: ProjectMeta;
+    activeProject: ProjectMeta;
     private projects;
     private projectPaths;
     private isValid;
     constructor(workspacePath: string);
     loadProject(): void;
     list(): Project[];
+    /** Get a project by its id or UUID */
     get(id: string): Project | undefined;
     getProjectPath(id: string): string | undefined;
     getActiveProject(): Project | undefined;
@@ -81,18 +82,11 @@ declare class Workspace {
     get valid(): boolean;
 }
 
-type RepoOptions = {
-    /**default workflow root when serializing to fs (relative to openfn.yaml) */
-    workflowRoot?: string;
-    formats: {
-        openfn: FileFormats;
-        workflow: FileFormats;
-        project: FileFormats;
-    };
-};
 declare class Project {
-    /** project name */
+    /** Human readable project name. This corresponds to the label in Lightning */
     name?: string;
+    /** Project id. Must be url safe. May be derived from the name. NOT a UUID */
+    id: string;
     description?: string;
     history: string[];
     workflows: Workflow[];
@@ -109,10 +103,9 @@ declare class Project {
     }): Project;
     static diff(a: Project, b: Project): void;
     static merge(source: Project, target: Project, options: MergeProjectOptions): Project;
-    constructor(data: l.Project, repoConfig?: RepoOptions);
+    constructor(data: l.Project, config?: RepoOptions);
     setConfig(config: Partial<WorkspaceConfig>): void;
     serialize(type?: 'json' | 'yaml' | 'fs' | 'state', options?: any): any;
-    getVersionHash(): void;
     getWorkflow(idOrName: string): Workflow | undefined;
     getIdentifier(): string;
     compare(proj: Project): void;

package/dist/index.js

@@ -4,6 +4,9 @@ var __export = (target, all) => {
     __defProp(target, name, { get: all[name], enumerable: true });
 };
 
+// src/Project.ts
+import { humanId } from "human-id";
+
 // src/util/slugify.ts
 function slugify(text) {
   return text?.replace(/\W/g, " ").trim().replace(/\s+/g, "-").toLowerCase();
@@ -384,7 +387,8 @@ var buildConfig = (config = {}) => ({
 });
 var extractConfig = (source) => {
   const project = {
-    ...source.openfn || {}
+    ...source.openfn || {},
+    id: source.id
   };
   const workspace = {
     ...source.config
@@ -438,13 +442,10 @@ var loadWorkspaceFile = (contents, format = "yaml") => {
   return { project, workspace };
 };
 var findWorkspaceFile = (dir = ".") => {
-  console.log({ dir });
   let content, type;
   try {
     type = "yaml";
-    console.log(path.resolve(path.join(dir, "openfn.yaml")));
     content = readFileSync(path.resolve(path.join(dir, "openfn.yaml")), "utf8");
-    console.log({ content });
   } catch (e) {
     try {
       type = "json";
@@ -710,6 +711,7 @@ var parseProject = async (options = {}) => {
     console.warn(`Failed to find state file for ${identifier}`);
   }
   const proj = {
+    name: state?.name,
     openfn: context.project,
     config,
     workflows: []
@@ -729,7 +731,7 @@ var parseProject = async (options = {}) => {
         const wfState = (state && state.getWorkflow(wf.id)) ?? {};
         wf.openfn = {
           uuid: wfState.openfn?.uuid ?? null
-          // TODO do we need to transfer more stuff?
+          // TODO do we need to transfer more stuff? Options maybe?
         };
         for (const step of wf.steps) {
           if (step.expression && step.expression.endsWith(".js")) {
@@ -1175,10 +1177,12 @@ var Project = class {
   // what schema version is this?
   // And how are we tracking this?
   // version;
-  /** project name */
+  /** Human readable project name. This corresponds to the label in Lightning */
   name;
+  /** Project id. Must be url safe. May be derived from the name. NOT a UUID */
+  id;
   description;
-  // array of version shas
+  // array of version hashes
   history = [];
   workflows;
   // option strings saved by the app
@@ -1191,11 +1195,6 @@ var Project = class {
   openfn;
   workspace;
   config;
-  // load a project from a state file (project.json)
-  // or from a path (the file system)
-  // TODO presumably we can detect a state file? Not a big deal?
-  // collections for the project
-  // TODO to be well typed
   collections;
   static from(type, data, options = {}) {
     if (type === "state") {
@@ -1221,8 +1220,9 @@ var Project = class {
   // maybe this second arg is config - like env, branch rules, serialisation rules
   // stuff that's external to the actual project and managed by the repo
   // TODO maybe the constructor is (data, Workspace)
-  constructor(data, repoConfig = {}) {
-    this.setConfig(repoConfig);
+  constructor(data, config = {}) {
+    this.setConfig(config);
+    this.id = data.id ?? data.name ? slugify(data.name) : humanId({ separator: "-", capitalize: false });
     this.name = data.name;
     this.description = data.description;
     this.openfn = data.openfn;
@@ -1241,16 +1241,9 @@ var Project = class {
     }
     throw new Error(`Cannot serialize ${type}`);
   }
-  // would like a better name for this
-  // stamp? id? sha?
-  // this builds a version string for the current state
-  getVersionHash() {
-  }
-  // what else might we need?
-  // get workflow by name or id
-  // this is fuzzy, but is that wrong?
+  // get workflow by name, id or uuid
   getWorkflow(idOrName) {
-    return this.workflows.find((wf) => wf.id == idOrName) || this.workflows.find((wf) => wf.name === idOrName);
+    return this.workflows.find((wf) => wf.id == idOrName) || this.workflows.find((wf) => wf.name === idOrName) || this.workflows.find((wf) => wf.openfn?.uuid === idOrName);
   }
   // it's the name of the project.yaml file
   // qualified name? Remote name? App name?
@@ -1308,7 +1301,7 @@ function pathExists(fpath, type) {
 var PROJECT_EXTENSIONS = [".yaml", ".yml"];
 var Workspace = class {
   config;
-  projectMeta;
+  activeProject;
   projects = [];
   projectPaths = /* @__PURE__ */ new Map();
   isValid = false;
@@ -1316,7 +1309,6 @@ var Workspace = class {
     let context;
     try {
       const { type, content } = findWorkspaceFile(workspacePath);
-      console.log(content);
       context = loadWorkspaceFile(content, type);
       this.isValid = true;
     } catch (e) {
@@ -1324,7 +1316,7 @@ var Workspace = class {
       return;
     }
     this.config = buildConfig(context.workspace);
-    this.projectMeta = context.project;
+    this.activeProject = context.project;
     const projectsPath = path3.join(workspacePath, this.config.dirs.projects);
     if (this.isValid && pathExists(projectsPath, "directory")) {
       const stateFiles = fs3.readdirSync(projectsPath).filter(
@@ -1334,7 +1326,7 @@ var Workspace = class {
         const stateFilePath = path3.join(projectsPath, file);
         const data = fs3.readFileSync(stateFilePath, "utf-8");
         const project = from_app_state_default(data, { format: "yaml" });
-        this.projectPaths.set(project.name, stateFilePath);
+        this.projectPaths.set(project.id, stateFilePath);
         return project;
       }).filter((s) => s);
     }
@@ -1349,15 +1341,15 @@ var Workspace = class {
   list() {
     return this.projects;
   }
-  // TODO clear up name/id confusion
+  /** Get a project by its id or UUID */
   get(id) {
-    return this.projects.find((p) => p.name === id);
+    return this.projects.find((p) => p.id === id) ?? this.projects.find((p) => p.openfn?.uuid === id);
   }
   getProjectPath(id) {
     return this.projectPaths.get(id);
   }
   getActiveProject() {
-    return this.projects.find((p) => p.name === this.projectMeta?.name);
+    return this.projects.find((p) => p.id === this.activeProject?.id) ?? this.projects.find((p) => p.openfn?.uuid === this.activeProject?.id);
   }
   // TODO this needs to return default values
   // We should always rely on the workspace to load these values
@@ -1365,7 +1357,7 @@ var Workspace = class {
     return this.config;
   }
   get activeProjectId() {
-    return this.projectMeta?.name;
+    return this.activeProject?.id;
   }
   get valid() {
     return this.isValid;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/project",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "Read, serialize, replicate and sync OpenFn projects",
   "type": "module",
   "exports": {
@@ -28,6 +28,7 @@
   },
   "dependencies": {
     "glob": "^11.0.2",
+    "human-id": "^4.1.1",
     "lodash": "^4.17.21",
     "lodash-es": "^4.17.21",
     "ohm-js": "^17.2.1",