@promptbook/vercel 0.79.0 → 0.80.0-1

package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts

@@ -54,7 +54,7 @@ export declare class RemoteLlmExecutionTools<TCustomOptions = undefined> impleme
     private callCommonModel;
 }
 /**
- * TODO: Maybe use `$asDeeplyFrozenSerializableJson`
+ * TODO: Maybe use `$exportJson`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
  * TODO: [🍓] Allow to list compatible models with each variant
  * TODO: [🗯] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable

package/esm/typings/src/llm-providers/remote/startRemoteServer.d.ts

@@ -11,7 +11,7 @@ import type { RemoteServerOptions } from './interfaces/RemoteServerOptions';
  */
 export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): IDestroyable;
 /**
- * TODO: Maybe use `$asDeeplyFrozenSerializableJson`
+ * TODO: Maybe use `$exportJson`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
  * TODO: [⚖] Expose the collection to be able to connect to same collection via createCollectionFromUrl
  * TODO: Handle progress - support streaming

package/esm/typings/src/prepare/prepareTasks.d.ts

@@ -22,6 +22,7 @@ type PreparedTasks = {
 export declare function prepareTasks(pipeline: PrepareTaskInput, tools: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<PreparedTasks>;
 export {};
 /**
+ * TODO: [😂] Adding knowledge should be convert to async high-level abstractions, simmilar thing with expectations to sync high-level abstractions
  * TODO: [🧠] Add context to each task (if missing)
  * TODO: [🧠] What is better name `prepareTask` or `prepareTaskAndParameters`
  * TODO: [♨][main] !!! Prepare index the examples and maybe tasks

package/esm/typings/src/prepare/unpreparePipeline.d.ts

@@ -2,6 +2,7 @@ import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 /**
  * Unprepare just strips the preparation data of the pipeline
  *
+ * @deprecated In future version this function will be removed or deprecated
  * @public exported from `@promptbook/core`
  */
 export declare function unpreparePipeline(pipeline: PipelineJson): PipelineJson;

package/esm/typings/src/types/typeAliases.d.ts

@@ -1,5 +1,5 @@
 import type { TupleToUnion } from 'type-fest';
-import { RESERVED_PARAMETER_NAMES } from '../config';
+import { RESERVED_PARAMETER_NAMES } from '../constants';
 /**
  * Semantic helper
  */

package/esm/typings/src/utils/normalization/orderJson.d.ts

@@ -0,0 +1,21 @@
+import type { JsonArray, JsonObject } from 'type-fest';
+/**
+ * Options for the `orderJson` function
+ */
+export type OrderJsonOptions<TObject extends JsonObject | JsonArray> = {
+    /**
+     * Value to checked, ordered and deeply frozen
+     */
+    value: TObject;
+    /**
+     * Order of the object properties
+     */
+    order: Array<keyof TObject>;
+};
+/**
+ * Orders JSON object by keys
+ *
+ * @returns The same type of object as the input re-ordered
+ * @public exported from `@promptbook/utils`
+ */
+export declare function orderJson<TObject extends JsonObject | JsonArray>(options: OrderJsonOptions<TObject>): TObject;

package/esm/typings/src/utils/normalization/orderJson.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠] Is there a way how to test order of value better way than via `JSON.stringify`
+ */

package/esm/typings/src/utils/organization/keepTypeImported.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Just says that the type is used but `organize-imports-cli` does not recognize it.
+ * [🤛] This is a workaround for the issue.
+ *
+ * @param value any values
+ * @returns void
+ * @private within the repository
+ */
+export declare function keepTypeImported<TTypeToKeep>(): void;

package/esm/typings/src/utils/serialization/$deepFreeze.d.ts

@@ -1,6 +1,6 @@
 import type { ReadonlyDeep } from 'type-fest';
 /**
- * @@@
+ * Freezes the given object and all its nested objects recursively
  *
  * Note: `$` is used to indicate that this function is not a pure function - it mutates given object
  * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object

package/esm/typings/src/utils/serialization/checkSerializableAsJson.d.ts

@@ -1,4 +1,22 @@
 import type { string_name } from '../../types/typeAliases';
+import type { really_unknown } from '../organization/really_unknown';
+/**
+ * Options for the `checkSerializableAsJson` function
+ */
+export type CheckSerializableAsJsonOptions = {
+    /**
+     * Value to be checked
+     */
+    value: really_unknown;
+    /**
+     * Semantic name of the value for debugging purposes
+     */
+    name?: string_name;
+    /**
+     * Message alongside the value for debugging purposes
+     */
+    message?: string;
+};
 /**
  * Checks if the value is [🚉] serializable as JSON
  * If not, throws an UnexpectedError with a rich error message and tracking
@@ -19,9 +37,9 @@ import type { string_name } from '../../types/typeAliases';
  * @throws UnexpectedError if the value is not serializable as JSON
  * @public exported from `@promptbook/utils`
  */
-export declare function checkSerializableAsJson(name: string_name, value: unknown): void;
+export declare function checkSerializableAsJson(options: CheckSerializableAsJsonOptions): void;
 /**
- * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
+ * TODO: Can be return type more type-safe? like `asserts options.value is JsonValue`
  * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
  * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
  */

package/esm/typings/src/utils/serialization/deepClone.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/utils/serialization/exportJson.d.ts

@@ -0,0 +1,29 @@
+import type { JsonArray, JsonObject } from 'type-fest';
+import type { OrderJsonOptions } from '../normalization/orderJson';
+import type { CheckSerializableAsJsonOptions } from './checkSerializableAsJson';
+/**
+ * Options for the `$exportJson` function
+ */
+export type ExportJsonOptions<TObject> = CheckSerializableAsJsonOptions & Partial<Pick<OrderJsonOptions<TObject & (JsonObject | JsonArray)>, 'order'>> & {
+    /**
+     * Value to be checked, ordered and deeply frozen
+     */
+    value: TObject;
+};
+/**
+ * Utility to export a JSON object from a function
+ *
+ * 1) Checks if the value is serializable as JSON
+ * 2) Makes a deep clone of the object
+ * 2) Orders the object properties
+ * 2) Deeply freezes the cloned object
+ *
+ * Note: This function does not mutates the given object
+ *
+ * @returns The same type of object as the input but read-only and re-ordered
+ * @public exported from `@promptbook/utils`
+ */
+export declare function exportJson<TObject>(options: ExportJsonOptions<TObject>): TObject;
+/**
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
+ */

package/esm/typings/src/utils/serialization/isSerializableAsJson.d.ts

@@ -1,3 +1,4 @@
+import { JsonValue } from 'type-fest';
 /**
  * Tests if the value is [🚉] serializable as JSON
  *
@@ -17,7 +18,7 @@
  *
  * @public exported from `@promptbook/utils`
  */
-export declare function isSerializableAsJson(value: unknown): boolean;
+export declare function isSerializableAsJson(value: unknown): value is JsonValue;
 /**
  * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
  * TODO: [🧠][💺] Can be done this on type-level?

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/vercel",
-    "version": "0.79.0",
+    "version": "0.80.0-1",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,
@@ -54,7 +54,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/vercel.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.79.0"
+        "@promptbook/core": "0.80.0-1"
     },
     "dependencies": {
         "colors": "1.4.0",