@promptlycms/prompts 0.5.0 → 0.6.0-canary.af507c4

package/README.md

@@ -171,6 +171,13 @@ const output = formatComposer({
 });
 ```
 
+Prompt results are treated as text by default. Newlines in strings or `{ text }`
+results are preserved as `<br>` tags when the composer output is assembled. If
+text prompt output is placed in its own rich-text paragraph, the SDK also keeps
+the visible paragraph gap in email-safe HTML. If a prompt result already
+contains trusted HTML, pass `{ html: '<p>...</p>' }` to `formatComposer()` to
+insert it without newline conversion.
+
 Batch fetch multiple composers in parallel:
 
 ```typescript
@@ -198,6 +205,9 @@ for (const segment of composer.segments) {
 
 Variable references inside an `html_block` (e.g. `<span data-variable-ref data-field-path="country">`) are interpolated normally during `formatComposer()` / `compose()`. Embedded prompt references inside an `html_block` are passed through opaquely — they aren't resolved as named prompts.
 
+HTML blocks are otherwise left raw, including whitespace, comments, and empty
+paragraphs.
+
 ## Model auto-detection
 
 The SDK automatically resolves models configured in the CMS to the correct AI SDK provider based on the model name prefix:

package/dist/index.cjs

@@ -186,6 +186,31 @@ var toCamelCase = (name) => name.replace(/[^a-zA-Z0-9]+(.)/g, (_, char) => char.
 var VARIABLE_REF_REGEX = /<span[^>]*\sdata-variable-ref(?:="[^"]*")?[^>]*\sdata-field-path="([^"]+)"[^>]*><\/span>/g;
 var VARIABLE_REF_ALT_REGEX = /<span[^>]*\sdata-field-path="([^"]+)"[^>]*\sdata-variable-ref(?:="[^"]*")?[^>]*><\/span>/g;
 var MUSTACHE_REGEX = /\{\{(\w[\w.]*)\}\}/g;
+var EMPTY_PARAGRAPH_REGEX = /<p(\s[^>]*)?>\s*<\/p>/gi;
+var preserveEmptyParagraphs = (content) => content.replace(
+  EMPTY_PARAGRAPH_REGEX,
+  (_, attributes) => `<p${attributes ?? ""}><br></p>`
+);
+var preserveTextLineBreaks = (content) => content.replace(/\r\n?/g, "\n").replaceAll("\n", "<br>");
+var isHtmlFormatInput = (input) => typeof input === "object" && input !== null && "html" in input;
+var formatComposerInput = (input) => {
+  if (typeof input === "string") {
+    return preserveTextLineBreaks(input);
+  }
+  if (isHtmlFormatInput(input)) {
+    return input.html;
+  }
+  return preserveTextLineBreaks(input.text);
+};
+var STANDALONE_PROMPT_OPEN_PARAGRAPH_REGEX = /<\/p>\s*<p(?:\s[^>]*)?>\s*$/i;
+var STANDALONE_PROMPT_CLOSE_PARAGRAPH_REGEX = /^\s*<\/p>/i;
+var EXPLICIT_SPACER_BEFORE_OPEN_PARAGRAPH_REGEX = /<p(?:\s[^>]*)?>\s*<br\s*\/?>\s*<\/p>\s*<p(?:\s[^>]*)?>\s*$/i;
+var shouldPrefixStandalonePromptText = (previous, next) => {
+  if (previous?.type !== "static" || next?.type !== "static") {
+    return false;
+  }
+  return STANDALONE_PROMPT_OPEN_PARAGRAPH_REGEX.test(previous.content) && STANDALONE_PROMPT_CLOSE_PARAGRAPH_REGEX.test(next.content) && !EXPLICIT_SPACER_BEFORE_OPEN_PARAGRAPH_REGEX.test(previous.content);
+};
 var interpolateStaticSegment = (content, input) => {
   let result = content;
   result = result.replace(
@@ -271,7 +296,9 @@ var createPromptlyClient = (config) => {
       if (segment.type === "static") {
         processedSegments.push({
           type: "static",
-          content: interpolateStaticSegment(segment.content, input)
+          content: preserveEmptyParagraphs(
+            interpolateStaticSegment(segment.content, input)
+          )
         });
         continue;
       }
@@ -303,7 +330,7 @@ var createPromptlyClient = (config) => {
     }
     const formatComposer = (results) => {
       const parts = [];
-      for (const seg of processedSegments) {
+      for (const [index, seg] of processedSegments.entries()) {
         if (seg.type === "static") {
           parts.push(seg.content);
           continue;
@@ -312,7 +339,12 @@ var createPromptlyClient = (config) => {
         if (val === void 0) {
           continue;
         }
-        parts.push(typeof val === "string" ? val : val.text);
+        const formattedInput = formatComposerInput(val);
+        const prefix = isHtmlFormatInput(val) || !shouldPrefixStandalonePromptText(
+          processedSegments[index - 1],
+          processedSegments[index + 1]
+        ) ? "" : "<br>";
+        parts.push(`${prefix}${formattedInput}`);
       }
       return parts.join("");
     };

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { P as PromptlyClientConfig, a as PromptlyClient, E as ErrorCode } from './types-DaIU82yN.cjs';
-export { C as ComposerConfig, b as ComposerFormatFn, c as ComposerGenerateFn, d as ComposerHtmlBlockSegment, e as ComposerId, f as ComposerInputFor, g as ComposerPrompt, h as ComposerPromptMap, i as ComposerPromptNamesFor, j as ComposerPromptSegment, k as ComposerRequest, l as ComposerResponse, m as ComposerResult, n as ComposerSegment, o as ComposerStaticSegment, p as ComposerVariableMap, q as ComposerVersion, r as ErrorResponse, F as FormatInput, G as GetComposerOptions, s as GetOptions, t as PromptConfig, u as PromptId, v as PromptMessage, w as PromptRequest, x as PromptResponse, y as PromptResult, z as PromptVariableMap, A as PromptVersion, B as PublishedVersion, S as SchemaField, D as SchemaFieldParams, V as ValidationRule } from './types-DaIU82yN.cjs';
+import { P as PromptlyClientConfig, a as PromptlyClient, E as ErrorCode } from './types-BStQVsgZ.cjs';
+export { C as ComposerConfig, b as ComposerFormatFn, c as ComposerGenerateFn, d as ComposerHtmlBlockSegment, e as ComposerId, f as ComposerInputFor, g as ComposerPrompt, h as ComposerPromptMap, i as ComposerPromptNamesFor, j as ComposerPromptSegment, k as ComposerRequest, l as ComposerResponse, m as ComposerResult, n as ComposerSegment, o as ComposerStaticSegment, p as ComposerVariableMap, q as ComposerVersion, r as ErrorResponse, F as FormatInput, G as GetComposerOptions, s as GetOptions, t as PromptConfig, u as PromptId, v as PromptMessage, w as PromptRequest, x as PromptResponse, y as PromptResult, z as PromptVariableMap, A as PromptVersion, B as PublishedVersion, S as SchemaField, D as SchemaFieldParams, V as ValidationRule } from './types-BStQVsgZ.cjs';
 import 'ai';
 
 declare const getSdkModelId: (modelId: string) => string;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { P as PromptlyClientConfig, a as PromptlyClient, E as ErrorCode } from './types-DaIU82yN.js';
-export { C as ComposerConfig, b as ComposerFormatFn, c as ComposerGenerateFn, d as ComposerHtmlBlockSegment, e as ComposerId, f as ComposerInputFor, g as ComposerPrompt, h as ComposerPromptMap, i as ComposerPromptNamesFor, j as ComposerPromptSegment, k as ComposerRequest, l as ComposerResponse, m as ComposerResult, n as ComposerSegment, o as ComposerStaticSegment, p as ComposerVariableMap, q as ComposerVersion, r as ErrorResponse, F as FormatInput, G as GetComposerOptions, s as GetOptions, t as PromptConfig, u as PromptId, v as PromptMessage, w as PromptRequest, x as PromptResponse, y as PromptResult, z as PromptVariableMap, A as PromptVersion, B as PublishedVersion, S as SchemaField, D as SchemaFieldParams, V as ValidationRule } from './types-DaIU82yN.js';
+import { P as PromptlyClientConfig, a as PromptlyClient, E as ErrorCode } from './types-BStQVsgZ.js';
+export { C as ComposerConfig, b as ComposerFormatFn, c as ComposerGenerateFn, d as ComposerHtmlBlockSegment, e as ComposerId, f as ComposerInputFor, g as ComposerPrompt, h as ComposerPromptMap, i as ComposerPromptNamesFor, j as ComposerPromptSegment, k as ComposerRequest, l as ComposerResponse, m as ComposerResult, n as ComposerSegment, o as ComposerStaticSegment, p as ComposerVariableMap, q as ComposerVersion, r as ErrorResponse, F as FormatInput, G as GetComposerOptions, s as GetOptions, t as PromptConfig, u as PromptId, v as PromptMessage, w as PromptRequest, x as PromptResponse, y as PromptResult, z as PromptVariableMap, A as PromptVersion, B as PublishedVersion, S as SchemaField, D as SchemaFieldParams, V as ValidationRule } from './types-BStQVsgZ.js';
 import 'ai';
 
 declare const getSdkModelId: (modelId: string) => string;

package/dist/index.js

@@ -145,6 +145,31 @@ var toCamelCase = (name) => name.replace(/[^a-zA-Z0-9]+(.)/g, (_, char) => char.
 var VARIABLE_REF_REGEX = /<span[^>]*\sdata-variable-ref(?:="[^"]*")?[^>]*\sdata-field-path="([^"]+)"[^>]*><\/span>/g;
 var VARIABLE_REF_ALT_REGEX = /<span[^>]*\sdata-field-path="([^"]+)"[^>]*\sdata-variable-ref(?:="[^"]*")?[^>]*><\/span>/g;
 var MUSTACHE_REGEX = /\{\{(\w[\w.]*)\}\}/g;
+var EMPTY_PARAGRAPH_REGEX = /<p(\s[^>]*)?>\s*<\/p>/gi;
+var preserveEmptyParagraphs = (content) => content.replace(
+  EMPTY_PARAGRAPH_REGEX,
+  (_, attributes) => `<p${attributes ?? ""}><br></p>`
+);
+var preserveTextLineBreaks = (content) => content.replace(/\r\n?/g, "\n").replaceAll("\n", "<br>");
+var isHtmlFormatInput = (input) => typeof input === "object" && input !== null && "html" in input;
+var formatComposerInput = (input) => {
+  if (typeof input === "string") {
+    return preserveTextLineBreaks(input);
+  }
+  if (isHtmlFormatInput(input)) {
+    return input.html;
+  }
+  return preserveTextLineBreaks(input.text);
+};
+var STANDALONE_PROMPT_OPEN_PARAGRAPH_REGEX = /<\/p>\s*<p(?:\s[^>]*)?>\s*$/i;
+var STANDALONE_PROMPT_CLOSE_PARAGRAPH_REGEX = /^\s*<\/p>/i;
+var EXPLICIT_SPACER_BEFORE_OPEN_PARAGRAPH_REGEX = /<p(?:\s[^>]*)?>\s*<br\s*\/?>\s*<\/p>\s*<p(?:\s[^>]*)?>\s*$/i;
+var shouldPrefixStandalonePromptText = (previous, next) => {
+  if (previous?.type !== "static" || next?.type !== "static") {
+    return false;
+  }
+  return STANDALONE_PROMPT_OPEN_PARAGRAPH_REGEX.test(previous.content) && STANDALONE_PROMPT_CLOSE_PARAGRAPH_REGEX.test(next.content) && !EXPLICIT_SPACER_BEFORE_OPEN_PARAGRAPH_REGEX.test(previous.content);
+};
 var interpolateStaticSegment = (content, input) => {
   let result = content;
   result = result.replace(
@@ -230,7 +255,9 @@ var createPromptlyClient = (config) => {
       if (segment.type === "static") {
         processedSegments.push({
           type: "static",
-          content: interpolateStaticSegment(segment.content, input)
+          content: preserveEmptyParagraphs(
+            interpolateStaticSegment(segment.content, input)
+          )
         });
         continue;
       }
@@ -262,7 +289,7 @@ var createPromptlyClient = (config) => {
     }
     const formatComposer = (results) => {
       const parts = [];
-      for (const seg of processedSegments) {
+      for (const [index, seg] of processedSegments.entries()) {
         if (seg.type === "static") {
           parts.push(seg.content);
           continue;
@@ -271,7 +298,12 @@ var createPromptlyClient = (config) => {
         if (val === void 0) {
           continue;
         }
-        parts.push(typeof val === "string" ? val : val.text);
+        const formattedInput = formatComposerInput(val);
+        const prefix = isHtmlFormatInput(val) || !shouldPrefixStandalonePromptText(
+          processedSegments[index - 1],
+          processedSegments[index + 1]
+        ) ? "" : "<br>";
+        parts.push(`${prefix}${formattedInput}`);
       }
       return parts.join("");
     };

package/dist/schema.d.cts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { S as SchemaField } from './types-DaIU82yN.cjs';
+import { S as SchemaField } from './types-BStQVsgZ.cjs';
 import 'ai';
 
 declare const buildFieldSchema: (field: SchemaField) => z.ZodTypeAny;

package/dist/schema.d.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { S as SchemaField } from './types-DaIU82yN.js';
+import { S as SchemaField } from './types-BStQVsgZ.js';
 import 'ai';
 
 declare const buildFieldSchema: (field: SchemaField) => z.ZodTypeAny;

package/dist/{types-DaIU82yN.d.cts → types-BStQVsgZ.d.cts}

@@ -147,10 +147,10 @@ type ComposerPrompt = {
 };
 type FormatInput = {
     text: string;
+} | {
+    html: string;
 } | string;
-type ComposerGenerateFn = (prompt: ComposerPrompt) => Promise<{
-    text: string;
-} | string>;
+type ComposerGenerateFn = (prompt: ComposerPrompt) => Promise<FormatInput>;
 type ComposerFormatFn<Names extends string = string> = (results: Record<Names, FormatInput>) => string;
 type ComposerResult<Names extends string = string> = {
     composerId: string;

package/dist/{types-DaIU82yN.d.ts → types-BStQVsgZ.d.ts}

@@ -147,10 +147,10 @@ type ComposerPrompt = {
 };
 type FormatInput = {
     text: string;
+} | {
+    html: string;
 } | string;
-type ComposerGenerateFn = (prompt: ComposerPrompt) => Promise<{
-    text: string;
-} | string>;
+type ComposerGenerateFn = (prompt: ComposerPrompt) => Promise<FormatInput>;
 type ComposerFormatFn<Names extends string = string> = (results: Record<Names, FormatInput>) => string;
 type ComposerResult<Names extends string = string> = {
     composerId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@promptlycms/prompts",
-  "version": "0.5.0",
+  "version": "0.6.0-canary.af507c4",
   "description": "TypeScript SDK for Promptly CMS — fetch prompts, build Zod schemas, generate typed code",
   "type": "module",
   "exports": {