@veracity/ai 0.0.17 → 2.0.0

package/dist/utils/Channel.d.ts

@@ -1,13 +1,54 @@
-import { CancellationToken } from "./CancellationToken";
+import { CancellationToken } from './CancellationToken';
+/**
+ * A generic asynchronous channel inspired by C# channels (https://learn.microsoft.com/en-us/dotnet/core/extensions/channels).
+ *
+ * This class facilitates asynchronous communication between producers and consumers,
+ * allowing items of type `T` to be written to and read from a queue. It supports
+ * cancellation tokens for managing asynchronous operations and can signal completion
+ * with or without errors.
+ *
+ * **Key Features:**
+ * - **Asynchronous Readiness:** Consumers can wait asynchronously for items to become available.
+ * - **Cancellation Support:** Asynchronous operations can be cancelled using `CancellationToken`.
+ * - **Completion Signaling:** The channel can be marked as completed, optionally with an error.
+ * - **Single Reader Limitation:** Currently supports a single consumer; multiple readers are not supported.
+ *
+ * @typeParam T - The type of items stored in the channel.
+ */
 export declare class Channel<T> {
     private _queue;
     private _waitToReadDeferred;
     private _isCompleted;
+    /**
+     * Resolves the deferred promise waiting to read.
+     * @param value - Indicates if data is available to read.
+     */
     private resolveWaitToReadDeferred;
+    /**
+     * Marks the channel as completed. No more items can be written after this call.
+     */
     complete(): void;
+    /**
+     * Completes the channel with an error. No more items can be written after this call.
+     * @param reason - The reason for the error.
+     */
     completeWithError(reason?: any): void;
+    /**
+     * Attempts to write an item to the channel.
+     * @param item - The item to write.
+     * @returns True if the item was written; false if the channel is completed.
+     */
     tryWrite(item: T): boolean;
+    /**
+     * Waits asynchronously until data is available to read or the channel is completed.
+     * @param cancellationToken - Token to cancel the operation.
+     * @returns A promise that resolves to true if data is available, or false if the channel is completed.
+     */
     waitToReadAsync(cancellationToken: CancellationToken): Promise<boolean>;
+    /**
+     * Reads all available items from the channel.
+     * @returns An array of items.
+     */
     read(): T[];
 }
 //# sourceMappingURL=Channel.d.ts.map

package/dist/utils/Channel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Channel.d.ts","sourceRoot":"","sources":["../../src/utils/Channel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD,qBAAa,OAAO,CAAC,CAAC;IACpB,OAAO,CAAC,MAAM,CAAW;IACzB,OAAO,CAAC,mBAAmB,CAAoB;IAC/C,OAAO,CAAC,YAAY,CAAS;IAE7B,OAAO,CAAC,yBAAyB;IASjC,QAAQ,IAAI,IAAI;IAMhB,iBAAiB,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,IAAI;IAWrC,QAAQ,CAAC,IAAI,EAAE,CAAC,GAAG,OAAO;IAO1B,eAAe,CAAC,iBAAiB,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC;IA0BvE,IAAI,IAAI,CAAC,EAAE;CAKZ"}
+{"version":3,"file":"Channel.d.ts","sourceRoot":"","sources":["../../src/utils/Channel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,OAAO,CAAC,CAAC;IACpB,OAAO,CAAC,MAAM,CAAW;IACzB,OAAO,CAAC,mBAAmB,CAAoB;IAC/C,OAAO,CAAC,YAAY,CAAS;IAE7B;;;OAGG;IACH,OAAO,CAAC,yBAAyB;IASjC;;OAEG;IACH,QAAQ,IAAI,IAAI;IAMhB;;;OAGG;IACH,iBAAiB,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,IAAI;IAWrC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,CAAC,GAAG,OAAO;IAO1B;;;;OAIG;IACH,eAAe,CAAC,iBAAiB,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC;IA4BvE;;;OAGG;IACH,IAAI,IAAI,CAAC,EAAE;CAKZ"}

package/dist/utils/animateAsync.d.ts

@@ -1,3 +1,3 @@
-import { CancellationToken } from "./CancellationToken";
+import { CancellationToken } from './CancellationToken';
 export declare function animateAsync(animatable: Animatable, keyframes: Keyframe[] | PropertyIndexedKeyframes | null, options?: number | KeyframeAnimationOptions, cancellationToken?: CancellationToken): Promise<void>;
 //# sourceMappingURL=animateAsync.d.ts.map

package/dist/utils/createDeferred.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createDeferred.d.ts","sourceRoot":"","sources":["../../src/utils/createDeferred.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,QAAQ,CAAC,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACpB,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;IAC5B,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,IAAI,CAAC;CAC/B;AAED,wBAAgB,cAAc,CAAC,CAAC,iBAO/B"}
+{"version":3,"file":"createDeferred.d.ts","sourceRoot":"","sources":["../../src/utils/createDeferred.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,QAAQ,CAAC,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACpB,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;IAC5B,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,IAAI,CAAC;CAC/B;AAED,wBAAgB,cAAc,CAAC,CAAC,KAMS,QAAQ,CAAC,CAAC,CAAC,CACnD"}

package/dist/utils/parsePartialJSON.d.ts

@@ -1,2 +1,2 @@
-export declare function parsePartialJSON(json: string): any;
+export declare function parsePartialJSON<T = any>(json: string): T;
 //# sourceMappingURL=parsePartialJSON.d.ts.map

package/dist/utils/parsePartialJSON.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parsePartialJSON.d.ts","sourceRoot":"","sources":["../../src/utils/parsePartialJSON.ts"],"names":[],"mappings":"AACA,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,OAiC5C"}
+{"version":3,"file":"parsePartialJSON.d.ts","sourceRoot":"","sources":["../../src/utils/parsePartialJSON.ts"],"names":[],"mappings":"AACA,wBAAgB,gBAAgB,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,CAiCzD"}