emberflow 1.0.8

package/lib/sample-custom/business-logics.js

@@ -0,0 +1,67 @@
+"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.logics = void 0;
+const admin = __importStar(require("firebase-admin"));
+const echoLogic = async (action) => {
+    const { document, timeCreated, path, modifiedFields } = action;
+    console.log(`Executing EchoLogic on document at ${path}...`);
+    const updatedDoc = {};
+    // 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 = [
+    {
+        name: "EchoLogic",
+        actionTypes: ["create", "update"],
+        modifiedFields: "all",
+        entities: "all",
+        logicFn: echoLogic,
+    },
+    // more logics here
+];
+exports.logics = logics;
+//# sourceMappingURL=business-logics.js.map

package/lib/sample-custom/business-logics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"business-logics.js","sourceRoot":"","sources":["../../src/sample-custom/business-logics.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sDAAwC;AAMxC,MAAM,SAAS,GAAY,KAAK,EAAE,MAAM,EAAE,EAAE;IAC1C,MAAM,EAAC,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,cAAc,EAAC,GAAG,MAAM,CAAC;IAC7D,OAAO,CAAC,GAAG,CAAC,sCAAsC,IAAI,KAAK,CAAC,CAAC;IAE7D,MAAM,UAAU,GAAiB,EAAE,CAAC;IAEpC,2DAA2D;IAC3D,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,cAAc,EAAE;QACvC,KAAK,MAAM,KAAK,IAAI,cAAc,EAAE;YAClC,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE;gBAC5B,UAAU,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC;aAC9C;SACF;KACF;IAED,0CAA0C;IAC1C,OAAO;QACL,IAAI,EAAE,WAAW;QACjB,MAAM,EAAE,UAAU;QAClB,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,CAAC,QAAQ,EAAE;QAC7C,YAAY,EAAE,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,EAAE;QAC7C,SAAS,EAAE;YACT;gBACE,MAAM,EAAE,OAAO;gBACf,OAAO,EAAE,IAAI;gBACb,GAAG,EAAE,UAAU;gBACf,YAAY,EAAE,EAAE;aACjB;SACF;KACF,CAAC;AACJ,CAAC,CAAC;AAGF,MAAM,MAAM,GAAkB;IAC5B;QACE,IAAI,EAAE,WAAW;QACjB,WAAW,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC;QACjC,cAAc,EAAE,KAAK;QACrB,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,SAAS;KACnB;IACD,mBAAmB;CACpB,CAAC;AAEM,wBAAM"}

package/lib/sample-custom/db-structure.d.ts

@@ -0,0 +1,29 @@
+export declare enum Entity {
+    User = "user",
+    Feed = "feed",
+    Friend = "friend",
+    Game = "game"
+}
+export declare const dbStructure: {
+    users: {
+        user: {
+            feeds: {
+                feed: {
+                    createdBy: string;
+                };
+            };
+            friends: {
+                friend: {
+                    [x: string]: {
+                        game?: undefined;
+                    } | {
+                        game: {};
+                    };
+                    games: {
+                        game: {};
+                    };
+                };
+            };
+        };
+    };
+};

package/lib/sample-custom/db-structure.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dbStructure = exports.Entity = void 0;
+// You should import from the path to the ember-flow package in your project
+const db_structure_1 = require("../utils/db-structure");
+var Entity;
+(function (Entity) {
+    Entity["User"] = "user";
+    // Add your custom entities below
+    Entity["Feed"] = "feed";
+    Entity["Friend"] = "friend";
+    Entity["Game"] = "game";
+})(Entity = exports.Entity || (exports.Entity = {}));
+// 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
+exports.dbStructure = {
+    users: {
+        [Entity.User]: {
+            feeds: {
+                [Entity.Feed]: {
+                    createdBy: (0, db_structure_1.view)(Entity.User, ["name", "email"]),
+                },
+            },
+            friends: {
+                [Entity.Friend]: {
+                    [(0, db_structure_1.view)(Entity.User, ["name", "email"])]: {},
+                    games: {
+                        game: {},
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=db-structure.js.map

package/lib/sample-custom/db-structure.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"db-structure.js","sourceRoot":"","sources":["../../src/sample-custom/db-structure.ts"],"names":[],"mappings":";;;AAAA,4EAA4E;AAC5E,wDAA2C;AAE3C,IAAY,MAMX;AAND,WAAY,MAAM;IACd,uBAAa,CAAA;IACb,iCAAiC;IACjC,uBAAa,CAAA;IACb,2BAAiB,CAAA;IACjB,uBAAa,CAAA;AACjB,CAAC,EANW,MAAM,GAAN,cAAM,KAAN,cAAM,QAMjB;AAED,iDAAiD;AACjD,wCAAwC;AACxC,+FAA+F;AAClF,QAAA,WAAW,GAAG;IACzB,KAAK,EAAE;QACL,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YACb,KAAK,EAAE;gBACL,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;oBACb,SAAS,EAAE,IAAA,mBAAI,EAAC,MAAM,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;iBAChD;aACF;YACD,OAAO,EAAE;gBACP,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;oBACf,CAAC,IAAA,mBAAI,EAAC,MAAM,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;oBAC1C,KAAK,EAAE;wBACL,IAAI,EAAE,EAAE;qBACT;iBACF;aACF;SACF;KACF;CACF,CAAC"}

package/lib/sample-custom/security.d.ts

@@ -0,0 +1,2 @@
+import { SecurityConfig } from "../types";
+export declare const securityConfig: SecurityConfig;

package/lib/sample-custom/security.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.securityConfig = void 0;
+const db_structure_1 = require("./db-structure");
+// A security function that allows all actions
+const allAllowed = async (entity, doc, actionType, modifiedFields) => {
+    console.log(`Security check for entity ${entity}, action type ${actionType},
+   and modified fields:`, modifiedFields);
+    return {
+        status: "allowed",
+    };
+};
+const userSecurityFn = async (entity, doc, actionType, modifiedFields) => {
+    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;
+            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 === null || modifiedFields === void 0 ? void 0 : 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",
+    };
+};
+exports.securityConfig = {
+    // Implement your security functions for each entity here
+    [db_structure_1.Entity.User]: userSecurityFn,
+    [db_structure_1.Entity.Feed]: allAllowed,
+    [db_structure_1.Entity.Friend]: allAllowed,
+};
+//# sourceMappingURL=security.js.map

package/lib/sample-custom/security.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"security.js","sourceRoot":"","sources":["../../src/sample-custom/security.ts"],"names":[],"mappings":";;;AAAA,iDAAsC;AAQtC,8CAA8C;AAC9C,MAAM,UAAU,GAAe,KAAK,EAClC,MAAM,EACN,GAAG,EACH,UAAU,EACV,cAAc,EACd,EAAE;IACF,OAAO,CAAC,GAAG,CAAC,6BAA6B,MAAM,iBAAiB,UAAU;wBACpD,EAAE,cAAc,CAAC,CAAC;IACxC,OAAO;QACL,MAAM,EAAE,SAAS;KAClB,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,cAAc,GAChB,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,cAAc,EAClB,EAAE;IAC5B,QAAQ,UAAU,EAAE;QACpB,KAAK,QAAQ,CAAC,CAAC;YACb,uDAAuD;YACvD,oDAAoD;YACpD,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC;YACjC,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YACnC,MAAM,cAAc,GAAG,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;YACtD,IAAI,MAAsB,CAAC;YAC3B,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBACpC,MAAM,GAAG;oBACP,MAAM,EAAE,UAAU;oBAClB,OAAO,EAAE;eACN,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;iBAC/B,CAAC;aACH;iBAAM;gBACL,MAAM,GAAG;oBACP,MAAM,EAAE,SAAS;iBAClB,CAAC;aACH;YACD,OAAO,MAAM,CAAC;SACf;QAED,KAAK,QAAQ,CAAC,CAAC;YACb,6DAA6D;YAC7D,IAAI,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,QAAQ,CAAC,YAAY,CAAC,EAAE;gBAC1C,OAAO;oBACL,MAAM,EAAE,UAAU;oBAClB,OAAO,EAAE,+CAA+C;iBACzD,CAAC;aACH;YACD,MAAM;SACP;QACD,KAAK,QAAQ;YACX,sCAAsC;YACtC,OAAO;gBACL,MAAM,EAAE,UAAU;gBAClB,OAAO,EAAE,6CAA6C;aACvD,CAAC;KACH;IAED,OAAO;QACL,MAAM,EAAE,SAAS;KAClB,CAAC;AACJ,CAAC,CAAC;AAEO,QAAA,cAAc,GAAmB;IAC5C,yDAAyD;IACzD,CAAC,qBAAM,CAAC,IAAI,CAAC,EAAE,cAAc;IAC7B,CAAC,qBAAM,CAAC,IAAI,CAAC,EAAE,UAAU;IACzB,CAAC,qBAAM,CAAC,MAAM,CAAC,EAAE,UAAU;CAC5B,CAAC"}

package/lib/sample-custom/validators.d.ts

@@ -0,0 +1,9 @@
+import { ValidatorConfig } from "../types";
+/**
+ * The validator configuration object, mapping entity names to their respective
+ * validator functions.
+ *
+ * @type {ValidatorConfig}
+ */
+declare const validatorConfig: ValidatorConfig;
+export { validatorConfig };

package/lib/sample-custom/validators.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validatorConfig = void 0;
+const db_structure_1 = require("./db-structure");
+/**
+ * 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, docPath) {
+    const data = document;
+    const result = {};
+    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, docPath) {
+    return Promise.resolve({});
+}
+/**
+ * The validator configuration object, mapping entity names to their respective
+ * validator functions.
+ *
+ * @type {ValidatorConfig}
+ */
+const validatorConfig = {
+    [db_structure_1.Entity.User]: userValidator,
+    [db_structure_1.Entity.Feed]: blankValidator,
+    [db_structure_1.Entity.Friend]: blankValidator,
+};
+exports.validatorConfig = validatorConfig;
+//# sourceMappingURL=validators.js.map

package/lib/sample-custom/validators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.js","sourceRoot":"","sources":["../../src/sample-custom/validators.ts"],"names":[],"mappings":";;;AAAA,iDAAsC;AAMtC;;;;;;GAMG;AACH,KAAK,UAAU,aAAa,CAAC,QAAsB,EAAE,OAAe;IAClE,MAAM,IAAI,GAAG,QAAQ,CAAC;IACtB,MAAM,MAAM,GAAqB,EAAE,CAAC;IACpC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;QACvB,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;KACvC;IACD,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,cAAc,CAAC,QAAsB,EAAE,OAAe;IACnE,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;AAC7B,CAAC;AAED;;;;;GAKG;AACH,MAAM,eAAe,GAAoB;IACvC,CAAC,qBAAM,CAAC,IAAI,CAAC,EAAE,aAAa;IAC5B,CAAC,qBAAM,CAAC,IAAI,CAAC,EAAE,cAAc;IAC7B,CAAC,qBAAM,CAAC,MAAM,CAAC,EAAE,cAAc;CAChC,CAAC;AAEM,0CAAe"}

package/lib/tests/index-utils.test.d.ts

@@ -0,0 +1 @@
+export {};