@promptbook/types - npm Package Compare versions

Comparing version 0.81.0-5 to 0.81.0-7

esm/typings/books/index.d.ts

@@ -23,2 +23,7 @@ declare const _default: ({
     knowledgePieces: never[];
+    sources: {
+        type: string;
+        path: null;
+        content: string;
+    }[];
     sourceFile: string;
@@ -53,2 +58,7 @@ } | {
     knowledgePieces: never[];
+    sources: {
+        type: string;
+        path: null;
+        content: string;
+    }[];
     sourceFile: string;
@@ -78,4 +88,9 @@ } | {
     knowledgePieces: never[];
+    sources: {
+        type: string;
+        path: null;
+        content: string;
+    }[];
     sourceFile: string;
 })[];
 export default _default;

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

@@ -30,2 +30,3 @@ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { DEFAULT_IS_AUTO_INSTALLED } from '../config';
+import { DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME } from '../config';
 import { ORDER_OF_PIPELINE_JSON } from '../constants';
@@ -149,2 +150,3 @@ import { RESERVED_PARAMETER_NAMES } from '../constants';
 export { DEFAULT_IS_AUTO_INSTALLED };
+export { DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME };
 export { ORDER_OF_PIPELINE_JSON };
@@ -151,0 +153,0 @@ export { RESERVED_PARAMETER_NAMES };

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

 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
-import { getBookTemplate } from '../utils/getBookTemplate';
+import { getBookTemplate } from '../other/templates/getBookTemplate';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { getBookTemplate };

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

 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
+import { VALUE_STRINGS } from '../config';
+import { SMALL_NUMBER } from '../config';
 import { renderPromptbookMermaid } from '../conversion/prettify/renderPipelineMermaidOptions';
@@ -49,3 +51,5 @@ import { extractVariablesFromScript } from '../conversion/utils/extractVariablesFromScript';
 import { extractParameterNames } from '../utils/parameters/extractParameterNames';
+import { numberToString } from '../utils/parameters/numberToString';
 import { templateParameters } from '../utils/parameters/templateParameters';
+import { valueToString } from '../utils/parameters/valueToString';
 import { parseNumber } from '../utils/parseNumber';
@@ -78,2 +82,4 @@ import { $randomSeed } from '../utils/random/$randomSeed';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
+export { VALUE_STRINGS };
+export { SMALL_NUMBER };
 export { renderPromptbookMermaid };
@@ -126,3 +132,5 @@ export { extractVariablesFromScript };
 export { extractParameterNames };
+export { numberToString };
 export { templateParameters };
+export { valueToString };
 export { parseNumber };
@@ -129,0 +137,0 @@ export { $randomSeed };

esm/typings/src/config.d.ts

@@ -81,2 +81,22 @@ import type { CsvSettings } from './formats/csv/CsvSettings';
 /**
+ * Strings to represent various values in the context of parameter values
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const VALUE_STRINGS: {
+    readonly empty: "(nothing; empty string)";
+    readonly null: "(no value; null)";
+    readonly undefined: "(unknown value; undefined)";
+    readonly nan: "(not a number; NaN)";
+    readonly infinity: "(infinity; ∞)";
+    readonly negativeInfinity: "(negative infinity; -∞)";
+    readonly unserializable: "(unserializable value)";
+};
+/**
+ * Small number limit
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const SMALL_NUMBER = 0.001;
+/**
  * Timeout for the connections in milliseconds
@@ -214,2 +234,8 @@ *
 /**
+ * Function name for generated function via `ptbk make` to get the pipeline collection
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME = "getPipelineCollection";
+/**
  * @@@
@@ -216,0 +242,0 @@ *

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

@@ -21,2 +21,7 @@ /**
         readonly preparations: import("../_packages/types.index").PreparationJson[];
+        readonly sources: readonly {
+            type: "BOOK";
+            path: string | null;
+            content: import("../pipeline/PipelineString").PipelineString;
+        }[];
         readonly formfactorName?: "CHATBOT" | "GENERATOR" | "GENERIC" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
@@ -39,2 +44,7 @@ }>): void;
         readonly preparations: import("../_packages/types.index").PreparationJson[];
+        readonly sources: readonly {
+            type: "BOOK";
+            path: string | null;
+            content: import("../pipeline/PipelineString").PipelineString;
+        }[];
         readonly formfactorName?: "CHATBOT" | "GENERATOR" | "GENERIC" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
@@ -41,0 +51,0 @@ }>): void;

esm/typings/src/pipeline/PipelineJson/PipelineJson.d.ts

@@ -6,3 +6,5 @@ import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
 import type { string_pipeline_url } from '../../types/typeAliases';
+import type { string_relative_filename } from '../../types/typeAliases';
 import type { string_semantic_version } from '../../types/typeAliases';
+import type { PipelineString } from '../PipelineString';
 import type { KnowledgePiecePreparedJson } from './KnowledgePieceJson';
@@ -95,2 +97,10 @@ import type { KnowledgeSourceJson } from './KnowledgeSourceJson';
     readonly preparations: Array<PreparationJson>;
+    /**
+     * Backup of the original book source
+     */
+    readonly sources: ReadonlyArray<{
+        type: 'BOOK';
+        path: string_relative_filename | null;
+        content: PipelineString;
+    }>;
 };
@@ -97,0 +107,0 @@ /**

esm/typings/src/utils/editable/types/PipelineEditableSerialized.d.ts

 import type { ErrorJson } from '../../../errors/utils/ErrorJson';
 import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
 import type { string_date_iso8601 } from '../../../types/typeAliases';
-import type { string_pipeline_url } from '../../../types/typeAliases';
-import type { PipelineString } from '../../../pipeline/PipelineString';
 /**
@@ -26,15 +24,2 @@ * Represents a single pipeline in PromptbookStudio
     /**
-     * Unique identifier of the pipeline
-     *
-     * Note: In PromptbookStudio it is required
-     */
-    readonly pipelineUrl: string_pipeline_url;
-    /**
-     * Backup of the pipeline string
-     *
-     * Note: This is present ONLY if pipelineString can not be automatically converted into json (i.e. compilePipeline throws an error)
-     *       In other words, this is just a BACKUP of pipeline which will be deleted whener pipeline is valid again
-     */
-    readonly pipelineString: PipelineString | string | null;
-    /**
      * Known errors to transfer to new PipelineEditable
@@ -41,0 +26,0 @@ */

esm/typings/src/utils/parameters/templateParameters.d.ts

@@ -1,6 +0,10 @@
-import type { Parameters } from '../../types/typeAliases';
+import type { string_parameter_name } from '../../types/typeAliases';
 import type { string_template } from '../../types/typeAliases';
+import type { really_unknown } from '../organization/really_unknown';
 /**
  * Replaces parameters in template with values from parameters object
  *
+ * Note: This function is not places strings into string,
+ *       It's more complex and can handle this operation specifically for LLM models
+ *
  * @param template the template with parameters in {curly} braces
@@ -12,2 +16,2 @@ * @param parameters the object with parameters
  */
-export declare function templateParameters(template: string_template, parameters: Parameters): string;
+export declare function templateParameters(template: string_template, parameters: Record<string_parameter_name, really_unknown>): string;

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

@@ -9,4 +9,8 @@ import type { really_any } from '../organization/really_any';
  *
+ * Note: There are 2 similar functions
+ * - `valueToString` converts value to string for LLM models as human-readable string
+ * - `asSerializable` converts value to string to preserve full information to be able to convert it back
+ *
  * @private Internal helper function
  */
 export declare function asSerializable(value: really_any): really_any;

esm/typings/src/version.d.ts

@@ -5,2 +5,3 @@ import type { string_semantic_version } from './types/typeAliases';
  *
+ * @generated
  * @see https://github.com/webgptorg/book
@@ -12,5 +13,11 @@ */
  *
+ * @generated
  * @see https://github.com/webgptorg/promptbook
  */
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
+/**
+ * @@@
+ *
+ * @generated
+ */
 export type string_promptbook_version = string_semantic_version;
@@ -17,0 +24,0 @@ /**

package.json

 {
     "name": "@promptbook/types",
-    "version": "0.81.0-5",
+    "version": "0.81.0-7",
     "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.81.0-5"
+        "@promptbook/core": "0.81.0-7"
     }
 }

No alert changes

Improved metrics

Total package byte prevSize

534928

increased by0.68%

Number of package files

641

increased by0.47%

Lines of code

12073

increased by0.84%

No dependency changes