@unyt/datex 0.0.7 → 0.0.9

package/esm/dif/display.d.ts

@@ -1,8 +1,31 @@
+/**
+ * @module
+ * @description
+ * This module contains helper functions to convert DIF structures to display strings.
+ */
 import { type DIFReference, DIFReferenceMutability, type DIFRepresentationValue, type DIFTypeContainer, type DIFValueContainer } from "./definitions.js";
+/**
+ * Converts a DIF reference mutability to a display string.
+ */
 export declare function mutabilityToDisplayString(mut: DIFReferenceMutability): string;
+/**
+ * Converts a DIF reference to a display string.
+ */
 export declare function difReferenceToDisplayString(reference: DIFReference): string;
+/**
+ * Converts a DIF value container to a display string.
+ */
 export declare function difValueContainerToDisplayString(container: DIFValueContainer): string;
+/**
+ * Converts a DIF representation value to a display string.
+ */
 export declare function difRepresentationValueToDisplayString(difRepValue: DIFRepresentationValue): string;
+/**
+ * Converts a DIF type container to a display string.
+ */
 export declare function difTypeContainerToDisplayString(difType: DIFTypeContainer): string;
+/**
+ * Converts a core type address to a display string.
+ */
 export declare function addressToDisplayString(address: string): string;
 //# sourceMappingURL=display.d.ts.map

package/esm/dif/display.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"display.d.ts","sourceRoot":"","sources":["../../src/dif/display.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,KAAK,YAAY,EACjB,sBAAsB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACzB,MAAM,kBAAkB,CAAC;AAE1B,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,sBAAsB,GAAG,MAAM,CAS7E;AAED,wBAAgB,2BAA2B,CACvC,SAAS,EAAE,YAAY,GACxB,MAAM,CAKR;AAED,wBAAgB,gCAAgC,CAC5C,SAAS,EAAE,iBAAiB,GAC7B,MAAM,CAgBR;AAED,wBAAgB,qCAAqC,CACjD,WAAW,EAAE,sBAAsB,GACpC,MAAM,CAyBR;AAED,wBAAgB,+BAA+B,CAC3C,OAAO,EAAE,gBAAgB,GAC1B,MAAM,CAQR;AAED,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAS9D"}
+{"version":3,"file":"display.d.ts","sourceRoot":"","sources":["../../src/dif/display.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EACH,KAAK,YAAY,EACjB,sBAAsB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACzB,MAAM,kBAAkB,CAAC;AAG1B;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,sBAAsB,GAAG,MAAM,CAO7E;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CACvC,SAAS,EAAE,YAAY,GACxB,MAAM,CAKR;AAED;;GAEG;AACH,wBAAgB,gCAAgC,CAC5C,SAAS,EAAE,iBAAiB,GAC7B,MAAM,CAgBR;AAED;;GAEG;AACH,wBAAgB,qCAAqC,CACjD,WAAW,EAAE,sBAAsB,GACpC,MAAM,CAyBR;AAED;;GAEG;AACH,wBAAgB,+BAA+B,CAC3C,OAAO,EAAE,gBAAgB,GAC1B,MAAM,CAQR;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAS9D"}

package/esm/dif/display.js

@@ -1,22 +1,34 @@
-import { CoreTypeAddress, DIFReferenceMutability, } from "./definitions.js";
+/**
+ * @module
+ * @description
+ * This module contains helper functions to convert DIF structures to display strings.
+ */
+import { DIFReferenceMutability, } from "./definitions.js";
+import { CoreTypeAddress } from "./core.js";
+/**
+ * Converts a DIF reference mutability to a display string.
+ */
 export function mutabilityToDisplayString(mut) {
     if (mut === DIFReferenceMutability.Mutable) {
         return "&mut ";
     }
-    else if (mut === DIFReferenceMutability.Final) {
-        return "&final ";
-    }
     else if (mut === DIFReferenceMutability.Immutable) {
         return "&";
     }
     throw new Error("Unknown mutability: " + mut);
 }
+/**
+ * Converts a DIF reference to a display string.
+ */
 export function difReferenceToDisplayString(reference) {
     const typeString = difTypeContainerToDisplayString(reference.allowed_type);
     const valueString = difValueContainerToDisplayString(reference.value);
     const mutString = mutabilityToDisplayString(reference.mut);
     return `${mutString}${valueString} (allowed: ${typeString})`;
 }
+/**
+ * Converts a DIF value container to a display string.
+ */
 export function difValueContainerToDisplayString(container) {
     if (typeof container === "string") {
         return addressToDisplayString(container);
@@ -34,6 +46,9 @@ export function difValueContainerToDisplayString(container) {
         }
     }
 }
+/**
+ * Converts a DIF representation value to a display string.
+ */
 export function difRepresentationValueToDisplayString(difRepValue) {
     if (Array.isArray(difRepValue)) {
         return `[${difRepValue.map((v) => {
@@ -53,6 +68,9 @@ export function difRepresentationValueToDisplayString(difRepValue) {
         return JSON.stringify(difRepValue);
     }
 }
+/**
+ * Converts a DIF type container to a display string.
+ */
 export function difTypeContainerToDisplayString(difType) {
     if (typeof difType === "string") {
         return addressToDisplayString(difType);
@@ -61,6 +79,9 @@ export function difTypeContainerToDisplayString(difType) {
         return `{ name: ${difType.name}, kind: ${difType.kind}, def: ${JSON.stringify(difType.def)}, mut: ${difType.mut} }`;
     }
 }
+/**
+ * Converts a core type address to a display string.
+ */
 export function addressToDisplayString(address) {
     const found = Object.entries(CoreTypeAddress).find(([_, addr]) => {
         return addr === address;

package/esm/dif/mod.d.ts

@@ -0,0 +1,5 @@
+export * as Definitions from "./definitions.js";
+export * as Builders from "./builders.js";
+export * as Display from "./display.js";
+export { CoreTypeAddress } from "./core.js";
+//# sourceMappingURL=mod.d.ts.map

package/esm/dif/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../src/dif/mod.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC"}

package/esm/dif/mod.js

@@ -0,0 +1,4 @@
+export * as Definitions from "./definitions.js";
+export * as Builders from "./builders.js";
+export * as Display from "./display.js";
+export { CoreTypeAddress } from "./core.js";

package/esm/mod.d.ts

@@ -1,12 +1,19 @@
 /**
  * @module mod.ts
  * @description
- * This module exports an instance of the DATEX runtime.
+ * This module exports all public APIs of the DATEX runtime.
  */
-import "./_dnt.polyfills.js";
-import { Runtime } from "./runtime/runtime.js";
+export * from "./runtime/runtime.js";
 /**
- * The default instance of the Datex runtime.
+ * @namespace DIF
+ * @description
+ * This namespace contains all modules related to the DIF (DATEX Interchange Format) interfaces of the DATEX runtime.
+ */
+export * as DIF from "./dif/mod.js";
+/**
+ * @namespace Network
+ * @description
+ * This namespace contains all modules related to the network interfaces of the DATEX runtime.
  */
-export declare const Datex: Runtime;
+export * as Network from "./network/mod.js";
 //# sourceMappingURL=mod.d.ts.map

package/esm/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,qBAAqB,CAAC;AAG7B,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAa/C;;GAEG;AACH,eAAO,MAAM,KAAK,EAAE,OAElB,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,qBAAqB,CAAC;AAG7B,cAAc,sBAAsB,CAAC;AACrC;;;;GAIG;AACH,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC;;;;GAIG;AACH,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC"}

package/esm/mod.js

@@ -1,31 +1,18 @@
 /**
  * @module mod.ts
  * @description
- * This module exports an instance of the DATEX runtime.
+ * This module exports all public APIs of the DATEX runtime.
  */
-import "./_dnt.polyfills.js";
-import { Runtime } from "./runtime/runtime.js";
+export * from "./runtime/runtime.js";
 /**
- * The default configuration for the Datex runtime.
+ * @namespace DIF
+ * @description
+ * This namespace contains all modules related to the DIF (DATEX Interchange Format) interfaces of the DATEX runtime.
  */
-const defaultConfig = {
-    interfaces: [{
-            type: "websocket-client",
-            config: { address: "wss://example.unyt.land" },
-        }],
-    debug: false, // set to true to show info/debug messages
-};
+export * as DIF from "./dif/mod.js";
 /**
- * The default instance of the Datex runtime.
+ * @namespace Network
+ * @description
+ * This namespace contains all modules related to the network interfaces of the DATEX runtime.
  */
-export const Datex = await Runtime.create(defaultConfig, {
-    allow_unsigned_blocks: true,
-});
-// try {
-//     console.log(
-//         "@example responded with:",
-//         await Datex.execute("@example :: 'Hello, World!'"),
-//     );
-// } catch (error) {
-//     console.error("Could not reach @example", error);
-// }
+export * as Network from "./network/mod.js";

package/esm/network/com-hub.d.ts

@@ -1,9 +1,22 @@
 import type { JSComHub } from "../datex-core/datex_core_js";
 import { ComInterface, type ComInterfaceImpl } from "./com-interface.js";
+/**
+ * Communication hub for managing communication interfaces.
+ */
 export declare class ComHub {
     #private;
     constructor(jsComHub: JSComHub);
+    /**
+     * Registers a communication interface implementation.
+     * @param interfaceType The type of the interface.
+     * @param impl The implementation class of the interface.
+     */
     static registerInterfaceImpl<N extends string>(interfaceType: N, impl: typeof ComInterfaceImpl<unknown>): void;
+    /**
+     * Creates a new communication interface.
+     * @param interfaceType The type of the interface to create.
+     * @param setupData The setup data for the interface.
+     */
     createInterface<T extends typeof ComInterfaceImpl<unknown>>(interfaceType: T, setupData: T extends typeof ComInterfaceImpl<infer P> ? P : never): Promise<ComInterface<InstanceType<T>>>;
     createInterface<T extends ComInterfaceImpl<unknown>>(interfaceType: string, setupData: T extends ComInterfaceImpl<infer P> ? P : never): Promise<ComInterface<T>>;
     _update(): Promise<void>;
@@ -17,6 +30,23 @@ export declare class ComHub {
      * @param endpoint The endpoint for which to print the trace.
      */
     printTrace(endpoint: string): Promise<void>;
+    /**
+     * Sends a block of data to a specific interface and socket.
+     * @param block The data block to send.
+     * @param interface_uuid The UUID of the interface to send the block to.
+     * @param socket_uuid The UUID of the socket to send the block to.
+     * @returns A promise that resolves to true if the block was sent successfully, false otherwise.
+     */
     sendBlock(block: Uint8Array, interface_uuid: string, socket_uuid: string): Promise<boolean>;
+    /**
+     * Registers a callback to intercept incoming blocks.
+     * @param callback The callback to be invoked for each incoming block.
+     */
+    registerIncomingBlockInterceptor(callback: (block: Uint8Array, socket_uuid: string) => void): void;
+    /**
+     * Registers a callback to intercept outgoing blocks.
+     * @param callback The callback to be invoked for each outgoing block.
+     */
+    registerOutgoingBlockInterceptor(callback: (block: Uint8Array, socket_uuid: string, endpoints: string[]) => void): void;
 }
 //# sourceMappingURL=com-hub.d.ts.map

package/esm/network/com-hub.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"com-hub.d.ts","sourceRoot":"","sources":["../../src/network/com-hub.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,KAAK,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEzE,qBAAa,MAAM;;gBAYH,QAAQ,EAAE,QAAQ;IAI9B,MAAM,CAAC,qBAAqB,CAAC,CAAC,SAAS,MAAM,EACzC,aAAa,EAAE,CAAC,EAChB,IAAI,EAAE,OAAO,gBAAgB,CAAC,OAAO,CAAC;IAWpC,eAAe,CAAC,CAAC,SAAS,OAAO,gBAAgB,CAAC,OAAO,CAAC,EAC5D,aAAa,EAAE,CAAC,EAChB,SAAS,EAAE,CAAC,SAAS,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,GAClE,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IACnC,eAAe,CACjB,CAAC,SAAS,gBAAgB,CAAC,OAAO,CAAC,EAEnC,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,CAAC,SAAS,gBAAgB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,GAC3D,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAkCpB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxB,sBAAsB,IAAI,UAAU,CAAC,eAAe,CAAC,EAAE;IAI9D;;OAEG;IACI,aAAa,IAAI,IAAI;IAO5B;;;OAGG;IACU,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAWjD,SAAS,CACZ,KAAK,EAAE,UAAU,EACjB,cAAc,EAAE,MAAM,EACtB,WAAW,EAAE,MAAM,GACpB,OAAO,CAAC,OAAO,CAAC;CAGtB"}
+{"version":3,"file":"com-hub.d.ts","sourceRoot":"","sources":["../../src/network/com-hub.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,KAAK,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEzE;;GAEG;AACH,qBAAa,MAAM;;gBAgBH,QAAQ,EAAE,QAAQ;IAI9B;;;;OAIG;IACH,MAAM,CAAC,qBAAqB,CAAC,CAAC,SAAS,MAAM,EACzC,aAAa,EAAE,CAAC,EAChB,IAAI,EAAE,OAAO,gBAAgB,CAAC,OAAO,CAAC;IAW1C;;;;OAIG;IACG,eAAe,CAAC,CAAC,SAAS,OAAO,gBAAgB,CAAC,OAAO,CAAC,EAC5D,aAAa,EAAE,CAAC,EAChB,SAAS,EAAE,CAAC,SAAS,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,GAClE,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IACnC,eAAe,CACjB,CAAC,SAAS,gBAAgB,CAAC,OAAO,CAAC,EAEnC,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,CAAC,SAAS,gBAAgB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,GAC3D,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAkCpB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxB,sBAAsB,IAAI,UAAU,CAAC,eAAe,CAAC,EAAE;IAI9D;;OAEG;IACI,aAAa,IAAI,IAAI;IAO5B;;;OAGG;IACU,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAWxD;;;;;;OAMG;IACI,SAAS,CACZ,KAAK,EAAE,UAAU,EACjB,cAAc,EAAE,MAAM,EACtB,WAAW,EAAE,MAAM,GACpB,OAAO,CAAC,OAAO,CAAC;IAInB;;;OAGG;IACI,gCAAgC,CACnC,QAAQ,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,KAAK,IAAI,GAC3D,IAAI;IAIP;;;OAGG;IACI,gCAAgC,CACnC,QAAQ,EAAE,CACN,KAAK,EAAE,UAAU,EACjB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EAAE,KAClB,IAAI,GACV,IAAI;CAGV"}

package/esm/network/com-hub.js

@@ -11,11 +11,20 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _a, _ComHub_interfaceImpls, _ComHub_interfaceImplsByClass, _ComHub_jsComHub;
 import { ComInterface } from "./com-interface.js";
+/**
+ * Communication hub for managing communication interfaces.
+ */
 export class ComHub {
     constructor(jsComHub) {
+        /** The JS communication hub. */
         _ComHub_jsComHub.set(this, void 0);
         __classPrivateFieldSet(this, _ComHub_jsComHub, jsComHub, "f");
     }
+    /**
+     * Registers a communication interface implementation.
+     * @param interfaceType The type of the interface.
+     * @param impl The implementation class of the interface.
+     */
     static registerInterfaceImpl(interfaceType, impl) {
         if (__classPrivateFieldGet(this, _a, "f", _ComHub_interfaceImpls).has(interfaceType)) {
             throw new Error(`Interface implementation for ${interfaceType} already registered.`);
@@ -68,10 +77,33 @@ export class ComHub {
         }
         console.log(trace);
     }
+    /**
+     * Sends a block of data to a specific interface and socket.
+     * @param block The data block to send.
+     * @param interface_uuid The UUID of the interface to send the block to.
+     * @param socket_uuid The UUID of the socket to send the block to.
+     * @returns A promise that resolves to true if the block was sent successfully, false otherwise.
+     */
     sendBlock(block, interface_uuid, socket_uuid) {
         return __classPrivateFieldGet(this, _ComHub_jsComHub, "f").send_block(block, interface_uuid, socket_uuid);
     }
+    /**
+     * Registers a callback to intercept incoming blocks.
+     * @param callback The callback to be invoked for each incoming block.
+     */
+    registerIncomingBlockInterceptor(callback) {
+        __classPrivateFieldGet(this, _ComHub_jsComHub, "f").register_incoming_block_interceptor(callback);
+    }
+    /**
+     * Registers a callback to intercept outgoing blocks.
+     * @param callback The callback to be invoked for each outgoing block.
+     */
+    registerOutgoingBlockInterceptor(callback) {
+        __classPrivateFieldGet(this, _ComHub_jsComHub, "f").register_outgoing_block_interceptor(callback);
+    }
 }
 _a = ComHub, _ComHub_jsComHub = new WeakMap();
+/** Static map of registered interface implementations. */
 _ComHub_interfaceImpls = { value: new Map() };
+/** Static map of interface implementations by class. */
 _ComHub_interfaceImplsByClass = { value: new Map() };

package/esm/network/com-interface.d.ts

@@ -1,17 +1,35 @@
 import type { JSComHub } from "../datex-core/datex_core_js";
+/**
+ * Abstract base class for communication interface implementations.
+ */
 export declare abstract class ComInterfaceImpl<SetupData> {
     protected readonly uuid: string;
     protected readonly setupData: SetupData;
     protected readonly jsComHub: JSComHub;
     constructor(uuid: string, setupData: SetupData, jsComHub: JSComHub);
+    /**
+     * Initializes the communication interface.
+     */
     init?(): Promise<void> | void;
+    /**
+     * Cleans up the communication interface.
+     */
     cleanup?(): Promise<void> | void;
 }
+/**
+ * Represents a communication interface.
+ */
 export declare class ComInterface<T extends ComInterfaceImpl<unknown>> {
     #private;
+    /** The UUID of the interface. */
     readonly uuid: string;
+    /** The implementation of the interface. */
     readonly impl: T;
     constructor(uuid: string, impl: T, jsComHub: JSComHub);
+    /**
+     * Closes the communication interface.
+     * @returns True if the interface was closed successfully, false otherwise.
+     */
     close(): Promise<boolean>;
 }
 //# sourceMappingURL=com-interface.d.ts.map

package/esm/network/com-interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"com-interface.d.ts","sourceRoot":"","sources":["../../src/network/com-interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAE5D,8BAAsB,gBAAgB,CAAC,SAAS;IAC5C,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAC;IACjC,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAG,SAAS,CAAC;IACzC,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAG,QAAQ,CAAC;gBAE3B,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ;IAMlE,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;IAC7B,OAAO,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;CACnC;AACD,qBAAa,YAAY,CAAC,CAAC,SAAS,gBAAgB,CAAC,OAAO,CAAC;;IACzD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;gBAGL,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,QAAQ;IAMxC,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC;CAIzC"}
+{"version":3,"file":"com-interface.d.ts","sourceRoot":"","sources":["../../src/network/com-interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAE5D;;GAEG;AACH,8BAAsB,gBAAgB,CAAC,SAAS;IAC5C,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAC;IACjC,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAG,SAAS,CAAC;IACzC,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAG,QAAQ,CAAC;gBAE3B,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ;IAKlE;;OAEG;IACH,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;IAC7B;;OAEG;IACH,OAAO,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;CACnC;AAED;;GAEG;AACH,qBAAa,YAAY,CAAC,CAAC,SAAS,gBAAgB,CAAC,OAAO,CAAC;;IACzD,iCAAiC;IACjC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,2CAA2C;IAC3C,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;gBAKL,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,QAAQ;IAMrD;;;OAGG;IACU,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC;CAIzC"}

package/esm/network/com-interface.js

@@ -10,6 +10,9 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _ComInterface_jsComHub;
+/**
+ * Abstract base class for communication interface implementations.
+ */
 export class ComInterfaceImpl {
     constructor(uuid, setupData, jsComHub) {
         Object.defineProperty(this, "uuid", {
@@ -35,25 +38,35 @@ export class ComInterfaceImpl {
         this.jsComHub = jsComHub;
     }
 }
+/**
+ * Represents a communication interface.
+ */
 export class ComInterface {
     constructor(uuid, impl, jsComHub) {
+        /** The UUID of the interface. */
         Object.defineProperty(this, "uuid", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** The implementation of the interface. */
         Object.defineProperty(this, "impl", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** The JS communication hub. */
         _ComInterface_jsComHub.set(this, void 0);
         this.uuid = uuid;
         this.impl = impl;
         __classPrivateFieldSet(this, _ComInterface_jsComHub, jsComHub, "f");
     }
+    /**
+     * Closes the communication interface.
+     * @returns True if the interface was closed successfully, false otherwise.
+     */
     async close() {
         await this.impl.cleanup?.();
         return __classPrivateFieldGet(this, _ComInterface_jsComHub, "f").close_interface(this.uuid);

package/esm/network/interface-impls/base.d.ts

@@ -1,11 +1,38 @@
-import "../../_dnt.polyfills.js";
 import { ComInterfaceImpl } from "../com-interface.js";
 import type { BaseInterfaceSetupData, InterfaceDirection } from "../../datex-core/datex_core_js";
+export type { BaseInterfaceSetupData, InterfaceDirection };
+/**
+ * Implementation of the base communication interface.
+ */
 export declare class BaseInterfaceImpl extends ComInterfaceImpl<BaseInterfaceSetupData> {
+    /**
+     * Registers a socket for the communication interface.
+     * @param interfaceDirection The direction of the interface (incoming/outgoing).
+     * @returns The UUID of the registered socket.
+     */
     registerSocket(interfaceDirection: InterfaceDirection): string;
+    /**
+     * Destroys a socket for the communication interface.
+     * @param socketUUID The UUID of the socket to destroy.
+     */
     destroySocket(socketUUID: string): void;
+    /**
+     * Receives a data block for the communication interface.
+     * @param socketUUID The UUID of the socket to receive data on.
+     * @param data The data block to receive.
+     */
     receive(socketUUID: string, data: Uint8Array): void;
+    /**
+     * Tests sending a data block for the communication interface.
+     * @param socketUUID The UUID of the socket to send data on.
+     * @param data The data block to send.
+     * @returns A promise that resolves to true if the block was sent successfully, false otherwise.
+     */
     testSendBlock(socketUUID: string, data: Uint8Array): Promise<boolean>;
+    /**
+     * Registers a callback to handle sending data blocks.
+     * @param callback The callback to be invoked when sending data.
+     */
     onSend(callback: (data: Uint8Array, receiver_socket_uuid: string) => Promise<boolean>): void;
 }
 //# sourceMappingURL=base.d.ts.map

package/esm/network/interface-impls/base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/network/interface-impls/base.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD,OAAO,KAAK,EACR,sBAAsB,EACtB,kBAAkB,EACrB,MAAM,gCAAgC,CAAC;AAExC,qBAAa,iBACT,SAAQ,gBAAgB,CAAC,sBAAsB,CAAC;IACzC,cAAc,CAAC,kBAAkB,EAAE,kBAAkB;IAOrD,aAAa,CAAC,UAAU,EAAE,MAAM;IAOhC,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU;IAQ5C,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU;IAQlD,MAAM,CACT,QAAQ,EAAE,CACN,IAAI,EAAE,UAAU,EAChB,oBAAoB,EAAE,MAAM,KAC3B,OAAO,CAAC,OAAO,CAAC;CAI5B"}
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/network/interface-impls/base.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD,OAAO,KAAK,EACR,sBAAsB,EACtB,kBAAkB,EACrB,MAAM,gCAAgC,CAAC;AACxC,YAAY,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,CAAC;AAE3D;;GAEG;AACH,qBAAa,iBACT,SAAQ,gBAAgB,CAAC,sBAAsB,CAAC;IAChD;;;;OAIG;IACI,cAAc,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,MAAM;IAOrE;;;OAGG;IACI,aAAa,CAAC,UAAU,EAAE,MAAM;IAOvC;;;;OAIG;IACI,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU;IAQnD;;;;;OAKG;IACI,aAAa,CAChB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,UAAU,GACjB,OAAO,CAAC,OAAO,CAAC;IAQnB;;;OAGG;IACI,MAAM,CACT,QAAQ,EAAE,CACN,IAAI,EAAE,UAAU,EAChB,oBAAoB,EAAE,MAAM,KAC3B,OAAO,CAAC,OAAO,CAAC;CAI5B"}

package/esm/network/interface-impls/base.js

@@ -1,21 +1,47 @@
-import "../../_dnt.polyfills.js";
 import { ComInterfaceImpl } from "../com-interface.js";
 import { ComHub } from "../com-hub.js";
+/**
+ * Implementation of the base communication interface.
+ */
 export class BaseInterfaceImpl extends ComInterfaceImpl {
+    /**
+     * Registers a socket for the communication interface.
+     * @param interfaceDirection The direction of the interface (incoming/outgoing).
+     * @returns The UUID of the registered socket.
+     */
     registerSocket(interfaceDirection) {
         return this.jsComHub.base_interface_register_socket(this.uuid, interfaceDirection);
     }
+    /**
+     * Destroys a socket for the communication interface.
+     * @param socketUUID The UUID of the socket to destroy.
+     */
     destroySocket(socketUUID) {
-        return this.jsComHub.base_interface_destroy_socket(this.uuid, socketUUID);
+        this.jsComHub.base_interface_destroy_socket(this.uuid, socketUUID);
     }
+    /**
+     * Receives a data block for the communication interface.
+     * @param socketUUID The UUID of the socket to receive data on.
+     * @param data The data block to receive.
+     */
     receive(socketUUID, data) {
-        return this.jsComHub.base_interface_receive(this.uuid, socketUUID, data);
+        this.jsComHub.base_interface_receive(this.uuid, socketUUID, data);
     }
+    /**
+     * Tests sending a data block for the communication interface.
+     * @param socketUUID The UUID of the socket to send data on.
+     * @param data The data block to send.
+     * @returns A promise that resolves to true if the block was sent successfully, false otherwise.
+     */
     testSendBlock(socketUUID, data) {
         return this.jsComHub.base_interface_test_send_block(this.uuid, socketUUID, data);
     }
+    /**
+     * Registers a callback to handle sending data blocks.
+     * @param callback The callback to be invoked when sending data.
+     */
     onSend(callback) {
-        return this.jsComHub.base_interface_on_send(this.uuid, callback);
+        this.jsComHub.base_interface_on_send(this.uuid, callback);
     }
 }
 ComHub.registerInterfaceImpl("base", BaseInterfaceImpl);

package/esm/network/interface-impls/websocket-client.d.ts

@@ -1,6 +1,8 @@
-import "../../_dnt.polyfills.js";
 import { ComInterfaceImpl } from "../com-interface.js";
 import type { WebSocketClientInterfaceSetupData } from "../../datex-core/datex_core_js";
+/**
+ * Implementation of the WebSocket client communication interface.
+ */
 export declare class WebSocketClientInterfaceImpl extends ComInterfaceImpl<WebSocketClientInterfaceSetupData> {
 }
 //# sourceMappingURL=websocket-client.d.ts.map

package/esm/network/interface-impls/websocket-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"websocket-client.d.ts","sourceRoot":"","sources":["../../../src/network/interface-impls/websocket-client.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,gCAAgC,CAAC;AAGxF,qBAAa,4BACT,SAAQ,gBAAgB,CAAC,iCAAiC,CAAC;CAC9D"}
+{"version":3,"file":"websocket-client.d.ts","sourceRoot":"","sources":["../../../src/network/interface-impls/websocket-client.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,gCAAgC,CAAC;AAGxF;;GAEG;AACH,qBAAa,4BACT,SAAQ,gBAAgB,CAAC,iCAAiC,CAAC;CAC9D"}

package/esm/network/interface-impls/websocket-client.js

@@ -1,6 +1,8 @@
-import "../../_dnt.polyfills.js";
 import { ComInterfaceImpl } from "../com-interface.js";
 import { ComHub } from "../com-hub.js";
+/**
+ * Implementation of the WebSocket client communication interface.
+ */
 export class WebSocketClientInterfaceImpl extends ComInterfaceImpl {
 }
 ComHub.registerInterfaceImpl("websocket-client", WebSocketClientInterfaceImpl);

package/esm/network/mod.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @module network/mod.ts
+ * @description
+ * This module re-exports all network-related functionalities, including
+ * communication hubs and interfaces.
+ */
+export * from "./com-hub.js";
+export * from "./com-interface.js";
+//# sourceMappingURL=mod.d.ts.map

package/esm/network/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../src/network/mod.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC"}

package/esm/network/mod.js

@@ -0,0 +1,8 @@
+/**
+ * @module network/mod.ts
+ * @description
+ * This module re-exports all network-related functionalities, including
+ * communication hubs and interfaces.
+ */
+export * from "./com-hub.js";
+export * from "./com-interface.js";

package/esm/refs/ref.d.ts

@@ -6,6 +6,9 @@ import type { DIFHandler } from "../dif/dif-handler.js";
 export declare class Ref<T> {
     #private;
     constructor(value: T, pointerAddress: string, difHandler: DIFHandler);
+    /**
+     * Gets the address of the pointer storing the reference.
+     */
     get pointerAddress(): string;
     /**
      * Silently updates the value of the reference without notifying observers.

package/esm/refs/ref.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ref.d.ts","sourceRoot":"","sources":["../../src/refs/ref.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAExD;;;GAGG;AACH,qBAAa,GAAG,CAAC,CAAC;;gBAKF,KAAK,EAAE,CAAC,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU;IAMpE,IAAI,cAAc,IAAI,MAAM,CAE3B;IAED;;;;OAIG;IACH,mBAAmB,CAAC,QAAQ,EAAE,CAAC;IAI/B;;OAEG;IACH,IAAI,KAAK,IAAI,CAAC,CAEb;IAED;;;;OAIG;IACH,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC,EAUpB;CACJ"}
+{"version":3,"file":"ref.d.ts","sourceRoot":"","sources":["../../src/refs/ref.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAExD;;;GAGG;AACH,qBAAa,GAAG,CAAC,CAAC;;gBAKF,KAAK,EAAE,CAAC,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU;IAMpE;;OAEG;IACH,IAAI,cAAc,IAAI,MAAM,CAE3B;IAED;;;;OAIG;IACH,mBAAmB,CAAC,QAAQ,EAAE,CAAC;IAI/B;;OAEG;IACH,IAAI,KAAK,IAAI,CAAC,CAEb;IAED;;;;OAIG;IACH,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC,EAUpB;CACJ"}

package/esm/refs/ref.js

@@ -24,6 +24,9 @@ export class Ref {
         __classPrivateFieldSet(this, _Ref_pointerAddress, pointerAddress, "f");
         __classPrivateFieldSet(this, _Ref_difHandler, difHandler, "f");
     }
+    /**
+     * Gets the address of the pointer storing the reference.
+     */
     get pointerAddress() {
         return __classPrivateFieldGet(this, _Ref_pointerAddress, "f");
     }