@ms-cloudpack/data-bus 0.3.1 → 0.4.1

package/README.md

@@ -25,6 +25,23 @@ import { createDataBus } from '@ms-cloudpack/data-bus';
 export const bus = createDataBus();
 ```
 
+### Creating data paths
+
+Data in the data bus is represented as a tree. Each node in the tree has a parent and children, and can contain data. To represent the expectations of what data is in each node, we define a data path object and reference it when publishing and subscribing to it. This ensures proper type safety.
+
+The purpose of the `path` parameter is to define the path in the tree where the data lives. This is useful because you can subscribe to any branch of the tree and receive change notifications (via subscriptions or provider activations) for all nodes under that branch.
+
+Example of defining a data path:
+
+```js
+import z from 'zod';
+
+const itemCountPath = createDataPath({
+  path: ['items', 'itemCount'],
+  type: z.number(),
+});
+```
+
 ### Subscribing to data
 
 The data bus provides a method `subscribe` for consumers to subscribe to different types of data. As that data changes, consumers will be notified of changes. Any number of consumers can subscribe for the same data. Data is
@@ -32,7 +49,9 @@ hierarchical, so you can subscribe to a full branch, or to a leaf node within th
 string arrays.
 
 ```js
-const dispose = bus.subscribe(['produce', 'apples'], (data, path) => {
+import { itemCountPath } from './dataPaths';
+
+const dispose = bus.subscribe(itemCountPath, (count) => {
   console.log(`${data} (${path.join('/')})`);
 });
 ```
@@ -44,9 +63,12 @@ Callers can unsubscribe from data by calling the `dispose` function returned fro
 Data can be published using the `publish` api:
 
 ```js
-bus.publish(['produce', 'apples'], 42);
+import { itemCountPath } from './dataPaths';
 
-// The subscriber will log "42 (produce/apples)"
+bus.subscribe(itemCountPath, (count) => console.log(count));
+bus.publish(itemCountPath, 42);
+
+// The console will read: 42
 ```
 
 ### Using providers to produce data on demand
@@ -55,20 +77,26 @@ Providers can also be registered with the bus to provide data on demand, so that
 to be gathered unless it is being observed:
 
 ```js
-const intervals = {};
+import { itemCountPath } from './dataPaths';
+
+const intervalId;
 
 bus.addProvider({
-  path: ['produce'],
-  onActivate: (path) => {
+  path: itemCountPath,
+
+  // Called when activated.
+  onActivate: (itemCountPath) => {
     let counter = 0;
-    interfaces[path.join('/')] = setInterval(() => {
-      bus.publish(type, id, counter++);
+
+    intervalId = setInterval(() => {
+      bus.publish(itemCountPath, counter++);
     }, 1000);
   },
-  onDeactivate: (path) => {
-    const pathId = path.join('/');
-    clearInterval(intervals[pathId]);
-    delete intervals[pathId];
+
+  // Called when deactivated.
+  onDeactivate: (itemCountPath) => {
+    bus.publish(itemCountPath, 0);
+    clearInterval(intervalId);
   },
 });
 ```
@@ -83,7 +111,9 @@ redundantly.
 In some cases, we may need to simply read the data without subscribing. In this case, the `getData` api can be used:
 
 ```js
-const currentValue = bus.getData(['some-data-type', 'some-data-id']);
+import { itemCountPath } from './dataPaths';
+
+const currentValue = bus.getData(itemCountPath);
 ```
 
 ## Motivation

package/lib/createDataBus.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createDataBus.d.ts","sourceRoot":"","sources":["../src/createDataBus.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAGlD;;GAEG;AACH,wBAAgB,aAAa,IAAI,OAAO,CAyCvC"}
+{"version":3,"file":"createDataBus.d.ts","sourceRoot":"","sources":["../src/createDataBus.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAIlD;;GAEG;AACH,wBAAgB,aAAa,IAAI,OAAO,CAmDvC"}

package/lib/createDataBus.js

@@ -12,12 +12,17 @@ export function createDataBus() {
     };
     const disposables = [];
     const bus = {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        publish: (path, value) => publish(state, bus, path, value),
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        getData: (path) => getData(state, path),
-        subscribe: (path, change) => {
-            const internalDispose = subscribe(state, bus, path, change);
+        publish(path, value) {
+            const publishPath = Array.isArray(path) ? path : path.path;
+            return publish(state, bus, publishPath, value);
+        },
+        getData(path) {
+            const publishPath = Array.isArray(path) ? path : path.path;
+            return getData(state, publishPath);
+        },
+        subscribe(path, change) {
+            const publishPath = Array.isArray(path) ? path : path.path;
+            const internalDispose = subscribe(state, bus, publishPath, change);
             const dispose = () => {
                 const index = disposables.indexOf(dispose);
                 if (index !== -1) {
@@ -28,8 +33,10 @@ export function createDataBus() {
             disposables.push(dispose);
             return dispose;
         },
-        addProvider: (provider) => addProvider(state, provider),
-        dispose: () => {
+        addProvider(provider) {
+            addProvider(state, provider);
+        },
+        dispose() {
             for (const dispose of disposables) {
                 dispose();
             }

package/lib/createDataBus.js.map

@@ -1 +1 @@
-{"version":3,"file":"createDataBus.js","sourceRoot":"","sources":["../src/createDataBus.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAO3C;;GAEG;AACH,MAAM,UAAU,aAAa;IAC3B,MAAM,KAAK,GAAiB;QAC1B,IAAI,EAAE,UAAU,EAAE;KACnB,CAAC;IAEF,MAAM,WAAW,GAAsB,EAAE,CAAC;IAC1C,MAAM,GAAG,GAAG;QACV,8DAA8D;QAC9D,OAAO,EAAE,CAAC,IAAc,EAAE,KAAU,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC;QAEzE,8DAA8D;QAC9D,OAAO,EAAE,CAAc,IAAc,EAAE,EAAE,CAAC,OAAO,CAAQ,KAAK,EAAE,IAAI,CAAC;QAErE,SAAS,EAAE,CAAC,IAAc,EAAE,MAA6B,EAAE,EAAE;YAC3D,MAAM,eAAe,GAAG,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;YAE5D,MAAM,OAAO,GAAG,GAAG,EAAE;gBACnB,MAAM,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBAE3C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;oBAChB,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;iBAC9B;gBAED,eAAe,EAAE,CAAC;YACpB,CAAC,CAAC;YAEF,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE1B,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,WAAW,EAAE,CAAC,QAAyB,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC;QAExE,OAAO,EAAE,GAAG,EAAE;YACZ,KAAK,MAAM,OAAO,IAAI,WAAW,EAAE;gBACjC,OAAO,EAAE,CAAC;aACX;QACH,CAAC;KACF,CAAC;IAEF,OAAO,GAAG,CAAC;AACb,CAAC","sourcesContent":["import { addProvider } from './addProvider.js';\nimport { createNode } from './createNode.js';\nimport { getData } from './getData.js';\nimport { publish } from './publish.js';\nimport { subscribe } from './subscribe.js';\nimport type { DataBusChangeFunction } from './types/DataBusChangeFunction.js';\nimport type { DataBusProvider } from './types/DataBusProvider.js';\nimport type { DataBusState } from './types/DataBusState.js';\nimport type { DataBus } from './types/DataBus.js';\nimport type { DisposeFunction } from './types/DisposeFunction.js';\n\n/**\n * Creates a new data bus instance.\n */\nexport function createDataBus(): DataBus {\n  const state: DataBusState = {\n    root: createNode(),\n  };\n\n  const disposables: DisposeFunction[] = [];\n  const bus = {\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    publish: (path: string[], value: any) => publish(state, bus, path, value),\n\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    getData: <TData = any>(path: string[]) => getData<TData>(state, path),\n\n    subscribe: (path: string[], change: DataBusChangeFunction) => {\n      const internalDispose = subscribe(state, bus, path, change);\n\n      const dispose = () => {\n        const index = disposables.indexOf(dispose);\n\n        if (index !== -1) {\n          disposables.splice(index, 1);\n        }\n\n        internalDispose();\n      };\n\n      disposables.push(dispose);\n\n      return dispose;\n    },\n\n    addProvider: (provider: DataBusProvider) => addProvider(state, provider),\n\n    dispose: () => {\n      for (const dispose of disposables) {\n        dispose();\n      }\n    },\n  };\n\n  return bus;\n}\n"]}
+{"version":3,"file":"createDataBus.js","sourceRoot":"","sources":["../src/createDataBus.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAQ3C;;GAEG;AACH,MAAM,UAAU,aAAa;IAC3B,MAAM,KAAK,GAAiB;QAC1B,IAAI,EAAE,UAAU,EAAE;KACnB,CAAC;IAEF,MAAM,WAAW,GAAsB,EAAE,CAAC;IAE1C,MAAM,GAAG,GAAY;QACnB,OAAO,CAAQ,IAA4B,EAAE,KAAY;YACvD,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YAE3D,OAAO,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;QACjD,CAAC;QAED,OAAO,CAAQ,IAA4B;YACzC,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YAE3D,OAAO,OAAO,CAAQ,KAAK,EAAE,WAAW,CAAC,CAAC;QAC5C,CAAC;QAED,SAAS,CAAC,IAA4B,EAAE,MAA6B;YACnE,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YAC3D,MAAM,eAAe,GAAG,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;YAEnE,MAAM,OAAO,GAAG,GAAG,EAAE;gBACnB,MAAM,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBAE3C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;oBAChB,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;iBAC9B;gBAED,eAAe,EAAE,CAAC;YACpB,CAAC,CAAC;YAEF,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE1B,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,WAAW,CAAC,QAAyB;YACnC,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAC/B,CAAC;QAED,OAAO;YACL,KAAK,MAAM,OAAO,IAAI,WAAW,EAAE;gBACjC,OAAO,EAAE,CAAC;aACX;QACH,CAAC;KACF,CAAC;IAEF,OAAO,GAAG,CAAC;AACb,CAAC","sourcesContent":["import { addProvider } from './addProvider.js';\nimport { createNode } from './createNode.js';\nimport { getData } from './getData.js';\nimport { publish } from './publish.js';\nimport { subscribe } from './subscribe.js';\nimport type { DataBusChangeFunction } from './types/DataBusChangeFunction.js';\nimport type { DataBusProvider } from './types/DataBusProvider.js';\nimport type { DataBusState } from './types/DataBusState.js';\nimport type { DataBus } from './types/DataBus.js';\nimport type { DisposeFunction } from './types/DisposeFunction.js';\nimport type { DataBusPath } from './index.js';\n\n/**\n * Creates a new data bus instance.\n */\nexport function createDataBus(): DataBus {\n  const state: DataBusState = {\n    root: createNode(),\n  };\n\n  const disposables: DisposeFunction[] = [];\n\n  const bus: DataBus = {\n    publish<TData>(path: string[] | DataBusPath, value: TData) {\n      const publishPath = Array.isArray(path) ? path : path.path;\n\n      return publish(state, bus, publishPath, value);\n    },\n\n    getData<TData>(path: string[] | DataBusPath) {\n      const publishPath = Array.isArray(path) ? path : path.path;\n\n      return getData<TData>(state, publishPath);\n    },\n\n    subscribe(path: string[] | DataBusPath, change: DataBusChangeFunction) {\n      const publishPath = Array.isArray(path) ? path : path.path;\n      const internalDispose = subscribe(state, bus, publishPath, change);\n\n      const dispose = () => {\n        const index = disposables.indexOf(dispose);\n\n        if (index !== -1) {\n          disposables.splice(index, 1);\n        }\n\n        internalDispose();\n      };\n\n      disposables.push(dispose);\n\n      return dispose;\n    },\n\n    addProvider(provider: DataBusProvider) {\n      addProvider(state, provider);\n    },\n\n    dispose() {\n      for (const dispose of disposables) {\n        dispose();\n      }\n    },\n  };\n\n  return bus;\n}\n"]}

package/lib/createDataPath.d.ts

@@ -0,0 +1,10 @@
+import type z from 'zod';
+import type { DataBusPath } from './types/DataBusPath.js';
+/**
+ * Helper to make source typing and paths joined in a structure.
+ */
+export declare function createDataPath<TZodType extends z.ZodType>(options: {
+    path: string[];
+    type: TZodType;
+}): DataBusPath<TZodType>;
+//# sourceMappingURL=createDataPath.d.ts.map

package/lib/createDataPath.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createDataPath.d.ts","sourceRoot":"","sources":["../src/createDataPath.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAE1D;;GAEG;AACH,wBAAgB,cAAc,CAAC,QAAQ,SAAS,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE;IAClE,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,IAAI,EAAE,QAAQ,CAAC;CAChB,GAAG,WAAW,CAAC,QAAQ,CAAC,CAExB"}

package/lib/createDataPath.js

@@ -0,0 +1,7 @@
+/**
+ * Helper to make source typing and paths joined in a structure.
+ */
+export function createDataPath(options) {
+    return options;
+}
+//# sourceMappingURL=createDataPath.js.map

package/lib/createDataPath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createDataPath.js","sourceRoot":"","sources":["../src/createDataPath.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,UAAU,cAAc,CAA6B,OAG1D;IACC,OAAO,OAAO,CAAC;AACjB,CAAC","sourcesContent":["import type z from 'zod';\nimport type { DataBusPath } from './types/DataBusPath.js';\n\n/**\n * Helper to make source typing and paths joined in a structure.\n */\nexport function createDataPath<TZodType extends z.ZodType>(options: {\n  path: string[];\n  type: TZodType;\n}): DataBusPath<TZodType> {\n  return options;\n}\n"]}

package/lib/index.d.ts

@@ -1,8 +1,10 @@
-export { createDataBus } from './createDataBus.js';
 export type { DataBus } from './types/DataBus.js';
 export type { DataBusChangeFunction } from './types/DataBusChangeFunction.js';
 export type { DataBusNode } from './types/DataBusNode.js';
+export type { DataBusPath } from './types/DataBusPath.js';
 export type { DataBusProvider } from './types/DataBusProvider.js';
 export type { DataBusState } from './types/DataBusState.js';
 export type { DisposeFunction } from './types/DisposeFunction.js';
+export { createDataBus } from './createDataBus.js';
+export { createDataPath } from './createDataPath.js';
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,YAAY,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAClD,YAAY,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AAC9E,YAAY,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC1D,YAAY,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAClE,YAAY,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAC5D,YAAY,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAClD,YAAY,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AAC9E,YAAY,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC1D,YAAY,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC1D,YAAY,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAClE,YAAY,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAC5D,YAAY,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAElE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC"}

package/lib/index.js

@@ -1,2 +1,3 @@
 export { createDataBus } from './createDataBus.js';
+export { createDataPath } from './createDataPath.js';
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC","sourcesContent":["export { createDataBus } from './createDataBus.js';\nexport type { DataBus } from './types/DataBus.js';\nexport type { DataBusChangeFunction } from './types/DataBusChangeFunction.js';\nexport type { DataBusNode } from './types/DataBusNode.js';\nexport type { DataBusProvider } from './types/DataBusProvider.js';\nexport type { DataBusState } from './types/DataBusState.js';\nexport type { DisposeFunction } from './types/DisposeFunction.js';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC","sourcesContent":["export type { DataBus } from './types/DataBus.js';\nexport type { DataBusChangeFunction } from './types/DataBusChangeFunction.js';\nexport type { DataBusNode } from './types/DataBusNode.js';\nexport type { DataBusPath } from './types/DataBusPath.js';\nexport type { DataBusProvider } from './types/DataBusProvider.js';\nexport type { DataBusState } from './types/DataBusState.js';\nexport type { DisposeFunction } from './types/DisposeFunction.js';\n\nexport { createDataBus } from './createDataBus.js';\nexport { createDataPath } from './createDataPath.js';\n"]}

package/lib/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.36.1"
+      "packageVersion": "7.36.4"
     }
   ]
 }

package/lib/types/DataBus.d.ts

@@ -1,10 +1,15 @@
 import type { DataBusChangeFunction } from './DataBusChangeFunction.js';
 import type { DisposeFunction } from './DisposeFunction.js';
 import type { DataBusProvider } from './DataBusProvider.js';
+import type { DataBusPath } from './DataBusPath.js';
+import type z from 'zod';
 export interface DataBus {
-    publish: <TData = any>(path: string[], value: TData) => void;
-    subscribe: <TData = any>(path: string[], callback: DataBusChangeFunction<TData>) => DisposeFunction;
-    getData: <TData = any>(path: string[]) => TData | undefined;
+    publish<TData = any>(path: string[], value: TData): void;
+    publish<TZodData extends z.ZodType>(path: DataBusPath<TZodData>, value: z.infer<TZodData>): void;
+    subscribe<TData = any>(path: string[], callback: DataBusChangeFunction<TData>): DisposeFunction;
+    subscribe<TZodData extends z.ZodType>(path: DataBusPath<TZodData>, callback: DataBusChangeFunction<z.infer<TZodData>>): DisposeFunction;
+    getData<TData = any>(path: string[]): TData | undefined;
+    getData<TZodData extends z.ZodType = z.ZodAny>(path: DataBusPath<TZodData>): z.infer<TZodData> | undefined;
     addProvider: (provider: DataBusProvider) => void;
     dispose: () => void;
 }

package/lib/types/DataBus.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DataBus.d.ts","sourceRoot":"","sources":["../../src/types/DataBus.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D,MAAM,WAAW,OAAO;IAEtB,OAAO,EAAE,CAAC,KAAK,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAE7D,SAAS,EAAE,CAAC,KAAK,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,qBAAqB,CAAC,KAAK,CAAC,KAAK,eAAe,CAAC;IAEpG,OAAO,EAAE,CAAC,KAAK,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,KAAK,GAAG,SAAS,CAAC;IAC5D,WAAW,EAAE,CAAC,QAAQ,EAAE,eAAe,KAAK,IAAI,CAAC;IACjD,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB"}
+{"version":3,"file":"DataBus.d.ts","sourceRoot":"","sources":["../../src/types/DataBus.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,MAAM,WAAW,OAAO;IAEtB,OAAO,CAAC,KAAK,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACzD,OAAO,CAAC,QAAQ,SAAS,CAAC,CAAC,OAAO,EAAE,IAAI,EAAE,WAAW,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAGjG,SAAS,CAAC,KAAK,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,qBAAqB,CAAC,KAAK,CAAC,GAAG,eAAe,CAAC;IAChG,SAAS,CAAC,QAAQ,SAAS,CAAC,CAAC,OAAO,EAClC,IAAI,EAAE,WAAW,CAAC,QAAQ,CAAC,EAC3B,QAAQ,EAAE,qBAAqB,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GACjD,eAAe,CAAC;IAGnB,OAAO,CAAC,KAAK,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,KAAK,GAAG,SAAS,CAAC;IACxD,OAAO,CAAC,QAAQ,SAAS,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC;IAE3G,WAAW,EAAE,CAAC,QAAQ,EAAE,eAAe,KAAK,IAAI,CAAC;IAEjD,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB"}

package/lib/types/DataBus.js.map

@@ -1 +1 @@
-{"version":3,"file":"DataBus.js","sourceRoot":"","sources":["../../src/types/DataBus.ts"],"names":[],"mappings":"","sourcesContent":["import type { DataBusChangeFunction } from './DataBusChangeFunction.js';\nimport type { DisposeFunction } from './DisposeFunction.js';\nimport type { DataBusProvider } from './DataBusProvider.js';\n\nexport interface DataBus {\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  publish: <TData = any>(path: string[], value: TData) => void;\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  subscribe: <TData = any>(path: string[], callback: DataBusChangeFunction<TData>) => DisposeFunction;\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  getData: <TData = any>(path: string[]) => TData | undefined;\n  addProvider: (provider: DataBusProvider) => void;\n  dispose: () => void;\n}\n"]}
+{"version":3,"file":"DataBus.js","sourceRoot":"","sources":["../../src/types/DataBus.ts"],"names":[],"mappings":"","sourcesContent":["import type { DataBusChangeFunction } from './DataBusChangeFunction.js';\nimport type { DisposeFunction } from './DisposeFunction.js';\nimport type { DataBusProvider } from './DataBusProvider.js';\nimport type { DataBusPath } from './DataBusPath.js';\nimport type z from 'zod';\nexport interface DataBus {\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  publish<TData = any>(path: string[], value: TData): void;\n  publish<TZodData extends z.ZodType>(path: DataBusPath<TZodData>, value: z.infer<TZodData>): void;\n\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  subscribe<TData = any>(path: string[], callback: DataBusChangeFunction<TData>): DisposeFunction;\n  subscribe<TZodData extends z.ZodType>(\n    path: DataBusPath<TZodData>,\n    callback: DataBusChangeFunction<z.infer<TZodData>>,\n  ): DisposeFunction;\n\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  getData<TData = any>(path: string[]): TData | undefined;\n  getData<TZodData extends z.ZodType = z.ZodAny>(path: DataBusPath<TZodData>): z.infer<TZodData> | undefined;\n\n  addProvider: (provider: DataBusProvider) => void;\n\n  dispose: () => void;\n}\n"]}

package/lib/types/DataBusPath.d.ts

@@ -0,0 +1,12 @@
+import type z from 'zod';
+export type DataBusPath<TZodData extends z.ZodType = z.ZodUnknown> = {
+    /**
+     * Path to the data within the databus tree.
+     */
+    path: string[];
+    /**
+     * The type of the data, represented by a zod schema.
+     */
+    type: TZodData;
+};
+//# sourceMappingURL=DataBusPath.d.ts.map

package/lib/types/DataBusPath.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataBusPath.d.ts","sourceRoot":"","sources":["../../src/types/DataBusPath.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,MAAM,MAAM,WAAW,CAAC,QAAQ,SAAS,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,UAAU,IAAI;IACnE;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;CAChB,CAAC"}

package/lib/types/DataBusPath.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=DataBusPath.js.map

package/lib/types/DataBusPath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataBusPath.js","sourceRoot":"","sources":["../../src/types/DataBusPath.ts"],"names":[],"mappings":"","sourcesContent":["import type z from 'zod';\n\nexport type DataBusPath<TZodData extends z.ZodType = z.ZodUnknown> = {\n  /**\n   * Path to the data within the databus tree.\n   */\n  path: string[];\n\n  /**\n   * The type of the data, represented by a zod schema.\n   */\n  type: TZodData;\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/data-bus",
-  "version": "0.3.1",
+  "version": "0.4.1",
   "description": "A data bus implementation.",
   "license": "MIT",
   "type": "module",
@@ -8,6 +8,7 @@
   "sideEffects": false,
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./lib/index.d.ts",
       "import": "./lib/index.js"
     }
@@ -22,6 +23,9 @@
     "test:watch": "cloudpack-scripts test-watch",
     "test": "cloudpack-scripts test"
   },
+  "dependencies": {
+    "zod": "^3.21.4"
+  },
   "devDependencies": {
     "@ms-cloudpack/eslint-plugin-internal": "*",
     "@ms-cloudpack/scripts": "*"