@promptbook/types 0.102.0-1 → 0.102.0-11

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

@@ -1,4 +1,5 @@
 import type { FormatCommand } from '../commands/FORMAT/FormatCommand';
+import type { ChatMessage } from '../book-components/Chat/types/ChatMessage';
 import type { Expectations } from '../pipeline/PipelineJson/Expectations';
 import type { ChatModelRequirements } from './ModelRequirements';
 import type { CompletionModelRequirements } from './ModelRequirements';
@@ -38,6 +39,10 @@ export type ChatPrompt = CommonPrompt & {
      * Requirements for chat model
      */
     modelRequirements: ChatModelRequirements;
+    /**
+     * Optional chat thread (history of previous messages)
+     */
+    thread?: ChatMessage[];
 };
 /**
  * Embedding prompt

package/esm/typings/src/utils/markdown/createMarkdownChart.d.ts

@@ -1,5 +1,5 @@
 import type { string_markdown } from '../../types/typeAliases';
-import type { FromtoItems } from '../FromtoItems';
+import type { FromtoItems } from '../misc/FromtoItems';
 /**
  * Options for `CreateMarkdownChartOptions`
  */

package/esm/typings/src/utils/markdown/humanizeAiText.d.ts

@@ -1,4 +1,4 @@
-import { string_markdown } from '../../types/typeAliases';
+import type { string_markdown } from '../../types/typeAliases';
 /**
  * Function `humanizeAiText` will remove traces of AI text generation artifacts
  *

package/esm/typings/src/utils/markdown/humanizeAiTextEllipsis.d.ts

@@ -1,4 +1,4 @@
-import { string_markdown } from '../../types/typeAliases';
+import type { string_markdown } from '../../types/typeAliases';
 /**
  * Change ellipsis character to three dots `…` -> `...`
  *

package/esm/typings/src/utils/markdown/humanizeAiTextEmdashed.d.ts

@@ -1,4 +1,4 @@
-import { string_markdown } from '../../types/typeAliases';
+import type { string_markdown } from '../../types/typeAliases';
 /**
  * Change em-dashes to regular dashes `—` -> `-`
  *

package/esm/typings/src/utils/markdown/humanizeAiTextQuotes.d.ts

@@ -1,4 +1,4 @@
-import { string_markdown } from '../../types/typeAliases';
+import type { string_markdown } from '../../types/typeAliases';
 /**
  * Change smart quotes to regular quotes
  *

package/esm/typings/src/utils/markdown/humanizeAiTextWhitespace.d.ts

@@ -1,4 +1,4 @@
-import { string_markdown } from '../../types/typeAliases';
+import type { string_markdown } from '../../types/typeAliases';
 /**
  * Change unprintable hard spaces to regular spaces
  *

package/esm/typings/src/utils/markdown/prettifyMarkdown.d.ts

@@ -5,6 +5,7 @@ import type { string_html } from '../../types/typeAliases';
  * @param content raw html code
  * @returns formatted html code
  * @private withing the package because of HUGE size of prettier dependency
+ * @deprecated Prettier removed from Promptbook due to package size
  */
 export declare function prettifyMarkdown<TContent extends string_html>(content: TContent): TContent;
 /**
@@ -13,5 +14,6 @@ export declare function prettifyMarkdown<TContent extends string_html>(content:
  * @param content raw html code
  * @returns formatted html code
  * @private withing the package because of HUGE size of prettier dependency
+ * @deprecated Prettier removed from Promptbook due to package size
  */
 export declare function prettifyMarkdownAsync<TContent extends string_html>(content: TContent): Promise<TContent>;

package/esm/typings/src/utils/markdown/promptbookifyAiText.d.ts

@@ -1,4 +1,4 @@
-import { string_markdown } from '../../types/typeAliases';
+import type { string_markdown } from '../../types/typeAliases';
 /**
  * Function `promptbookifyAiText` will slightly modify the text so we know it was processed by Promptbook
  *

package/esm/typings/src/utils/{trimCodeBlock.d.ts → markdown/trimCodeBlock.d.ts}

@@ -5,6 +5,6 @@
  * Note: This is useful for post-processing of the result of the chat LLM model
  *       when the model wraps the result in the (markdown) code block.
  *
- * @public exported from `@promptbook/utils`
+ * @public exported from `@promptbook/markdown-utils`
  */
 export declare function trimCodeBlock(value: string): string;

package/esm/typings/src/utils/{trimEndOfCodeBlock.d.ts → markdown/trimEndOfCodeBlock.d.ts}

@@ -4,6 +4,6 @@
  * Note: This is useful for post-processing of the result of the completion LLM model
  *       if you want to start code block in the prompt but you don't want to end it in the result.
  *
- * @public exported from `@promptbook/utils`
+ * @public exported from `@promptbook/markdown-utils`
  */
 export declare function trimEndOfCodeBlock(value: string): string;

package/esm/typings/src/utils/{$Register.d.ts → misc/$Register.d.ts}

@@ -1,6 +1,6 @@
 import { type IDestroyable } from 'destroyable';
-import type { string_name } from '../types/typeAliases';
-import type { TODO_string } from './organization/TODO_string';
+import type { string_name } from '../../types/typeAliases';
+import type { TODO_string } from '../organization/TODO_string';
 /**
  * Represents an entity in a global registry.
  * Contains identifying information about the package and class.

package/esm/typings/src/utils/{$getCurrentDate.d.ts → misc/$getCurrentDate.d.ts}

@@ -1,4 +1,4 @@
-import type { string_date_iso8601 } from '../types/typeAliases';
+import type { string_date_iso8601 } from '../../types/typeAliases';
 /**
  * Simple wrapper `new Date().toISOString()`
  *

package/esm/typings/src/utils/{arrayableToArray.d.ts → misc/arrayableToArray.d.ts}

@@ -1,4 +1,4 @@
-import type { Arrayable } from '../types/Arrayable';
+import type { Arrayable } from '../../types/Arrayable';
 /**
  * Takes an item or an array of items and returns an array of items
  *

package/esm/typings/src/utils/misc/debounce.d.ts

@@ -0,0 +1,5 @@
+import type { TODO_any } from '../organization/TODO_any';
+/**
+ * @public exported from `@promptbook/utils`
+ */
+export declare function debounce<T extends (...args: TODO_any[]) => void>(fn: T, delay: number): (...args: Parameters<T>) => void;

package/esm/typings/src/utils/{emojis.d.ts → misc/emojis.d.ts}

@@ -1,4 +1,4 @@
-import type { string_char_emoji } from '../types/typeAliasEmoji';
+import type { string_char_emoji } from '../../types/typeAliasEmoji';
 /**
  * All possible emoji chars like "🍆", "🍡", "🍤"...
  * Note: this will be needed to update annually - now updated at 2022-01-19

package/esm/typings/src/utils/misc/injectCssModuleIntoShadowRoot.d.ts

@@ -0,0 +1,20 @@
+import type { string_css_class } from '../../types/typeAliases';
+export type InjectCssModuleIntoShadowRootOptions = {
+    /**
+     * The shadow root where the styles should be injected
+     */
+    shadowRoot: ShadowRoot;
+    /**
+     * The imported CSS module styles object
+     */
+    styles: Record<string_css_class, string_css_class>;
+};
+/**
+ * Inject the CSS module rules (derived from imported `styles`) into the provided shadow root.
+ * This allows CSS modules (which are normally emitted into the document head) to be
+ * available inside the component's shadow DOM.
+ *
+ * @public exported from `@promptbook/components`
+ *         <- TODO: [🧠] Make `@promptbook/components-utils`
+ */
+export declare function injectCssModuleIntoShadowRoot(options: InjectCssModuleIntoShadowRootOptions): void;

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

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.102.0-0`).
+ * It follows semantic versioning (e.g., `0.102.0-10`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.102.0-1",
+    "version": "0.102.0-11",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -92,6 +92,6 @@
     },
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.102.0-1"
+        "@promptbook/core": "0.102.0-11"
     }
 }

package/esm/typings/src/book-components/BookEditor/injectCssModuleIntoShadowRoot.d.ts

@@ -1,11 +0,0 @@
-/**
- * Inject the CSS module rules (derived from imported `styles`) into the provided shadow root.
- * This allows CSS modules (which are normally emitted into the document head) to be
- * available inside the component's shadow DOM.
- *
- * @private within the promptbook components <- TODO: Maybe make promptbook util from this
- */
-export declare function injectCssModuleIntoShadowRoot(shadowRoot: ShadowRoot): void;
-/**
- * TODO: Make some utility functions for working with CSS modules in shadow DOM independent of `BookEditor.module.css`
- */

package/esm/typings/src/book-components/Chat/save/savePlugins.d.ts

@@ -1,105 +0,0 @@
-import { string_file_extension, string_mime_type } from '../../../types/typeAliases';
-import type { ChatMessage } from '../types/ChatMessage';
-/**
- * Supported chat export formatNames
- * @public exported from `@promptbook/components`
- */
-export type string_chat_format_name = typeof CHAT_SAVE_FORMATS[number]['formatName'];
-/**
- * Plugin contract for chat export formatNames
- * @public exported from `@promptbook/components`
- */
-export type ChatSaveFormatDefinition = {
-    formatName: string_file_extension | string_mime_type | string;
-    label: string;
-    getContent: (messages: ChatMessage[]) => string;
-    mimeType: string;
-    fileExtension: string;
-};
-/**
- * JSON export plugin (full metadata)
- *
- * @public exported from `@promptbook/components`
- */
-export declare const jsonSaveFormatDefinition: {
-    readonly formatName: "json";
-    readonly label: "JSON (full)";
-    readonly getContent: (messages: ChatMessage[]) => string;
-    readonly mimeType: "application/json";
-    readonly fileExtension: "json";
-};
-/**
- * Plain text export plugin (messages only)
- *
- * @public exported from `@promptbook/components`
- */
-export declare const txtSaveFormatDefinition: {
-    readonly formatName: "txt";
-    readonly label: "Plain Text";
-    readonly getContent: (messages: ChatMessage[]) => string;
-    readonly mimeType: "text/plain";
-    readonly fileExtension: "txt";
-};
-/**
- * Markdown export plugin
- *
- * @public exported from `@promptbook/components`
- */
-export declare const mdSaveFormatDefinition: {
-    readonly formatName: "md";
-    readonly label: "Markdown";
-    readonly getContent: (messages: ChatMessage[]) => string;
-    readonly mimeType: "text/markdown";
-    readonly fileExtension: "md";
-};
-/**
- * HTML export plugin
- *
- * @public exported from `@promptbook/components`
- */
-export declare const htmlSaveFormatDefinition: {
-    readonly formatName: "html";
-    readonly label: "HTML";
-    readonly getContent: (messages: ChatMessage[]) => string;
-    readonly mimeType: "text/html";
-    readonly fileExtension: "html";
-};
-/**
- * Registry of all built-in chat save plugins
- *
- * @public exported from `@promptbook/components`
- */
-export declare const CHAT_SAVE_FORMATS: readonly [{
-    readonly formatName: "json";
-    readonly label: "JSON (full)";
-    readonly getContent: (messages: ChatMessage[]) => string;
-    readonly mimeType: "application/json";
-    readonly fileExtension: "json";
-}, {
-    readonly formatName: "txt";
-    readonly label: "Plain Text";
-    readonly getContent: (messages: ChatMessage[]) => string;
-    readonly mimeType: "text/plain";
-    readonly fileExtension: "txt";
-}, {
-    readonly formatName: "md";
-    readonly label: "Markdown";
-    readonly getContent: (messages: ChatMessage[]) => string;
-    readonly mimeType: "text/markdown";
-    readonly fileExtension: "md";
-}, {
-    readonly formatName: "html";
-    readonly label: "HTML";
-    readonly getContent: (messages: ChatMessage[]) => string;
-    readonly mimeType: "text/html";
-    readonly fileExtension: "html";
-}];
-/**
- * Returns enabled chat save plugins filtered by formatNames (or all when omitted)
- *
- * @public exported from `@promptbook/components`
- */
-export declare function getChatSaveFormatDefinitions(formatNames?: ReadonlyArray<string_chat_format_name>): ReadonlyArray<ChatSaveFormatDefinition>;
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */