@unyt/datex 0.0.8 → 0.0.10

package/esm/dif/definitions.d.ts

@@ -1,10 +1,28 @@
-/** 3, 5, or 26 byte hex string */
+/**
+ * @module
+ * @description
+ * This module contains all definitions related to the DIF (DATEX Interchange Format) interfaces of the DATEX runtime.
+ */
+/**
+ * A DATEX pointer address representation in the DIF format.
+ * (3, 5, or 26 byte hex string)
+ */
 export type DIFPointerAddress = string;
+/**
+ * A DATEX value representation in the DIF format,
+ * which may optionally include type information.
+ */
 export type DIFValue = {
     type?: DIFTypeContainer;
     value: DIFRepresentationValue;
 };
+/**
+ * A DATEX value or pointer address representation in the DIF format.
+ */
 export type DIFContainer = DIFValue | DIFPointerAddress;
+/**
+ * Mapping of DIF type kinds.
+ */
 export declare const DIFTypeKinds: {
     readonly Structural: 0;
     readonly Reference: 1;
@@ -13,30 +31,47 @@ export declare const DIFTypeKinds: {
     readonly Unit: 4;
     readonly Function: 5;
 };
+/** A DIF type kind. */
 export type DIFTypeKind = typeof DIFTypeKinds[keyof typeof DIFTypeKinds];
+/**
+ * Representation of reference mutability (mutable or immutable) in DIF.
+ */
 export declare const DIFReferenceMutability: {
     readonly Mutable: 0;
     readonly Immutable: 1;
 };
+/** A DIF reference mutability. */
 export type DIFReferenceMutability = typeof DIFReferenceMutability[keyof typeof DIFReferenceMutability];
+/** A DIF type definition based on its kind. */
 export type DIFTypeDefinition<Kind extends DIFTypeKind = DIFTypeKind> = Kind extends typeof DIFTypeKinds.Structural ? DIFValue : Kind extends typeof DIFTypeKinds.Reference ? DIFPointerAddress : Kind extends typeof DIFTypeKinds.Intersection ? Array<DIFTypeContainer> : Kind extends typeof DIFTypeKinds.Union ? Array<DIFTypeContainer> : Kind extends typeof DIFTypeKinds.Unit ? null : Kind extends typeof DIFTypeKinds.Function ? unknown : never;
+/** A DIF type representation. */
 export type DIFType<Kind extends DIFTypeKind = DIFTypeKind> = {
     name?: string;
     kind: Kind;
     def: DIFTypeDefinition<Kind>;
     mut?: DIFReferenceMutability;
 };
+/** A representation of a reference in DIF. */
 export type DIFReference = {
     value: DIFValueContainer;
     allowed_type: DIFTypeContainer;
     mut: DIFReferenceMutability;
 };
+/** A representation of a value or pointer address in DIF. */
 export type DIFValueContainer = DIFValue | DIFPointerAddress;
+/** A representation of a type or type pointer address in DIF. */
 export type DIFTypeContainer = DIFType | DIFPointerAddress;
+/** A DIF object, mapping string keys to DIF value containers. */
 export type DIFObject = Record<string, DIFValueContainer>;
+/** A DIF array, containing DIF value containers. */
 export type DIFArray = DIFValueContainer[];
+/** A DIF map, containing key-value pairs of DIF value containers. */
 export type DIFMap = [DIFValueContainer, DIFValueContainer][];
+/** Any DIF representation value (JSON-compatible values). */
 export type DIFRepresentationValue = string | number | boolean | null | DIFObject | DIFMap | DIFArray;
+/**
+ * Representation of a property in DIF, which can be a text key, an index, or a generic value.
+ */
 export type DIFProperty = {
     kind: "text";
     value: string;
@@ -47,6 +82,9 @@ export type DIFProperty = {
     kind: "value";
     value: DIFValueContainer;
 };
+/**
+ * Kinds of updates that can be applied to a DIF value.
+ */
 export declare const DIFUpdateKind: {
     readonly Replace: "replace";
     readonly Push: "push";
@@ -54,7 +92,9 @@ export declare const DIFUpdateKind: {
     readonly Remove: "remove";
     readonly Clear: "clear";
 };
+/** A DIF update kind. */
 export type DIFUpdateKind = typeof DIFUpdateKind[keyof typeof DIFUpdateKind];
+/** Different kinds of updates that can be applied to a DIF value. */
 export type DIFUpdateData = {
     kind: typeof DIFUpdateKind.Replace;
     value: DIFValueContainer;
@@ -71,10 +111,12 @@ export type DIFUpdateData = {
 } | {
     kind: typeof DIFUpdateKind.Clear;
 };
+/** A DIF update struct, associating a source ID with update data. */
 export type DIFUpdate = {
     source_id: number;
     data: DIFUpdateData;
 };
+/** Options for observing DIF pointers. */
 export type ObserveOptions = {
     relay_own_updates: boolean;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"definitions.d.ts","sourceRoot":"","sources":["../../src/dif/definitions.ts"],"names":[],"mappings":"AAAA,kCAAkC;AAClC,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACvC,MAAM,MAAM,QAAQ,GAAG;IACnB,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACxB,KAAK,EAAE,sBAAsB,CAAC;CACjC,CAAC;AACF,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,iBAAiB,CAAC;AAExD,eAAO,MAAM,YAAY;;;;;;;CAOf,CAAC;AACX,MAAM,MAAM,WAAW,GAAG,OAAO,YAAY,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAEzE,eAAO,MAAM,sBAAsB;;;CAGzB,CAAC;AACX,MAAM,MAAM,sBAAsB,GAC9B,OAAO,sBAAsB,CAAC,MAAM,OAAO,sBAAsB,CAAC,CAAC;AAEvE,MAAM,MAAM,iBAAiB,CAAC,IAAI,SAAS,WAAW,GAAG,WAAW,IAChE,IAAI,SAAS,OAAO,YAAY,CAAC,UAAU,GAAG,QAAQ,GAChD,IAAI,SAAS,OAAO,YAAY,CAAC,SAAS,GAAG,iBAAiB,GAC9D,IAAI,SAAS,OAAO,YAAY,CAAC,YAAY,GACzC,KAAK,CAAC,gBAAgB,CAAC,GAC3B,IAAI,SAAS,OAAO,YAAY,CAAC,KAAK,GAAG,KAAK,CAAC,gBAAgB,CAAC,GAChE,IAAI,SAAS,OAAO,YAAY,CAAC,IAAI,GAAG,IAAI,GAC5C,IAAI,SAAS,OAAO,YAAY,CAAC,QAAQ,GAAG,OAAO,GACnD,KAAK,CAAC;AAEhB,MAAM,MAAM,OAAO,CAAC,IAAI,SAAS,WAAW,GAAG,WAAW,IAAI;IAC1D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,IAAI,CAAC;IACX,GAAG,EAAE,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC7B,GAAG,CAAC,EAAE,sBAAsB,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACvB,KAAK,EAAE,iBAAiB,CAAC;IACzB,YAAY,EAAE,gBAAgB,CAAC;IAC/B,GAAG,EAAE,sBAAsB,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,iBAAiB,CAAC;AAC7D,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,iBAAiB,CAAC;AAE3D,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC1D,MAAM,MAAM,QAAQ,GAAG,iBAAiB,EAAE,CAAC;AAC3C,MAAM,MAAM,MAAM,GAAG,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,EAAE,CAAC;AAE9D,MAAM,MAAM,sBAAsB,GAC5B,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,GACT,MAAM,GACN,QAAQ,CAAC;AAGf,MAAM,MAAM,WAAW,GACjB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAC/B;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,iBAAiB,CAAA;CAAE,CAAC;AAElD,eAAO,MAAM,aAAa;;;;;;CAMhB,CAAC;AACX,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE7E,MAAM,MAAM,aAAa,GACnB;IAAE,IAAI,EAAE,OAAO,aAAa,CAAC,OAAO,CAAC;IAAC,KAAK,EAAE,iBAAiB,CAAA;CAAE,GAChE;IAAE,IAAI,EAAE,OAAO,aAAa,CAAC,IAAI,CAAC;IAAC,KAAK,EAAE,iBAAiB,CAAA;CAAE,GAC7D;IAAE,IAAI,EAAE,OAAO,aAAa,CAAC,MAAM,CAAC;IAAC,GAAG,EAAE,WAAW,CAAA;CAAE,GACvD;IACE,IAAI,EAAE,OAAO,aAAa,CAAC,GAAG,CAAC;IAC/B,GAAG,EAAE,WAAW,CAAC;IACjB,KAAK,EAAE,iBAAiB,CAAC;CAC5B,GACC;IAAE,IAAI,EAAE,OAAO,aAAa,CAAC,KAAK,CAAA;CAAE,CAAC;AAE3C,MAAM,MAAM,SAAS,GAAG;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IACzB,iBAAiB,EAAE,OAAO,CAAC;CAC9B,CAAC"}
+{"version":3,"file":"definitions.d.ts","sourceRoot":"","sources":["../../src/dif/definitions.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACvC;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG;IACnB,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACxB,KAAK,EAAE,sBAAsB,CAAC;CACjC,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,iBAAiB,CAAC;AAExD;;GAEG;AACH,eAAO,MAAM,YAAY;;;;;;;CAOf,CAAC;AACX,uBAAuB;AACvB,MAAM,MAAM,WAAW,GAAG,OAAO,YAAY,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAEzE;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;CAGzB,CAAC;AACX,kCAAkC;AAClC,MAAM,MAAM,sBAAsB,GAC9B,OAAO,sBAAsB,CAAC,MAAM,OAAO,sBAAsB,CAAC,CAAC;AAEvE,+CAA+C;AAC/C,MAAM,MAAM,iBAAiB,CAAC,IAAI,SAAS,WAAW,GAAG,WAAW,IAChE,IAAI,SAAS,OAAO,YAAY,CAAC,UAAU,GAAG,QAAQ,GAChD,IAAI,SAAS,OAAO,YAAY,CAAC,SAAS,GAAG,iBAAiB,GAC9D,IAAI,SAAS,OAAO,YAAY,CAAC,YAAY,GACzC,KAAK,CAAC,gBAAgB,CAAC,GAC3B,IAAI,SAAS,OAAO,YAAY,CAAC,KAAK,GAAG,KAAK,CAAC,gBAAgB,CAAC,GAChE,IAAI,SAAS,OAAO,YAAY,CAAC,IAAI,GAAG,IAAI,GAC5C,IAAI,SAAS,OAAO,YAAY,CAAC,QAAQ,GAAG,OAAO,GACnD,KAAK,CAAC;AAEhB,iCAAiC;AACjC,MAAM,MAAM,OAAO,CAAC,IAAI,SAAS,WAAW,GAAG,WAAW,IAAI;IAC1D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,IAAI,CAAC;IACX,GAAG,EAAE,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC7B,GAAG,CAAC,EAAE,sBAAsB,CAAC;CAChC,CAAC;AAEF,8CAA8C;AAC9C,MAAM,MAAM,YAAY,GAAG;IACvB,KAAK,EAAE,iBAAiB,CAAC;IACzB,YAAY,EAAE,gBAAgB,CAAC;IAC/B,GAAG,EAAE,sBAAsB,CAAC;CAC/B,CAAC;AAEF,6DAA6D;AAC7D,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,iBAAiB,CAAC;AAC7D,iEAAiE;AACjE,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,iBAAiB,CAAC;AAE3D,iEAAiE;AACjE,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC1D,oDAAoD;AACpD,MAAM,MAAM,QAAQ,GAAG,iBAAiB,EAAE,CAAC;AAC3C,qEAAqE;AACrE,MAAM,MAAM,MAAM,GAAG,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,EAAE,CAAC;AAE9D,6DAA6D;AAC7D,MAAM,MAAM,sBAAsB,GAC5B,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,GACT,MAAM,GACN,QAAQ,CAAC;AAEf;;GAEG;AACH,MAAM,MAAM,WAAW,GACjB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAC/B;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,iBAAiB,CAAA;CAAE,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;CAMhB,CAAC;AACX,yBAAyB;AACzB,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE7E,qEAAqE;AACrE,MAAM,MAAM,aAAa,GACnB;IAAE,IAAI,EAAE,OAAO,aAAa,CAAC,OAAO,CAAC;IAAC,KAAK,EAAE,iBAAiB,CAAA;CAAE,GAChE;IAAE,IAAI,EAAE,OAAO,aAAa,CAAC,IAAI,CAAC;IAAC,KAAK,EAAE,iBAAiB,CAAA;CAAE,GAC7D;IAAE,IAAI,EAAE,OAAO,aAAa,CAAC,MAAM,CAAC;IAAC,GAAG,EAAE,WAAW,CAAA;CAAE,GACvD;IACE,IAAI,EAAE,OAAO,aAAa,CAAC,GAAG,CAAC;IAC/B,GAAG,EAAE,WAAW,CAAC;IACjB,KAAK,EAAE,iBAAiB,CAAC;CAC5B,GACC;IAAE,IAAI,EAAE,OAAO,aAAa,CAAC,KAAK,CAAA;CAAE,CAAC;AAE3C,qEAAqE;AACrE,MAAM,MAAM,SAAS,GAAG;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF,0CAA0C;AAC1C,MAAM,MAAM,cAAc,GAAG;IACzB,iBAAiB,EAAE,OAAO,CAAC;CAC9B,CAAC"}

package/esm/dif/definitions.js

@@ -1,3 +1,11 @@
+/**
+ * @module
+ * @description
+ * This module contains all definitions related to the DIF (DATEX Interchange Format) interfaces of the DATEX runtime.
+ */
+/**
+ * Mapping of DIF type kinds.
+ */
 export const DIFTypeKinds = {
     Structural: 0,
     Reference: 1,
@@ -6,10 +14,16 @@ export const DIFTypeKinds = {
     Unit: 4,
     Function: 5,
 };
+/**
+ * Representation of reference mutability (mutable or immutable) in DIF.
+ */
 export const DIFReferenceMutability = {
     Mutable: 0,
     Immutable: 1,
 };
+/**
+ * Kinds of updates that can be applied to a DIF value.
+ */
 export const DIFUpdateKind = {
     Replace: "replace",
     Push: "push",

package/esm/dif/dif-handler.d.ts

@@ -1,10 +1,27 @@
 import type { JSRuntime, RuntimeDIFHandle } from "../datex-core.js";
 import { Ref } from "../refs/ref.js";
 import { type DIFContainer, type DIFPointerAddress, DIFReferenceMutability, type DIFTypeContainer, type DIFUpdate, type DIFUpdateData, type DIFValue, type DIFValueContainer, type ObserveOptions } from "./definitions.js";
+/**
+ * The DIFHandler class provides methods to interact with the DATEX Core DIF runtime,
+ * including executing Datex scripts, creating and managing pointers, and observing changes.
+ * It includes a local pointer cache to optimize performance and reduce cross-language calls.
+ */
 export declare class DIFHandler {
     #private;
+    /**
+     * Internal property
+     * @returns The map of observers for each pointer address.
+     */
     get _observers(): Map<string, Map<number, (value: DIFUpdateData) => void>>;
+    /**
+     * Internal property
+     * @returns The RuntimeDIFHandle instance.
+     */
     get _handle(): RuntimeDIFHandle;
+    /**
+     * Internal property
+     * @returns The transceiver ID of the DIF client.
+     */
     get _transceiver_id(): number;
     /**
      * Creates a new DIFHandler instance.

package/esm/dif/dif-handler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dif-handler.d.ts","sourceRoot":"","sources":["../../src/dif/dif-handler.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpE,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAErC,OAAO,EAEH,KAAK,YAAY,EAGjB,KAAK,iBAAiB,EAGtB,sBAAsB,EACtB,KAAK,gBAAgB,EACrB,KAAK,SAAS,EACd,KAAK,aAAa,EAElB,KAAK,QAAQ,EACb,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACtB,MAAM,kBAAkB,CAAC;AAI1B,qBAAa,UAAU;;IAqBnB,IAAI,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAAC,CAAC,CAEzE;IAED,IAAI,OAAO,IAAI,gBAAgB,CAE9B;IAED,IAAI,eAAe,IAAI,MAAM,CAE5B;IAED;;;;OAIG;gBAEC,OAAO,EAAE,SAAS;IAMtB;;;;;;OAMG;IACI,UAAU,CACb,WAAW,EAAE,MAAM,EACnB,MAAM,GAAE,OAAO,EAAE,GAAG,IAAS,GAC9B,OAAO,CAAC,YAAY,CAAC;IAOxB;;;;;;OAMG;IACI,cAAc,CACjB,WAAW,EAAE,MAAM,EACnB,MAAM,GAAE,OAAO,EAAE,GAAG,IAAS,GAC9B,YAAY;IAOf;;;;;;OAMG;IACI,aAAa,CAChB,QAAQ,EAAE,QAAQ,EAClB,WAAW,GAAE,gBAAgB,GAAG,IAAI,aAAO,EAC3C,UAAU,EAAE,sBAAsB,GACnC,MAAM;IAQT;;;;;;OAMG;IACI,gBAAgB,CACnB,OAAO,EAAE,MAAM,EACf,WAAW,GAAE,gBAAgB,GAAG,IAAI,aAAO,EAC3C,UAAU,EAAE,sBAAsB,GACnC,MAAM;IAQT;;;;OAIG;IACI,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,aAAa;IAIxD;;;;;;;;;;OAUG;IACI,wBAAwB,CAC3B,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,EACpC,OAAO,GAAE,cAA6C,GACvD,MAAM;IAST;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;IAY7B;;;;OAIG;IACI,2BAA2B,CAC9B,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM;IAOtB;;;;OAIG;IACI,4BAA4B,CAC/B,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM;IAOtB;;;;;;OAMG;IACI,0BAA0B,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAIrE;;;;;;;;;;OAUG;IACI,cAAc,CACjB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,GACzC,MAAM;IA2BT;;;;;OAKG;IACI,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO;IAqBrE;;;;;OAKG;IACI,eAAe,CAAC,CAAC,SAAS,OAAO,EACpC,KAAK,EAAE,QAAQ,GAChB,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAuGjB;;;OAGG;IACH,gBAAgB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE;IAQnE;;;OAGG;IACI,uBAAuB,CAAC,CAAC,EAC5B,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;KAAE,GAC1C,OAAO,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAA;KAAE,CAAC,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAA;KAAE;IAgBvD;;OAEG;IACI,UAAU,CAAC,CAAC,EAAE,CAAC,EAClB,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EACrB,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAC7B,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAQjB;;;;;;OAMG;IACI,wBAAwB,CAAC,CAAC,SAAS,OAAO,EAC7C,KAAK,EAAE,iBAAiB,GACzB,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAQjB;;;;;;;OAOG;IACI,4BAA4B,CAAC,CAAC,SAAS,OAAO,EACjD,KAAK,EAAE,iBAAiB,GACzB,CAAC;IAUJ;;;;;;OAMG;IACI,qBAAqB,CAAC,CAAC,SAAS,OAAO,EAC1C,OAAO,EAAE,MAAM,GAChB,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;IA0BjB;;;;;;;OAOG;IACI,yBAAyB,CAAC,CAAC,SAAS,OAAO,EAC9C,OAAO,EAAE,MAAM,GAChB,CAAC;IAgBJ;;;;OAIG;IACI,kBAAkB,CAAC,CAAC,SAAS,OAAO,EAAE,EACzC,MAAM,EAAE,CAAC,GAAG,IAAI,GACjB,QAAQ,EAAE,GAAG,IAAI;IAKpB;;OAEG;IACH,SAAS,CAAC,0BAA0B,CAChC,OAAO,EAAE,iBAAiB,EAC1B,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,GACnB,OAAO;IAIV;;;OAGG;IACH,SAAS,CAAC,WAAW,CAAC,CAAC,EACnB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,CAAC,EACR,UAAU,EAAE,sBAAsB,EAClC,WAAW,GAAE,gBAAgB,GAAG,IAAW,GAC5C,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;IAwCb;;;;;;OAMG;IACH,SAAS,CAAC,mBAAmB,CACzB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,aAAa,GACtB,OAAO;IAgBV;;;OAGG;IACH,SAAS,CAAC,wBAAwB,CAC9B,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,OAAO,EACd,UAAU,EAAE,MAAM,GAAG,IAAI,GAC1B,IAAI;IAqBP,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAWhE;;;;OAIG;IACI,wBAAwB,CAC3B,KAAK,EAAE,OAAO,EACd,WAAW,GAAE,gBAAgB,GAAG,IAAW,EAC3C,UAAU,GAAE,sBAAuD,GACpE,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IAiBzB,SAAS,CAAC,kBAAkB,CAAC,CAAC,EAC1B,KAAK,EAAE,CAAC,EACR,cAAc,EAAE,MAAM,EACtB,KAAK,GAAE,gBAAgB,GAAG,IAAW,GACtC,CAAC,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,GAAG,OAAO;IAkB/B,OAAO,CAAC,KAAK;IAIb,OAAO,CAAC,YAAY;IAwDpB,OAAO,CAAC,mBAAmB;IAuCpB,yBAAyB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,GAAG,IAAI;IAU5D;;OAEG;IACI,wBAAwB,CAAC,CAAC,SAAS,OAAO,EAC7C,KAAK,EAAE,CAAC,GACT,QAAQ;CAwDd"}
+{"version":3,"file":"dif-handler.d.ts","sourceRoot":"","sources":["../../src/dif/dif-handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpE,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAErC,OAAO,EAEH,KAAK,YAAY,EAGjB,KAAK,iBAAiB,EAGtB,sBAAsB,EACtB,KAAK,gBAAgB,EACrB,KAAK,SAAS,EACd,KAAK,aAAa,EAElB,KAAK,QAAQ,EACb,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACtB,MAAM,kBAAkB,CAAC;AAI1B;;;;GAIG;AACH,qBAAa,UAAU;;IAqBnB;;;OAGG;IACH,IAAI,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAAC,CAAC,CAEzE;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,gBAAgB,CAE9B;IAED;;;OAGG;IACH,IAAI,eAAe,IAAI,MAAM,CAE5B;IAED;;;;OAIG;gBAEC,OAAO,EAAE,SAAS;IAMtB;;;;;;OAMG;IACI,UAAU,CACb,WAAW,EAAE,MAAM,EACnB,MAAM,GAAE,OAAO,EAAE,GAAG,IAAS,GAC9B,OAAO,CAAC,YAAY,CAAC;IAOxB;;;;;;OAMG;IACI,cAAc,CACjB,WAAW,EAAE,MAAM,EACnB,MAAM,GAAE,OAAO,EAAE,GAAG,IAAS,GAC9B,YAAY;IAOf;;;;;;OAMG;IACI,aAAa,CAChB,QAAQ,EAAE,QAAQ,EAClB,WAAW,GAAE,gBAAgB,GAAG,IAAI,aAAO,EAC3C,UAAU,EAAE,sBAAsB,GACnC,MAAM;IAQT;;;;;;OAMG;IACI,gBAAgB,CACnB,OAAO,EAAE,MAAM,EACf,WAAW,GAAE,gBAAgB,GAAG,IAAI,aAAO,EAC3C,UAAU,EAAE,sBAAsB,GACnC,MAAM;IAQT;;;;OAIG;IACI,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,aAAa;IAIxD;;;;;;;;;;OAUG;IACI,wBAAwB,CAC3B,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,EACpC,OAAO,GAAE,cAA6C,GACvD,MAAM;IAST;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;IAY7B;;;;OAIG;IACI,2BAA2B,CAC9B,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM;IAOtB;;;;OAIG;IACI,4BAA4B,CAC/B,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM;IAOtB;;;;;;OAMG;IACI,0BAA0B,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAIrE;;;;;;;;;;OAUG;IACI,cAAc,CACjB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,GACzC,MAAM;IA2BT;;;;;OAKG;IACI,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO;IAqBrE;;;;;OAKG;IACI,eAAe,CAAC,CAAC,SAAS,OAAO,EACpC,KAAK,EAAE,QAAQ,GAChB,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAuGjB;;;OAGG;IACH,gBAAgB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE;IAQnE;;;OAGG;IACI,uBAAuB,CAAC,CAAC,EAC5B,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;KAAE,GAC1C,OAAO,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAA;KAAE,CAAC,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAA;KAAE;IAgBvD;;OAEG;IACI,UAAU,CAAC,CAAC,EAAE,CAAC,EAClB,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EACrB,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAC7B,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAQjB;;;;;;OAMG;IACI,wBAAwB,CAAC,CAAC,SAAS,OAAO,EAC7C,KAAK,EAAE,iBAAiB,GACzB,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAQjB;;;;;;;OAOG;IACI,4BAA4B,CAAC,CAAC,SAAS,OAAO,EACjD,KAAK,EAAE,iBAAiB,GACzB,CAAC;IAUJ;;;;;;OAMG;IACI,qBAAqB,CAAC,CAAC,SAAS,OAAO,EAC1C,OAAO,EAAE,MAAM,GAChB,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;IA0BjB;;;;;;;OAOG;IACI,yBAAyB,CAAC,CAAC,SAAS,OAAO,EAC9C,OAAO,EAAE,MAAM,GAChB,CAAC;IAgBJ;;;;OAIG;IACI,kBAAkB,CAAC,CAAC,SAAS,OAAO,EAAE,EACzC,MAAM,EAAE,CAAC,GAAG,IAAI,GACjB,QAAQ,EAAE,GAAG,IAAI;IAKpB;;OAEG;IACH,SAAS,CAAC,0BAA0B,CAChC,OAAO,EAAE,iBAAiB,EAC1B,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,GACnB,OAAO;IAIV;;;OAGG;IACH,SAAS,CAAC,WAAW,CAAC,CAAC,EACnB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,CAAC,EACR,UAAU,EAAE,sBAAsB,EAClC,WAAW,GAAE,gBAAgB,GAAG,IAAW,GAC5C,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;IAwCb;;;;;;OAMG;IACH,SAAS,CAAC,mBAAmB,CACzB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,aAAa,GACtB,OAAO;IAgBV;;;OAGG;IACH,SAAS,CAAC,wBAAwB,CAC9B,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,OAAO,EACd,UAAU,EAAE,MAAM,GAAG,IAAI,GAC1B,IAAI;IAqBP,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAWhE;;;;OAIG;IACI,wBAAwB,CAC3B,KAAK,EAAE,OAAO,EACd,WAAW,GAAE,gBAAgB,GAAG,IAAW,EAC3C,UAAU,GAAE,sBAAuD,GACpE,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IAiBzB,SAAS,CAAC,kBAAkB,CAAC,CAAC,EAC1B,KAAK,EAAE,CAAC,EACR,cAAc,EAAE,MAAM,EACtB,KAAK,GAAE,gBAAgB,GAAG,IAAW,GACtC,CAAC,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,GAAG,OAAO;IAkB/B,OAAO,CAAC,KAAK;IAIb,OAAO,CAAC,YAAY;IAwDpB,OAAO,CAAC,mBAAmB;IAuCpB,yBAAyB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,GAAG,IAAI;IAU5D;;OAEG;IACI,wBAAwB,CAAC,CAAC,SAAS,OAAO,EAC7C,KAAK,EAAE,CAAC,GACT,QAAQ;CAwDd"}

package/esm/dif/dif-handler.js

@@ -10,19 +10,35 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
     return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
 var _DIFHandler_runtime, _DIFHandler_handle, _DIFHandler_transceiver_id, _DIFHandler_cache, _DIFHandler_observers;
-import * as dntShim from "../_dnt.shims.js";
 import { Ref } from "../refs/ref.js";
 import { Endpoint } from "../runtime/special-core-types.js";
 import { DIFReferenceMutability, DIFUpdateKind, } from "./definitions.js";
 import { CoreTypeAddress, CoreTypeAddressRanges } from "./core.js";
 import { difValueContainerToDisplayString } from "./display.js";
+/**
+ * The DIFHandler class provides methods to interact with the DATEX Core DIF runtime,
+ * including executing Datex scripts, creating and managing pointers, and observing changes.
+ * It includes a local pointer cache to optimize performance and reduce cross-language calls.
+ */
 export class DIFHandler {
+    /**
+     * Internal property
+     * @returns The map of observers for each pointer address.
+     */
     get _observers() {
         return __classPrivateFieldGet(this, _DIFHandler_observers, "f");
     }
+    /**
+     * Internal property
+     * @returns The RuntimeDIFHandle instance.
+     */
     get _handle() {
         return __classPrivateFieldGet(this, _DIFHandler_handle, "f");
     }
+    /**
+     * Internal property
+     * @returns The transceiver ID of the DIF client.
+     */
     get _transceiver_id() {
         return __classPrivateFieldGet(this, _DIFHandler_transceiver_id, "f");
     }
@@ -468,7 +484,7 @@ export class DIFHandler {
      */
     cacheWrappedPointerValue(address, value, observerId) {
         __classPrivateFieldGet(this, _DIFHandler_cache, "f").set(address, {
-            val: new dntShim.WeakRef(value),
+            val: new WeakRef(value),
             observerId,
         });
         // register finalizer to clean up the cache and free the pointer in the runtime

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,EACH,KAAK,YAAY,EACjB,sBAAsB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACzB,MAAM,kBAAkB,CAAC;AAG1B,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,sBAAsB,GAAG,MAAM,CAO7E;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,5 +1,13 @@
+/**
+ * @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 ";
@@ -9,12 +17,18 @@ export function mutabilityToDisplayString(mut) {
     }
     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);
@@ -32,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) => {
@@ -51,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);
@@ -59,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

@@ -1,3 +1,8 @@
+/**
+ * @module dif/mod.ts
+ * @description
+ * This namespace contains all modules related to the DIF (DATEX Interchange Format) interfaces of the DATEX runtime.
+ */
 export * as Definitions from "./definitions.js";
 export * as Builders from "./builders.js";
 export * as Display from "./display.js";

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

@@ -1 +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"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../src/dif/mod.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,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

@@ -1,3 +1,8 @@
+/**
+ * @module dif/mod.ts
+ * @description
+ * This namespace contains all modules related to the DIF (DATEX Interchange Format) interfaces of the DATEX runtime.
+ */
 export * as Definitions from "./definitions.js";
 export * as Builders from "./builders.js";
 export * as Display from "./display.js";

package/esm/mod.d.ts

@@ -2,8 +2,23 @@
  * @module mod.ts
  * @description
  * This module exports all public APIs of the DATEX runtime.
+ *
+ * @example
+ * ```ts
+ * import { Runtime } from "@unyt/datex";
+ *
+ * // Create a runtime instance
+ * export const runtime: Runtime = await Runtime.create({
+ *    interfaces: [{
+ *         type: "websocket-client",
+ *         config: { address: "wss://example.unyt.land" },
+ *     }],
+ * });
+ *
+ *  // Use the runtime instance
+ * const result = await runtime.execute("@example :: 1 + 2");
+ * ```
  */
-import "./_dnt.polyfills.js";
 export * from "./runtime/runtime.js";
 export * as DIF from "./dif/mod.js";
 export * as Network from "./network/mod.js";

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,cAAc,sBAAsB,CAAC;AACrC,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,OAAO,qBAAqB,CAAC;AAG7B,cAAc,sBAAsB,CAAC;AACrC,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC"}

package/esm/mod.js

@@ -2,8 +2,23 @@
  * @module mod.ts
  * @description
  * This module exports all public APIs of the DATEX runtime.
+ *
+ * @example
+ * ```ts
+ * import { Runtime } from "@unyt/datex";
+ *
+ * // Create a runtime instance
+ * export const runtime: Runtime = await Runtime.create({
+ *    interfaces: [{
+ *         type: "websocket-client",
+ *         config: { address: "wss://example.unyt.land" },
+ *     }],
+ * });
+ *
+ *  // Use the runtime instance
+ * const result = await runtime.execute("@example :: 1 + 2");
+ * ```
  */
-import "./_dnt.polyfills.js";
 export * from "./runtime/runtime.js";
 export * as DIF from "./dif/mod.js";
 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);