emberflow 1.0.8

package/lib/utils/paths.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hydrateDocPath = exports.expandAndGroupDocPaths = exports.filterSubDocPathsByEntity = exports.findMatchingDocPathRegex = exports._mockable = void 0;
+const query_1 = require("./query");
+const index_1 = require("../index");
+exports._mockable = {
+    filterSubDocPathsByEntity: (entity, excludeEntities) => {
+        const path = index_1.docPaths[entity];
+        const paths = Object.values(index_1.docPaths);
+        // Find the doc paths of the excluded entities
+        const excludePaths = excludeEntities === null || excludeEntities === void 0 ? void 0 : excludeEntities.map((excludeEntity) => index_1.docPaths[excludeEntity]);
+        return paths.filter((p) => {
+            // Check if the path starts with the given entity's doc path
+            const startsWithPath = p.startsWith(path);
+            // Check if the path starts with any of the excluded entity's doc paths
+            const startsWithExcludedPath = excludePaths === null || excludePaths === void 0 ? void 0 : excludePaths.some((excludePath) => p.startsWith(excludePath));
+            return startsWithPath && !startsWithExcludedPath;
+        });
+    },
+};
+function findMatchingDocPathRegex(docPath) {
+    for (const key in index_1.docPathsRegex) {
+        if (index_1.docPathsRegex[key].test(docPath)) {
+            return { entity: key, regex: index_1.docPathsRegex[key] };
+        }
+    }
+    return { entity: null, regex: null };
+}
+exports.findMatchingDocPathRegex = findMatchingDocPathRegex;
+function filterSubDocPathsByEntity(entity, excludeEntities) {
+    return exports._mockable.filterSubDocPathsByEntity(entity, excludeEntities);
+}
+exports.filterSubDocPathsByEntity = filterSubDocPathsByEntity;
+async function expandAndGroupDocPaths(startingDocPath, entityCondition, excludeEntities) {
+    const groupedPaths = {};
+    const { entity } = findMatchingDocPathRegex(startingDocPath);
+    if (!entity) {
+        return groupedPaths;
+    }
+    const entityDocPath = index_1.docPaths[entity];
+    const subDocPaths = filterSubDocPathsByEntity(entity, excludeEntities);
+    const values = Object.values(subDocPaths).map((p) => p.replace(entityDocPath, startingDocPath));
+    const sortedValues = values.sort();
+    const newPathMap = new Map();
+    const expandedPaths = [];
+    while (sortedValues.length > 0) {
+        const path = sortedValues.shift();
+        if (!path) {
+            break;
+        }
+        let skipPath = false;
+        for (const key of [...newPathMap.keys()].sort()) {
+            if (path.startsWith(key)) {
+                skipPath = true;
+                const values = newPathMap.get(key);
+                const newPaths = (values || []).map((value) => path.replace(key, value));
+                sortedValues.push(...newPaths);
+                break;
+            }
+        }
+        if (skipPath)
+            continue;
+        if (/{\w+Id}$/.test(path)) {
+            const idIndex = path.lastIndexOf("/");
+            const collectionPath = path.substring(0, idIndex);
+            const { entity } = findMatchingDocPathRegex(path);
+            const ids = await (0, query_1.fetchIds)(collectionPath, entityCondition === null || entityCondition === void 0 ? void 0 : entityCondition[entity]);
+            const newPaths = ids.map((id) => path.replace(/{\w+Id}$/, id.toString()));
+            newPathMap.set(path, newPaths);
+            sortedValues.push(...newPaths);
+            continue;
+        }
+        expandedPaths.push(path);
+    }
+    // Group expandedPaths based on docPaths keys and values
+    for (const [key, regex] of Object.entries(index_1.docPathsRegex)) {
+        const paths = expandedPaths.filter((p) => regex.test(p));
+        if (!paths.length)
+            continue;
+        groupedPaths[key] = paths;
+    }
+    return groupedPaths;
+}
+exports.expandAndGroupDocPaths = expandAndGroupDocPaths;
+async function hydrateDocPath(destDocPath, entityCondition) {
+    const pathSegments = destDocPath.split("/");
+    const documentPaths = [];
+    // Create a queue to keep track of the remaining path segments to process
+    const queue = [[pathSegments, 0]];
+    // Process the queue until all path segments have been processed
+    while (queue.length > 0) {
+        const [segments, idx] = queue.shift();
+        // Find the next path segment that is wrapped by curly braces
+        let braceIdx = -1;
+        for (let i = idx; i < segments.length; i++) {
+            if (segments[i].startsWith("{")) {
+                braceIdx = i;
+                break;
+            }
+        }
+        if (braceIdx === -1) {
+            // We've reached the end of the path, so add it to the document paths
+            const path = segments.join("/");
+            if (idx < segments.length - 1) {
+                // This means that the path contains hard coded ids, so we need to check if that pat exists in the database
+                const doc = await index_1.admin.firestore().doc(path).get();
+                if (!doc.exists) {
+                    console.error(`Document ${path} does not exist. Skipping...`);
+                    continue;
+                }
+            }
+            documentPaths.push(path);
+        }
+        else {
+            // Extract the collection path and fetch its IDs
+            const collectionPathSegments = segments.slice(0, braceIdx);
+            const collectionPath = collectionPathSegments.join("/");
+            const entity = segments[braceIdx].slice(1, -3);
+            const condition = entityCondition[entity];
+            const ids = await (0, query_1.fetchIds)(collectionPath, condition);
+            if (ids.length === 0) {
+                console.info(`No IDs found for ${collectionPath} with condition ${JSON.stringify(condition)}. Skipping...`);
+                continue;
+            }
+            // Generate the document paths by merging the IDs with the collection path
+            const remainingPathSegments = segments.slice(braceIdx);
+            for (const id of ids) {
+                const documentPathSegments = [...collectionPathSegments, id, ...remainingPathSegments.slice(1)];
+                queue.push([documentPathSegments, braceIdx + 1]);
+            }
+        }
+    }
+    return documentPaths;
+}
+exports.hydrateDocPath = hydrateDocPath;
+//# sourceMappingURL=paths.js.map

package/lib/utils/paths.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.js","sourceRoot":"","sources":["../../src/utils/paths.ts"],"names":[],"mappings":";;;AACA,mCAAiC;AACjC,oCAAwD;AAE3C,QAAA,SAAS,GAAG;IACvB,yBAAyB,EAAE,CAAC,MAAc,EAAE,eAA0B,EAAY,EAAE;QAClF,MAAM,IAAI,GAAG,gBAAQ,CAAC,MAAM,CAAC,CAAC;QAC9B,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,gBAAQ,CAAC,CAAC;QAEtC,8CAA8C;QAC9C,MAAM,YAAY,GAAG,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,gBAAQ,CAAC,aAAa,CAAC,CAAC,CAAC;QAEtF,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;YACxB,4DAA4D;YAC5D,MAAM,cAAc,GAAG,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YAE1C,uEAAuE;YACvE,MAAM,sBAAsB,GAAG,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;YAE9F,OAAO,cAAc,IAAI,CAAC,sBAAsB,CAAC;QACnD,CAAC,CAAC,CAAC;IACL,CAAC;CACF,CAAC;AAEF,SAAgB,wBAAwB,CAAC,OAAe;IACtD,KAAK,MAAM,GAAG,IAAI,qBAAa,EAAE;QAC/B,IAAI,qBAAa,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YACpC,OAAO,EAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,qBAAa,CAAC,GAAG,CAAC,EAAC,CAAC;SACjD;KACF;IACD,OAAO,EAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAC,CAAC;AACrC,CAAC;AAPD,4DAOC;AAED,SAAgB,yBAAyB,CAAC,MAAc,EAAE,eAA0B;IAClF,OAAO,iBAAS,CAAC,yBAAyB,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;AACtE,CAAC;AAFD,8DAEC;AAEM,KAAK,UAAU,sBAAsB,CAC1C,eAAuB,EACvB,eAAgD,EAChD,eAA0B;IAC1B,MAAM,YAAY,GAAgC,EAAE,CAAC;IACrD,MAAM,EAAC,MAAM,EAAC,GAAG,wBAAwB,CAAC,eAAe,CAAC,CAAC;IAC3D,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,YAAY,CAAC;KACrB;IACD,MAAM,aAAa,GAAG,gBAAQ,CAAC,MAAM,CAAC,CAAC;IACvC,MAAM,WAAW,GAAG,yBAAyB,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAEvE,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC,CAAC;IAChG,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;IACnC,MAAM,UAAU,GAAG,IAAI,GAAG,EAAoB,CAAC;IAC/C,MAAM,aAAa,GAAa,EAAE,CAAC;IAEnC,OAAO,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;QAC9B,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,EAAE,CAAC;QAClC,IAAI,CAAC,IAAI,EAAE;YACT,MAAM;SACP;QAED,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,KAAK,MAAM,GAAG,IAAI,CAAC,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE;YAC/C,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;gBACxB,QAAQ,GAAG,IAAI,CAAC;gBAChB,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBACnC,MAAM,QAAQ,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;gBACzE,YAAY,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC;gBAC/B,MAAM;aACP;SACF;QAED,IAAI,QAAQ;YAAE,SAAS;QAEvB,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YACzB,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YACtC,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAClD,MAAM,EAAC,MAAM,EAAC,GAAG,wBAAwB,CAAC,IAAI,CAAC,CAAC;YAChD,MAAM,GAAG,GAAG,MAAM,IAAA,gBAAQ,EAAC,cAAc,EAAE,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAG,MAAO,CAAC,CAAC,CAAC;YACvE,MAAM,QAAQ,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YAC1E,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAC/B,YAAY,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC;YAC/B,SAAS;SACV;QAED,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KAC1B;IAED,wDAAwD;IACxD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,qBAAa,CAAC,EAAE;QACxD,MAAM,KAAK,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACzD,IAAI,CAAC,KAAK,CAAC,MAAM;YAAE,SAAS;QAC5B,YAAY,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;KAC3B;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AA1DD,wDA0DC;AAEM,KAAK,UAAU,cAAc,CAAC,WAAmB,EAAE,eAA+C;IACvG,MAAM,YAAY,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC5C,MAAM,aAAa,GAAa,EAAE,CAAC;IAEnC,yEAAyE;IACzE,MAAM,KAAK,GAAyB,CAAC,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,CAAC;IAExD,gEAAgE;IAChE,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;QACvB,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,EAAG,CAAC;QAEvC,6DAA6D;QAC7D,IAAI,QAAQ,GAAG,CAAC,CAAC,CAAC;QAClB,KAAK,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC1C,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;gBAC/B,QAAQ,GAAG,CAAC,CAAC;gBACb,MAAM;aACP;SACF;QAED,IAAI,QAAQ,KAAK,CAAC,CAAC,EAAE;YACnB,qEAAqE;YACrE,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAChC,IAAI,GAAG,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC7B,2GAA2G;gBAC3G,MAAM,GAAG,GAAG,MAAM,aAAK,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC;gBACpD,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE;oBACf,OAAO,CAAC,KAAK,CAAC,YAAY,IAAI,8BAA8B,CAAC,CAAC;oBAC9D,SAAS;iBACV;aACF;YACD,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC1B;aAAM;YACL,gDAAgD;YAChD,MAAM,sBAAsB,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;YAC3D,MAAM,cAAc,GAAG,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACxD,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YAC/C,MAAM,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;YAC1C,MAAM,GAAG,GAAG,MAAM,IAAA,gBAAQ,EAAC,cAAc,EAAE,SAAS,CAAC,CAAC;YACtD,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE;gBACpB,OAAO,CAAC,IAAI,CAAC,oBAAoB,cAAc,mBAAmB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;gBAC5G,SAAS;aACV;YAED,0EAA0E;YAC1E,MAAM,qBAAqB,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACvD,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE;gBACpB,MAAM,oBAAoB,GAAG,CAAC,GAAG,sBAAsB,EAAE,EAAE,EAAE,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBAChG,KAAK,CAAC,IAAI,CAAC,CAAC,oBAAoB,EAAE,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC;aAClD;SACF;KACF;IACD,OAAO,aAAa,CAAC;AACvB,CAAC;AArDD,wCAqDC"}

package/lib/utils/query.d.ts

@@ -0,0 +1,2 @@
+import { QueryCondition } from "../types";
+export declare function fetchIds(collectionPath: string, condition?: QueryCondition): Promise<string[]>;

package/lib/utils/query.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchIds = void 0;
+const index_1 = require("../index");
+const firebase_admin_1 = require("firebase-admin");
+async function fetchIds(collectionPath, condition) {
+    const ids = [];
+    const baseQuery = index_1.admin.firestore().collection(collectionPath).select(firebase_admin_1.firestore.FieldPath.documentId());
+    async function executeQuery(query) {
+        const querySnapshot = await query.get();
+        querySnapshot.docs.forEach((doc) => {
+            ids.push(doc.id);
+        });
+    }
+    if (condition &&
+        (condition.operator === "in" ||
+            condition.operator === "not-in" ||
+            condition.operator === "array-contains-any")) {
+        const chunkSize = 10;
+        const values = condition.value;
+        const chunks = [];
+        for (let i = 0; i < values.length; i += chunkSize) {
+            chunks.push(values.slice(i, i + chunkSize));
+        }
+        const promises = chunks.map((chunk) => {
+            const query = baseQuery.where(condition.fieldName, condition.operator, chunk);
+            return executeQuery(query);
+        });
+        await Promise.all(promises);
+    }
+    else {
+        let query = baseQuery;
+        if (condition) {
+            query = query.where(condition.fieldName, condition.operator, condition.value);
+        }
+        await executeQuery(query);
+    }
+    return ids;
+}
+exports.fetchIds = fetchIds;
+//# sourceMappingURL=query.js.map

package/lib/utils/query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.js","sourceRoot":"","sources":["../../src/utils/query.ts"],"names":[],"mappings":";;;AAAA,oCAA+B;AAC/B,mDAAyC;AAKlC,KAAK,UAAU,QAAQ,CAAC,cAAsB,EAAE,SAA0B;IAC/E,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,MAAM,SAAS,GAAG,aAAK,CAAC,SAAS,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,0BAAS,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC,CAAC;IAExG,KAAK,UAAU,YAAY,CAAC,KAA0B;QACpD,MAAM,aAAa,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,CAAC;QACxC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACjC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IACE,SAAS;QACP,CACE,SAAS,CAAC,QAAQ,KAAK,IAAI;YACzB,SAAS,CAAC,QAAQ,KAAK,QAAQ;YAC/B,SAAS,CAAC,QAAQ,KAAK,oBAAoB,CAC9C,EACH;QACA,MAAM,SAAS,GAAG,EAAE,CAAC;QACrB,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,CAAC;QAC/B,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,SAAS,EAAE;YACjD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;SAC7C;QACD,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YACpC,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YAC9E,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QACH,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;KAC7B;SAAM;QACL,IAAI,KAAK,GAAG,SAAS,CAAC;QACtB,IAAI,SAAS,EAAE;YACb,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;SAC/E;QACD,MAAM,YAAY,CAAC,KAAK,CAAC,CAAC;KAC3B;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAvCD,4BAuCC"}

package/lib/utils/sample.d.ts

@@ -0,0 +1,5 @@
+import * as admin from "firebase-admin";
+export declare const _mockable: {
+    createNowTimestamp: () => admin.firestore.Timestamp;
+};
+export declare function sampleFunction(): void;

package/lib/utils/sample.js

@@ -0,0 +1,37 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sampleFunction = exports._mockable = void 0;
+const admin = __importStar(require("firebase-admin"));
+exports._mockable = {
+    createNowTimestamp: () => admin.firestore.Timestamp.now(),
+};
+function sampleFunction() {
+    const firestore = admin.firestore();
+    const now = exports._mockable.createNowTimestamp();
+    console.info(firestore != null, now);
+}
+exports.sampleFunction = sampleFunction;
+//# sourceMappingURL=sample.js.map

package/lib/utils/sample.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sample.js","sourceRoot":"","sources":["../../src/utils/sample.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sDAAwC;AAE3B,QAAA,SAAS,GAAG;IACvB,kBAAkB,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,EAAE;CAC1D,CAAC;AAEF,SAAgB,cAAc;IAC5B,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;IACpC,MAAM,GAAG,GAAG,iBAAS,CAAC,kBAAkB,EAAE,CAAC;IAC3C,OAAO,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,EAAE,GAAG,CAAC,CAAC;AACvC,CAAC;AAJD,wCAIC"}

package/lib/utils.d.ts

@@ -0,0 +1,12 @@
+declare function findMatchingDocPathRegex(docPath: string, docPathsRegex: Record<string, RegExp>): {
+    entity: string;
+    regex: RegExp;
+} | {
+    entity: null;
+    regex: null;
+};
+declare function filterSubDocPathsByEntity(entity: string, docPaths: Record<string, string>): string[];
+declare function expandAndGroupDocPaths(startingDocPath: string, idsFetcher: (collectionPath: string) => Promise<string[]>): Promise<{
+    [key: string]: string[];
+}>;
+export { expandAndGroupDocPaths, filterSubDocPathsByEntity, findMatchingDocPathRegex };

package/lib/utils.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findMatchingDocPathRegex = exports.filterSubDocPathsByEntity = exports.expandAndGroupDocPaths = void 0;
+const index_1 = require("./index");
+function findMatchingDocPathRegex(docPath, docPathsRegex) {
+    for (const key in docPathsRegex) {
+        if (docPathsRegex[key].test(docPath)) {
+            return { entity: key, regex: docPathsRegex[key] };
+        }
+    }
+    return { entity: null, regex: null };
+}
+exports.findMatchingDocPathRegex = findMatchingDocPathRegex;
+function filterSubDocPathsByEntity(entity, docPaths) {
+    const path = docPaths[entity];
+    const paths = Object.values(docPaths);
+    return paths.filter((p) => p.startsWith(path));
+}
+exports.filterSubDocPathsByEntity = filterSubDocPathsByEntity;
+async function expandAndGroupDocPaths(startingDocPath, idsFetcher) {
+    const groupedPaths = {};
+    const { entity } = findMatchingDocPathRegex(startingDocPath, index_1.docPathsRegex);
+    if (!entity) {
+        return groupedPaths;
+    }
+    const entityDocPath = index_1.docPaths[entity];
+    const subDocPaths = filterSubDocPathsByEntity(entity, index_1.docPaths);
+    const values = Object.values(subDocPaths).map((p) => p.replace(entityDocPath, startingDocPath));
+    const sortedValues = values.sort();
+    const newPathMap = new Map();
+    const expandedPaths = [];
+    while (sortedValues.length > 0) {
+        const path = sortedValues.shift();
+        if (!path) {
+            break;
+        }
+        let skipPath = false;
+        for (const key of [...newPathMap.keys()].sort()) {
+            if (path.startsWith(key)) {
+                skipPath = true;
+                const values = newPathMap.get(key);
+                const newPaths = (values || []).map((value) => path.replace(key, value));
+                sortedValues.push(...newPaths);
+                break;
+            }
+        }
+        if (skipPath)
+            continue;
+        if (/{\w+Id}$/.test(path)) {
+            const idIndex = path.lastIndexOf("/");
+            const collectionPath = path.substring(0, idIndex);
+            const ids = await idsFetcher(collectionPath);
+            const newPaths = ids.map((id) => path.replace(/{\w+Id}$/, id.toString()));
+            newPathMap.set(path, newPaths);
+            sortedValues.push(...newPaths);
+            continue;
+        }
+        expandedPaths.push(path);
+    }
+    // Group expandedPaths based on docPaths keys and values
+    for (const [key, regex] of Object.entries(index_1.docPathsRegex)) {
+        groupedPaths[key] = expandedPaths.filter((path) => path.match(regex));
+    }
+    return groupedPaths;
+}
+exports.expandAndGroupDocPaths = expandAndGroupDocPaths;
+//# sourceMappingURL=utils.js.map

package/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAAA,mCAAgD;AAEhD,SAAS,wBAAwB,CAAC,OAAe,EAAE,aAAqC;IACtF,KAAK,MAAM,GAAG,IAAI,aAAa,EAAE;QAC/B,IAAI,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YACpC,OAAO,EAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,aAAa,CAAC,GAAG,CAAC,EAAC,CAAC;SACjD;KACF;IACD,OAAO,EAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAC,CAAC;AACrC,CAAC;AA8D0D,4DAAwB;AA5DnF,SAAS,yBAAyB,CAAC,MAAc,EAAE,QAAgC;IACjF,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC9B,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACtC,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;AACjD,CAAC;AAwD+B,8DAAyB;AAtDzD,KAAK,UAAU,sBAAsB,CAAC,eAAuB,EAAE,UAAyD;IACtH,MAAM,YAAY,GAAgC,EAAE,CAAC;IACrD,MAAM,EAAC,MAAM,EAAC,GAAG,wBAAwB,CAAC,eAAe,EAAE,qBAAa,CAAC,CAAC;IAC1E,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,YAAY,CAAC;KACrB;IACD,MAAM,aAAa,GAAG,gBAAQ,CAAC,MAAM,CAAC,CAAC;IACvC,MAAM,WAAW,GAAG,yBAAyB,CAAC,MAAM,EAAE,gBAAQ,CAAC,CAAC;IAEhE,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC,CAAC;IAChG,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;IACnC,MAAM,UAAU,GAAG,IAAI,GAAG,EAAoB,CAAC;IAC/C,MAAM,aAAa,GAAa,EAAE,CAAC;IAEnC,OAAO,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;QAC9B,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,EAAE,CAAC;QAClC,IAAI,CAAC,IAAI,EAAE;YACT,MAAM;SACP;QAED,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,KAAK,MAAM,GAAG,IAAI,CAAC,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE;YAC/C,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;gBACxB,QAAQ,GAAG,IAAI,CAAC;gBAChB,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBACnC,MAAM,QAAQ,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;gBACzE,YAAY,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC;gBAC/B,MAAM;aACP;SACF;QAED,IAAI,QAAQ;YAAE,SAAS;QAEvB,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YACzB,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YACtC,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAClD,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC,cAAc,CAAC,CAAC;YAC7C,MAAM,QAAQ,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YAC1E,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAC/B,YAAY,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC;YAC/B,SAAS;SACV;QAED,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KAC1B;IAED,wDAAwD;IACxD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,qBAAa,CAAC,EAAE;QACxD,YAAY,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAa,CAAC;KACnF;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAEO,wDAAsB"}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "emberflow",
+  "version": "1.0.8",
+  "description": "A Firebase Cloud Functions library for handling document changes in a structured way",
+  "main": "lib/index.js",
+  "types": "lib/index.d.js",
+  "files": [
+    "lib/",
+    "src/sample-custom"
+  ],
+  "scripts": {
+    "prepublishOnly": "tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aris-i/emberflow.git"
+  },
+  "peerDependencies": {
+    "firebase-admin": "^11.5.0",
+    "firebase-functions": "^4.2.0"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.3.4",
+    "@types/jest": "^29.4.0",
+    "@typescript-eslint/eslint-plugin": "^5.12.0",
+    "@typescript-eslint/parser": "^5.12.0",
+    "chai": "^4.3.7",
+    "eslint": "^8.9.0",
+    "eslint-config-google": "^0.14.0",
+    "eslint-plugin-import": "^2.25.4",
+    "firebase-functions-test": "^3.0.0",
+    "jest": "^29.4.3",
+    "ts-jest": "^29.0.5",
+    "typescript": "^4.9.0"
+  },
+  "private": false
+}

package/src/sample-custom/business-logics.ts

@@ -0,0 +1,51 @@
+import * as admin from "firebase-admin";
+import {firestore} from "firebase-admin";
+import DocumentData = firestore.DocumentData;
+// You should import from the path to the ember-flow package in your project
+import {LogicConfig, LogicFn} from "../types";
+
+const echoLogic: LogicFn = async (action) => {
+  const {document, timeCreated, path, modifiedFields} = action;
+  console.log(`Executing EchoLogic on document at ${path}...`);
+
+  const updatedDoc: DocumentData = {};
+
+  // Copy modified fields of document's @form to the document
+  if (document["@form"] && modifiedFields) {
+    for (const field of modifiedFields) {
+      if (document["@form"][field]) {
+        updatedDoc[field] = document["@form"][field];
+      }
+    }
+  }
+
+  // Return the result of the logic function
+  return {
+    name: "EchoLogic",
+    status: "finished",
+    execTime: Date.now() - timeCreated.toMillis(),
+    timeFinished: admin.firestore.Timestamp.now(),
+    documents: [
+      {
+        action: "merge",
+        dstPath: path,
+        doc: updatedDoc,
+        instructions: {},
+      },
+    ],
+  };
+};
+
+
+const logics: LogicConfig[] = [
+  {
+    name: "EchoLogic",
+    actionTypes: ["create", "update"],
+    modifiedFields: "all",
+    entities: "all",
+    logicFn: echoLogic,
+  },
+  // more logics here
+];
+
+export {logics};

package/src/sample-custom/db-structure.ts

@@ -0,0 +1,33 @@
+// You should import from the path to the ember-flow package in your project
+import {view} from "../utils/db-structure";
+
+export enum Entity {
+    User = "user", // do not delete
+    // Add your custom entities below
+    Feed = "feed",
+    Friend = "friend",
+    Game = "game",
+}
+
+// Map your custom entities to dbStructure below.
+// Do not remove users and [Entity.User]
+// by default, view matches the id attribute of the view so make the sure that a view has an id
+export const dbStructure = {
+  users: {
+    [Entity.User]: {
+      feeds: {
+        [Entity.Feed]: {
+          createdBy: view(Entity.User, ["name", "email"]),
+        },
+      },
+      friends: {
+        [Entity.Friend]: {
+          [view(Entity.User, ["name", "email"])]: {},
+          games: {
+            game: {},
+          },
+        },
+      },
+    },
+  },
+};

package/src/sample-custom/security.ts

@@ -0,0 +1,77 @@
+import {Entity} from "./db-structure";
+// You should import from the path to the ember-flow package in your project
+import {
+  SecurityConfig,
+  SecurityFn,
+  SecurityResult,
+} from "../types";
+
+// A security function that allows all actions
+const allAllowed: SecurityFn = async (
+  entity,
+  doc,
+  actionType,
+  modifiedFields
+) => {
+  console.log(`Security check for entity ${entity}, action type ${actionType},
+   and modified fields:`, modifiedFields);
+  return {
+    status: "allowed",
+  };
+};
+
+const userSecurityFn: SecurityFn =
+    async (entity, doc, actionType, modifiedFields):
+        Promise<SecurityResult> => {
+      switch (actionType) {
+      case "create": {
+        // Example: allow the user to create a new account only
+        // if they are registering from a whitelisted domain
+        const email = doc["@form"].email;
+        const domain = email.split("@")[1];
+        const allowedDomains = ["example.com", "example.org"];
+        let result: SecurityResult;
+        if (!allowedDomains.includes(domain)) {
+          result = {
+            status: "rejected",
+            message: `Registration is only allowed from these domains:
+             ${allowedDomains.join(", ")}`,
+          };
+        } else {
+          result = {
+            status: "allowed",
+          };
+        }
+        return result;
+      }
+
+      case "update": {
+        // Example: do not allow the user to update their system role
+        if (modifiedFields?.includes("systemRole")) {
+          return {
+            status: "rejected",
+            message: "User is not allowed to change his system role",
+          };
+        }
+        break;
+      }
+      case "delete":
+        // Example: reject all delete requests
+        return {
+          status: "rejected",
+          message: "You are not allowed to delete this document",
+        };
+      }
+
+      return {
+        status: "allowed",
+      };
+    };
+
+export const securityConfig: SecurityConfig = {
+  // Implement your security functions for each entity here
+  [Entity.User]: userSecurityFn,
+  [Entity.Feed]: allAllowed,
+  [Entity.Friend]: allAllowed,
+};
+

package/src/sample-custom/validators.ts

@@ -0,0 +1,46 @@
+import {Entity} from "./db-structure";
+import {firestore} from "firebase-admin";
+import DocumentData = firestore.DocumentData;
+// You should import from the path to the ember-flow package in your project
+import {ValidationResult, ValidatorConfig} from "../types";
+
+/**
+ * Validates the user document.
+ *
+ * @param {DocumentData} document - The document data to validate.
+ * @param {string} docPath - The path to the document.
+ * @return {Promise<ValidationResult>} An object containing validation errors, if any.
+ */
+async function userValidator(document: DocumentData, docPath: string): Promise<ValidationResult> {
+  const data = document;
+  const result: ValidationResult = {};
+  if (!data || !data.name) {
+    result["name"] = ["Name is required"];
+  }
+  return Promise.resolve(result);
+}
+
+/**
+ * A blank validator that always returns an empty ValidationResult object.
+ *
+ * @param {DocumentData} document - The document data to validate.
+ * @param {string} docPath - The path to the document.
+ * @return {Promise<ValidationResult>} An empty ValidationResult object.
+ */
+async function blankValidator(document: DocumentData, docPath: string): Promise<ValidationResult> {
+  return Promise.resolve({});
+}
+
+/**
+ * The validator configuration object, mapping entity names to their respective
+ * validator functions.
+ *
+ * @type {ValidatorConfig}
+ */
+const validatorConfig: ValidatorConfig = {
+  [Entity.User]: userValidator,
+  [Entity.Feed]: blankValidator,
+  [Entity.Friend]: blankValidator,
+};
+
+export {validatorConfig};