bruce-models 7.1.44 → 7.1.46

package/dist/types/server/record-change-feed.d.ts

@@ -0,0 +1,125 @@
+import { AccountConcept } from "../account/account-concept";
+import { Api } from "../api/api";
+import { CacheControl } from "../common/cache";
+import { MessageBroker } from "./message-broker";
+/**
+ * Handles change events from Bruce API for various concepts.
+ * Apps/utils can subscribe to specific concept changes, eg: N Entity was updated so we should reload a panel.
+ */
+export declare namespace RecordChangeFeed {
+    type TAction = "C" | "U" | "D";
+    /**
+     * A parsed record-change event received from the server.
+     */
+    interface IEvent {
+        topic?: string;
+        concept: AccountConcept.EConcept;
+        action: TAction;
+        data: unknown;
+        user?: string;
+        message: MessageBroker.IMessage;
+    }
+    /**
+     * Filtering criteria for a record-change subscription.
+     * All fields are optional, omitting a field means "match all values".
+     */
+    interface ISubscribeParams {
+        concepts?: AccountConcept.EConcept[];
+        actions?: TAction[];
+        recordId?: string | number;
+        entityInternalId?: number;
+    }
+    /**
+     * Parses a raw broker message into a typed record-change event.
+     * Returns null if the message does not conform to the record-change format.
+     */
+    const parseEvent: (message: MessageBroker.IMessage) => IEvent | null;
+    /**
+     * Returns true if the given Entity internal ID falls within the reported range string.
+     *
+     * @example
+     * isEntityInternalIdInRangeString("100-200,305,400-450", 150) // true
+     * isEntityInternalIdInRangeString("100-200,305,400-450", 301) // false
+     */
+    const isEntityInternalIdInRangeString: (rangeString: string | null | undefined, entityInternalId: number) => boolean;
+    /**
+     * Returns true if the given record ID appears in a comma-separated list string.
+     *
+     * @example
+     * isRecordIdInListString("abc,def,ghi", "def") // true
+     * isRecordIdInListString("abc,def,ghi", "xyz") // false
+     */
+    const isRecordIdInListString: (listString: string | null | undefined, recordId: string | number) => boolean;
+    /**
+     * Returns the set of {@link Api.ECacheKey} namespaces that should be
+     * invalidated when a record-change event arrives for the given concept.
+     *
+     * A concept can map to multiple cache namespaces (e.g. a tileset change
+     * also invalidates the publish-tileset and tileset-access caches).
+     */
+    const getConceptCacheKeys: (concept: AccountConcept.EConcept) => string[];
+    /**
+     * Evicts relevant cache entries in response to a record-change event.
+     */
+    const clearCachesForEvent: (event: IEvent, cache: CacheControl<any>) => void;
+    /**
+     * A typed, self-managing live feed for Bruce record-change events.
+     *
+     * Wraps a {@link MessageBroker.IBroker} and routes incoming WebSocket messages
+     * to strongly-typed, optionally-filtered subscriber callbacks.
+     *
+     * When a "cache" is provided (via the {@link BruceApi.Api} constructor),
+     * relevant cache entries are automatically evicted on every incoming event
+     * before subscribers are notified.
+     *
+     * Reconnection is handled by the underlying broker, subscribers do not need
+     * to re-register after a disconnect/reconnect cycle.
+     *
+     * @example
+     * const unsub = api.RecordChangeFeed.Subscribe(
+     *   { concepts: [AccountConcept.EConcept.ENTITY_TYPE] },
+     *   (event) => console.log("Entity type changed:", event)
+     * );
+     *
+     * // Later:
+     * unsub();
+     */
+    class Client {
+        private readonly broker;
+        private readonly topic;
+        private readonly cache;
+        private readonly subscribers;
+        private readonly brokerCallback;
+        /**
+         * Initialize new instance. Done through a BruceAPI instance in all current uses.
+         * @param broker
+         * @param accountId
+         * @param env
+         * @param cache
+         */
+        constructor(broker: MessageBroker.IBroker, accountId: string, env: Api.Env, cache?: CacheControl<any>);
+        /**
+         * Whether the underlying WebSocket connection is currently open.
+         */
+        get IsConnected(): boolean;
+        /**
+         * Forward the authenticated user ID to the underlying broker.
+         */
+        SetUserId(userId: string): void;
+        private onBrokerMessage;
+        private matchesFilter;
+        /**
+         * Register a typed callback for record-change events.
+         *
+         * @param params Filtering criteria. All fields are optional.
+         * @param callback Invoked for each matching event.
+         * @returns An unsubscribe function. Call it to stop receiving events.
+         */
+        Subscribe(params: ISubscribeParams, callback: (event: IEvent) => void): () => void;
+        /**
+         * Unsubscribes from the broker topic and clears all local subscribers.
+         * Call this when the owning API instance is being torn down.
+         */
+        Destroy(): void;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "bruce-models",
-    "version": "7.1.44",
+    "version": "7.1.46",
     "description": "",
     "keywords": [],
     "main": "dist/bruce-models.umd.js",