@promptlycms/prompts 0.4.1 → 0.5.0

package/README.md

@@ -180,6 +180,24 @@ const [first, second] = await promptly.getComposers([
 ]);
 ```
 
+### HTML blocks
+
+Composers can contain raw HTML blocks (for vendor-specific markup like MSO conditional comments in transactional emails). These surface as a distinct `html_block` segment type:
+
+```typescript
+const composer = await promptly.getComposer('my-email-composer', {
+  input: { country: 'United Kingdom' },
+});
+
+for (const segment of composer.segments) {
+  if (segment.type === 'html_block') {
+    console.log(segment.html); // raw HTML, byte-exact
+  }
+}
+```
+
+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.
+
 ## Model auto-detection
 
 The SDK automatically resolves models configured in the CMS to the correct AI SDK provider based on the model name prefix:
@@ -232,7 +250,7 @@ declare module '@promptlycms/prompts' {
 }
 ```
 
-With this file present, `getPrompt()` and `getPrompts()` return typed `userMessage` functions with autocomplete. `getComposer()` and `getComposers()` get typed `input` and named prompt properties. Unknown IDs fall back to `Record<string, string>`.
+With this file present, `getPrompt()` and `getPrompts()` return typed `userMessage` functions with autocomplete. `getComposer()` and `getComposers()` only accept generated composer IDs, with typed `input` and named prompt properties. Unknown prompt IDs fall back to `Record<string, unknown>`.
 
 Add the generated file to version control so types are available without running codegen in CI. Re-run `npx promptly generate` whenever you add, remove, or rename template variables in the CMS.
 
@@ -286,7 +304,7 @@ Fetch a single composer. Returns `ComposerResult` with named prompt properties,
 
 | Option    | Type                      | Description          |
 |-----------|---------------------------|----------------------|
-| `input`   | `Record<string, string>`  | Template variables to interpolate |
+| `input`   | `Record<string, unknown>` | Template variables to interpolate |
 | `version` | `string`                  | Specific version to fetch (default: latest) |
 
 ### `client.getComposers(entries)`

package/dist/cli.js

@@ -148,6 +148,10 @@ var extractComposerVariables = (composer) => {
       for (const v of extractStaticSegmentVariables(segment.content)) {
         vars.add(v);
       }
+    } else if (segment.type === "html_block") {
+      for (const v of extractStaticSegmentVariables(segment.html)) {
+        vars.add(v);
+      }
     }
   }
   return [...vars];
@@ -277,6 +281,13 @@ var buildSchemaMap = (schema) => {
   }
   return map;
 };
+var TYPE_IDENTIFIER_RE = /^[A-Za-z_$][A-Za-z0-9_$]*$/;
+var typePropertyKey = (key) => {
+  if (TYPE_IDENTIFIER_RE.test(key)) {
+    return key;
+  }
+  return `'${key.replaceAll("\\", "\\\\").replaceAll("'", "\\'")}'`;
+};
 var generateMappedTypeBlock = (group, indent, schemaMap = /* @__PURE__ */ new Map()) => {
   const lines = [];
   const { versions, variables } = group;
@@ -358,6 +369,7 @@ var generateTypeDeclaration = (prompts, composers = []) => {
     lines.push("  interface ComposerVariableMap {");
     for (const composer of composers) {
       const variables = extractComposerVariables(composer);
+      const composerKey = typePropertyKey(composer.composerId);
       const schemaMap = buildSchemaMap(composer.config.schema);
       const versions = ["'latest'"];
       if (composer.publishedVersions) {
@@ -367,7 +379,7 @@ var generateTypeDeclaration = (prompts, composers = []) => {
       } else {
         versions.push(`'${composer.version}'`);
       }
-      lines.push(`    '${composer.composerId}': {`);
+      lines.push(`    ${composerKey}: {`);
       if (versions.length === 1) {
         if (variables.length === 0) {
           lines.push(`      [V in ${versions[0]}]: Record<string, never>;`);
@@ -400,11 +412,12 @@ var generateTypeDeclaration = (prompts, composers = []) => {
     lines.push("  interface ComposerPromptMap {");
     for (const composer of composers) {
       const names = extractComposerPromptNames(composer);
+      const composerKey = typePropertyKey(composer.composerId);
       if (names.length === 0) {
-        lines.push(`    '${composer.composerId}': never;`);
+        lines.push(`    ${composerKey}: never;`);
       } else {
         const union = names.map((n) => `'${n}'`).join(" | ");
-        lines.push(`    '${composer.composerId}': ${union};`);
+        lines.push(`    ${composerKey}: ${union};`);
       }
     }
     lines.push("  }");

package/dist/index.cjs

@@ -275,6 +275,13 @@ var createPromptlyClient = (config) => {
         });
         continue;
       }
+      if (segment.type === "html_block") {
+        processedSegments.push({
+          type: "static",
+          content: interpolateStaticSegment(segment.html, input)
+        });
+        continue;
+      }
       const camelName = toCamelCase(segment.promptName);
       if (!promptsByName.has(camelName)) {
         const segmentConfig = segment.config;

package/dist/index.d.cts

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

package/dist/index.js

@@ -234,6 +234,13 @@ var createPromptlyClient = (config) => {
         });
         continue;
       }
+      if (segment.type === "html_block") {
+        processedSegments.push({
+          type: "static",
+          content: interpolateStaticSegment(segment.html, input)
+        });
+        continue;
+      }
       const camelName = toCamelCase(segment.promptName);
       if (!promptsByName.has(camelName)) {
         const segmentConfig = segment.config;

package/dist/schema.d.cts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { S as SchemaField } from './types-DIVyjOlH.cjs';
+import { S as SchemaField } from './types-DaIU82yN.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-DIVyjOlH.js';
+import { S as SchemaField } from './types-DaIU82yN.js';
 import 'ai';
 
 declare const buildFieldSchema: (field: SchemaField) => z.ZodTypeAny;

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

@@ -108,7 +108,11 @@ type ComposerPromptSegment = {
     userMessage: string | null;
     config: Record<string, unknown>;
 };
-type ComposerSegment = ComposerStaticSegment | ComposerPromptSegment;
+type ComposerHtmlBlockSegment = {
+    type: 'html_block';
+    html: string;
+};
+type ComposerSegment = ComposerStaticSegment | ComposerPromptSegment | ComposerHtmlBlockSegment;
 type ComposerConfig = {
     schema: SchemaField[];
     inputData: unknown;
@@ -128,7 +132,8 @@ interface ComposerVariableMap {
 }
 interface ComposerPromptMap {
 }
-type ComposerId = keyof ComposerVariableMap | (string & {});
+type KnownComposerId = Extract<keyof ComposerVariableMap, string>;
+type ComposerId = [KnownComposerId] extends [never] ? string : KnownComposerId;
 type ComposerVersion<Id extends string> = Id extends keyof ComposerVariableMap ? Exclude<keyof ComposerVariableMap[Id], 'latest'> : string;
 type ComposerInputFor<Id extends string, Ver extends string = 'latest'> = Id extends keyof ComposerVariableMap ? Ver extends keyof ComposerVariableMap[Id] ? ComposerVariableMap[Id][Ver] : Record<string, unknown> : Record<string, unknown>;
 type ComposerPromptNamesFor<Id extends string> = Id extends keyof ComposerPromptMap ? ComposerPromptMap[Id] : string;
@@ -159,12 +164,12 @@ type ComposerResult<Names extends string = string> = {
 } & {
     [K in Names]: ComposerPrompt;
 };
-type GetComposerOptions<Id extends string = string, V extends string = 'latest'> = {
+type GetComposerOptions<Id extends string = ComposerId, V extends string = 'latest'> = {
     input?: ComposerInputFor<Id, V>;
     version?: V;
 };
 type ComposerRequest = {
-    composerId: string;
+    composerId: ComposerId;
     input?: Record<string, unknown>;
     version?: string;
 };
@@ -191,8 +196,8 @@ type GetOptions<V extends string = string> = {
 type PromptlyClient = {
     getPrompt: <T extends string, V extends PromptVersion<T> | 'latest' = 'latest'>(promptId: T, options?: GetOptions<V>) => Promise<PromptResult<VariablesFor<T, V>>>;
     getPrompts: <const T extends readonly PromptRequest[]>(entries: T) => Promise<GetPromptsResults<T>>;
-    getComposer: <T extends string, V extends ComposerVersion<T> | 'latest' = 'latest'>(composerId: T, options?: GetComposerOptions<T, V>) => Promise<ComposerResult<ComposerPromptNamesFor<T>>>;
+    getComposer: <T extends ComposerId, V extends ComposerVersion<T> | 'latest' = 'latest'>(composerId: T, options?: GetComposerOptions<T, V>) => Promise<ComposerResult<ComposerPromptNamesFor<T>>>;
     getComposers: <const T extends readonly ComposerRequest[]>(entries: T) => Promise<GetComposersResults<T>>;
 };
 
-export type { PublishedVersion as A, SchemaFieldParams as B, ComposerConfig as C, ErrorCode as E, FormatInput as F, GetComposerOptions as G, PromptlyClientConfig as P, SchemaField as S, ValidationRule as V, PromptlyClient as a, ComposerFormatFn as b, ComposerGenerateFn as c, ComposerId as d, ComposerInputFor as e, ComposerPrompt as f, ComposerPromptMap as g, ComposerPromptNamesFor as h, ComposerPromptSegment as i, ComposerRequest as j, ComposerResponse as k, ComposerResult as l, ComposerSegment as m, ComposerStaticSegment as n, ComposerVariableMap as o, ComposerVersion as p, ErrorResponse as q, GetOptions as r, PromptConfig as s, PromptId as t, PromptMessage as u, PromptRequest as v, PromptResponse as w, PromptResult as x, PromptVariableMap as y, PromptVersion as z };
+export type { PromptVersion as A, PublishedVersion as B, ComposerConfig as C, SchemaFieldParams as D, ErrorCode as E, FormatInput as F, GetComposerOptions as G, PromptlyClientConfig as P, SchemaField as S, ValidationRule as V, PromptlyClient as a, ComposerFormatFn as b, ComposerGenerateFn as c, ComposerHtmlBlockSegment as d, ComposerId as e, ComposerInputFor as f, ComposerPrompt as g, ComposerPromptMap as h, ComposerPromptNamesFor as i, ComposerPromptSegment as j, ComposerRequest as k, ComposerResponse as l, ComposerResult as m, ComposerSegment as n, ComposerStaticSegment as o, ComposerVariableMap as p, ComposerVersion as q, ErrorResponse as r, GetOptions as s, PromptConfig as t, PromptId as u, PromptMessage as v, PromptRequest as w, PromptResponse as x, PromptResult as y, PromptVariableMap as z };

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

@@ -108,7 +108,11 @@ type ComposerPromptSegment = {
     userMessage: string | null;
     config: Record<string, unknown>;
 };
-type ComposerSegment = ComposerStaticSegment | ComposerPromptSegment;
+type ComposerHtmlBlockSegment = {
+    type: 'html_block';
+    html: string;
+};
+type ComposerSegment = ComposerStaticSegment | ComposerPromptSegment | ComposerHtmlBlockSegment;
 type ComposerConfig = {
     schema: SchemaField[];
     inputData: unknown;
@@ -128,7 +132,8 @@ interface ComposerVariableMap {
 }
 interface ComposerPromptMap {
 }
-type ComposerId = keyof ComposerVariableMap | (string & {});
+type KnownComposerId = Extract<keyof ComposerVariableMap, string>;
+type ComposerId = [KnownComposerId] extends [never] ? string : KnownComposerId;
 type ComposerVersion<Id extends string> = Id extends keyof ComposerVariableMap ? Exclude<keyof ComposerVariableMap[Id], 'latest'> : string;
 type ComposerInputFor<Id extends string, Ver extends string = 'latest'> = Id extends keyof ComposerVariableMap ? Ver extends keyof ComposerVariableMap[Id] ? ComposerVariableMap[Id][Ver] : Record<string, unknown> : Record<string, unknown>;
 type ComposerPromptNamesFor<Id extends string> = Id extends keyof ComposerPromptMap ? ComposerPromptMap[Id] : string;
@@ -159,12 +164,12 @@ type ComposerResult<Names extends string = string> = {
 } & {
     [K in Names]: ComposerPrompt;
 };
-type GetComposerOptions<Id extends string = string, V extends string = 'latest'> = {
+type GetComposerOptions<Id extends string = ComposerId, V extends string = 'latest'> = {
     input?: ComposerInputFor<Id, V>;
     version?: V;
 };
 type ComposerRequest = {
-    composerId: string;
+    composerId: ComposerId;
     input?: Record<string, unknown>;
     version?: string;
 };
@@ -191,8 +196,8 @@ type GetOptions<V extends string = string> = {
 type PromptlyClient = {
     getPrompt: <T extends string, V extends PromptVersion<T> | 'latest' = 'latest'>(promptId: T, options?: GetOptions<V>) => Promise<PromptResult<VariablesFor<T, V>>>;
     getPrompts: <const T extends readonly PromptRequest[]>(entries: T) => Promise<GetPromptsResults<T>>;
-    getComposer: <T extends string, V extends ComposerVersion<T> | 'latest' = 'latest'>(composerId: T, options?: GetComposerOptions<T, V>) => Promise<ComposerResult<ComposerPromptNamesFor<T>>>;
+    getComposer: <T extends ComposerId, V extends ComposerVersion<T> | 'latest' = 'latest'>(composerId: T, options?: GetComposerOptions<T, V>) => Promise<ComposerResult<ComposerPromptNamesFor<T>>>;
     getComposers: <const T extends readonly ComposerRequest[]>(entries: T) => Promise<GetComposersResults<T>>;
 };
 
-export type { PublishedVersion as A, SchemaFieldParams as B, ComposerConfig as C, ErrorCode as E, FormatInput as F, GetComposerOptions as G, PromptlyClientConfig as P, SchemaField as S, ValidationRule as V, PromptlyClient as a, ComposerFormatFn as b, ComposerGenerateFn as c, ComposerId as d, ComposerInputFor as e, ComposerPrompt as f, ComposerPromptMap as g, ComposerPromptNamesFor as h, ComposerPromptSegment as i, ComposerRequest as j, ComposerResponse as k, ComposerResult as l, ComposerSegment as m, ComposerStaticSegment as n, ComposerVariableMap as o, ComposerVersion as p, ErrorResponse as q, GetOptions as r, PromptConfig as s, PromptId as t, PromptMessage as u, PromptRequest as v, PromptResponse as w, PromptResult as x, PromptVariableMap as y, PromptVersion as z };
+export type { PromptVersion as A, PublishedVersion as B, ComposerConfig as C, SchemaFieldParams as D, ErrorCode as E, FormatInput as F, GetComposerOptions as G, PromptlyClientConfig as P, SchemaField as S, ValidationRule as V, PromptlyClient as a, ComposerFormatFn as b, ComposerGenerateFn as c, ComposerHtmlBlockSegment as d, ComposerId as e, ComposerInputFor as f, ComposerPrompt as g, ComposerPromptMap as h, ComposerPromptNamesFor as i, ComposerPromptSegment as j, ComposerRequest as k, ComposerResponse as l, ComposerResult as m, ComposerSegment as n, ComposerStaticSegment as o, ComposerVariableMap as p, ComposerVersion as q, ErrorResponse as r, GetOptions as s, PromptConfig as t, PromptId as u, PromptMessage as v, PromptRequest as w, PromptResponse as x, PromptResult as y, PromptVariableMap as z };

package/package.json

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