emberflow 1.5.1 → 2.0.0

package/lib/utils/pubsub.d.ts

@@ -1,9 +1,7 @@
-import type { ScheduledEvent } from "firebase-functions/v2/scheduler";
 declare function trackProcessedIds(topicName: string, id: string): Promise<void>;
 declare function isProcessed(topicName: string, id: string): Promise<boolean>;
 export declare const pubsubUtils: {
     trackProcessedIds: typeof trackProcessedIds;
     isProcessed: typeof isProcessed;
 };
-export declare function cleanPubSubProcessedIds(_event: ScheduledEvent): Promise<void>;
 export {};

package/lib/utils/pubsub.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cleanPubSubProcessedIds = exports.pubsubUtils = void 0;
+exports.pubsubUtils = void 0;
 const index_1 = require("../index");
-const misc_1 = require("./misc");
 async function trackProcessedIds(topicName, id) {
     const docRef = index_1.db.doc(`@topics/${topicName}/processedIds/${id}`);
     await docRef.set({ timestamp: new Date() });
@@ -16,18 +15,4 @@ exports.pubsubUtils = {
     trackProcessedIds,
     isProcessed,
 };
-async function cleanPubSubProcessedIds(_event) {
-    console.info("Running cleanPubSubProcessedIds");
-    let i = 0;
-    for (const pubSubTopic of index_1.pubSubTopics) {
-        const query = index_1.db
-            .collection(`@topics/${pubSubTopic}/processedIds`)
-            .where("timestamp", "<", new Date(Date.now() - 1000 * 60 * 60 * 24 * 7));
-        await (0, misc_1.deleteCollection)(query, (snapshot) => {
-            i += snapshot.size;
-        });
-    }
-    console.info(`Cleaned ${i} topics of processedIds`);
-}
-exports.cleanPubSubProcessedIds = cleanPubSubProcessedIds;
 //# sourceMappingURL=pubsub.js.map

package/lib/utils/pubsub.js.map

@@ -1 +1 @@
-{"version":3,"file":"pubsub.js","sourceRoot":"","sources":["../../src/utils/pubsub.ts"],"names":[],"mappings":";;;AAAA,oCAA0C;AAC1C,iCAAwC;AAGxC,KAAK,UAAU,iBAAiB,CAAC,SAAiB,EAAE,EAAU;IAC5D,MAAM,MAAM,GAAG,UAAE,CAAC,GAAG,CAAC,WAAW,SAAS,iBAAiB,EAAE,EAAE,CAAC,CAAC;IACjE,MAAM,MAAM,CAAC,GAAG,CAAC,EAAC,SAAS,EAAE,IAAI,IAAI,EAAE,EAAC,CAAC,CAAC;AAC5C,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,SAAiB,EAAE,EAAU;IACtD,MAAM,MAAM,GAAG,UAAE,CAAC,GAAG,CAAC,WAAW,SAAS,iBAAiB,EAAE,EAAE,CAAC,CAAC;IACjE,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC;IAC/B,OAAO,GAAG,CAAC,MAAM,CAAC;AACpB,CAAC;AAEY,QAAA,WAAW,GAAG;IACzB,iBAAiB;IACjB,WAAW;CACZ,CAAC;AAEK,KAAK,UAAU,uBAAuB,CAAC,MAAsB;IAClE,OAAO,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;IAChD,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,KAAK,MAAM,WAAW,IAAI,oBAAY,EAAE;QACtC,MAAM,KAAK,GAAG,UAAE;aACb,UAAU,CAAC,WAAW,WAAW,eAAe,CAAC;aACjD,KAAK,CAAC,WAAW,EAAE,GAAG,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;QAE3E,MAAM,IAAA,uBAAgB,EAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE;YACzC,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC;QACrB,CAAC,CAAC,CAAC;KACJ;IACD,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,yBAAyB,CAAC,CAAC;AACtD,CAAC;AAbD,0DAaC"}
+{"version":3,"file":"pubsub.js","sourceRoot":"","sources":["../../src/utils/pubsub.ts"],"names":[],"mappings":";;;AAAA,oCAA4B;AAE5B,KAAK,UAAU,iBAAiB,CAAC,SAAiB,EAAE,EAAU;IAC5D,MAAM,MAAM,GAAG,UAAE,CAAC,GAAG,CAAC,WAAW,SAAS,iBAAiB,EAAE,EAAE,CAAC,CAAC;IACjE,MAAM,MAAM,CAAC,GAAG,CAAC,EAAC,SAAS,EAAE,IAAI,IAAI,EAAE,EAAC,CAAC,CAAC;AAC5C,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,SAAiB,EAAE,EAAU;IACtD,MAAM,MAAM,GAAG,UAAE,CAAC,GAAG,CAAC,WAAW,SAAS,iBAAiB,EAAE,EAAE,CAAC,CAAC;IACjE,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC;IAC/B,OAAO,GAAG,CAAC,MAAM,CAAC;AACpB,CAAC;AAEY,QAAA,WAAW,GAAG;IACzB,iBAAiB;IACjB,WAAW;CACZ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "emberflow",
-  "version": "1.5.1",
+  "version": "2.0.0",
   "description": "A Firebase Cloud Functions library for handling document changes in a structured way",
   "main": "lib/index.js",
   "types": "lib/index.d.js",

package/src/sample-custom/cleanup-configs.ts

@@ -0,0 +1,15 @@
+import {CleanupConfig} from "../types";
+
+export const cleanupConfigs: CleanupConfig[] = [
+  {
+    // Purge stale askJaris documents that never got a topic assigned.
+    // "attribute missing" is modeled as an indexed boolean flag (hasTopic).
+    collectionPath: "askJaris",
+    isCollectionGroup: true,
+    timestampField: "createdAt",
+    olderThan: {value: 1, unit: "months"},
+    conditions: [
+      {fieldName: "hasTopic", operator: "==", value: false},
+    ],
+  },
+];

package/src/sample-custom/index.ts

@@ -1,24 +1,28 @@
 import * as admin from "firebase-admin";
-import { initializeEmberFlow } from "../index";
-import { projectConfig } from "./project-config";
-import { dbStructure, Entity } from "./db-structure";
-import { securityConfigs } from "./security";
-import { validatorConfigs } from "./validators";
-import { logics } from "./business-logics";
-import { patchLogicConfigs } from "./patch-logics";
+import {initializeEmberFlow} from "../index";
+import {projectConfig} from "./project-config";
+import {dbStructure, Entity} from "./db-structure";
+import {securityConfigs} from "./security";
+import {validatorConfigs} from "./validators";
+import {logics} from "./business-logics";
+import {patchLogicConfigs} from "./patch-logics";
+import {backFillPatchConfigs} from "./one-time-patches";
+import {cleanupConfigs} from "./cleanup-configs";
 
 admin.initializeApp();
 
-const { functionsConfig } = initializeEmberFlow(
+const {functionsConfig} = initializeEmberFlow({
   projectConfig,
   admin,
   dbStructure,
   Entity,
   securityConfigs,
   validatorConfigs,
-  logics,
-  patchLogicConfigs
-);
+  logicConfigs: logics,
+  patchLogicConfigs,
+  cleanupConfigs,
+  backFillPatchConfigs,
+});
 
 // Export the generated functions
 Object.entries(functionsConfig).forEach(([key, value]) => {

package/src/sample-custom/one-time-patches.ts

@@ -0,0 +1,13 @@
+import {BackFillPatchConfig} from "../types";
+
+const sampleOneTimePatch: BackFillPatchConfig = {
+  name: "sample-one-time-patch",
+  patchFn: async (collectionPath, docs) => {
+    console.log(`Executing sample one-time patch on collection ${collectionPath} (${docs.length} docs)...`);
+    // Add your custom bulk back-fill logic here, e.g. bulk-update docs via a single db.batch().
+  },
+};
+
+export const backFillPatchConfigs: BackFillPatchConfig[] = [
+  sampleOneTimePatch,
+];