@unyt/datex 0.0.5 → 0.0.7

package/esm/deno.json

@@ -1,6 +1,6 @@
 {
     "name": "@unyt/datex",
-    "version": "0.0.5",
+    "version": "0.0.7",
     "license": "MIT",
     "exports": "./src/mod.ts",
     "compilerOptions": {
@@ -14,6 +14,7 @@
         "test": "deno task build && deno test -A",
         "test-no-build": "deno test -A",
         "build-npm": "deno run -A scripts/build-npm.ts",
+        "build-bundle": "deno run -A scripts/build-bundle.ts",
         "serve": "deno run -A https://raw.githubusercontent.com/unyt-org/ts-file-server/main/src/run.ts -w --minify=false --port 8042",
         "fmt": "deno fmt && cargo fmt",
         "lint": "deno lint --fix && cargo clippy --fix --features debug"
@@ -23,7 +24,15 @@
         "exclude": ["./npm"]
     },
     "imports": {
-        "@deno/dnt": "jsr:@deno/dnt@^0.42.1"
+        "@david/path": "jsr:@david/path@^0.2.0",
+        "@deno/dnt": "jsr:@deno/dnt@^0.42.1",
+        "@deno/wasmbuild": "https://jsr.io/@deno/wasmbuild/0.19.3/lib/commands/build_command.ts",
+        "@qnighy/dedent": "jsr:@qnighy/dedent@^0.1.2",
+        "@std/assert": "jsr:@std/assert@^1.0.15",
+        "@std/cli": "jsr:@std/cli@^1.0.23",
+        "@std/encoding": "jsr:@std/encoding@^1.0.10",
+        "@std/fmt": "jsr:@std/fmt@^1.0.8",
+        "@std/uuid": "jsr:@std/uuid@^1.0.9"
     },
     "test": {
         "exclude": ["./npm"]

package/esm/dif/builders.d.ts

@@ -0,0 +1,11 @@
+import { type DIFUpdateData } from "./definitions.js";
+import type { DIFHandler } from "./dif-handler.js";
+/**
+ * Creates a DIFUpdate object that describes replacing a pointer's value.
+ */
+export declare function DIF_Replace<T>(difHandler: DIFHandler, value: T): DIFUpdateData;
+/**
+ * Creates a DIFUpdate object that describes updating a property of a pointer's value.
+ */
+export declare function DIF_UpdateProperty<K, V>(difHandler: DIFHandler, property: K, value: V): DIFUpdateData;
+//# sourceMappingURL=builders.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"builders.d.ts","sourceRoot":"","sources":["../../src/dif/builders.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAiB,MAAM,kBAAkB,CAAC;AACrE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD;;GAEG;AACH,wBAAgB,WAAW,CAAC,CAAC,EACzB,UAAU,EAAE,UAAU,EACtB,KAAK,EAAE,CAAC,GACT,aAAa,CAMf;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,CAAC,EACnC,UAAU,EAAE,UAAU,EACtB,QAAQ,EAAE,CAAC,EACX,KAAK,EAAE,CAAC,GACT,aAAa,CAQf"}

package/esm/dif/builders.js

@@ -0,0 +1,23 @@
+import { DIFUpdateKind } from "./definitions.js";
+/**
+ * Creates a DIFUpdate object that describes replacing a pointer's value.
+ */
+export function DIF_Replace(difHandler, value) {
+    const difValue = difHandler.convertJSValueToDIFValue(value);
+    return {
+        kind: DIFUpdateKind.Replace,
+        value: difValue,
+    };
+}
+/**
+ * Creates a DIFUpdate object that describes updating a property of a pointer's value.
+ */
+export function DIF_UpdateProperty(difHandler, property, value) {
+    const difKey = difHandler.convertJSValueToDIFValue(property);
+    const difValue = difHandler.convertJSValueToDIFValue(value);
+    return {
+        kind: DIFUpdateKind.Set,
+        key: { kind: "value", value: difKey },
+        value: difValue,
+    };
+}

package/esm/dif/definitions.d.ts

@@ -0,0 +1,116 @@
+export declare const CoreTypeAddress: {
+    readonly null: "010000";
+    readonly type: "020000";
+    readonly boolean: "030000";
+    readonly endpoint: "070000";
+    readonly text: "080000";
+    readonly list: "090000";
+    readonly unit: "0b0000";
+    readonly map: "0c0000";
+    readonly decimal: "2c0100";
+    readonly decimal_f32: "2d0100";
+    readonly decimal_f64: "2e0100";
+    readonly decimal_big: "2f0100";
+    readonly integer: "640000";
+    readonly integer_u8: "650000";
+    readonly integer_u16: "660000";
+    readonly integer_u32: "670000";
+    readonly integer_u64: "680000";
+    readonly integer_u128: "690000";
+    readonly integer_i8: "6a0000";
+    readonly integer_i16: "6b0000";
+    readonly integer_i32: "6c0000";
+    readonly integer_i64: "6d0000";
+    readonly integer_i128: "6e0000";
+    readonly integer_big: "6f0000";
+};
+export type CoreTypeAddress = typeof CoreTypeAddress[keyof typeof CoreTypeAddress];
+export declare const CoreTypeAddressRanges: {
+    readonly small_unsigned_integers: Set<"650000" | "660000" | "670000" | "680000" | "690000">;
+    readonly big_unsigned_integers: Set<"6f0000">;
+    readonly small_signed_integers: Set<"6a0000" | "6b0000" | "6c0000" | "6d0000" | "6e0000">;
+    readonly big_signed_integers: Set<"6f0000">;
+    readonly decimals: Set<"2c0100" | "2d0100" | "2e0100" | "2f0100">;
+};
+/** 3, 5, or 26 byte hex string */
+export type DIFPointerAddress = string;
+export type DIFValue = {
+    type?: DIFTypeContainer;
+    value: DIFRepresentationValue;
+};
+export type DIFContainer = DIFValue | DIFPointerAddress;
+export declare const DIFTypeKinds: {
+    readonly Structural: 0;
+    readonly Reference: 1;
+    readonly Intersection: 2;
+    readonly Union: 3;
+    readonly Unit: 4;
+    readonly Function: 5;
+};
+export type DIFTypeKind = typeof DIFTypeKinds[keyof typeof DIFTypeKinds];
+export declare const DIFReferenceMutability: {
+    readonly Mutable: 0;
+    readonly Immutable: 1;
+    readonly Final: 2;
+};
+export type DIFReferenceMutability = typeof DIFReferenceMutability[keyof typeof DIFReferenceMutability];
+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;
+export type DIFType<Kind extends DIFTypeKind = DIFTypeKind> = {
+    name?: string;
+    kind: Kind;
+    def: DIFTypeDefinition<Kind>;
+    mut?: DIFReferenceMutability;
+};
+export type DIFReference = {
+    value: DIFValueContainer;
+    allowed_type: DIFTypeContainer;
+    mut: DIFReferenceMutability;
+};
+export type DIFValueContainer = DIFValue | DIFPointerAddress;
+export type DIFTypeContainer = DIFType | DIFPointerAddress;
+export type DIFObject = Record<string, DIFValueContainer>;
+export type DIFArray = DIFValueContainer[];
+export type DIFMap = [DIFValueContainer, DIFValueContainer][];
+export type DIFRepresentationValue = string | number | boolean | null | DIFObject | DIFMap | DIFArray;
+export type DIFProperty = {
+    kind: "text";
+    value: string;
+} | {
+    kind: "index";
+    value: number;
+} | {
+    kind: "value";
+    value: DIFValueContainer;
+};
+export declare const DIFUpdateKind: {
+    readonly Replace: "replace";
+    readonly Push: "push";
+    readonly Set: "set";
+    readonly Remove: "remove";
+    readonly Clear: "clear";
+};
+export type DIFUpdateKind = typeof DIFUpdateKind[keyof typeof DIFUpdateKind];
+export type DIFUpdateData = {
+    kind: typeof DIFUpdateKind.Replace;
+    value: DIFValueContainer;
+} | {
+    kind: typeof DIFUpdateKind.Push;
+    value: DIFValueContainer;
+} | {
+    kind: typeof DIFUpdateKind.Remove;
+    key: DIFProperty;
+} | {
+    kind: typeof DIFUpdateKind.Set;
+    key: DIFProperty;
+    value: DIFValueContainer;
+} | {
+    kind: typeof DIFUpdateKind.Clear;
+};
+export type DIFUpdate = {
+    source_id: number;
+    data: DIFUpdateData;
+};
+export type ObserveOptions = {
+    relay_own_updates: boolean;
+};
+//# sourceMappingURL=definitions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.d.ts","sourceRoot":"","sources":["../../src/dif/definitions.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;CAyBlB,CAAC;AACX,MAAM,MAAM,eAAe,GACvB,OAAO,eAAe,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC;AAEzD,eAAO,MAAM,qBAAqB;;;;;;CAuBxB,CAAC;AAEX,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;;;;CAIzB,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"}

package/esm/dif/definitions.js

@@ -0,0 +1,70 @@
+export const CoreTypeAddress = {
+    null: "010000",
+    type: "020000",
+    boolean: "030000",
+    endpoint: "070000",
+    text: "080000",
+    list: "090000",
+    unit: "0b0000",
+    map: "0c0000",
+    decimal: "2c0100",
+    decimal_f32: "2d0100",
+    decimal_f64: "2e0100",
+    decimal_big: "2f0100",
+    integer: "640000",
+    integer_u8: "650000",
+    integer_u16: "660000",
+    integer_u32: "670000",
+    integer_u64: "680000",
+    integer_u128: "690000",
+    integer_i8: "6a0000",
+    integer_i16: "6b0000",
+    integer_i32: "6c0000",
+    integer_i64: "6d0000",
+    integer_i128: "6e0000",
+    integer_big: "6f0000",
+};
+export const CoreTypeAddressRanges = {
+    small_unsigned_integers: new Set([
+        CoreTypeAddress.integer_u8,
+        CoreTypeAddress.integer_u16,
+        CoreTypeAddress.integer_u32,
+        CoreTypeAddress.integer_u64,
+        CoreTypeAddress.integer_u128,
+    ]),
+    big_unsigned_integers: new Set([CoreTypeAddress.integer_big]),
+    small_signed_integers: new Set([
+        CoreTypeAddress.integer_i8,
+        CoreTypeAddress.integer_i16,
+        CoreTypeAddress.integer_i32,
+        CoreTypeAddress.integer_i64,
+        CoreTypeAddress.integer_i128,
+    ]),
+    big_signed_integers: new Set([CoreTypeAddress.integer_big]),
+    decimals: new Set([
+        CoreTypeAddress.decimal,
+        CoreTypeAddress.decimal_f32,
+        CoreTypeAddress.decimal_f64,
+        CoreTypeAddress.decimal_big,
+    ]),
+};
+export const DIFTypeKinds = {
+    Structural: 0,
+    Reference: 1,
+    Intersection: 2,
+    Union: 3,
+    Unit: 4,
+    Function: 5,
+};
+export const DIFReferenceMutability = {
+    Mutable: 0,
+    Immutable: 1,
+    Final: 2,
+};
+export const DIFUpdateKind = {
+    Replace: "replace",
+    Push: "push",
+    Set: "set",
+    Remove: "remove",
+    Clear: "clear",
+};

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

@@ -0,0 +1,217 @@
+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";
+export declare class DIFHandler {
+    #private;
+    get _observers(): Map<string, Map<number, (value: DIFUpdateData) => void>>;
+    get _handle(): RuntimeDIFHandle;
+    get _transceiver_id(): number;
+    /**
+     * Creates a new DIFHandler instance.
+     * @param runtime - The JSRuntime instance for executing Datex scripts.
+     * @param pointerCache - The PointerCache instance for managing object pointers. If not provided, a new PointerCache will be created.
+     */
+    constructor(runtime: JSRuntime);
+    /**
+     * Executes a Datex script asynchronously and returns a Promise that resolves to a DIFContainer.
+     * @param datexScript - The Datex script source code to execute.
+     * @param values - An optional array of values to inject into the script.
+     * @returns A Promise that resolves to the execution result as a DIFContainer.
+     * @throws If an error occurs during execution.
+     */
+    executeDIF(datexScript: string, values?: unknown[] | null): Promise<DIFContainer>;
+    /**
+     * Executes a Datex script synchronously and returns the result as a DIFContainer.
+     * @param datexScript - The Datex script source code to execute.
+     * @param values - An optional array of values to inject into the script.
+     * @returns The execution result as a DIFContainer.
+     * @throws If an error occurs during execution.
+     */
+    executeSyncDIF(datexScript: string, values?: unknown[] | null): DIFContainer;
+    /**
+     * Creates a new pointer for the specified value.
+     * @param difValue - The DIFValue value to create a pointer for.
+     * @param allowedType - The allowed type for the pointer.
+     * @param mutability - The mutability of the pointer.
+     * @returns The created pointer address.
+     */
+    createPointer(difValue: DIFValue, allowedType: (DIFTypeContainer | null) | undefined, mutability: DIFReferenceMutability): string;
+    /**
+     * Creates a new pointer that points to an existing address.
+     * @param address - The address to create a reference pointer for.
+     * @param allowedType - The allowed type for the pointer.
+     * @param mutability - The mutability of the pointer.
+     * @returns A Promise that resolves to the created pointer address.
+     */
+    createRefPointer(address: string, allowedType: (DIFTypeContainer | null) | undefined, mutability: DIFReferenceMutability): string;
+    /**
+     * Updates the DIF value at the specified address.
+     * @param address - The address of the DIF value to update.
+     * @param dif - The DIFUpdate object containing the update information.
+     */
+    updatePointer(address: string, dif: DIFUpdateData): void;
+    /**
+     * Registers an observer callback for changes to the DIF value at the specified address
+     * directly on the DATEX core runtime.
+     * This method should only be used internally, since it comes with additional overhead.
+     * For normal use cases, use the observePointer method instead.
+     * The callback will be invoked whenever the value at the address is updated.
+     * @param address - The address of the DIF value to observe.
+     * @param callback - The callback function to invoke on updates.
+     * @returns An observer ID that can be used to unregister the observer.
+     * @throws If the pointer is final.
+     */
+    observePointerBindDirect(address: string, callback: (value: DIFUpdate) => void, options?: ObserveOptions): number;
+    /**
+     * Updates the observe options for a registered observer.
+     * @param address - The address of the DIF value being observed.
+     * @param observerId - The observer ID returned by the observePointer method.
+     * @param options - The new observe options to apply.
+     */
+    private updateObserverOptions;
+    /**
+     * Enables propagation of own updates for a registered observer.
+     * @param address - The address of the DIF value being observed.
+     * @param observerId - The observer ID returned by the observePointer method.
+     */
+    enableOwnUpdatesPropagation(address: string, observerId: number): void;
+    /**
+     * Disables propagation of own updates for a registered observer.
+     * @param address - The address of the DIF value being observed.
+     * @param observerId - The observer ID returned by the observePointer method.
+     */
+    disableOwnUpdatesPropagation(address: string, observerId: number): void;
+    /**
+     * Unregisters an observer that was registered directly on the DATEX core runtime
+     * with the observePointerBindDirect method.
+     * For internal use only.
+     * @param address - The address of the DIF value being observed.
+     * @param observerId - The observer ID returned by the observePointer method.
+     */
+    unobservePointerBindDirect(address: string, observerId: number): void;
+    /**
+     * Registers a local observer callback for changes to the DIF value at the specified address.
+     * The callback will be invoked whenever the value at the address is updated.
+     * In contrast to observePointerBindDirect, this method does not register the observer
+     * directly on the DATEX core runtime, but keeps it local in the JS side, which prevents
+     * unnecessary overhead from additional cross-language calls.
+     * @param address - The address of the DIF value to observe.
+     * @param callback - The callback function to invoke on updates.
+     * @returns An observer ID that can be used to unregister the observer.
+     * @throws If the pointer is final.
+     */
+    observePointer(address: string, callback: (value: DIFUpdateData) => void): number;
+    /**
+     * Unregisters an observer that was registered with the observePointer method.
+     * @param address - The address of the DIF value being observed.
+     * @param observerId - The observer ID returned by the observePointer method.
+     * @returns True if the observer was successfully unregistered, false otherwise.
+     */
+    unobservePointer(address: string, observerId: number): boolean;
+    /**
+     * Resolves a DIFValue to its corresponding JS value.
+     * This function handles core types and custom types (not yet implemented).
+     * It returns the resolved value as the specified type T.
+     * @param value
+     */
+    resolveDIFValue<T extends unknown>(value: DIFValue): T | Promise<T>;
+    /**
+     * Converts an array of Promises or resolved values to either a Promise of an array of resolved values,
+     * or an array of resolved values if all values are already resolved.
+     */
+    promiseAllOrSync<T>(values: (T | Promise<T>)[]): Promise<T[]> | T[];
+    /**
+     * Converts an object with values that may be Promises to either a Promise of an object with resolved values,
+     * or an object with resolved values if all values are already resolved.
+     */
+    promiseFromObjectOrSync<T>(values: {
+        [key: string]: T | Promise<T>;
+    }): Promise<{
+        [key: string]: T;
+    }> | {
+        [key: string]: T;
+    };
+    /**
+     * Maps a value or Promise of a value to another value or Promise of a value using the provided onfulfilled function.
+     */
+    mapPromise<T, N>(value: T | Promise<T>, onfulfilled: (value: T) => N): N | Promise<N>;
+    /**
+     * Resolves a DIFValueContainer (either a DIFValue or a pointer address) to its corresponding JS value.
+     * If the container contains pointers that are not yet loaded in memory, it returns a Promise that resolves to the value.
+     * Otherwise, it returns the resolved value directly.
+     * @param value - The DIFValueContainer to resolve.
+     * @returns The resolved value as type T, or a Promise that resolves to type T.
+     */
+    resolveDIFValueContainer<T extends unknown>(value: DIFValueContainer): T | Promise<T>;
+    /**
+     * Synchronous version of resolveDIFValueContainer.
+     * This method can only be used if the value only contains pointer addresses that are already loaded in memory -
+     * otherwise, use the asynchronous `resolveDIFValueContainer` method instead.
+     * @param value - The DIFValueContainer to resolve.
+     * @returns The resolved value as type T.
+     * @throws If the resolution would require asynchronous operations.
+     */
+    resolveDIFValueContainerSync<T extends unknown>(value: DIFValueContainer): T;
+    /**
+     * Resolves a pointer address to its corresponding JS value.
+     * If the pointer address is not yet loaded in memory, it returns a Promise that resolves to the value.
+     * Otherwise, it returns the resolved value directly.
+     * @param address - The pointer address to resolve.
+     * @returns The resolved value as type T, or a Promise that resolves to type T.
+     */
+    resolvePointerAddress<T extends unknown>(address: string): Promise<T> | T;
+    /**
+     * Resolves a pointer address to its corresponding JS value synchronously.
+     * If the pointer address is not yet loaded in memory, it returns a Promise that resolves to the value.
+     * Otherwise, it returns the resolved value directly.
+     * @param address - The pointer address to resolve.
+     * @returns The resolved value as type T, or a Promise that resolves to type T.
+     * @throws If the resolution would require asynchronous operations.
+     */
+    resolvePointerAddressSync<T extends unknown>(address: string): T;
+    /**
+     * Converts an array of JS values to an array of DIFValues.
+     * If the input is null, it returns null.
+     * @param values
+     */
+    convertToDIFValues<T extends unknown[]>(values: T | null): DIFValue[] | null;
+    /**
+     * Returns true if the given address is within the specified address range.
+     */
+    protected isPointerAddressInAdresses(address: DIFPointerAddress, range: Set<string>): boolean;
+    /**
+     * Initializes a pointer with the given value and mutability, by
+     * adding a proxy wrapper if necessary, and setting up observation and caching on the JS side.
+     */
+    protected initPointer<T>(ptrAddress: string, value: T, mutability: DIFReferenceMutability, allowedType?: DIFTypeContainer | null): T | Ref<T>;
+    /**
+     * Handles a pointer update received from the DATEX core runtime.
+     * If the pointer is cached and has a dereferenceable value, it updates the value.
+     * @param address - The address of the pointer being updated.
+     * @param update - The DIFUpdateData containing the update information.
+     * @returns True if the pointer was found and updated, false otherwise.
+     */
+    protected handlePointerUpdate(address: string, update: DIFUpdateData): boolean;
+    /**
+     * Caches the given pointer value with the given address in the JS side cache.
+     * The pointer must already be wrapped if necessary.
+     */
+    protected cacheWrappedPointerValue(address: string, value: WeakKey, observerId: number | null): void;
+    protected getCachedPointer(address: string): WeakKey | undefined;
+    /**
+     * Creates a new pointer containg the given JS value.
+     * The returned value is a proxy object that behaves like the original object,
+     * but also propagates changes between JS and the DATEX runtime.
+     */
+    createPointerFromJSValue(value: unknown, allowedType?: DIFTypeContainer | null, mutability?: DIFReferenceMutability): unknown | Ref<unknown>;
+    protected wrapJSValueInProxy<T>(value: T, pointerAddress: string, _type?: DIFTypeContainer | null): (T | Ref<unknown>) & WeakKey;
+    private isRef;
+    private proxifyJSMap;
+    private wrapJSObjectInProxy;
+    getPointerAddressForValue<T>(value: T): string | null;
+    /**
+     * Converts a given JS value to its DIFValue representation.
+     */
+    convertJSValueToDIFValue<T extends unknown>(value: T): DIFValue;
+}
+//# sourceMappingURL=dif-handler.d.ts.map

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

@@ -0,0 +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,EAIH,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;AAG1B,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"}