@openfn/language-collections 0.8.6 → 0.9.1

package/configuration-schema.json

@@ -23,6 +23,13 @@
       "description": "Access token for the collection",
       "writeOnly": true,
       "examples": ["x.y.z"]
+    },
+    "project_id": {
+      "title": "Project Id",
+      "type": "string",
+      "description": "The project id for the run",
+      "writeOnly": true,
+      "examples": ["46569296-9d82-4a32-8737-fbe64b7851cf"]
     }
   },
   "type": "object",

package/dist/index.cjs

@@ -52,28 +52,48 @@ var import_stream_json = __toESM(require("stream-json"), 1);
 
 // src/mock.js
 var import_undici = require("undici");
+var MULTIPLE_MATCHES = "MULTIPLE_MATCHES_FOUND";
+var UNKNOWN_PROJECT = "INVALID_PROJECT_ID";
 var COLLECTION_NOT_FOUND = "COLLECTION_NOT_FOUND";
 var INVALID_AUTH = "INVALID_AUTH";
 function API() {
-  let collections = {};
-  const createCollection = (name, values = {}) => {
-    collections[name] = values;
+  let collectionsByProject = {};
+  let collectionsByName = {};
+  const createCollection = (projectId, name, values = {}) => {
+    (collectionsByProject[projectId] ?? (collectionsByProject[projectId] = {}))[name] = values;
+    (collectionsByName[name] ?? (collectionsByName[name] = [])).push(values);
+  };
+  const getCollection = (projectId, name) => {
+    if (projectId) {
+      if (!(projectId in collectionsByProject)) {
+        throw new Error(UNKNOWN_PROJECT);
+      }
+      if (!(name in collectionsByProject[projectId])) {
+        throw new Error(COLLECTION_NOT_FOUND);
+      }
+      return collectionsByProject[projectId][name];
+    } else {
+      const results = collectionsByName[name] ?? [];
+      if (results.length === 0) {
+        throw new Error(COLLECTION_NOT_FOUND);
+      }
+      if (results.length > 1) {
+        throw new Error(MULTIPLE_MATCHES);
+      }
+      return collectionsByName[name][0];
+    }
   };
   const reset = () => {
-    collections = api.collections = {};
+    api.collectionsByProject = collectionsByProject = {};
+    api.collectionsByName = collectionsByName = {};
   };
-  const upsert = (name, key, value) => {
-    if (!(name in collections)) {
-      throw new Error(COLLECTION_NOT_FOUND);
-    }
-    collections[name][key] = value;
+  const upsert = (projectId, name, key, value) => {
+    const col = getCollection(projectId, name);
+    col[key] = value;
   };
-  const fetch = (name, key, query = {}) => {
+  const fetch = (projectId, name, key, query = {}) => {
     const { cursor = 0, limit = Infinity } = query;
-    if (!(name in collections)) {
-      throw new Error(COLLECTION_NOT_FOUND);
-    }
-    const col = collections[name];
+    const col = getCollection(projectId, name);
     const items = [];
     let idx = 0;
     let count2 = 0;
@@ -99,29 +119,16 @@ function API() {
     }
     return result;
   };
-  const byKey = (name, key) => {
-    if (!(name in collections)) {
-      throw new Error(COLLECTION_NOT_FOUND);
-    }
-    return collections[name][key];
+  const asJSON = (projectId, name, key) => {
+    const col = getCollection(projectId, name);
+    return JSON.parse(col[key]);
   };
-  const asJSON = (name, key) => {
-    if (!(name in collections)) {
-      throw new Error(COLLECTION_NOT_FOUND);
-    }
-    return JSON.parse(collections[name][key]);
+  const count = (projectId, name) => {
+    const col = getCollection(projectId, name);
+    return Object.keys(col).length;
   };
-  const count = (name) => {
-    if (!(name in collections)) {
-      throw new Error(COLLECTION_NOT_FOUND);
-    }
-    return Object.keys(collections[name]).length;
-  };
-  const remove2 = (name, key) => {
-    if (!(name in collections)) {
-      throw new Error(COLLECTION_NOT_FOUND);
-    }
-    const col = collections[name];
+  const remove2 = (projectId, name, key) => {
+    const col = getCollection(projectId, name);
     const regex = new RegExp(key.replace("*", "(.*)"));
     const removed = [];
     for (const key2 in col) {
@@ -133,15 +140,16 @@ function API() {
     return removed;
   };
   const api = {
-    collections,
+    asJSON,
+    collectionsByName,
+    collectionsByProject,
+    count,
     createCollection,
-    reset,
-    upsert,
     fetch,
+    getCollection,
     remove: remove2,
-    byKey,
-    asJSON,
-    count
+    reset,
+    upsert
   };
   return api;
 }
@@ -165,6 +173,7 @@ function createServer(url = "https://app.openfn.org") {
   const mockPool = agent.get(url);
   const api = new API();
   const get2 = (req) => {
+    var _a;
     try {
       assertAuth(req);
     } catch (e) {
@@ -172,10 +181,12 @@ function createServer(url = "https://app.openfn.org") {
     }
     try {
       let { name, key } = parsePath(req.path);
+      const projectId = ((_a = req.query) == null ? void 0 : _a.project_id) ?? null;
       let body;
       let statusCode = 200;
       if (key) {
-        const result = api.byKey(name, key);
+        const collection = api.getCollection(projectId, name);
+        const result = collection[key];
         if (!result) {
           body = {};
           statusCode = 204;
@@ -190,7 +201,7 @@ function createServer(url = "https://app.openfn.org") {
         key = params.get("key") ?? "*";
         const limit = params.get("limit") ?? Infinity;
         const cursor = params.get("cursor") ?? 0;
-        const { items, cursor: finalCursor } = api.fetch(name, key, {
+        const { items, cursor: finalCursor } = api.fetch(projectId, name, key, {
           limit,
           cursor
         });
@@ -207,13 +218,17 @@ function createServer(url = "https://app.openfn.org") {
         }
       };
     } catch (e) {
-      if (e.message === COLLECTION_NOT_FOUND) {
+      if (e.message === COLLECTION_NOT_FOUND || e.message === UNKNOWN_PROJECT) {
         return { statusCode: 404 };
       }
+      if (e.message === MULTIPLE_MATCHES) {
+        return { statusCode: 409 };
+      }
     }
     return { statusCode: 500 };
   };
   const post = (req) => {
+    var _a;
     try {
       assertAuth(req);
     } catch (e) {
@@ -224,8 +239,9 @@ function createServer(url = "https://app.openfn.org") {
     try {
       const { name, key } = parsePath(req.path);
       const body = JSON.parse(req.body);
+      const projectId = ((_a = req.query) == null ? void 0 : _a.project_id) ?? null;
       for (const { key: key2, value } of body.items) {
-        api.upsert(name, key2, value);
+        api.upsert(projectId, name, key2, value);
         upserted++;
       }
       return {
@@ -239,9 +255,13 @@ function createServer(url = "https://app.openfn.org") {
       if (e.message === COLLECTION_NOT_FOUND) {
         return { statusCode: 404 };
       }
+      if (e.message === MULTIPLE_MATCHES) {
+        return { statusCode: 409 };
+      }
     }
   };
   const remove2 = (req) => {
+    var _a;
     try {
       assertAuth(req);
     } catch (e) {
@@ -249,11 +269,12 @@ function createServer(url = "https://app.openfn.org") {
     }
     try {
       let { name, key } = parsePath(req.path);
+      const projectId = ((_a = req.query) == null ? void 0 : _a.project_id) ?? null;
       if (!key) {
         const params = new URLSearchParams(req.query || req.path.split("?")[1]);
         key = params.get("key") ?? "*";
       }
-      const keys = api.remove(name, key);
+      const keys = api.remove(projectId, name, key);
       return {
         statusCode: 200,
         responseOptions: {
@@ -265,6 +286,9 @@ function createServer(url = "https://app.openfn.org") {
       if (e.message === COLLECTION_NOT_FOUND) {
         return { statusCode: 404 };
       }
+      if (e.message === MULTIPLE_MATCHES) {
+        return { statusCode: 409 };
+      }
     }
   };
   mockPool.intercept({ method: "get", path: /collections\/./ }).reply(get2).persist();
@@ -591,6 +615,9 @@ var request = async (state, client2, path, options = {}) => {
   Object.assign(headers, options == null ? void 0 : options.headers);
   const { headers: _h, query: _q, ...otherOptions } = options;
   const query = parseQuery(options);
+  if (state.configuration.project_id) {
+    query.project_id = state.configuration.project_id;
+  }
   const args = {
     path: import_node_path.default.posix.join(basePath, path),
     headers,
@@ -600,11 +627,36 @@ var request = async (state, client2, path, options = {}) => {
   };
   const response = await client2.request(args);
   if (response.statusCode >= 400) {
-    await handleError(response, path, state.configuration.collections_endpoint);
+    await handleError(
+      response,
+      path,
+      state.configuration.collections_endpoint,
+      query.project_id
+    );
   }
   return response;
 };
-var handleError = async (response, path, endpoint) => {
+var handleError = async (response, path, endpoint, project_id) => {
+  if (response.statusCode === 409) {
+    if (!project_id) {
+      const [collection] = path.split("/");
+      const e2 = new Error("NO_PROJECT_ID");
+      e2.code = "NO_PROJECT_ID";
+      e2.description = `The collection "${collection}" matched multiple collections on the server and project_id was omitted`;
+      e2.collection = collection;
+      e2.endpoint = endpoint;
+      e2.fix = "Set state.configuration.project_id before using the collections API";
+      throw e2;
+    } else {
+      const [collection] = path.split("/");
+      const e2 = new Error("COLLECTION_CONFLICT");
+      e2.code = "COLLECTION_CONFLICT";
+      e2.description = `Multiple collections named "${collection}" were found on the server`;
+      e2.collection = collection;
+      e2.endpoint = endpoint;
+      e2.fix = "Contact your system administrator";
+    }
+  }
   if (response.statusCode === 404) {
     const [collection] = path.split("/");
     console.error(`Error! Collection ${collection} does not exist`);

package/dist/index.js

@@ -27,28 +27,48 @@ import parser from "stream-json";
 
 // src/mock.js
 import { MockAgent } from "undici";
+var MULTIPLE_MATCHES = "MULTIPLE_MATCHES_FOUND";
+var UNKNOWN_PROJECT = "INVALID_PROJECT_ID";
 var COLLECTION_NOT_FOUND = "COLLECTION_NOT_FOUND";
 var INVALID_AUTH = "INVALID_AUTH";
 function API() {
-  let collections = {};
-  const createCollection = (name, values = {}) => {
-    collections[name] = values;
+  let collectionsByProject = {};
+  let collectionsByName = {};
+  const createCollection = (projectId, name, values = {}) => {
+    (collectionsByProject[projectId] ?? (collectionsByProject[projectId] = {}))[name] = values;
+    (collectionsByName[name] ?? (collectionsByName[name] = [])).push(values);
+  };
+  const getCollection = (projectId, name) => {
+    if (projectId) {
+      if (!(projectId in collectionsByProject)) {
+        throw new Error(UNKNOWN_PROJECT);
+      }
+      if (!(name in collectionsByProject[projectId])) {
+        throw new Error(COLLECTION_NOT_FOUND);
+      }
+      return collectionsByProject[projectId][name];
+    } else {
+      const results = collectionsByName[name] ?? [];
+      if (results.length === 0) {
+        throw new Error(COLLECTION_NOT_FOUND);
+      }
+      if (results.length > 1) {
+        throw new Error(MULTIPLE_MATCHES);
+      }
+      return collectionsByName[name][0];
+    }
   };
   const reset = () => {
-    collections = api.collections = {};
+    api.collectionsByProject = collectionsByProject = {};
+    api.collectionsByName = collectionsByName = {};
   };
-  const upsert = (name, key, value) => {
-    if (!(name in collections)) {
-      throw new Error(COLLECTION_NOT_FOUND);
-    }
-    collections[name][key] = value;
+  const upsert = (projectId, name, key, value) => {
+    const col = getCollection(projectId, name);
+    col[key] = value;
   };
-  const fetch = (name, key, query = {}) => {
+  const fetch = (projectId, name, key, query = {}) => {
     const { cursor = 0, limit = Infinity } = query;
-    if (!(name in collections)) {
-      throw new Error(COLLECTION_NOT_FOUND);
-    }
-    const col = collections[name];
+    const col = getCollection(projectId, name);
     const items = [];
     let idx = 0;
     let count2 = 0;
@@ -74,29 +94,16 @@ function API() {
     }
     return result;
   };
-  const byKey = (name, key) => {
-    if (!(name in collections)) {
-      throw new Error(COLLECTION_NOT_FOUND);
-    }
-    return collections[name][key];
+  const asJSON = (projectId, name, key) => {
+    const col = getCollection(projectId, name);
+    return JSON.parse(col[key]);
   };
-  const asJSON = (name, key) => {
-    if (!(name in collections)) {
-      throw new Error(COLLECTION_NOT_FOUND);
-    }
-    return JSON.parse(collections[name][key]);
+  const count = (projectId, name) => {
+    const col = getCollection(projectId, name);
+    return Object.keys(col).length;
   };
-  const count = (name) => {
-    if (!(name in collections)) {
-      throw new Error(COLLECTION_NOT_FOUND);
-    }
-    return Object.keys(collections[name]).length;
-  };
-  const remove2 = (name, key) => {
-    if (!(name in collections)) {
-      throw new Error(COLLECTION_NOT_FOUND);
-    }
-    const col = collections[name];
+  const remove2 = (projectId, name, key) => {
+    const col = getCollection(projectId, name);
     const regex = new RegExp(key.replace("*", "(.*)"));
     const removed = [];
     for (const key2 in col) {
@@ -108,15 +115,16 @@ function API() {
     return removed;
   };
   const api = {
-    collections,
+    asJSON,
+    collectionsByName,
+    collectionsByProject,
+    count,
     createCollection,
-    reset,
-    upsert,
     fetch,
+    getCollection,
     remove: remove2,
-    byKey,
-    asJSON,
-    count
+    reset,
+    upsert
   };
   return api;
 }
@@ -140,6 +148,7 @@ function createServer(url = "https://app.openfn.org") {
   const mockPool = agent.get(url);
   const api = new API();
   const get2 = (req) => {
+    var _a;
     try {
       assertAuth(req);
     } catch (e) {
@@ -147,10 +156,12 @@ function createServer(url = "https://app.openfn.org") {
     }
     try {
       let { name, key } = parsePath(req.path);
+      const projectId = ((_a = req.query) == null ? void 0 : _a.project_id) ?? null;
       let body;
       let statusCode = 200;
       if (key) {
-        const result = api.byKey(name, key);
+        const collection = api.getCollection(projectId, name);
+        const result = collection[key];
         if (!result) {
           body = {};
           statusCode = 204;
@@ -165,7 +176,7 @@ function createServer(url = "https://app.openfn.org") {
         key = params.get("key") ?? "*";
         const limit = params.get("limit") ?? Infinity;
         const cursor = params.get("cursor") ?? 0;
-        const { items, cursor: finalCursor } = api.fetch(name, key, {
+        const { items, cursor: finalCursor } = api.fetch(projectId, name, key, {
           limit,
           cursor
         });
@@ -182,13 +193,17 @@ function createServer(url = "https://app.openfn.org") {
         }
       };
     } catch (e) {
-      if (e.message === COLLECTION_NOT_FOUND) {
+      if (e.message === COLLECTION_NOT_FOUND || e.message === UNKNOWN_PROJECT) {
         return { statusCode: 404 };
       }
+      if (e.message === MULTIPLE_MATCHES) {
+        return { statusCode: 409 };
+      }
     }
     return { statusCode: 500 };
   };
   const post = (req) => {
+    var _a;
     try {
       assertAuth(req);
     } catch (e) {
@@ -199,8 +214,9 @@ function createServer(url = "https://app.openfn.org") {
     try {
       const { name, key } = parsePath(req.path);
       const body = JSON.parse(req.body);
+      const projectId = ((_a = req.query) == null ? void 0 : _a.project_id) ?? null;
       for (const { key: key2, value } of body.items) {
-        api.upsert(name, key2, value);
+        api.upsert(projectId, name, key2, value);
         upserted++;
       }
       return {
@@ -214,9 +230,13 @@ function createServer(url = "https://app.openfn.org") {
       if (e.message === COLLECTION_NOT_FOUND) {
         return { statusCode: 404 };
       }
+      if (e.message === MULTIPLE_MATCHES) {
+        return { statusCode: 409 };
+      }
     }
   };
   const remove2 = (req) => {
+    var _a;
     try {
       assertAuth(req);
     } catch (e) {
@@ -224,11 +244,12 @@ function createServer(url = "https://app.openfn.org") {
     }
     try {
       let { name, key } = parsePath(req.path);
+      const projectId = ((_a = req.query) == null ? void 0 : _a.project_id) ?? null;
       if (!key) {
         const params = new URLSearchParams(req.query || req.path.split("?")[1]);
         key = params.get("key") ?? "*";
       }
-      const keys = api.remove(name, key);
+      const keys = api.remove(projectId, name, key);
       return {
         statusCode: 200,
         responseOptions: {
@@ -240,6 +261,9 @@ function createServer(url = "https://app.openfn.org") {
       if (e.message === COLLECTION_NOT_FOUND) {
         return { statusCode: 404 };
       }
+      if (e.message === MULTIPLE_MATCHES) {
+        return { statusCode: 409 };
+      }
     }
   };
   mockPool.intercept({ method: "get", path: /collections\/./ }).reply(get2).persist();
@@ -566,6 +590,9 @@ var request = async (state, client2, path, options = {}) => {
   Object.assign(headers, options == null ? void 0 : options.headers);
   const { headers: _h, query: _q, ...otherOptions } = options;
   const query = parseQuery(options);
+  if (state.configuration.project_id) {
+    query.project_id = state.configuration.project_id;
+  }
   const args = {
     path: nodepath.posix.join(basePath, path),
     headers,
@@ -575,11 +602,36 @@ var request = async (state, client2, path, options = {}) => {
   };
   const response = await client2.request(args);
   if (response.statusCode >= 400) {
-    await handleError(response, path, state.configuration.collections_endpoint);
+    await handleError(
+      response,
+      path,
+      state.configuration.collections_endpoint,
+      query.project_id
+    );
   }
   return response;
 };
-var handleError = async (response, path, endpoint) => {
+var handleError = async (response, path, endpoint, project_id) => {
+  if (response.statusCode === 409) {
+    if (!project_id) {
+      const [collection] = path.split("/");
+      const e2 = new Error("NO_PROJECT_ID");
+      e2.code = "NO_PROJECT_ID";
+      e2.description = `The collection "${collection}" matched multiple collections on the server and project_id was omitted`;
+      e2.collection = collection;
+      e2.endpoint = endpoint;
+      e2.fix = "Set state.configuration.project_id before using the collections API";
+      throw e2;
+    } else {
+      const [collection] = path.split("/");
+      const e2 = new Error("COLLECTION_CONFLICT");
+      e2.code = "COLLECTION_CONFLICT";
+      e2.description = `Multiple collections named "${collection}" were found on the server`;
+      e2.collection = collection;
+      e2.endpoint = endpoint;
+      e2.fix = "Contact your system administrator";
+    }
+  }
   if (response.statusCode === 404) {
     const [collection] = path.split("/");
     console.error(`Error! Collection ${collection} does not exist`);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openfn/language-collections",
   "label": "Collections",
-  "version": "0.8.6",
+  "version": "0.9.1",
   "description": "Collections Adaptor for OpenFn",
   "type": "module",
   "exports": {
@@ -23,7 +23,7 @@
   "dependencies": {
     "stream-json": "^1.8.0",
     "undici": "^7.24.7",
-    "@openfn/language-common": "3.3.1"
+    "@openfn/language-common": "3.3.2"
   },
   "devDependencies": {
     "assertion-error": "2.0.0",

package/types/collections.d.ts

@@ -92,7 +92,7 @@ export function streamResponse(response: any, onValue: any): Promise<any>;
 export function expandQuery(query: any): any;
 export function parseQuery(options?: {}): {};
 export function request(state: any, client: any, path: any, options?: {}): Promise<any>;
-export function handleError(response: any, path: any, endpoint: any): Promise<never>;
+export function handleError(response: any, path: any, endpoint: any, project_id: any): Promise<never>;
 /**
  * Query options. All dates should be parseable as ISO 8601 strings, see https://simple.wikipedia.org/wiki/ISO_8601
  */

package/types/mock.d.ts

@@ -1,19 +1,20 @@
 export function API(): {
-    collections: {};
-    createCollection: (name: any, values?: {}) => void;
-    reset: () => void;
-    upsert: (name: any, key: any, value: any) => void;
-    fetch: (name: any, key: any, query?: {}) => {
+    asJSON: (projectId: any, name: any, key: any) => any;
+    collectionsByName: {};
+    collectionsByProject: {};
+    count: (projectId: any, name: any) => number;
+    createCollection: (projectId: any, name: any, values?: {}) => void;
+    fetch: (projectId: any, name: any, key: any, query?: {}) => {
         items: {
             key: string;
             value: any;
         }[];
         count: number;
     };
-    remove: (name: any, key: any) => string[];
-    byKey: (name: any, key: any) => any;
-    asJSON: (name: any, key: any) => any;
-    count: (name: any) => number;
+    getCollection: (projectId: any, name: any) => any;
+    remove: (projectId: any, name: any, key: any) => string[];
+    reset: () => void;
+    upsert: (projectId: any, name: any, key: any, value: any) => void;
 };
 export function createServer(url?: string): {
     api: any;
@@ -25,4 +26,8 @@ export function createServer(url?: string): {
         data: any;
     }) => Promise<import("undici/types/dispatcher").default.ResponseData<null>>;
 };
+export const MULTIPLE_MATCHES: "MULTIPLE_MATCHES_FOUND";
+export const UNKNOWN_PROJECT: "INVALID_PROJECT_ID";
+export const COLLECTION_NOT_FOUND: "COLLECTION_NOT_FOUND";
+export const INVALID_AUTH: "INVALID_AUTH";
 import { MockAgent } from "undici/types";