@promptbook/utils 0.102.0-12 → 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/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
      *

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/utils",
-    "version": "0.102.0-12",
+    "version": "0.102.0-16",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -22,7 +22,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.102.0-12';
+    const PROMPTBOOK_ENGINE_VERSION = '0.102.0-16';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -305,7 +305,7 @@
                 return Color.fromString(CSS_COLORS[color]);
                 // -----
             }
-            else if (/^#(?:[0-9a-fA-F]{3}){1,2}$/.test(color)) {
+            else if (Color.isHexColorString(color)) {
                 return Color.fromHex(color);
                 // -----
             }
@@ -564,6 +564,15 @@
             }
             return true;
         }
+        /**
+         * 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) {
+            return typeof value === 'string' && /^#(?:[0-9a-fA-F]{3}){1,2}$/.test(value);
+        }
         /**
          * Creates new Color object
          *
@@ -3504,6 +3513,68 @@
      * TODO: Type the return type correctly
      */
 
+    /**
+     * Function `serializeToPromptbookJavascript` will serialize a value to a javascript representation using `@promptbook/*` entities where possible.
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    function serializeToPromptbookJavascript(value) {
+        let serializedValue;
+        let imports = [];
+        if (value === null || value === undefined || typeof value === 'number' || typeof value === 'boolean') {
+            serializedValue = JSON.stringify(value, null, 4);
+        }
+        else if (Array.isArray(value)) {
+            const serializedItems = value.map((item) => serializeToPromptbookJavascript(item));
+            serializedValue = `[${serializedItems.map((item) => item.value).join(', ')}]`;
+            imports = serializedItems.flatMap((item) => item.imports);
+        }
+        else if (value instanceof Date) {
+            serializedValue = `new Date('${value.toISOString()}')`;
+        }
+        else if (value instanceof Color) {
+            serializedValue = `Color.fromHex('${value.toHex()}')`;
+            imports.push(`import { Color } from '@promptbook/color';`);
+        }
+        else if (typeof value === 'string') {
+            const trimmed = spaceTrim__default["default"](value);
+            if (trimmed.includes('\n')) {
+                // Multiline string -> use `spaceTrim`
+                serializedValue = `spaceTrim(\`\n${value.replace(/`/g, '\\`')}\n\`)`;
+                imports.push(`import { spaceTrim } from '@promptbook/utils';`);
+            }
+            else if (Color.isHexColorString(trimmed)) {
+                return serializeToPromptbookJavascript(Color.fromHex(trimmed));
+            }
+            else {
+                // Single line string -> use normal quotes
+                serializedValue = JSON.stringify(value);
+            }
+        }
+        else if (typeof value === 'object') {
+            const entries = Object.entries(value).map(([key, val]) => {
+                const serializedEntry = serializeToPromptbookJavascript(val);
+                imports.push(...serializedEntry.imports);
+                return [key, serializedEntry.value];
+            });
+            const objectString = `{\n${entries
+            .map(([key, val]) => `    ${JSON.stringify(key)}: ${val === null || val === void 0 ? void 0 : val.split('\n').map((line) => `    ${line}`).join('\n')}`)
+            .join(',\n')}\n}`;
+            serializedValue = objectString;
+        }
+        else {
+            throw new Error(`Cannot serialize to Promptbook Javascript value of type "${typeof value}"`);
+        }
+        if (serializedValue === undefined) {
+            throw new UnexpectedError(`Serialization resulted in undefined value`);
+        }
+        const uniqueImports = Array.from(new Set(imports)).filter((imp) => !!imp && imp.trim().length > 0);
+        return { imports: uniqueImports, value: serializedValue };
+    }
+    /**
+     * TODO: Dynamic indentation passable through options in a second argument
+     */
+
     /**
      * Create difference set of two sets.
      *
@@ -3822,6 +3893,7 @@
     exports.renderPromptbookMermaid = renderPromptbookMermaid;
     exports.searchKeywords = searchKeywords;
     exports.serializeError = serializeError;
+    exports.serializeToPromptbookJavascript = serializeToPromptbookJavascript;
     exports.spaceTrim = spaceTrim;
     exports.splitIntoSentences = splitIntoSentences;
     exports.suffixUrl = suffixUrl;