@memberjunction/core-entities 5.44.0 → 5.45.1

package/dist/engines/UserRoutineEngine.js

@@ -0,0 +1,180 @@
+import { BaseEngine, } from '@memberjunction/core';
+import { NormalizeUUID, UUIDsEqual } from '@memberjunction/global';
+/** Client-side cap applied by the {@link UserRoutineEngine.RecentRuns} getter. */
+const RECENT_RUNS_CAP = 500;
+/**
+ * UserRoutineEngine provides centralized, cached access to the current user's
+ * User Routines ("MJ: User Routines"), their notification recipients, and their
+ * recent runs. It is the single data source the User Routines UI widgets consume —
+ * components should NOT issue ad-hoc RunViews for data this engine already caches.
+ *
+ * Unlike {@link UserInfoEngine} this engine is NOT auto-configured at startup —
+ * routines are a lazily-entered surface, so every consumer calls
+ * `await UserRoutineEngine.Instance.Config(false, user, provider)` on entry
+ * (a no-op once loaded).
+ *
+ * All three configs load UNFILTERED (client and server alike) and the public
+ * getters scope to the loaded user. Unfiltered + unordered configs are the
+ * canonical BaseEngine shape: the engine maintains the arrays IN PLACE on
+ * save / delete / remote-invalidate entity events — no filter snapshot to go
+ * stale after creating or deleting a routine, and no full-refresh churn.
+ * Row-level visibility is the server's job (entity permissions / RLS), not a
+ * client-side Filter's.
+ *
+ * Usage:
+ * ```typescript
+ * const engine = UserRoutineEngine.Instance;
+ * await engine.Config(false, currentUser, provider);
+ * const routines = engine.Routines;             // current user's routines
+ * const runs = engine.RunsForRoutine(routineId); // most recent first
+ * engine.Routines$.subscribe(r => ...);          // reactive updates
+ * ```
+ */
+export class UserRoutineEngine extends BaseEngine {
+    constructor() {
+        super(...arguments);
+        // Private storage for entity data (populated by BaseEngine.Load via Configs)
+        this._Routines = [];
+        this._Recipients = [];
+        this._Runs = [];
+        // Track the user ID we loaded data for
+        this._loadedForUserId = null;
+    }
+    /**
+     * Returns the global instance of the class. This is a singleton class, so there is
+     * only one instance of it in the application. Do not directly create new instances
+     * of it, always use this method (or `GetProviderInstance` for non-default providers).
+     */
+    static get Instance() {
+        return super.getInstance();
+    }
+    /**
+     * Configures the engine by loading the current user's routines, recipients, and runs.
+     *
+     * @param forceRefresh - If true, forces a refresh from the server even if data is cached
+     * @param contextUser - The user context (required for server-side, auto-detected on client)
+     * @param provider - Optional custom metadata provider
+     */
+    async Config(forceRefresh, contextUser, provider) {
+        const md = provider ?? this.ProviderToUse;
+        const userId = contextUser?.ID || md.CurrentUser?.ID;
+        if (!userId) {
+            console.warn('UserRoutineEngine: No user context available, skipping configuration');
+            return;
+        }
+        // Unfiltered + unordered on purpose: this is the canonical BaseEngine shape,
+        // so the engine maintains all three arrays in place on entity events (no
+        // stale filter snapshots, no full-refresh churn). The cache is user-agnostic;
+        // getters scope per user, so a user change needs no reload.
+        const configs = [
+            {
+                Type: 'entity',
+                EntityName: 'MJ: User Routines',
+                PropertyName: '_Routines',
+                CacheLocal: true,
+            },
+            {
+                Type: 'entity',
+                EntityName: 'MJ: User Routine Recipients',
+                PropertyName: '_Recipients',
+                CacheLocal: true,
+            },
+            {
+                Type: 'entity',
+                EntityName: 'MJ: User Routine Runs',
+                PropertyName: '_Runs',
+                CacheLocal: true,
+            },
+        ];
+        await super.Load(configs, provider, forceRefresh, contextUser);
+        this._loadedForUserId = userId;
+    }
+    // ========================================================================
+    // OBSERVABLE ACCESSORS
+    // ========================================================================
+    /**
+     * Observable stream of the routines cache. Emits the current (raw/unfiltered) array on
+     * subscribe and re-emits on save / delete / remote-invalidate / refresh. Consumers that
+     * need the per-user view should read the {@link Routines} getter inside the subscription.
+     */
+    get Routines$() {
+        return this.ObserveProperty('_Routines');
+    }
+    /** Observable stream of the recipients cache (raw). */
+    get Recipients$() {
+        return this.ObserveProperty('_Recipients');
+    }
+    /** Observable stream of the runs cache (raw). */
+    get Runs$() {
+        return this.ObserveProperty('_Runs');
+    }
+    // ========================================================================
+    // PUBLIC ACCESSORS (per-user filtered)
+    // ========================================================================
+    /** The loaded user's routines, sorted by name. */
+    get Routines() {
+        if (!this._loadedForUserId)
+            return [];
+        return this.GetConfigData('_Routines')
+            .filter((r) => UUIDsEqual(r.UserID, this._loadedForUserId))
+            .sort((a, b) => (a.Name || '').localeCompare(b.Name || ''));
+    }
+    /** All recipients across the loaded user's routines. */
+    get Recipients() {
+        const routineIds = this.loadedRoutineIdSet();
+        return this.GetConfigData('_Recipients').filter((r) => routineIds.has(NormalizeUUID(r.RoutineID)));
+    }
+    /**
+     * Recent runs across the loaded user's routines, most recent first (capped at
+     * {@link RECENT_RUNS_CAP} rows client-side).
+     */
+    get RecentRuns() {
+        const routineIds = this.loadedRoutineIdSet();
+        return this.GetConfigData('_Runs')
+            .filter((r) => routineIds.has(NormalizeUUID(r.RoutineID)))
+            .sort((a, b) => new Date(b.StartedAt).getTime() - new Date(a.StartedAt).getTime())
+            .slice(0, RECENT_RUNS_CAP);
+    }
+    // ========================================================================
+    // CONVENIENCE METHODS
+    // ========================================================================
+    /** A routine by ID (loaded user's routines only). */
+    GetRoutineByID(routineId) {
+        return this.Routines.find((r) => UUIDsEqual(r.ID, routineId));
+    }
+    /** Runs for one routine, most recent first. */
+    RunsForRoutine(routineId, maxRuns) {
+        const runs = this.GetConfigData('_Runs')
+            .filter((r) => UUIDsEqual(r.RoutineID, routineId))
+            .sort((a, b) => new Date(b.StartedAt).getTime() - new Date(a.StartedAt).getTime());
+        return maxRuns != null && maxRuns > 0 ? runs.slice(0, maxRuns) : runs;
+    }
+    /** Recipients for one routine, in Sequence order. */
+    RecipientsForRoutine(routineId) {
+        return this.GetConfigData('_Recipients')
+            .filter((r) => UUIDsEqual(r.RoutineID, routineId))
+            .sort((a, b) => a.Sequence - b.Sequence);
+    }
+    /** Routines for an arbitrary user (server-side / admin scenarios; raw cache scan). */
+    GetRoutinesForUser(userId) {
+        return (this._Routines || [])
+            .filter((r) => UUIDsEqual(r.UserID, userId))
+            .sort((a, b) => (a.Name || '').localeCompare(b.Name || ''));
+    }
+    /** The user ID this engine was loaded for. */
+    get LoadedForUserId() {
+        return this._loadedForUserId;
+    }
+    /**
+     * Force-refreshes all cached data from the server. Rarely needed — the unfiltered
+     * configs are maintained in place on entity events — but useful as an explicit
+     * "pull latest" (e.g. the UI's refresh button picking up dispatcher-written runs).
+     */
+    async Refresh(contextUser) {
+        await this.Config(true, contextUser);
+    }
+    loadedRoutineIdSet() {
+        return new Set(this.Routines.map((r) => NormalizeUUID(r.ID)));
+    }
+}
+//# sourceMappingURL=UserRoutineEngine.js.map

package/dist/engines/UserRoutineEngine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserRoutineEngine.js","sourceRoot":"","sources":["../../src/engines/UserRoutineEngine.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,GAIX,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AASnE,kFAAkF;AAClF,MAAM,eAAe,GAAG,GAAG,CAAC;AAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,OAAO,iBAAkB,SAAQ,UAA6B;IAApE;;QAUE,6EAA6E;QACrE,cAAS,GAA0B,EAAE,CAAC;QACtC,gBAAW,GAAmC,EAAE,CAAC;QACjD,UAAK,GAA6B,EAAE,CAAC;QAE7C,uCAAuC;QAC/B,qBAAgB,GAAkB,IAAI,CAAC;IAsJjD,CAAC;IArKC;;;;OAIG;IACI,MAAM,KAAK,QAAQ;QACxB,OAAO,KAAK,CAAC,WAAW,EAAqB,CAAC;IAChD,CAAC;IAUD;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAAC,YAAsB,EAAE,WAAsB,EAAE,QAA4B;QAC9F,MAAM,EAAE,GAAG,QAAQ,IAAI,IAAI,CAAC,aAAa,CAAC;QAC1C,MAAM,MAAM,GAAG,WAAW,EAAE,EAAE,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC;QAErD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,CAAC,IAAI,CAAC,sEAAsE,CAAC,CAAC;YACrF,OAAO;QACT,CAAC;QAED,6EAA6E;QAC7E,yEAAyE;QACzE,8EAA8E;QAC9E,4DAA4D;QAC5D,MAAM,OAAO,GAAwC;YACnD;gBACE,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,mBAAmB;gBAC/B,YAAY,EAAE,WAAW;gBACzB,UAAU,EAAE,IAAI;aACjB;YACD;gBACE,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,6BAA6B;gBACzC,YAAY,EAAE,aAAa;gBAC3B,UAAU,EAAE,IAAI;aACjB;YACD;gBACE,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,uBAAuB;gBACnC,YAAY,EAAE,OAAO;gBACrB,UAAU,EAAE,IAAI;aACjB;SACF,CAAC;QAEF,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;QAC/D,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC;IACjC,CAAC;IAED,2EAA2E;IAC3E,uBAAuB;IACvB,2EAA2E;IAE3E;;;;OAIG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,eAAe,CAAsB,WAAW,CAAC,CAAC;IAChE,CAAC;IAED,uDAAuD;IACvD,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,eAAe,CAA+B,aAAa,CAAC,CAAC;IAC3E,CAAC;IAED,iDAAiD;IACjD,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,eAAe,CAAyB,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED,2EAA2E;IAC3E,uCAAuC;IACvC,2EAA2E;IAE3E,kDAAkD;IAClD,IAAW,QAAQ;QACjB,IAAI,CAAC,IAAI,CAAC,gBAAgB;YAAE,OAAO,EAAE,CAAC;QACtC,OAAO,IAAI,CAAC,aAAa,CAAsB,WAAW,CAAC;aACxD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;aAC1D,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;IAChE,CAAC;IAED,wDAAwD;IACxD,IAAW,UAAU;QACnB,MAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC,aAAa,CAA+B,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAClF,UAAU,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAC3C,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,IAAW,UAAU;QACnB,MAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC,aAAa,CAAyB,OAAO,CAAC;aACvD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;aACzD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC;aACjF,KAAK,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC;IAC/B,CAAC;IAED,2EAA2E;IAC3E,sBAAsB;IACtB,2EAA2E;IAE3E,qDAAqD;IAC9C,cAAc,CAAC,SAAiB;QACrC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;IAChE,CAAC;IAED,+CAA+C;IACxC,cAAc,CAAC,SAAiB,EAAE,OAAgB;QACvD,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAyB,OAAO,CAAC;aAC7D,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;aACjD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACrF,OAAO,OAAO,IAAI,IAAI,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACxE,CAAC;IAED,qDAAqD;IAC9C,oBAAoB,CAAC,SAAiB;QAC3C,OAAO,IAAI,CAAC,aAAa,CAA+B,aAAa,CAAC;aACnE,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;aACjD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC;IAC7C,CAAC;IAED,sFAAsF;IAC/E,kBAAkB,CAAC,MAAc;QACtC,OAAO,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC;aAC1B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;aAC3C,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;IAChE,CAAC;IAED,8CAA8C;IAC9C,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAAC,WAAsB;QACzC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IACvC,CAAC;IAEO,kBAAkB;QACxB,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAChE,CAAC;CACF"}