@promptbook/editable 0.102.0-11 → 0.102.0-16

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

@@ -1,13 +1,51 @@
+import type { Promisable } from 'type-fest';
 import type { string_file_extension, string_mime_type } from '../../../../types/typeAliases';
 import type { ChatMessage } from '../../types/ChatMessage';
+import { ChatParticipant } from '../../types/ChatParticipant';
 /**
  * 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;
+    /**
+     * A unique name for the format (e.g. 'json', 'txt', 'md', 'html', 'pdf', etc.)
+     */
+    readonly formatName: string_file_extension | string_mime_type | string;
+    /**
+     * A human-readable label for the format (e.g. 'JSON', 'Plain Text', 'Markdown', 'HTML', 'PDF', etc.) shown in UI
+     */
+    readonly label: string;
+    /**
+     * MIME type (e.g. 'application/json', 'text/plain', 'text/markdown', 'text/html', 'application/pdf', etc.)
+     */
+    readonly mimeType: string;
+    /**
+     * File extension without leading dot (e.g. 'json', 'txt', 'md', 'html', 'pdf', etc.)
+     */
+    readonly fileExtension: string;
+    /**
+     * The function that generates the content of the file to be saved
+     */
+    getContent(chatExportData: ChatExportData): Promisable<string>;
 };
+/**
+ * Plugin contract for the data passed to `ChatSaveFormatDefinition.getContent()`
+ *
+ * @public exported from `@promptbook/components`
+ */
+type ChatExportData = {
+    /**
+     * The title of the chat (used for file naming, etc.)
+     */
+    readonly title: string;
+    /**
+     * The chat messages to be exported
+     */
+    readonly messages: ReadonlyArray<ChatMessage>;
+    /**
+     * The participants in the chat
+     */
+    readonly participants: ReadonlyArray<ChatParticipant>;
+};
+export {};

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

@@ -5,8 +5,12 @@
  */
 export declare const htmlSaveFormatDefinition: {
     readonly formatName: "html";
-    readonly label: "HTML";
-    readonly getContent: (messages: import("../../types/ChatMessage").ChatMessage[]) => string;
+    readonly label: "Html";
+    readonly getContent: ({ messages }: {
+        readonly title: string;
+        readonly messages: readonly import("../../types/ChatMessage").ChatMessage[];
+        readonly participants: readonly import("../../types/ChatParticipant").ChatParticipant[];
+    }) => string;
     readonly mimeType: "text/html";
     readonly fileExtension: "html";
 };

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

@@ -5,32 +5,62 @@
  */
 export declare const CHAT_SAVE_FORMATS: readonly [{
     readonly formatName: "json";
-    readonly label: "JSON (full)";
-    readonly getContent: (messages: import("../types/ChatMessage").ChatMessage[]) => string;
+    readonly label: "Json";
+    readonly getContent: ({ messages }: {
+        readonly title: string;
+        readonly messages: readonly import("../types/ChatMessage").ChatMessage[];
+        readonly participants: readonly import("../types/ChatParticipant").ChatParticipant[];
+    }) => string;
     readonly mimeType: "application/json";
     readonly fileExtension: "json";
 }, {
     readonly formatName: "txt";
     readonly label: "Plain Text";
-    readonly getContent: (messages: import("../types/ChatMessage").ChatMessage[]) => string;
+    readonly getContent: ({ messages }: {
+        readonly title: string;
+        readonly messages: readonly import("../types/ChatMessage").ChatMessage[];
+        readonly participants: readonly import("../types/ChatParticipant").ChatParticipant[];
+    }) => string;
     readonly mimeType: "text/plain";
     readonly fileExtension: "txt";
 }, {
     readonly formatName: "md";
     readonly label: "Markdown";
-    readonly getContent: (messages: import("../types/ChatMessage").ChatMessage[]) => string;
+    readonly getContent: ({ messages }: {
+        readonly title: string;
+        readonly messages: readonly import("../types/ChatMessage").ChatMessage[];
+        readonly participants: readonly import("../types/ChatParticipant").ChatParticipant[];
+    }) => string;
     readonly mimeType: "text/markdown";
     readonly fileExtension: "md";
 }, {
     readonly formatName: "html";
-    readonly label: "HTML";
-    readonly getContent: (messages: import("../types/ChatMessage").ChatMessage[]) => string;
+    readonly label: "Html";
+    readonly getContent: ({ messages }: {
+        readonly title: string;
+        readonly messages: readonly import("../types/ChatMessage").ChatMessage[];
+        readonly participants: readonly import("../types/ChatParticipant").ChatParticipant[];
+    }) => string;
     readonly mimeType: "text/html";
     readonly fileExtension: "html";
+}, {
+    readonly formatName: "jsx";
+    readonly label: "React";
+    readonly getContent: (chatExportData: {
+        readonly title: string;
+        readonly messages: readonly import("../types/ChatMessage").ChatMessage[];
+        readonly participants: readonly import("../types/ChatParticipant").ChatParticipant[];
+    }) => string;
+    readonly mimeType: "application/javascript";
+    readonly fileExtension: "jsx";
 }, {
     readonly formatName: "pdf";
-    readonly label: "PDF";
-    readonly getContent: (messages: import("../types/ChatMessage").ChatMessage[]) => string;
+    readonly label: "Pdf";
+    readonly getContent: (chatExportData: {
+        readonly title: string;
+        readonly messages: readonly import("../types/ChatMessage").ChatMessage[];
+        readonly participants: readonly import("../types/ChatParticipant").ChatParticipant[];
+    }) => Promise<string>;
     readonly mimeType: "application/pdf";
     readonly fileExtension: "pdf";
 }];

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

@@ -5,8 +5,12 @@
  */
 export declare const jsonSaveFormatDefinition: {
     readonly formatName: "json";
-    readonly label: "JSON (full)";
-    readonly getContent: (messages: import("../../types/ChatMessage").ChatMessage[]) => string;
+    readonly label: "Json";
+    readonly getContent: ({ messages }: {
+        readonly title: string;
+        readonly messages: readonly import("../../types/ChatMessage").ChatMessage[];
+        readonly participants: readonly import("../../types/ChatParticipant").ChatParticipant[];
+    }) => string;
     readonly mimeType: "application/json";
     readonly fileExtension: "json";
 };

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

@@ -6,7 +6,11 @@
 export declare const mdSaveFormatDefinition: {
     readonly formatName: "md";
     readonly label: "Markdown";
-    readonly getContent: (messages: import("../../types/ChatMessage").ChatMessage[]) => string;
+    readonly getContent: ({ messages }: {
+        readonly title: string;
+        readonly messages: readonly import("../../types/ChatMessage").ChatMessage[];
+        readonly participants: readonly import("../../types/ChatParticipant").ChatParticipant[];
+    }) => string;
     readonly mimeType: "text/markdown";
     readonly fileExtension: "md";
 };

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

@@ -5,8 +5,12 @@
  */
 export declare const pdfSaveFormatDefinition: {
     readonly formatName: "pdf";
-    readonly label: "PDF";
-    readonly getContent: (messages: import("../../types/ChatMessage").ChatMessage[]) => string;
+    readonly label: "Pdf";
+    readonly getContent: (chatExportData: {
+        readonly title: string;
+        readonly messages: readonly import("../../types/ChatMessage").ChatMessage[];
+        readonly participants: readonly import("../../types/ChatParticipant").ChatParticipant[];
+    }) => Promise<string>;
     readonly mimeType: "application/pdf";
     readonly fileExtension: "pdf";
 };

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

@@ -0,0 +1,16 @@
+/**
+ * React <jsx/> export plugin (full metadata)
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const reactSaveFormatDefinition: {
+    readonly formatName: "jsx";
+    readonly label: "React";
+    readonly getContent: (chatExportData: {
+        readonly title: string;
+        readonly messages: readonly import("../../types/ChatMessage").ChatMessage[];
+        readonly participants: readonly import("../../types/ChatParticipant").ChatParticipant[];
+    }) => string;
+    readonly mimeType: "application/javascript";
+    readonly fileExtension: "jsx";
+};

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

@@ -6,7 +6,11 @@
 export declare const txtSaveFormatDefinition: {
     readonly formatName: "txt";
     readonly label: "Plain Text";
-    readonly getContent: (messages: import("../../types/ChatMessage").ChatMessage[]) => string;
+    readonly getContent: ({ messages }: {
+        readonly title: string;
+        readonly messages: readonly import("../../types/ChatMessage").ChatMessage[];
+        readonly participants: readonly import("../../types/ChatParticipant").ChatParticipant[];
+    }) => string;
     readonly mimeType: "text/plain";
     readonly fileExtension: "txt";
 };

package/esm/typings/src/book-components/Chat/types/ChatParticipant.d.ts

@@ -25,7 +25,7 @@ export type ChatParticipant = {
     /**
      * Color associated with the participant
      */
-    color: string_color | Color;
+    color?: string_color | Color;
 };
 /**
  * TODO: [🕛] Unite `AgentBasicInformation`, `ChatParticipant`, `LlmExecutionTools` +  `LlmToolsMetadata`

package/esm/typings/src/book-components/icons/SaveIcon.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function SaveIcon({ size, color, ...props }: {
+    size?: number;
+    color?: string;
+} & React.SVGProps<SVGSVGElement>): import("react/jsx-runtime").JSX.Element;

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

@@ -1,9 +1,7 @@
+import { Color } from './_packages/color.index';
 import type { CsvSettings } from './formats/csv/CsvSettings';
 import type { IntermediateFilesStrategy } from './types/IntermediateFilesStrategy';
-import type { string_app_id } from './types/typeAliases';
-import type { string_email } from './types/typeAliases';
-import type { string_name } from './types/typeAliases';
-import type { string_promptbook_server_url } from './types/typeAliases';
+import type { string_app_id, string_email, string_name, string_promptbook_server_url } from './types/typeAliases';
 /**
  * Warning message for the generated sections and files files
  *
@@ -38,6 +36,30 @@ export declare const ADMIN_GITHUB_NAME: string_name;
  * @public exported from `@promptbook/core`
  */
 export declare const CLAIM = "It's time for a paradigm shift. The future of software in plain English, French or Latin";
+/**
+ * Color of the Promptbook
+ *
+ * TODO: [🗽] Unite branding and make single place for it
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const PROMPTBOOK_COLOR: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
+/**
+ * Dark color of the Promptbook
+ *
+ * TODO: [🗽] Unite branding and make single place for it
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const PROMPTBOOK_CHAT_COLOR: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
+/**
+ * Color of the user (in chat)
+ *
+ * TODO: [🗽] Unite branding and make single place for it
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const USER_CHAT_COLOR: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
 /**
  * When the title is not provided, the default title is used
  *

package/esm/typings/src/utils/color/Color.d.ts

@@ -111,6 +111,13 @@ export declare class Color {
      * @return {value is WithTake<Color>} Returns true if the value is a valid Color object, false otherwise.
      */
     static isColor(value: unknown): value is WithTake<Color>;
+    /**
+     * Checks if the given value is a valid hex color string
+     *
+     * @param value - value to check
+     * @returns true if the value is a valid hex color string (e.g., `#009edd`, `#fff`, etc.)
+     */
+    static isHexColorString(value: unknown): value is string_color;
     /**
      * Creates new Color object
      *
@@ -163,6 +170,7 @@ export declare class Color {
     toHsl(): string_color;
 }
 /**
+ * TODO: [🥻] Split Color class and color type
  * TODO: For each method a corresponding static method should be created
  *       Like clone can be done by color.clone() OR Color.clone(color)
  * TODO: Probably as an independent LIB OR add to LIB xyzt (ask @roseckyj)

package/esm/typings/src/utils/color/operators/darken.d.ts

@@ -1,3 +1,4 @@
+import { number_percent } from '../../../types/typeAliases';
 import type { ColorTransformer } from './ColorTransformer';
 /**
  * Makes color transformer which darker the given color
@@ -6,4 +7,4 @@ import type { ColorTransformer } from './ColorTransformer';
  *
  * @public exported from `@promptbook/color`
  */
-export declare function darken(amount: number): ColorTransformer;
+export declare function darken(amount: number_percent): ColorTransformer;

package/esm/typings/src/utils/color/operators/grayscale.d.ts

@@ -1,3 +1,4 @@
+import { number_percent } from '../../../types/typeAliases';
 import type { ColorTransformer } from './ColorTransformer';
 /**
  * Makes color transformer which returns a grayscale version of the color
@@ -6,4 +7,4 @@ import type { ColorTransformer } from './ColorTransformer';
  *
  * @public exported from `@promptbook/color`
  */
-export declare function grayscale(amount: number): ColorTransformer;
+export declare function grayscale(amount: number_percent): ColorTransformer;

package/esm/typings/src/utils/color/operators/lighten.d.ts

@@ -1,4 +1,5 @@
 import type { ColorTransformer } from './ColorTransformer';
+import { number_percent } from '../../../types/typeAliases';
 /**
  * Makes color transformer which lighten the given color
  *
@@ -6,7 +7,7 @@ import type { ColorTransformer } from './ColorTransformer';
  *
  * @public exported from `@promptbook/color`
  */
-export declare function lighten(amount: number): ColorTransformer;
+export declare function lighten(amount: number_percent): ColorTransformer;
 /**
  * TODO: Maybe implement by mix+hsl
  */

package/esm/typings/src/utils/color/operators/mixWithColor.d.ts

@@ -1,5 +1,6 @@
 import { Color } from '../Color';
 import type { ColorTransformer } from './ColorTransformer';
+import { number_percent } from '../../../types/typeAliases';
 /**
  * Makes color transformer which returns a mix of two colors based on a ratio
  *
@@ -8,4 +9,4 @@ import type { ColorTransformer } from './ColorTransformer';
  *
  * @public exported from `@promptbook/color`
  */
-export declare function mixWithColor(ratio: number, additionalColor: Color): ColorTransformer;
+export declare function mixWithColor(ratio: number_percent, additionalColor: Color): ColorTransformer;

package/esm/typings/src/utils/color/operators/saturate.d.ts

@@ -0,0 +1,13 @@
+import { number_percent } from '../../../types/typeAliases';
+import type { ColorTransformer } from './ColorTransformer';
+/**
+ * Makes color transformer which saturate the given color
+ *
+ * @param amount from -1 to 1
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function saturate(amount: number_percent): ColorTransformer;
+/**
+ * TODO: Maybe implement by mix+hsl
+ */

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

@@ -0,0 +1,22 @@
+import { string_javascript } from '../../types/typeAliases';
+import { TODO_any } from '../organization/TODO_any';
+type SerializeToPromptbookJavascriptReturn = {
+    /**
+     * Array of import statements required for the `value` to work
+     */
+    readonly imports: ReadonlyArray<string_javascript>;
+    /**
+     * The serialized value as a string of JavaScript code
+     */
+    readonly value: string_javascript;
+};
+/**
+ * Function `serializeToPromptbookJavascript` will serialize a value to a javascript representation using `@promptbook/*` entities where possible.
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function serializeToPromptbookJavascript(value: TODO_any): SerializeToPromptbookJavascriptReturn;
+export {};
+/**
+ * TODO: Dynamic indentation passable through options in a second argument
+ */

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-10`).
+ * It follows semantic versioning (e.g., `0.102.0-15`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/editable",
-    "version": "0.102.0-11",
+    "version": "0.102.0-16",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -95,7 +95,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/editable.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.102.0-11"
+        "@promptbook/core": "0.102.0-16"
     },
     "dependencies": {
         "crypto-js": "4.2.0",