@promptbook/types - npm Package Compare versions

Comparing version 0.79.0 to 0.80.0-0

esm/typings/books/index.d.ts

@@ -19,6 +19,6 @@ declare const _default: ({
     }[];
+    personas: never[];
+    preparations: never[];
     knowledgeSources: never[];
     knowledgePieces: never[];
-    personas: never[];
-    preparations: never[];
     sourceFile: string;
@@ -49,6 +49,6 @@ } | {
     }[];
+    personas: never[];
+    preparations: never[];
     knowledgeSources: never[];
     knowledgePieces: never[];
-    personas: never[];
-    preparations: never[];
     sourceFile: string;
@@ -74,8 +74,8 @@ } | {
     }[];
+    personas: never[];
+    preparations: never[];
     knowledgeSources: never[];
     knowledgePieces: never[];
-    personas: never[];
-    preparations: never[];
     sourceFile: string;
 })[];
 export default _default;

esm/typings/src/_packages/core.index.d.ts

@@ -24,3 +24,2 @@ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME } from '../config';
-import { RESERVED_PARAMETER_NAMES } from '../config';
 import { DEFAULT_REMOTE_URL } from '../config';
@@ -32,2 +31,4 @@ import { DEFAULT_REMOTE_URL_PATH } from '../config';
 import { DEFAULT_IS_AUTO_INSTALLED } from '../config';
+import { ORDER_OF_PIPELINE_JSON } from '../constants';
+import { RESERVED_PARAMETER_NAMES } from '../constants';
 import { pipelineJsonToString } from '../conversion/pipelineJsonToString';
@@ -146,3 +147,2 @@ import { pipelineStringToJson } from '../conversion/pipelineStringToJson';
 export { DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME };
-export { RESERVED_PARAMETER_NAMES };
 export { DEFAULT_REMOTE_URL };
@@ -154,2 +154,4 @@ export { DEFAULT_REMOTE_URL_PATH };
 export { DEFAULT_IS_AUTO_INSTALLED };
+export { ORDER_OF_PIPELINE_JSON };
+export { RESERVED_PARAMETER_NAMES };
 export { pipelineJsonToString };
@@ -156,0 +158,0 @@ export { pipelineStringToJson };

esm/typings/src/_packages/types.index.d.ts

@@ -49,2 +49,4 @@ import type { PipelineCollection } from '../collection/PipelineCollection';
 import type { string_formfactor_name } from '../formfactors/_common/string_formfactor_name';
+import type { AsyncHighLevelAbstraction } from '../high-level-abstractions/_common/HighLevelAbstraction';
+import type { CommonHighLevelAbstraction } from '../high-level-abstractions/_common/HighLevelAbstraction';
 import type { LlmToolsConfiguration } from '../llm-providers/_common/register/LlmToolsConfiguration';
@@ -257,5 +259,8 @@ import type { LlmToolsMetadata } from '../llm-providers/_common/register/LlmToolsMetadata';
 import type { string_snake_case } from '../utils/normalization/normalizeTo_snake_case';
+import type { OrderJsonOptions } from '../utils/normalization/orderJson';
 import type { empty_object } from '../utils/organization/empty_object';
 import type { really_any } from '../utils/organization/really_any';
 import type { TODO_any } from '../utils/organization/TODO_any';
+import type { CheckSerializableAsJsonOptions } from '../utils/serialization/checkSerializableAsJson';
+import type { ExportJsonOptions } from '../utils/serialization/exportJson';
 import type { string_promptbook_version } from '../version';
@@ -310,2 +315,4 @@ export type { PipelineCollection };
 export type { string_formfactor_name };
+export type { AsyncHighLevelAbstraction };
+export type { CommonHighLevelAbstraction };
 export type { LlmToolsConfiguration };
@@ -518,5 +525,8 @@ export type { LlmToolsMetadata };
 export type { string_snake_case };
+export type { OrderJsonOptions };
 export type { empty_object };
 export type { really_any };
 export type { TODO_any };
+export type { CheckSerializableAsJsonOptions };
+export type { ExportJsonOptions };
 export type { string_promptbook_version };

esm/typings/src/_packages/utils.index.d.ts

@@ -41,2 +41,3 @@ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { normalizeWhitespaces } from '../utils/normalization/normalizeWhitespaces';
+import { orderJson } from '../utils/normalization/orderJson';
 import { parseKeywords } from '../utils/normalization/parseKeywords';
@@ -58,2 +59,3 @@ import { parseKeywordsFromString } from '../utils/normalization/parseKeywordsFromString';
 import { deepClone } from '../utils/serialization/deepClone';
+import { exportJson } from '../utils/serialization/exportJson';
 import { isSerializableAsJson } from '../utils/serialization/isSerializableAsJson';
@@ -116,2 +118,3 @@ import { difference } from '../utils/sets/difference';
 export { normalizeWhitespaces };
+export { orderJson };
 export { parseKeywords };
@@ -133,2 +136,3 @@ export { parseKeywordsFromString };
 export { deepClone };
+export { exportJson };
 export { isSerializableAsJson };
@@ -135,0 +139,0 @@ export { difference };

esm/typings/src/commands/_common/types/CommandParser.d.ts

@@ -68,2 +68,3 @@ import type { SetOptional, WritableDeep } from 'type-fest';
      * Note: This is used in `pipelineJsonToString` utility
+     * @deprecated TODO: [🥍][🧠] Backup original files in `PipelineJson` same as in Promptbook.studio
      */
@@ -98,2 +99,3 @@ stringify(command: TCommand): string_markdown_text;
      * Note: This is used in `pipelineJsonToString` utility
+     * @deprecated TODO: [🥍][🧠] Backup original files in `PipelineJson` same as in Promptbook.studio
      */
@@ -188,2 +190,3 @@ takeFromPipelineJson(pipelineJson: PipelineJson): ReadonlyArray<TCommand>;
  * TODO: [♓️] Add order here
+ * TODO: [🧠][🍱] Maybe make some common abstraction between `HighLevelAbstraction` and `CommandParser`
  */

esm/typings/src/config.d.ts

@@ -166,26 +166,2 @@ import type { CsvSettings } from './formats/csv/CsvSettings';
 /**
- * Nonce which is used for replacing things in strings
- *
- * @private within the repository
- */
-export declare const REPLACING_NONCE = "u$k42k%!V2zo34w7Fu#@QUHYPW";
-/**
- * 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"];
-/**
- * @@@
- *
- * @private within the repository
- */
-export declare const RESERVED_PARAMETER_MISSING_VALUE: string;
-/**
- * @@@
- *
- * @private within the repository
- */
-export declare const RESERVED_PARAMETER_RESTRICTED: string;
-/**
  * The thresholds for the relative time in the `moment` NPM package.
@@ -250,5 +226,4 @@ *
 /**
- * TODO: Extract `constants.ts` from `config.ts`
  * Note: [💞] Ignore a discrepancy between file name and entity name
  * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
  */

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

@@ -6,2 +6,3 @@ import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
  *
+ * @deprecated TODO: [🥍][🧠] Backup original files in `PipelineJson` same as in Promptbook.studio
  * @param pipelineJson Promptbook in JSON format (.book.json)
@@ -8,0 +9,0 @@ * @returns Promptbook in string format (.book.md)

esm/typings/src/conversion/pipelineStringToJsonSync.d.ts

@@ -21,2 +21,3 @@ import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 /**
+ * TODO: [🧠] Maybe more things here can be refactored as high-level abstractions
  * TODO: [main] !!!! Warn if used only sync version
@@ -23,0 +24,0 @@ * TODO: [🚞] Report here line/column of error

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

@@ -57,3 +57,3 @@ import type { AvailableModel } from '../../execution/AvailableModel';
 /**
- * TODO: Maybe use `$asDeeplyFrozenSerializableJson`
+ * TODO: Maybe use `$exportJson`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
@@ -60,0 +60,0 @@ * TODO: [🍓] Allow to list compatible models with each variant

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

@@ -14,3 +14,3 @@ import type { IDestroyable } from 'destroyable';
 /**
- * TODO: Maybe use `$asDeeplyFrozenSerializableJson`
+ * TODO: Maybe use `$exportJson`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
@@ -17,0 +17,0 @@ * TODO: [⚖] Expose the collection to be able to connect to same collection via createCollectionFromUrl

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

@@ -25,2 +25,3 @@ import type { ExecutionTools } from '../execution/ExecutionTools';
 /**
+ * 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)
@@ -27,0 +28,0 @@ * TODO: [🧠] What is better name `prepareTask` or `prepareTaskAndParameters`

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

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

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

 import type { ReadonlyDeep } from 'type-fest';
 /**
- * @@@
+ * Freezes the given object and all its nested objects recursively
  *
@@ -5,0 +5,0 @@ * Note: `$` is used to indicate that this function is not a pure function - it mutates given object

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

 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
@@ -22,7 +40,7 @@ * If not, throws an UnexpectedError with a rich error message and tracking
  */
-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
  */

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

@@ -0,1 +1,2 @@
+import { JsonValue } from 'type-fest';
 /**
@@ -20,3 +21,3 @@ * Tests if the value is [🚉] serializable as JSON
  */
-export declare function isSerializableAsJson(value: unknown): boolean;
+export declare function isSerializableAsJson(value: unknown): value is JsonValue;
 /**
@@ -23,0 +24,0 @@ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks

package.json

 {
     "name": "@promptbook/types",
-    "version": "0.79.0",
+    "version": "0.80.0-0",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
@@ -55,4 +55,4 @@ "--note-0": "    <- [🐊]",
     "peerDependencies": {
-        "@promptbook/core": "0.79.0"
+        "@promptbook/core": "0.80.0-0"
     }
 }

README.md

@@ -26,2 +26,6 @@ <!-- ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten -->
 
+<blockquote style="color: #ff8811">
+    <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
+</blockquote>
+
 ## 📦 Package `@promptbook/types`
@@ -28,0 +32,0 @@

No alert changes

Improved metrics

Total package byte prevSize

527398

increased by1.78%

Number of package files

631

increased by1.61%

Lines of code

11884

increased by1.83%

Number of lines in readme file

442

increased by0.91%

No dependency changes