@promptbook/openai 0.79.0 → 0.80.0-1

package/esm/typings/src/constants.d.ts

@@ -0,0 +1,35 @@
+import type { PipelineJson } from './pipeline/PipelineJson/PipelineJson';
+import type { ExportJsonOptions } from './utils/serialization/exportJson';
+/**
+ * Order of keys in the pipeline JSON
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const ORDER_OF_PIPELINE_JSON: ExportJsonOptions<PipelineJson>['order'];
+/**
+ * Nonce which is used for replacing things in strings
+ *
+ * @private within the repository
+ */
+export declare const REPLACING_NONCE = "u$k42k%!V2zo34w7Fu#@QUHYPW";
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare const RESERVED_PARAMETER_MISSING_VALUE: string;
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare const RESERVED_PARAMETER_RESTRICTED: string;
+/**
+ * The names of the parameters that are reserved for special purposes
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const RESERVED_PARAMETER_NAMES: readonly ["content", "context", "knowledge", "examples", "modelName", "currentDate"];
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/conversion/{pipelineStringToJson.d.ts → compilePipeline.d.ts}

@@ -6,8 +6,8 @@ import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions
  * Compile pipeline from string (markdown) format to JSON format
  *
  * Note: There are 3 similar functions:
- * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
- * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ * - `compilePipeline` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
+ * - `precompilePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
  * - `preparePipeline` - just one step in the compilation process
  *
  * Note: This function does not validate logic of the pipeline only the parsing
@@ -20,7 +20,7 @@ import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */
-export declare function pipelineStringToJson(pipelineString: PipelineString, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
+export declare function compilePipeline(pipelineString: PipelineString, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
 /**
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools

package/esm/typings/src/conversion/pipelineJsonToString.d.ts

@@ -3,6 +3,7 @@ import type { PipelineString } from '../pipeline/PipelineString';
 /**
  * Converts promptbook in JSON format to string format
  *
+ * @deprecated TODO: [🥍][🧠] Backup original files in `PipelineJson` same as in Promptbook.studio
  * @param pipelineJson Promptbook in JSON format (.book.json)
  * @returns Promptbook in string format (.book.md)
  * @public exported from `@promptbook/core`

package/esm/typings/src/conversion/{pipelineStringToJsonSync.d.ts → precompilePipeline.d.ts}

@@ -4,8 +4,8 @@ import type { PipelineString } from '../pipeline/PipelineString';
  * Compile pipeline from string (markdown) format to JSON format synchronously
  *
  * Note: There are 3 similar functions:
- * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
- * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ * - `compilePipeline` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
+ * - `precompilePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
  * - `preparePipeline` - just one step in the compilation process
  *
  * Note: This function does not validate logic of the pipeline only the parsing
@@ -16,8 +16,9 @@ import type { PipelineString } from '../pipeline/PipelineString';
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */
-export declare function pipelineStringToJsonSync(pipelineString: PipelineString): PipelineJson;
+export declare function precompilePipeline(pipelineString: PipelineString): PipelineJson;
 /**
+ * TODO: [🧠] Maybe more things here can be refactored as high-level abstractions
  * TODO: [main] !!!! Warn if used only sync version
  * TODO: [🚞] Report here line/column of error
  * TODO: Use spaceTrim more effectively

package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts

@@ -0,0 +1,20 @@
+import type { $PipelineJson } from '../../commands/_common/types/CommandParser';
+/**
+ * Used in `precompilePipeline`
+ *
+ * @private
+ */
+export type SyncHighLevelAbstraction = {
+    type: 'SYNC';
+    /**
+     * Apply the abstraction to the `pipelineJson`
+     *
+     * Note: `$` is used to indicate that this function mutates given `pipelineJson`
+     */
+    $applyToPipelineJson($pipelineJson: $PipelineJson): void;
+};
+/**
+ * TODO: [♓️] Add order here
+ * TODO: [🧠][🍱] Maybe make some common abstraction between `HighLevelAbstraction` and `CommandParser`
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/high-level-abstractions/implicit-formfactor/ImplicitFormfactorHla.d.ts

@@ -0,0 +1,10 @@
+import type { $PipelineJson } from '../../commands/_common/types/CommandParser';
+/**
+ * Set formfactor based on the pipeline interface e
+ *
+ * @private
+ */
+export declare const ImplicitFormfactorHla: {
+    type: "SYNC";
+    $applyToPipelineJson($pipelineJson: $PipelineJson): void;
+};

package/esm/typings/src/high-level-abstractions/index.d.ts

@@ -0,0 +1,44 @@
+/**
+ * All high-level abstractions
+ *
+ * @private internal index of `precompilePipeline` (= used for sync) and `preparePipeline` (= used for async)
+ */
+export declare const HIGH_LEVEL_ABSTRACTIONS: readonly [{
+    type: "SYNC";
+    $applyToPipelineJson($pipelineJson: import("type-fest/source/writable-deep").WritableObjectDeep<{
+        readonly pipelineUrl?: string | undefined;
+        readonly sourceFile?: string | undefined;
+        readonly title: string;
+        readonly bookVersion?: string | undefined;
+        readonly description?: string | undefined;
+        readonly parameters: import("../_packages/types.index").ParameterJson[];
+        readonly defaultModelRequirements?: Partial<import("../types/ModelRequirements").ModelRequirements> | undefined;
+        readonly tasks: import("../_packages/types.index").TaskJson[];
+        readonly knowledgeSources: (import("../_packages/types.index").KnowledgeSourceJson | import("../_packages/types.index").KnowledgeSourcePreparedJson)[];
+        readonly knowledgePieces: import("../_packages/types.index").KnowledgePiecePreparedJson[];
+        readonly personas: (import("../_packages/types.index").PersonaJson | import("../_packages/types.index").PersonaPreparedJson)[];
+        readonly preparations: import("../_packages/types.index").PreparationJson[];
+        readonly formfactorName?: "CHATBOT" | "GENERATOR" | "GENERIC" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
+    }>): void;
+}, {
+    type: "SYNC";
+    $applyToPipelineJson($pipelineJson: import("type-fest/source/writable-deep").WritableObjectDeep<{
+        readonly pipelineUrl?: string | undefined;
+        readonly sourceFile?: string | undefined;
+        readonly title: string;
+        readonly bookVersion?: string | undefined;
+        readonly description?: string | undefined;
+        readonly parameters: import("../_packages/types.index").ParameterJson[];
+        readonly defaultModelRequirements?: Partial<import("../types/ModelRequirements").ModelRequirements> | undefined;
+        readonly tasks: import("../_packages/types.index").TaskJson[];
+        readonly knowledgeSources: (import("../_packages/types.index").KnowledgeSourceJson | import("../_packages/types.index").KnowledgeSourcePreparedJson)[];
+        readonly knowledgePieces: import("../_packages/types.index").KnowledgePiecePreparedJson[];
+        readonly personas: (import("../_packages/types.index").PersonaJson | import("../_packages/types.index").PersonaPreparedJson)[];
+        readonly preparations: import("../_packages/types.index").PreparationJson[];
+        readonly formfactorName?: "CHATBOT" | "GENERATOR" | "GENERIC" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
+    }>): void;
+}];
+/**
+ * TODO: Test that all sync high-level abstractions are before async high-level abstractions
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/high-level-abstractions/quick-chatbot/QuickChatbotHla.d.ts

@@ -0,0 +1,10 @@
+import type { $PipelineJson } from '../../commands/_common/types/CommandParser';
+/**
+ * Allow to define chatbot with no need to write full interface
+ *
+ * @private
+ */
+export declare const QuickChatbotHla: {
+    type: "SYNC";
+    $applyToPipelineJson($pipelineJson: $PipelineJson): void;
+};

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/openai",
-    "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/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.79.0"
+        "@promptbook/core": "0.80.0-1"
     },
     "dependencies": {
         "colors": "1.4.0",