@typecms/sdk 0.1.0

package/dist/index.mjs

@@ -0,0 +1,174 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+
+// src/client.ts
+var DEFAULT_BASE_URL = "https://api.typecms.com";
+var DEFAULT_TIMEOUT = 3e4;
+var TypeCMSError = class extends Error {
+  constructor(message, status, details) {
+    super(message);
+    /** HTTP status code */
+    __publicField(this, "status");
+    /** Validation error details from the API, when present */
+    __publicField(this, "details");
+    this.name = "TypeCMSError";
+    this.status = status;
+    this.details = details;
+  }
+};
+function toApiSort(sort) {
+  return sort.startsWith("-") ? `${sort.slice(1)}:-1` : `${sort}:1`;
+}
+function createClient(config) {
+  const {
+    projectId,
+    token,
+    baseUrl = DEFAULT_BASE_URL,
+    language: defaultLanguage,
+    variant: defaultVariant,
+    timeout = DEFAULT_TIMEOUT,
+    fetch: customFetch
+  } = config;
+  if (!projectId) throw new TypeCMSError("projectId is required", 0);
+  if (!token) throw new TypeCMSError("token is required", 0);
+  const origin = baseUrl.replace(/\/$/, "");
+  async function request(endpoint, body, params = {}) {
+    const url = new URL(`${origin}/api/projects/${projectId}${endpoint}`);
+    if (params.q !== void 0) url.searchParams.set("query", params.q);
+    if (params.skip !== void 0) url.searchParams.set("skip", String(params.skip));
+    if (params.limit !== void 0) url.searchParams.set("limit", String(params.limit));
+    if (params.sort) url.searchParams.set("sort", toApiSort(params.sort));
+    if (params.format) url.searchParams.set("format", params.format);
+    if (params.draft) url.searchParams.set("draft", "true");
+    const controller = new AbortController();
+    const timeoutId = setTimeout(() => controller.abort(), timeout);
+    try {
+      const doFetch = customFetch ?? globalThis.fetch;
+      const response = await doFetch(url.toString(), {
+        method: "POST",
+        signal: controller.signal,
+        headers: {
+          Authorization: `Bearer ${token}`,
+          "Content-Type": "application/json"
+        },
+        body: JSON.stringify(body)
+      });
+      if (response.status === 404) return null;
+      let data;
+      try {
+        data = await response.json();
+      } catch {
+        data = void 0;
+      }
+      if (!response.ok) {
+        const error = data ?? {};
+        throw new TypeCMSError(
+          error.message || `Request failed with status ${response.status}`,
+          response.status,
+          error.errors
+        );
+      }
+      return data;
+    } catch (cause) {
+      if (cause instanceof TypeCMSError) throw cause;
+      if (cause?.name === "AbortError") {
+        throw new TypeCMSError(`Request timed out after ${timeout}ms`, 0);
+      }
+      throw new TypeCMSError(cause?.message || "Network error", 0);
+    } finally {
+      clearTimeout(timeoutId);
+    }
+  }
+  function resolveVariant(optionVariant) {
+    if (optionVariant === null) return void 0;
+    return optionVariant ?? defaultVariant;
+  }
+  function baseBody(options) {
+    const language = options.language ?? defaultLanguage;
+    return language ? { language } : {};
+  }
+  async function fetchEntries(body, params) {
+    const raw = await request("/content", body, params);
+    return {
+      entries: raw?.results ?? [],
+      count: raw?.count ?? 0,
+      skip: raw?.skip ?? params.skip ?? 0,
+      limit: raw?.limit ?? params.limit ?? 0
+    };
+  }
+  return {
+    async getEntry(options) {
+      const { path, slug, entryId, variantFallback = true, draft, format } = options;
+      const selectors = [path, slug, entryId].filter((s) => s !== void 0);
+      if (selectors.length !== 1) {
+        throw new TypeCMSError("Provide exactly one of: path, slug, entryId", 0);
+      }
+      const body = {
+        ...baseBody(options),
+        ...path !== void 0 && { path },
+        ...slug !== void 0 && { slug },
+        ...entryId !== void 0 && { entryId }
+      };
+      const params = { limit: 1, draft, format };
+      const variant = resolveVariant(options.variant);
+      if (variant) {
+        const withVariant = await fetchEntries({ ...body, variant }, params);
+        if (withVariant.entries.length > 0) return withVariant.entries[0];
+        if (!variantFallback) return null;
+      }
+      const result = await fetchEntries(body, params);
+      return result.entries[0] ?? null;
+    },
+    async getEntries(options = {}) {
+      const { templateId, filter, limit, skip, sort, variantFallback = true, draft, format } = options;
+      const body = {
+        ...baseBody(options),
+        ...templateId !== void 0 && { templateId },
+        ...filter
+      };
+      const params = { limit, skip, sort, draft, format };
+      const variant = resolveVariant(options.variant);
+      if (variant) {
+        const withVariant = await fetchEntries({ ...body, variant }, params);
+        if (withVariant.entries.length > 0 || !variantFallback) return withVariant;
+      }
+      return fetchEntries(body, params);
+    },
+    async search(query, options = {}) {
+      const { fields, filters, limit, skip, sort } = options;
+      const body = {
+        ...baseBody(options),
+        ...fields !== void 0 && { fields },
+        ...filters !== void 0 && { filters }
+      };
+      const raw = await request("/content/search", body, {
+        q: query,
+        limit,
+        skip,
+        sort
+      });
+      return {
+        entries: raw?.entries ?? [],
+        count: raw?.count ?? 0,
+        skip: raw?.skip ?? skip ?? 0,
+        limit: raw?.limit ?? limit ?? 0
+      };
+    },
+    async query(body, params = {}) {
+      return fetchEntries(body, params);
+    }
+  };
+}
+
+// src/types/base.ts
+function isComponentType(component, typename) {
+  return component.__typename === typename;
+}
+export {
+  TypeCMSError,
+  createClient,
+  isComponentType,
+  toApiSort
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/client.ts","../src/types/base.ts"],"sourcesContent":["/**\n * Type CMS SDK Client\n *\n * Typed client for the Type CMS Content Delivery API\n * (`POST /api/projects/:projectId/content` and `/content/search`).\n *\n * Design notes:\n * - `getEntry` returns `null` (and `getEntries`/`search` return empty pages)\n *   when nothing matches — the API's \"empty result\" 404 is not an exception.\n * - Personalization is first-class: set a client-wide `variant` or pass one\n *   per call; when the variant has no published row the base content is\n *   served automatically (opt out with `variantFallback: false`).\n * - Drafts: `draft: true` reads unpublished content through the same shapes,\n *   gated server-side to preview-environment tokens.\n */\n\nimport type {\n  TypeCMSClientConfig,\n  TypeCMSClient,\n  GetEntryOptions,\n  GetEntriesOptions,\n  ContentEntry,\n  EntryList,\n  SearchOptions,\n  SearchResult,\n  SortExpression,\n  APIError,\n} from './types'\n\n// =============================================================================\n// Constants\n// =============================================================================\n\nconst DEFAULT_BASE_URL = 'https://api.typecms.com'\nconst DEFAULT_TIMEOUT = 30_000\n\n// =============================================================================\n// Errors\n// =============================================================================\n\n/**\n * Error thrown when an API request fails (auth, validation, server errors).\n * Empty results are NOT errors — the typed reads return `null`/empty pages.\n */\nexport class TypeCMSError extends Error {\n  /** HTTP status code */\n  public readonly status: number\n  /** Validation error details from the API, when present */\n  public readonly details?: unknown[]\n\n  constructor(message: string, status: number, details?: unknown[]) {\n    super(message)\n    this.name = 'TypeCMSError'\n    this.status = status\n    this.details = details\n  }\n}\n\n// =============================================================================\n// Internals\n// =============================================================================\n\n/** `'-publishedAt'` → `'publishedAt:-1'`, `'title'` → `'title:1'`. */\nexport function toApiSort(sort: SortExpression): string {\n  return sort.startsWith('-') ? `${sort.slice(1)}:-1` : `${sort}:1`\n}\n\ninterface RequestParams {\n  skip?: number\n  limit?: number\n  sort?: SortExpression\n  format?: 'json' | 'html'\n  draft?: boolean\n  /** Search endpoint's query string */\n  q?: string\n}\n\n// =============================================================================\n// Client\n// =============================================================================\n\n/**\n * Create a Type CMS content client.\n *\n * @example\n * ```typescript\n * import { createClient } from '@typecms/sdk'\n *\n * const cms = createClient({\n *   projectId: '665f00000000000000000001',\n *   token: process.env.TYPECMS_TOKEN!,\n * })\n *\n * // By URL path — null when nothing is published there\n * const home = await cms.getEntry<HomePage>({ path: '/' })\n *\n * // Personalized, with automatic fallback to base content\n * const vipHome = await cms.getEntry({ path: '/', variant: 'vip' })\n *\n * // Lists\n * const { entries, count } = await cms.getEntries({\n *   templateId: '665f00000000000000000002',\n *   sort: '-publishedAt',\n *   limit: 10,\n * })\n *\n * // Drafts for live preview (preview-environment token)\n * const draft = await cms.getEntry({ path: '/', draft: true })\n *\n * // Full-text search\n * const hits = await cms.search('astronaut', { limit: 5 })\n * ```\n */\nexport function createClient(config: TypeCMSClientConfig): TypeCMSClient {\n  const {\n    projectId,\n    token,\n    baseUrl = DEFAULT_BASE_URL,\n    language: defaultLanguage,\n    variant: defaultVariant,\n    timeout = DEFAULT_TIMEOUT,\n    fetch: customFetch,\n  } = config\n\n  if (!projectId) throw new TypeCMSError('projectId is required', 0)\n  if (!token) throw new TypeCMSError('token is required', 0)\n\n  const origin = baseUrl.replace(/\\/$/, '')\n\n  async function request<T>(\n    endpoint: '/content' | '/content/search',\n    body: Record<string, unknown>,\n    params: RequestParams = {}\n  ): Promise<T | null> {\n    const url = new URL(`${origin}/api/projects/${projectId}${endpoint}`)\n    if (params.q !== undefined) url.searchParams.set('query', params.q)\n    if (params.skip !== undefined) url.searchParams.set('skip', String(params.skip))\n    if (params.limit !== undefined) url.searchParams.set('limit', String(params.limit))\n    if (params.sort) url.searchParams.set('sort', toApiSort(params.sort))\n    if (params.format) url.searchParams.set('format', params.format)\n    if (params.draft) url.searchParams.set('draft', 'true')\n\n    const controller = new AbortController()\n    const timeoutId = setTimeout(() => controller.abort(), timeout)\n\n    try {\n      const doFetch = customFetch ?? globalThis.fetch\n      const response = await doFetch(url.toString(), {\n        method: 'POST',\n        signal: controller.signal,\n        headers: {\n          Authorization: `Bearer ${token}`,\n          'Content-Type': 'application/json',\n        },\n        body: JSON.stringify(body),\n      })\n\n      // The API answers 404 for \"nothing matched\" — that's an empty result,\n      // not an exception.\n      if (response.status === 404) return null\n\n      let data: unknown\n      try {\n        data = await response.json()\n      } catch {\n        data = undefined\n      }\n\n      if (!response.ok) {\n        const error = (data ?? {}) as APIError\n        throw new TypeCMSError(\n          error.message || `Request failed with status ${response.status}`,\n          response.status,\n          error.errors\n        )\n      }\n\n      return data as T\n    } catch (cause) {\n      if (cause instanceof TypeCMSError) throw cause\n      if ((cause as Error)?.name === 'AbortError') {\n        throw new TypeCMSError(`Request timed out after ${timeout}ms`, 0)\n      }\n      throw new TypeCMSError((cause as Error)?.message || 'Network error', 0)\n    } finally {\n      clearTimeout(timeoutId)\n    }\n  }\n\n  /** Resolve the effective variant for a call (per-call > client default; null forces base). */\n  function resolveVariant(optionVariant: string | null | undefined): string | undefined {\n    if (optionVariant === null) return undefined\n    return optionVariant ?? defaultVariant\n  }\n\n  function baseBody(options: { language?: string }): Record<string, unknown> {\n    const language = options.language ?? defaultLanguage\n    return language ? { language } : {}\n  }\n\n  async function fetchEntries<T>(\n    body: Record<string, unknown>,\n    params: RequestParams\n  ): Promise<EntryList<T>> {\n    const raw = await request<{\n      results: ContentEntry<T>[]\n      count: number\n      skip: number\n      limit: number\n    }>('/content', body, params)\n\n    return {\n      entries: raw?.results ?? [],\n      count: raw?.count ?? 0,\n      skip: raw?.skip ?? params.skip ?? 0,\n      limit: raw?.limit ?? params.limit ?? 0,\n    }\n  }\n\n  return {\n    async getEntry<T = Record<string, unknown>>(\n      options: GetEntryOptions\n    ): Promise<ContentEntry<T> | null> {\n      const { path, slug, entryId, variantFallback = true, draft, format } = options\n\n      const selectors = [path, slug, entryId].filter((s) => s !== undefined)\n      if (selectors.length !== 1) {\n        throw new TypeCMSError('Provide exactly one of: path, slug, entryId', 0)\n      }\n\n      const body: Record<string, unknown> = {\n        ...baseBody(options),\n        ...(path !== undefined && { path }),\n        ...(slug !== undefined && { slug }),\n        ...(entryId !== undefined && { entryId }),\n      }\n      const params: RequestParams = { limit: 1, draft, format }\n\n      const variant = resolveVariant(options.variant)\n      if (variant) {\n        const withVariant = await fetchEntries<T>({ ...body, variant }, params)\n        if (withVariant.entries.length > 0) return withVariant.entries[0]\n        if (!variantFallback) return null\n      }\n\n      const result = await fetchEntries<T>(body, params)\n      return result.entries[0] ?? null\n    },\n\n    async getEntries<T = Record<string, unknown>>(\n      options: GetEntriesOptions = {}\n    ): Promise<EntryList<T>> {\n      const { templateId, filter, limit, skip, sort, variantFallback = true, draft, format } = options\n\n      const body: Record<string, unknown> = {\n        ...baseBody(options),\n        ...(templateId !== undefined && { templateId }),\n        ...filter,\n      }\n      const params: RequestParams = { limit, skip, sort, draft, format }\n\n      const variant = resolveVariant(options.variant)\n      if (variant) {\n        const withVariant = await fetchEntries<T>({ ...body, variant }, params)\n        if (withVariant.entries.length > 0 || !variantFallback) return withVariant\n      }\n\n      return fetchEntries<T>(body, params)\n    },\n\n    async search(query: string, options: SearchOptions = {}): Promise<SearchResult> {\n      const { fields, filters, limit, skip, sort } = options\n\n      const body: Record<string, unknown> = {\n        ...baseBody(options),\n        ...(fields !== undefined && { fields }),\n        ...(filters !== undefined && { filters }),\n      }\n\n      const raw = await request<SearchResult>('/content/search', body, {\n        q: query,\n        limit,\n        skip,\n        sort,\n      })\n\n      return {\n        entries: raw?.entries ?? [],\n        count: raw?.count ?? 0,\n        skip: raw?.skip ?? skip ?? 0,\n        limit: raw?.limit ?? limit ?? 0,\n      }\n    },\n\n    async query<T = Record<string, unknown>>(\n      body: Record<string, unknown>,\n      params: { skip?: number; limit?: number; sort?: SortExpression; format?: 'json' | 'html'; draft?: boolean } = {}\n    ): Promise<EntryList<T>> {\n      return fetchEntries<T>(body, params)\n    },\n  }\n}\n","/**\n * Base types for Type CMS content.\n * These types are used by the SDK and can be imported by generated type files.\n */\n\n// =============================================================================\n// Asset Types\n// =============================================================================\n\n/**\n * Represents a file/media asset in Type CMS.\n */\nexport interface Asset {\n  /** Unique identifier */\n  _id: string\n  /** Public URL of the asset */\n  url: string\n  /** Alt text for accessibility */\n  alt?: string\n  /** Display title */\n  title?: string\n  /** Original filename */\n  name?: string\n  /** Width in pixels (for images) */\n  width?: number\n  /** Height in pixels (for images) */\n  height?: number\n  /** File size in bytes */\n  size?: number\n  /** MIME type */\n  mimeType?: string\n  /** File type category */\n  type?: AssetType\n}\n\n/**\n * Asset type categories\n */\nexport interface AssetType {\n  category?: 'image' | 'video' | 'audio' | 'document' | 'archive' | 'other'\n  extension?: string\n}\n\n// =============================================================================\n// Link Types\n// =============================================================================\n\n/**\n * Represents a hyperlink.\n */\nexport interface Link {\n  /** Link URL */\n  url: string\n  /** Link display text */\n  label?: string\n  /** Open in new tab */\n  newTab?: boolean\n}\n\n// =============================================================================\n// Address Types\n// =============================================================================\n\n/**\n * Represents a physical address.\n */\nexport interface Address {\n  /** Street address line 1 */\n  street?: string\n  /** Street address line 2 */\n  street2?: string\n  /** City */\n  city?: string\n  /** State/Province */\n  state?: string\n  /** Postal/ZIP code */\n  zip?: string\n  /** Country */\n  country?: string\n  /** Latitude coordinate */\n  lat?: number\n  /** Longitude coordinate */\n  lng?: number\n}\n\n// =============================================================================\n// Reference Types\n// =============================================================================\n\n/**\n * Reference to another entry.\n */\nexport interface EntryReference {\n  /** Entry ID */\n  _id: string\n  /** Entry type slug */\n  _type: string\n  /** Entry title */\n  title?: string\n  /** Entry slug */\n  slug?: string\n}\n\n/**\n * Reference to a collection item.\n */\nexport interface CollectionReference {\n  /** Item ID */\n  _id: string\n  /** Collection ID */\n  collectionId: string\n  /** Item title */\n  title?: string\n}\n\n// =============================================================================\n// Rich Text Types\n// =============================================================================\n\n/**\n * Slate.js rich text node (v1 rich text).\n */\nexport interface RichTextNode {\n  type?: string\n  children?: RichTextNode[]\n  text?: string\n  bold?: boolean\n  italic?: boolean\n  underline?: boolean\n  strikethrough?: boolean\n  code?: boolean\n  url?: string\n  [key: string]: unknown\n}\n\n/**\n * TipTap rich text node (v2 rich text).\n */\nexport interface TipTapNode {\n  type: string\n  content?: TipTapNode[]\n  text?: string\n  marks?: TipTapMark[]\n  attrs?: Record<string, unknown>\n}\n\n/**\n * TipTap mark (formatting).\n */\nexport interface TipTapMark {\n  type: string\n  attrs?: Record<string, unknown>\n}\n\n// =============================================================================\n// Base Entry Types\n// =============================================================================\n\n/**\n * Base fields present on all entries.\n */\nexport interface BaseEntry {\n  /** Unique identifier */\n  _id: string\n  /** Content type slug */\n  _type: string\n  /** Creation timestamp (ISO string) */\n  _createdAt: string\n  /** Last update timestamp (ISO string) */\n  _updatedAt: string\n  /** Publication timestamp (ISO string, if published) */\n  _publishedAt?: string\n  /** Locale code */\n  _locale?: string\n  /** Version number */\n  _version?: number\n}\n\n/**\n * Base fields for canvas/component blocks.\n */\nexport interface BaseComponent {\n  /** Component type identifier (discriminator) */\n  __typename: string\n}\n\n// =============================================================================\n// Utility Types\n// =============================================================================\n\n/**\n * Extract component type from a union by __typename.\n */\nexport type ExtractComponent<\n  TUnion extends BaseComponent,\n  TTypename extends TUnion['__typename']\n> = Extract<TUnion, { __typename: TTypename }>\n\n/**\n * Type guard to narrow canvas component by __typename.\n */\nexport function isComponentType<\n  TComponent extends BaseComponent,\n  TTypename extends TComponent['__typename']\n>(\n  component: TComponent,\n  typename: TTypename\n): component is Extract<TComponent, { __typename: TTypename }> {\n  return component.__typename === typename\n}\n"],"mappings":";;;;;AAiCA,IAAM,mBAAmB;AACzB,IAAM,kBAAkB;AAUjB,IAAM,eAAN,cAA2B,MAAM;AAAA,EAMtC,YAAY,SAAiB,QAAgB,SAAqB;AAChE,UAAM,OAAO;AALf;AAAA,wBAAgB;AAEhB;AAAA,wBAAgB;AAId,SAAK,OAAO;AACZ,SAAK,SAAS;AACd,SAAK,UAAU;AAAA,EACjB;AACF;AAOO,SAAS,UAAU,MAA8B;AACtD,SAAO,KAAK,WAAW,GAAG,IAAI,GAAG,KAAK,MAAM,CAAC,CAAC,QAAQ,GAAG,IAAI;AAC/D;AAgDO,SAAS,aAAa,QAA4C;AACvE,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA,UAAU;AAAA,IACV,UAAU;AAAA,IACV,SAAS;AAAA,IACT,UAAU;AAAA,IACV,OAAO;AAAA,EACT,IAAI;AAEJ,MAAI,CAAC,UAAW,OAAM,IAAI,aAAa,yBAAyB,CAAC;AACjE,MAAI,CAAC,MAAO,OAAM,IAAI,aAAa,qBAAqB,CAAC;AAEzD,QAAM,SAAS,QAAQ,QAAQ,OAAO,EAAE;AAExC,iBAAe,QACb,UACA,MACA,SAAwB,CAAC,GACN;AACnB,UAAM,MAAM,IAAI,IAAI,GAAG,MAAM,iBAAiB,SAAS,GAAG,QAAQ,EAAE;AACpE,QAAI,OAAO,MAAM,OAAW,KAAI,aAAa,IAAI,SAAS,OAAO,CAAC;AAClE,QAAI,OAAO,SAAS,OAAW,KAAI,aAAa,IAAI,QAAQ,OAAO,OAAO,IAAI,CAAC;AAC/E,QAAI,OAAO,UAAU,OAAW,KAAI,aAAa,IAAI,SAAS,OAAO,OAAO,KAAK,CAAC;AAClF,QAAI,OAAO,KAAM,KAAI,aAAa,IAAI,QAAQ,UAAU,OAAO,IAAI,CAAC;AACpE,QAAI,OAAO,OAAQ,KAAI,aAAa,IAAI,UAAU,OAAO,MAAM;AAC/D,QAAI,OAAO,MAAO,KAAI,aAAa,IAAI,SAAS,MAAM;AAEtD,UAAM,aAAa,IAAI,gBAAgB;AACvC,UAAM,YAAY,WAAW,MAAM,WAAW,MAAM,GAAG,OAAO;AAE9D,QAAI;AACF,YAAM,UAAU,eAAe,WAAW;AAC1C,YAAM,WAAW,MAAM,QAAQ,IAAI,SAAS,GAAG;AAAA,QAC7C,QAAQ;AAAA,QACR,QAAQ,WAAW;AAAA,QACnB,SAAS;AAAA,UACP,eAAe,UAAU,KAAK;AAAA,UAC9B,gBAAgB;AAAA,QAClB;AAAA,QACA,MAAM,KAAK,UAAU,IAAI;AAAA,MAC3B,CAAC;AAID,UAAI,SAAS,WAAW,IAAK,QAAO;AAEpC,UAAI;AACJ,UAAI;AACF,eAAO,MAAM,SAAS,KAAK;AAAA,MAC7B,QAAQ;AACN,eAAO;AAAA,MACT;AAEA,UAAI,CAAC,SAAS,IAAI;AAChB,cAAM,QAAS,QAAQ,CAAC;AACxB,cAAM,IAAI;AAAA,UACR,MAAM,WAAW,8BAA8B,SAAS,MAAM;AAAA,UAC9D,SAAS;AAAA,UACT,MAAM;AAAA,QACR;AAAA,MACF;AAEA,aAAO;AAAA,IACT,SAAS,OAAO;AACd,UAAI,iBAAiB,aAAc,OAAM;AACzC,UAAK,OAAiB,SAAS,cAAc;AAC3C,cAAM,IAAI,aAAa,2BAA2B,OAAO,MAAM,CAAC;AAAA,MAClE;AACA,YAAM,IAAI,aAAc,OAAiB,WAAW,iBAAiB,CAAC;AAAA,IACxE,UAAE;AACA,mBAAa,SAAS;AAAA,IACxB;AAAA,EACF;AAGA,WAAS,eAAe,eAA8D;AACpF,QAAI,kBAAkB,KAAM,QAAO;AACnC,WAAO,iBAAiB;AAAA,EAC1B;AAEA,WAAS,SAAS,SAAyD;AACzE,UAAM,WAAW,QAAQ,YAAY;AACrC,WAAO,WAAW,EAAE,SAAS,IAAI,CAAC;AAAA,EACpC;AAEA,iBAAe,aACb,MACA,QACuB;AACvB,UAAM,MAAM,MAAM,QAKf,YAAY,MAAM,MAAM;AAE3B,WAAO;AAAA,MACL,SAAS,KAAK,WAAW,CAAC;AAAA,MAC1B,OAAO,KAAK,SAAS;AAAA,MACrB,MAAM,KAAK,QAAQ,OAAO,QAAQ;AAAA,MAClC,OAAO,KAAK,SAAS,OAAO,SAAS;AAAA,IACvC;AAAA,EACF;AAEA,SAAO;AAAA,IACL,MAAM,SACJ,SACiC;AACjC,YAAM,EAAE,MAAM,MAAM,SAAS,kBAAkB,MAAM,OAAO,OAAO,IAAI;AAEvE,YAAM,YAAY,CAAC,MAAM,MAAM,OAAO,EAAE,OAAO,CAAC,MAAM,MAAM,MAAS;AACrE,UAAI,UAAU,WAAW,GAAG;AAC1B,cAAM,IAAI,aAAa,+CAA+C,CAAC;AAAA,MACzE;AAEA,YAAM,OAAgC;AAAA,QACpC,GAAG,SAAS,OAAO;AAAA,QACnB,GAAI,SAAS,UAAa,EAAE,KAAK;AAAA,QACjC,GAAI,SAAS,UAAa,EAAE,KAAK;AAAA,QACjC,GAAI,YAAY,UAAa,EAAE,QAAQ;AAAA,MACzC;AACA,YAAM,SAAwB,EAAE,OAAO,GAAG,OAAO,OAAO;AAExD,YAAM,UAAU,eAAe,QAAQ,OAAO;AAC9C,UAAI,SAAS;AACX,cAAM,cAAc,MAAM,aAAgB,EAAE,GAAG,MAAM,QAAQ,GAAG,MAAM;AACtE,YAAI,YAAY,QAAQ,SAAS,EAAG,QAAO,YAAY,QAAQ,CAAC;AAChE,YAAI,CAAC,gBAAiB,QAAO;AAAA,MAC/B;AAEA,YAAM,SAAS,MAAM,aAAgB,MAAM,MAAM;AACjD,aAAO,OAAO,QAAQ,CAAC,KAAK;AAAA,IAC9B;AAAA,IAEA,MAAM,WACJ,UAA6B,CAAC,GACP;AACvB,YAAM,EAAE,YAAY,QAAQ,OAAO,MAAM,MAAM,kBAAkB,MAAM,OAAO,OAAO,IAAI;AAEzF,YAAM,OAAgC;AAAA,QACpC,GAAG,SAAS,OAAO;AAAA,QACnB,GAAI,eAAe,UAAa,EAAE,WAAW;AAAA,QAC7C,GAAG;AAAA,MACL;AACA,YAAM,SAAwB,EAAE,OAAO,MAAM,MAAM,OAAO,OAAO;AAEjE,YAAM,UAAU,eAAe,QAAQ,OAAO;AAC9C,UAAI,SAAS;AACX,cAAM,cAAc,MAAM,aAAgB,EAAE,GAAG,MAAM,QAAQ,GAAG,MAAM;AACtE,YAAI,YAAY,QAAQ,SAAS,KAAK,CAAC,gBAAiB,QAAO;AAAA,MACjE;AAEA,aAAO,aAAgB,MAAM,MAAM;AAAA,IACrC;AAAA,IAEA,MAAM,OAAO,OAAe,UAAyB,CAAC,GAA0B;AAC9E,YAAM,EAAE,QAAQ,SAAS,OAAO,MAAM,KAAK,IAAI;AAE/C,YAAM,OAAgC;AAAA,QACpC,GAAG,SAAS,OAAO;AAAA,QACnB,GAAI,WAAW,UAAa,EAAE,OAAO;AAAA,QACrC,GAAI,YAAY,UAAa,EAAE,QAAQ;AAAA,MACzC;AAEA,YAAM,MAAM,MAAM,QAAsB,mBAAmB,MAAM;AAAA,QAC/D,GAAG;AAAA,QACH;AAAA,QACA;AAAA,QACA;AAAA,MACF,CAAC;AAED,aAAO;AAAA,QACL,SAAS,KAAK,WAAW,CAAC;AAAA,QAC1B,OAAO,KAAK,SAAS;AAAA,QACrB,MAAM,KAAK,QAAQ,QAAQ;AAAA,QAC3B,OAAO,KAAK,SAAS,SAAS;AAAA,MAChC;AAAA,IACF;AAAA,IAEA,MAAM,MACJ,MACA,SAA8G,CAAC,GACxF;AACvB,aAAO,aAAgB,MAAM,MAAM;AAAA,IACrC;AAAA,EACF;AACF;;;ACpGO,SAAS,gBAId,WACA,UAC6D;AAC7D,SAAO,UAAU,eAAe;AAClC;","names":[]}

package/dist/overlay-CLYAeNwg.d.mts

@@ -0,0 +1,43 @@
+import { P as PreviewState } from './types-BNHDdA2G.mjs';
+
+/**
+ * Preview Overlay
+ *
+ * Draws a highlight box over the element whose `data-preview-field`
+ * matches the field currently focused in the Type CMS editor.
+ * Zero-markup alternative to hand-rolling highlights with useFocusedField().
+ */
+
+interface PreviewOverlayOptions {
+    /** Outline color of the highlight box */
+    color?: string;
+    /** z-index of the highlight box */
+    zIndex?: number;
+    /** Scroll the highlighted element into view when focus changes */
+    scrollIntoView?: boolean;
+    /** Attribute used to locate field elements */
+    attribute?: string;
+}
+interface OverlayClient {
+    subscribe(listener: (state: PreviewState) => void): () => void;
+    getState(): PreviewState;
+}
+/**
+ * Attach a focus-highlight overlay to the document.
+ *
+ * Subscribes to the preview client's state; whenever `focusedPath` changes,
+ * positions a non-interactive highlight box over the matching
+ * `[data-preview-field]` element. Returns a detach function.
+ *
+ * @example
+ * ```typescript
+ * const preview = createPreviewClient()
+ * preview.connect()
+ * const detach = attachPreviewOverlay(preview)
+ * // ...on teardown
+ * detach()
+ * ```
+ */
+declare function attachPreviewOverlay(client: OverlayClient, options?: PreviewOverlayOptions): () => void;
+
+export { type PreviewOverlayOptions as P, attachPreviewOverlay as a };

package/dist/preview/dom.d.mts

@@ -0,0 +1,76 @@
+import { P as PreviewListener } from '../client-BW6BWpfF.mjs';
+import { P as PreviewState, a as PreviewConfig } from '../types-BNHDdA2G.mjs';
+
+interface PreviewDomBindingOptions {
+    /** Root node to search for bound elements (defaults to `document`) */
+    root?: ParentNode;
+    /** Attribute carrying the field path (defaults to `data-preview-field`) */
+    attribute?: string;
+    /**
+     * Called for non-primitive values (objects, arrays, booleans, null).
+     * Return a string to set as the element's textContent, or null/undefined
+     * to skip the element. Without this callback, non-primitive values are
+     * skipped entirely.
+     */
+    renderValue?: (el: Element, path: string, value: unknown) => string | null | undefined;
+}
+interface DomClient {
+    subscribe(listener: (state: PreviewState) => void): () => void;
+    getState(): PreviewState;
+}
+/**
+ * Bind preview values to the DOM.
+ *
+ * Subscribes to the preview client's state; whenever values change while
+ * preview is enabled, every `[data-preview-field]` element whose path
+ * resolves to a value (array notation like `items[0].name` is supported)
+ * has its textContent updated. Each element's original textContent is
+ * remembered the first time it is overwritten and restored on detach.
+ *
+ * SECURITY: values come from the editor via postMessage and are treated as
+ * untrusted content. This binding only ever writes `textContent` — never
+ * `innerHTML` — so preview values cannot inject markup or scripts (XSS).
+ *
+ * @returns A detach function that unsubscribes and restores originals.
+ *
+ * @example
+ * ```typescript
+ * const preview = createPreviewClient()
+ * preview.connect()
+ * const detach = bindPreviewToDom(preview)
+ * // ...on teardown
+ * detach()
+ * ```
+ */
+declare function bindPreviewToDom(client: DomClient, options?: PreviewDomBindingOptions): () => void;
+/**
+ * One-call live preview for vanilla DOM sites.
+ *
+ * Creates a preview client, connects it, and binds it to the DOM.
+ * Returns the client (for advanced use like `notifyFieldFocus`) and a
+ * `destroy` function that unbinds and disconnects.
+ *
+ * @example Astro — add to a shared layout:
+ * ```astro
+ * <script>
+ *   import { initDomPreview } from '@typecms/sdk/preview/dom'
+ *   initDomPreview()
+ * </script>
+ * ```
+ * Then annotate markup: `<h1 data-preview-field="title">{entry.title}</h1>`
+ */
+declare function initDomPreview(options?: PreviewConfig & PreviewDomBindingOptions): {
+    client: {
+        connect(): void;
+        disconnect(): void;
+        getState(): PreviewState;
+        isEnabled(): boolean;
+        getValue<T = unknown>(path: string): T | undefined;
+        subscribe(listener: PreviewListener): () => void;
+        notifyNavigation(pathname: string): void;
+        notifyFieldFocus(path: string): void;
+    };
+    destroy(): void;
+};
+
+export { type PreviewDomBindingOptions, bindPreviewToDom, initDomPreview };

package/dist/preview/dom.mjs

@@ -0,0 +1,352 @@
+// src/preview/client.ts
+var DEFAULT_ALLOWED_ORIGINS = [
+  "https://app.typecms.com",
+  "https://staging.typecms.com",
+  "http://localhost:3000",
+  "http://localhost:3001"
+];
+function createPreviewClient(config = {}) {
+  const {
+    allowedOrigins = DEFAULT_ALLOWED_ORIGINS,
+    onInit,
+    onUpdate,
+    onNavigate,
+    onFocus,
+    debug = false
+  } = config;
+  let state = {
+    enabled: false,
+    entryId: null,
+    projectId: null,
+    locale: null,
+    typeId: null,
+    values: {},
+    focusedPath: null
+  };
+  const listeners = /* @__PURE__ */ new Set();
+  let isConnected = false;
+  let parentOrigin = null;
+  function log(...args) {
+    if (debug) {
+      console.log("[TypeCMS Preview]", ...args);
+    }
+  }
+  function setState(updates) {
+    state = { ...state, ...updates };
+    listeners.forEach((listener) => listener(state));
+  }
+  function isAllowedOrigin(origin) {
+    return allowedOrigins.some((allowed) => {
+      if (allowed === "*") return true;
+      const expected = allowed.endsWith("/*") ? allowed.slice(0, -2) : allowed;
+      return origin === expected;
+    });
+  }
+  function sendMessage(message) {
+    if (!parentOrigin) {
+      log("Cannot send message: no parent origin");
+      return;
+    }
+    if (typeof window === "undefined" || !window.parent) {
+      log("Cannot send message: not in iframe");
+      return;
+    }
+    log("Sending message:", message.type);
+    window.parent.postMessage(message, parentOrigin);
+  }
+  function handleMessage(event) {
+    if (!isAllowedOrigin(event.origin)) {
+      log("Ignored message from untrusted origin:", event.origin);
+      return;
+    }
+    const message = event.data;
+    if (!message?.type?.startsWith("typecms:preview:")) {
+      return;
+    }
+    log("Received message:", message.type, message);
+    parentOrigin = event.origin;
+    switch (message.type) {
+      case "typecms:preview:init": {
+        const initMsg = message;
+        setState({
+          enabled: true,
+          entryId: initMsg.payload.entryId,
+          projectId: initMsg.payload.projectId,
+          locale: initMsg.payload.locale,
+          typeId: initMsg.payload.typeId,
+          values: {},
+          focusedPath: null
+        });
+        onInit?.(initMsg.payload);
+        const readyMessage = {
+          type: "typecms:preview:ready",
+          timestamp: Date.now(),
+          payload: {
+            pathname: typeof window !== "undefined" ? window.location.pathname : "/"
+          }
+        };
+        sendMessage(readyMessage);
+        break;
+      }
+      case "typecms:preview:update": {
+        const updateMsg = message;
+        if (updateMsg.payload.values) {
+          setState({ values: updateMsg.payload.values });
+        } else {
+          const newValues = { ...state.values };
+          setNestedValue(newValues, updateMsg.payload.path, updateMsg.payload.value);
+          setState({ values: newValues });
+        }
+        onUpdate?.(updateMsg.payload);
+        break;
+      }
+      case "typecms:preview:navigate": {
+        onNavigate?.(message.payload.url);
+        break;
+      }
+      case "typecms:preview:focus": {
+        setState({ focusedPath: message.payload.path });
+        onFocus?.(message.payload.path);
+        break;
+      }
+    }
+  }
+  return {
+    /**
+     * Start listening for preview messages.
+     * Call this on mount.
+     */
+    connect() {
+      if (typeof window === "undefined") {
+        log("Cannot connect: not in browser");
+        return;
+      }
+      if (isConnected) {
+        log("Already connected");
+        return;
+      }
+      log("Connecting...");
+      window.addEventListener("message", handleMessage);
+      isConnected = true;
+      if (window.parent && window.parent !== window) {
+        const hello = {
+          type: "typecms:preview:ready",
+          timestamp: Date.now(),
+          payload: { pathname: window.location?.pathname ?? "/" }
+        };
+        for (const allowed of allowedOrigins) {
+          const target = allowed === "*" ? "*" : allowed.endsWith("/*") ? allowed.slice(0, -2) : allowed;
+          try {
+            window.parent.postMessage(hello, target);
+          } catch {
+          }
+        }
+      }
+    },
+    /**
+     * Stop listening for preview messages.
+     * Call this on unmount.
+     */
+    disconnect() {
+      if (typeof window === "undefined") return;
+      log("Disconnecting...");
+      window.removeEventListener("message", handleMessage);
+      isConnected = false;
+      parentOrigin = null;
+      setState({
+        enabled: false,
+        entryId: null,
+        projectId: null,
+        locale: null,
+        typeId: null,
+        values: {},
+        focusedPath: null
+      });
+    },
+    /**
+     * Get current preview state.
+     */
+    getState() {
+      return state;
+    },
+    /**
+     * Check if preview mode is active.
+     */
+    isEnabled() {
+      return state.enabled;
+    },
+    /**
+     * Get a preview value by path.
+     * Returns undefined if no preview value exists.
+     */
+    getValue(path) {
+      return getNestedValue(state.values, path);
+    },
+    /**
+     * Subscribe to state changes.
+     */
+    subscribe(listener) {
+      listeners.add(listener);
+      return () => listeners.delete(listener);
+    },
+    /**
+     * Notify the editor that the preview has navigated.
+     */
+    notifyNavigation(pathname) {
+      const message = {
+        type: "typecms:preview:ready",
+        timestamp: Date.now(),
+        payload: { pathname }
+      };
+      sendMessage(message);
+    },
+    /**
+     * Notify the editor that a field was clicked in the preview.
+     * The editor will scroll to the corresponding field.
+     *
+     * @example
+     * ```typescript
+     * // On click of an element with data-preview-field attribute:
+     * const path = el.closest('[data-preview-field]')?.dataset.previewField
+     * if (path) preview.notifyFieldFocus(path)
+     * ```
+     */
+    notifyFieldFocus(path) {
+      const message = {
+        type: "typecms:preview:focus",
+        timestamp: Date.now(),
+        payload: { path }
+      };
+      sendMessage(message);
+    }
+  };
+}
+var UNSAFE_KEYS = /* @__PURE__ */ new Set(["__proto__", "constructor", "prototype"]);
+function setNestedValue(obj, path, value) {
+  const parts = path.split(".");
+  let current = obj;
+  for (let i = 0; i < parts.length - 1; i++) {
+    const part = parts[i];
+    const arrayMatch2 = part.match(/^(\w+)\[(\d+)\]$/);
+    if (arrayMatch2) {
+      const [, name, indexStr] = arrayMatch2;
+      const index = parseInt(indexStr, 10);
+      if (UNSAFE_KEYS.has(name)) continue;
+      if (!current[name]) {
+        current[name] = [];
+      }
+      const arr = current[name];
+      if (!arr[index]) {
+        arr[index] = {};
+      }
+      current = arr[index];
+    } else {
+      if (UNSAFE_KEYS.has(part)) continue;
+      if (!current[part] || typeof current[part] !== "object") {
+        current[part] = {};
+      }
+      current = current[part];
+    }
+  }
+  const lastPart = parts[parts.length - 1];
+  const arrayMatch = lastPart.match(/^(\w+)\[(\d+)\]$/);
+  if (arrayMatch) {
+    const [, name, indexStr] = arrayMatch;
+    const index = parseInt(indexStr, 10);
+    if (UNSAFE_KEYS.has(name)) return;
+    if (!current[name]) {
+      current[name] = [];
+    }
+    current[name][index] = value;
+  } else {
+    if (UNSAFE_KEYS.has(lastPart)) return;
+    current[lastPart] = value;
+  }
+}
+function getNestedValue(obj, path) {
+  const parts = path.split(".");
+  let current = obj;
+  for (const part of parts) {
+    if (current === null || current === void 0) {
+      return void 0;
+    }
+    const arrayMatch = part.match(/^(\w+)\[(\d+)\]$/);
+    if (arrayMatch) {
+      const [, name, indexStr] = arrayMatch;
+      const index = parseInt(indexStr, 10);
+      const arr = current[name];
+      if (!arr) return void 0;
+      current = arr[index];
+    } else {
+      current = current[part];
+    }
+  }
+  return current;
+}
+
+// src/preview/dom.ts
+var DEFAULT_ATTRIBUTE = "data-preview-field";
+function bindPreviewToDom(client, options = {}) {
+  if (typeof document === "undefined") {
+    return () => {
+    };
+  }
+  const attribute = options.attribute ?? DEFAULT_ATTRIBUTE;
+  const renderValue = options.renderValue;
+  const originals = /* @__PURE__ */ new Map();
+  function update(state) {
+    if (!state.enabled) return;
+    const root = options.root ?? document;
+    const elements = root.querySelectorAll(`[${attribute}]`);
+    elements.forEach((el) => {
+      const path = el.getAttribute(attribute);
+      if (!path) return;
+      const value = getNestedValue(state.values, path);
+      if (value === void 0) return;
+      let text = null;
+      if (typeof value === "string") {
+        text = value;
+      } else if (typeof value === "number") {
+        text = String(value);
+      } else if (renderValue) {
+        const result = renderValue(el, path, value);
+        if (typeof result === "string") {
+          text = result;
+        }
+      }
+      if (text === null) return;
+      if (el.textContent === text) return;
+      if (!originals.has(el)) {
+        originals.set(el, el.textContent);
+      }
+      el.textContent = text;
+    });
+  }
+  const unsubscribe = client.subscribe(update);
+  update(client.getState());
+  return () => {
+    unsubscribe();
+    originals.forEach((text, el) => {
+      el.textContent = text;
+    });
+    originals.clear();
+  };
+}
+function initDomPreview(options = {}) {
+  const { root, attribute, renderValue, ...config } = options;
+  const client = createPreviewClient(config);
+  client.connect();
+  const unbind = bindPreviewToDom(client, { root, attribute, renderValue });
+  return {
+    client,
+    destroy() {
+      unbind();
+      client.disconnect();
+    }
+  };
+}
+export {
+  bindPreviewToDom,
+  initDomPreview
+};
+//# sourceMappingURL=dom.mjs.map