@base-framework/base 3.8.3 → 3.9.0

package/dist/types/modules/data-binder/data-pub-sub.d.ts

@@ -7,11 +7,29 @@
  * @class
  */
 export class DataPubSub {
+    /**
+     * This will create a data pub sub.
+     *
+     * @constructor
+     * @param {boolean} [indexPrefixes=false] Maintain an index of
+     * subscribed messages grouped by their `prefix:` segment. Used by
+     * the data binder so deep data can publish only to subscribed
+     * paths instead of walking every node of a value.
+     */
+    constructor(indexPrefixes?: boolean);
     /**
      * @type {Map} callBacks
      * @protected
      */
     protected callBacks: Map<any, any>;
+    /**
+     * Index of subscribed messages keyed by message prefix
+     * (substring through the first ':'). Null when disabled.
+     *
+     * @type {Map<string, Set<string>>|null}
+     * @protected
+     */
+    protected prefixIndex: Map<string, Set<string>> | null;
     /**
      * Queue for batching publish calls
      * @type {Map<string, Array>}
@@ -81,19 +99,55 @@ export class DataPubSub {
     /**
      * This will add a subscriber.
      *
+     * Tokens are numbers — string conversion was allocating a new
+     * string per watcher during page builds. Tokens are opaque to
+     * callers and only round-trip back into off().
+     *
      * @param {string} msg
      * @param {function} callBack
-     * @returns {string} The subscriber token.
+     * @returns {number} The subscriber token.
+     */
+    on(msg: string, callBack: Function): number;
+    /**
+     * This will add a message to the prefix index.
+     *
+     * @protected
+     * @param {string} msg
+     * @returns {void}
+     */
+    protected _indexMessage(msg: string): void;
+    /**
+     * This will remove a message from the prefix index.
+     *
+     * @protected
+     * @param {string} msg
+     * @returns {void}
+     */
+    protected _unindexMessage(msg: string): void;
+    /**
+     * This will get the subscribed messages for a prefix
+     * (e.g. 'dt-3:'). Returns null when prefix indexing is
+     * disabled or no messages are subscribed.
+     *
+     * @param {string} prefix
+     * @returns {Set<string>|null}
+     */
+    getPrefixMessages(prefix: string): Set<string> | null;
+    /**
+     * This will get the subscribed message keys. Used by deep data
+     * to publish only to subscribed paths.
+     *
+     * @returns {IterableIterator<string>}
      */
-    on(msg: string, callBack: Function): string;
+    getMessages(): IterableIterator<string>;
     /**
      * This will remove a subscriber.
      *
      * @param {string} msg
-     * @param {string} token
+     * @param {number} token
      * @returns {void}
      */
-    off(msg: string, token: string): void;
+    off(msg: string, token: number): void;
     /**
      * This will delete a message.
      *

package/dist/types/modules/state/state-tracker.d.ts

@@ -70,9 +70,9 @@ export class StateTracker {
      * @param {string} targetId
      * @param {string} action
      * @param {function} callBack
-     * @returns {?string}
+     * @returns {?number}
      */
-    static on(targetId: string, action: string, callBack: Function): string | null;
+    static on(targetId: string, action: string, callBack: Function): number | null;
     /**
      * This will remove a subscriber from an action.
      *

package/dist/types/modules/state/state.d.ts

@@ -29,9 +29,9 @@ export class State extends SimpleData {
      * whole action is removed.
      *
      * @param {string} action
-     * @param {string} [token]
+     * @param {number} [token]
      * @returns {this}
      */
-    removeAction(action: string, token?: string): this;
+    removeAction(action: string, token?: number): this;
 }
 import { SimpleData } from '../data/data.js';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@base-framework/base",
-	"version": "3.8.3",
+	"version": "3.9.0",
 	"description": "This is a javascript framework.",
 	"main": "./dist/base.js",
 	"type": "module",