@typecms/sdk 0.1.0

package/README.md

@@ -0,0 +1,151 @@
+# @typecms/sdk
+
+Typed JavaScript/TypeScript SDK for Type CMS: content delivery, live preview, and feature flags.
+
+```bash
+npm install @typecms/sdk
+```
+
+## Content client
+
+```typescript
+import { createClient } from '@typecms/sdk'
+
+const cms = createClient({
+  projectId: 'your-project-id',
+  token: process.env.TYPECMS_TOKEN!, // Project Settings → Tokens
+})
+```
+
+The token is bound to an environment — content is always served from that environment.
+
+### Fetch a single entry
+
+```typescript
+// By URL path (localized path aliases match too)
+const home = await cms.getEntry({ path: '/' })
+
+// By slug or entry id
+const post = await cms.getEntry({ slug: 'hello-world', language: 'fr-FR' })
+const byId = await cms.getEntry({ entryId: '665f...' })
+
+// null when nothing is published — no try/catch needed for missing pages
+if (!home) return notFound()
+```
+
+Type the `content` payload per call:
+
+```typescript
+interface HomePage {
+  heading: string
+  hero: { image: Asset; cta: Link }
+}
+
+const home = await cms.getEntry<HomePage>({ path: '/' })
+home?.content.heading // typed
+```
+
+### Personalization (audiences)
+
+Ask for an audience's variant; when it has no published row you get the base
+content automatically. The row's `variantSlug` tells you which one was served.
+
+```typescript
+const page = await cms.getEntry({ path: '/', variant: 'vip' })
+page?.variantSlug // 'vip' or null (base)
+
+// Client-wide personalization lens
+const vipCms = createClient({ projectId, token, variant: 'vip' })
+await vipCms.getEntry({ path: '/' })              // vip with base fallback
+await vipCms.getEntry({ path: '/', variant: null }) // force base
+
+// Strict mode: no fallback
+await cms.getEntry({ path: '/', variant: 'vip', variantFallback: false })
+```
+
+### Lists
+
+```typescript
+const { entries, count } = await cms.getEntries({
+  templateId: '665f...',
+  filter: { tags: 'featured' },
+  sort: '-publishedAt', // '-' prefix = descending
+  limit: 10,
+  skip: 0,
+})
+```
+
+### Drafts (live preview)
+
+With a token bound to a **preview environment**, read unpublished content in
+exactly the same shapes. Draft responses are never CDN-cached.
+
+```typescript
+const draft = await cms.getEntry({ path: '/', draft: true })
+```
+
+### Full-text search
+
+```typescript
+const { entries: hits } = await cms.search('astronaut', {
+  limit: 5,
+  filters: { publishedAt: ['2026-01-01', '2026-07-01'] },
+})
+```
+
+### Escape hatch
+
+Anything the helpers don't cover — POST a raw query body:
+
+```typescript
+const page = await cms.query({ publishedBy: '665f...', language: 'de-DE' }, { limit: 20 })
+```
+
+### Errors
+
+Missing content is `null` / an empty page. Real failures (auth, validation,
+network, timeouts) throw `TypeCMSError` with `status` and optional `details`.
+
+```typescript
+import { TypeCMSError } from '@typecms/sdk'
+
+try {
+  await cms.getEntry({ path: '/' })
+} catch (error) {
+  if (error instanceof TypeCMSError && error.status === 401) {
+    // bad/disabled token
+  }
+}
+```
+
+## Live preview — `@typecms/sdk/preview`
+
+Real-time editing preview for sites embedded in the Type CMS editor's preview
+pane. Edits stream over postMessage and merge over your fetched content.
+
+```tsx
+import { PreviewProvider, usePreviewContent } from '@typecms/sdk/preview'
+
+function Page({ entry }) {
+  const content = usePreviewContent(entry.content) // live values merged in
+  return <h1 data-preview-field="title">{content.title}</h1>
+}
+```
+
+`data-preview-field="<path>"` enables click-to-edit: clicking the element in
+the preview scrolls the editor to that field.
+
+## Feature flags — `@typecms/sdk/flags`
+
+```typescript
+import { initFlags } from '@typecms/sdk/flags'
+
+const flags = await initFlags({
+  clientKey: 'sdk_xxxxxxxx',
+  attributes: { id: user.id, plan: user.plan },
+})
+
+if (flags.isOn('new-checkout')) {
+  // ...
+}
+```

package/dist/client-BW6BWpfF.d.mts

@@ -0,0 +1,92 @@
+import { P as PreviewState, a as PreviewConfig } from './types-BNHDdA2G.mjs';
+
+/**
+ * Preview Client
+ *
+ * Core client for handling live preview PostMessage communication.
+ * This runs on the preview site (your frontend) inside an iframe.
+ */
+
+type PreviewListener = (state: PreviewState) => void;
+/**
+ * Create a preview client instance.
+ *
+ * This handles PostMessage communication between the Type CMS editor
+ * and your preview site. The client runs in the preview iframe.
+ *
+ * @example
+ * ```typescript
+ * import { createPreviewClient } from '@typecms/sdk/preview'
+ *
+ * const preview = createPreviewClient({
+ *   debug: true,
+ *   onUpdate: (data) => {
+ *     console.log('Value changed:', data.path, data.value)
+ *   },
+ * })
+ *
+ * // Start listening for messages
+ * preview.connect()
+ *
+ * // Get current preview state
+ * const state = preview.getState()
+ *
+ * // Cleanup when done
+ * preview.disconnect()
+ * ```
+ */
+declare function createPreviewClient(config?: PreviewConfig): {
+    /**
+     * Start listening for preview messages.
+     * Call this on mount.
+     */
+    connect(): void;
+    /**
+     * Stop listening for preview messages.
+     * Call this on unmount.
+     */
+    disconnect(): void;
+    /**
+     * Get current preview state.
+     */
+    getState(): PreviewState;
+    /**
+     * Check if preview mode is active.
+     */
+    isEnabled(): boolean;
+    /**
+     * Get a preview value by path.
+     * Returns undefined if no preview value exists.
+     */
+    getValue<T = unknown>(path: string): T | undefined;
+    /**
+     * Subscribe to state changes.
+     */
+    subscribe(listener: PreviewListener): () => void;
+    /**
+     * Notify the editor that the preview has navigated.
+     */
+    notifyNavigation(pathname: string): void;
+    /**
+     * 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: string): void;
+};
+/**
+ * Get a nested value by path (supports "items[0].name" array notation)
+ */
+declare function getNestedValue(obj: Record<string, unknown>, path: string): unknown;
+/**
+ * Deep merge two objects
+ */
+declare function deepMerge<T extends Record<string, unknown>>(target: T, source: Record<string, unknown>): T;
+
+export { type PreviewListener as P, createPreviewClient as c, deepMerge as d, getNestedValue as g };

package/dist/flags/index.d.mts

@@ -0,0 +1,100 @@
+import { Attributes, GrowthBook, StickyBucketService } from '@growthbook/growthbook';
+export { Attributes, GrowthBook } from '@growthbook/growthbook';
+
+/**
+ * @typecms/sdk/flags
+ *
+ * Feature flags client for Type CMS. A thin, typed wrapper around the
+ * GrowthBook JS SDK (peer dependency) pointed at Type CMS as the flag
+ * backend — Type CMS serves the GrowthBook SDK payload contract at
+ * `GET {apiHost}/api/features/{clientKey}`.
+ *
+ * @example
+ * ```typescript
+ * import { initFlags } from '@typecms/sdk/flags'
+ *
+ * const flags = await initFlags({
+ *   clientKey: 'sdk_xxxxxxxx',
+ *   attributes: { id: user.id, plan: user.plan },
+ * })
+ *
+ * if (flags.isOn('new-checkout')) {
+ *   // ...
+ * }
+ * ```
+ */
+
+interface TypeCMSFlagsConfig {
+    /** SDK connection client key (Project settings → Feature Flags → SDK connections) */
+    clientKey: string;
+    /** Override for self-hosted / regional API hosts */
+    apiHost?: string;
+    /** Targeting attributes (id, plan, country, …) */
+    attributes?: Attributes;
+    /**
+     * Decryption key for connections created with payload encryption.
+     * Never ship alongside truly sensitive flag values — encryption hides
+     * payloads from casual inspection, it is not access control.
+     */
+    decryptionKey?: string;
+    /** Callback fired on experiment exposure (wire to your analytics) */
+    trackingCallback?: ConstructorParameters<typeof GrowthBook>[0] extends infer C ? C extends {
+        trackingCallback?: infer T;
+    } ? T : never : never;
+    /** Enable SSE streaming updates when the host supports it (off by default) */
+    streaming?: boolean;
+    /**
+     * Resolve Type CMS audience membership for this visitor (headers, cookies,
+     * geo) and inject it as the `audiences` attribute, so flag conditions can
+     * target audiences: { audiences: { $in: ["beta-users"] } }. Adds one
+     * uncached request during init.
+     */
+    resolveAudiences?: boolean;
+    /**
+     * Sticky bucketing: keep experiment assignments consistent across
+     * sessions/devices even when weights or coverage change mid-experiment.
+     * 'cookie' / 'localStorage' use the GrowthBook browser implementations;
+     * pass a custom StickyBucketService for server-backed storage.
+     */
+    stickyBucketing?: 'cookie' | 'localStorage' | StickyBucketService;
+}
+/** Structural match for GrowthBook's js-cookie-shaped `JsCookiesCompat`. */
+interface CookieAttributes {
+    path?: string;
+    expires?: number | Date;
+    domain?: string;
+    secure?: boolean;
+    sameSite?: string;
+}
+interface DocumentCookieAdapter {
+    set(name: string, value: string, options?: CookieAttributes): string | undefined;
+    get(name: string): string | undefined;
+    get(): Record<string, string>;
+    remove(name: string, options?: CookieAttributes): void;
+}
+/**
+ * Minimal document.cookie adapter satisfying GrowthBook's js-cookie-shaped
+ * dependency, so 'cookie' sticky bucketing works without shipping js-cookie.
+ * Exported for tests; not part of the public API surface.
+ */
+declare function createDocumentCookieAdapter(): DocumentCookieAdapter;
+/**
+ * Create a GrowthBook instance configured for Type CMS. Does not fetch —
+ * call `init()` yourself or use `initFlags` below.
+ */
+declare function createFlagsClient(config: TypeCMSFlagsConfig): GrowthBook;
+/**
+ * Fetch this visitor's Type CMS audience memberships (slugs). Audience rules
+ * evaluate from request attributes (IP/geo/headers) at the API edge, not from
+ * an authenticated session — so this request is credential-less (`omit`). The
+ * attributes endpoint deliberately does not accept credentials; sending them
+ * would only get the response blocked cross-origin. Failures return [] — flags
+ * must not break when the attributes endpoint is unreachable.
+ */
+declare function fetchAudiences(config: TypeCMSFlagsConfig): Promise<string[]>;
+/**
+ * Create + initialize (fetch the payload) in one call.
+ */
+declare function initFlags(config: TypeCMSFlagsConfig): Promise<GrowthBook>;
+
+export { type DocumentCookieAdapter, type TypeCMSFlagsConfig, createDocumentCookieAdapter, createFlagsClient, fetchAudiences, initFlags };

package/dist/flags/index.mjs

@@ -0,0 +1,99 @@
+// src/flags/index.ts
+import {
+  GrowthBook,
+  BrowserCookieStickyBucketService,
+  LocalStorageStickyBucketService
+} from "@growthbook/growthbook";
+var DEFAULT_API_HOST = "https://api.typecms.com";
+function createDocumentCookieAdapter() {
+  const readAll = () => {
+    const out = {};
+    if (typeof document === "undefined" || !document.cookie) return out;
+    for (const pair of document.cookie.split("; ")) {
+      const eq = pair.indexOf("=");
+      if (eq === -1) continue;
+      out[decodeURIComponent(pair.slice(0, eq))] = decodeURIComponent(pair.slice(eq + 1));
+    }
+    return out;
+  };
+  function get(name) {
+    const all = readAll();
+    return name === void 0 ? all : all[name];
+  }
+  return {
+    get,
+    set(name, value, options) {
+      if (typeof document === "undefined") return void 0;
+      let cookie = `${encodeURIComponent(name)}=${encodeURIComponent(String(value))}; path=${options?.path ?? "/"}`;
+      if (options?.expires !== void 0) {
+        const expires = typeof options.expires === "number" ? new Date(Date.now() + options.expires * 864e5) : options.expires;
+        cookie += `; expires=${expires.toUTCString()}`;
+      }
+      if (options?.domain) cookie += `; domain=${options.domain}`;
+      if (options?.secure) cookie += "; secure";
+      if (options?.sameSite) cookie += `; samesite=${options.sameSite}`;
+      document.cookie = cookie;
+      return cookie;
+    },
+    remove(name, options) {
+      this.set(name, "", { ...options, expires: -1 });
+    }
+  };
+}
+function resolveStickyBucketService(config) {
+  if (!config) return void 0;
+  if (config === "cookie") {
+    return new BrowserCookieStickyBucketService({ jsCookie: createDocumentCookieAdapter() });
+  }
+  if (config === "localStorage") return new LocalStorageStickyBucketService();
+  return config;
+}
+function createFlagsClient(config) {
+  const { clientKey, apiHost, attributes, decryptionKey, trackingCallback, streaming } = config;
+  if (!clientKey || !clientKey.startsWith("sdk_")) {
+    throw new Error("@typecms/sdk/flags: clientKey must be an SDK connection key (sdk_...)");
+  }
+  return new GrowthBook({
+    apiHost: (apiHost ?? DEFAULT_API_HOST).replace(/\/$/, ""),
+    clientKey,
+    attributes,
+    decryptionKey,
+    trackingCallback,
+    backgroundSync: streaming === true,
+    stickyBucketService: resolveStickyBucketService(config.stickyBucketing)
+  });
+}
+async function fetchAudiences(config) {
+  const host = (config.apiHost ?? DEFAULT_API_HOST).replace(/\/$/, "");
+  try {
+    const response = await fetch(`${host}/api/features/${config.clientKey}/attributes`, {
+      credentials: "omit"
+    });
+    if (!response.ok) return [];
+    const data = await response.json();
+    return Array.isArray(data.audiences) ? data.audiences : [];
+  } catch {
+    return [];
+  }
+}
+async function initFlags(config) {
+  const gb = createFlagsClient(config);
+  if (config.resolveAudiences) {
+    const [audiences] = await Promise.all([
+      fetchAudiences(config),
+      gb.init({ streaming: config.streaming === true })
+    ]);
+    gb.setAttributes({ ...gb.getAttributes(), audiences });
+  } else {
+    await gb.init({ streaming: config.streaming === true });
+  }
+  return gb;
+}
+export {
+  GrowthBook,
+  createDocumentCookieAdapter,
+  createFlagsClient,
+  fetchAudiences,
+  initFlags
+};
+//# sourceMappingURL=index.mjs.map

package/dist/flags/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/flags/index.ts"],"sourcesContent":["/**\n * @typecms/sdk/flags\n *\n * Feature flags client for Type CMS. A thin, typed wrapper around the\n * GrowthBook JS SDK (peer dependency) pointed at Type CMS as the flag\n * backend — Type CMS serves the GrowthBook SDK payload contract at\n * `GET {apiHost}/api/features/{clientKey}`.\n *\n * @example\n * ```typescript\n * import { initFlags } from '@typecms/sdk/flags'\n *\n * const flags = await initFlags({\n *   clientKey: 'sdk_xxxxxxxx',\n *   attributes: { id: user.id, plan: user.plan },\n * })\n *\n * if (flags.isOn('new-checkout')) {\n *   // ...\n * }\n * ```\n */\n\nimport {\n  GrowthBook,\n  BrowserCookieStickyBucketService,\n  LocalStorageStickyBucketService,\n} from '@growthbook/growthbook'\nimport type { Attributes, StickyBucketService } from '@growthbook/growthbook'\n\nconst DEFAULT_API_HOST = 'https://api.typecms.com'\n\nexport interface TypeCMSFlagsConfig {\n  /** SDK connection client key (Project settings → Feature Flags → SDK connections) */\n  clientKey: string\n  /** Override for self-hosted / regional API hosts */\n  apiHost?: string\n  /** Targeting attributes (id, plan, country, …) */\n  attributes?: Attributes\n  /**\n   * Decryption key for connections created with payload encryption.\n   * Never ship alongside truly sensitive flag values — encryption hides\n   * payloads from casual inspection, it is not access control.\n   */\n  decryptionKey?: string\n  /** Callback fired on experiment exposure (wire to your analytics) */\n  trackingCallback?: ConstructorParameters<typeof GrowthBook>[0] extends infer C\n    ? C extends { trackingCallback?: infer T }\n      ? T\n      : never\n    : never\n  /** Enable SSE streaming updates when the host supports it (off by default) */\n  streaming?: boolean\n  /**\n   * Resolve Type CMS audience membership for this visitor (headers, cookies,\n   * geo) and inject it as the `audiences` attribute, so flag conditions can\n   * target audiences: { audiences: { $in: [\"beta-users\"] } }. Adds one\n   * uncached request during init.\n   */\n  resolveAudiences?: boolean\n  /**\n   * Sticky bucketing: keep experiment assignments consistent across\n   * sessions/devices even when weights or coverage change mid-experiment.\n   * 'cookie' / 'localStorage' use the GrowthBook browser implementations;\n   * pass a custom StickyBucketService for server-backed storage.\n   */\n  stickyBucketing?: 'cookie' | 'localStorage' | StickyBucketService\n}\n\n/** Structural match for GrowthBook's js-cookie-shaped `JsCookiesCompat`. */\ninterface CookieAttributes {\n  path?: string\n  expires?: number | Date\n  domain?: string\n  secure?: boolean\n  sameSite?: string\n}\n\nexport interface DocumentCookieAdapter {\n  set(name: string, value: string, options?: CookieAttributes): string | undefined\n  get(name: string): string | undefined\n  get(): Record<string, string>\n  remove(name: string, options?: CookieAttributes): void\n}\n\n/**\n * Minimal document.cookie adapter satisfying GrowthBook's js-cookie-shaped\n * dependency, so 'cookie' sticky bucketing works without shipping js-cookie.\n * Exported for tests; not part of the public API surface.\n */\nexport function createDocumentCookieAdapter(): DocumentCookieAdapter {\n  const readAll = (): Record<string, string> => {\n    const out: Record<string, string> = {}\n    if (typeof document === 'undefined' || !document.cookie) return out\n    for (const pair of document.cookie.split('; ')) {\n      const eq = pair.indexOf('=')\n      if (eq === -1) continue\n      out[decodeURIComponent(pair.slice(0, eq))] = decodeURIComponent(pair.slice(eq + 1))\n    }\n    return out\n  }\n\n  function get(): Record<string, string>\n  function get(name: string): string | undefined\n  function get(name?: string): Record<string, string> | string | undefined {\n    const all = readAll()\n    return name === undefined ? all : all[name]\n  }\n\n  return {\n    get,\n    set(name, value, options) {\n      if (typeof document === 'undefined') return undefined\n      let cookie = `${encodeURIComponent(name)}=${encodeURIComponent(String(value))}; path=${options?.path ?? '/'}`\n      if (options?.expires !== undefined) {\n        const expires =\n          typeof options.expires === 'number'\n            ? new Date(Date.now() + options.expires * 864e5)\n            : options.expires\n        cookie += `; expires=${expires.toUTCString()}`\n      }\n      if (options?.domain) cookie += `; domain=${options.domain}`\n      if (options?.secure) cookie += '; secure'\n      if (options?.sameSite) cookie += `; samesite=${options.sameSite}`\n      document.cookie = cookie\n      return cookie\n    },\n    remove(name, options) {\n      this.set(name, '', { ...options, expires: -1 })\n    },\n  }\n}\n\nfunction resolveStickyBucketService(\n  config: TypeCMSFlagsConfig['stickyBucketing']\n): StickyBucketService | undefined {\n  if (!config) return undefined\n  if (config === 'cookie') {\n    return new BrowserCookieStickyBucketService({ jsCookie: createDocumentCookieAdapter() })\n  }\n  if (config === 'localStorage') return new LocalStorageStickyBucketService()\n  return config\n}\n\n/**\n * Create a GrowthBook instance configured for Type CMS. Does not fetch —\n * call `init()` yourself or use `initFlags` below.\n */\nexport function createFlagsClient(config: TypeCMSFlagsConfig): GrowthBook {\n  const { clientKey, apiHost, attributes, decryptionKey, trackingCallback, streaming } = config\n\n  if (!clientKey || !clientKey.startsWith('sdk_')) {\n    throw new Error('@typecms/sdk/flags: clientKey must be an SDK connection key (sdk_...)')\n  }\n\n  return new GrowthBook({\n    apiHost: (apiHost ?? DEFAULT_API_HOST).replace(/\\/$/, ''),\n    clientKey,\n    attributes,\n    decryptionKey,\n    trackingCallback,\n    backgroundSync: streaming === true,\n    stickyBucketService: resolveStickyBucketService(config.stickyBucketing),\n  })\n}\n\n/**\n * Fetch this visitor's Type CMS audience memberships (slugs). Audience rules\n * evaluate from request attributes (IP/geo/headers) at the API edge, not from\n * an authenticated session — so this request is credential-less (`omit`). The\n * attributes endpoint deliberately does not accept credentials; sending them\n * would only get the response blocked cross-origin. Failures return [] — flags\n * must not break when the attributes endpoint is unreachable.\n */\nexport async function fetchAudiences(config: TypeCMSFlagsConfig): Promise<string[]> {\n  const host = (config.apiHost ?? DEFAULT_API_HOST).replace(/\\/$/, '')\n  try {\n    const response = await fetch(`${host}/api/features/${config.clientKey}/attributes`, {\n      credentials: 'omit',\n    })\n    if (!response.ok) return []\n    const data = (await response.json()) as { audiences?: string[] }\n    return Array.isArray(data.audiences) ? data.audiences : []\n  } catch {\n    return []\n  }\n}\n\n/**\n * Create + initialize (fetch the payload) in one call.\n */\nexport async function initFlags(config: TypeCMSFlagsConfig): Promise<GrowthBook> {\n  const gb = createFlagsClient(config)\n\n  if (config.resolveAudiences) {\n    // Audience resolution and payload fetch run concurrently\n    const [audiences] = await Promise.all([\n      fetchAudiences(config),\n      gb.init({ streaming: config.streaming === true }),\n    ])\n    gb.setAttributes({ ...gb.getAttributes(), audiences })\n  } else {\n    await gb.init({ streaming: config.streaming === true })\n  }\n\n  return gb\n}\n\n// Re-export the evaluation surface so consumers don't need a direct\n// @growthbook/growthbook import for common usage.\nexport { GrowthBook }\nexport type { Attributes }\n"],"mappings":";AAuBA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAGP,IAAM,mBAAmB;AA4DlB,SAAS,8BAAqD;AACnE,QAAM,UAAU,MAA8B;AAC5C,UAAM,MAA8B,CAAC;AACrC,QAAI,OAAO,aAAa,eAAe,CAAC,SAAS,OAAQ,QAAO;AAChE,eAAW,QAAQ,SAAS,OAAO,MAAM,IAAI,GAAG;AAC9C,YAAM,KAAK,KAAK,QAAQ,GAAG;AAC3B,UAAI,OAAO,GAAI;AACf,UAAI,mBAAmB,KAAK,MAAM,GAAG,EAAE,CAAC,CAAC,IAAI,mBAAmB,KAAK,MAAM,KAAK,CAAC,CAAC;AAAA,IACpF;AACA,WAAO;AAAA,EACT;AAIA,WAAS,IAAI,MAA4D;AACvE,UAAM,MAAM,QAAQ;AACpB,WAAO,SAAS,SAAY,MAAM,IAAI,IAAI;AAAA,EAC5C;AAEA,SAAO;AAAA,IACL;AAAA,IACA,IAAI,MAAM,OAAO,SAAS;AACxB,UAAI,OAAO,aAAa,YAAa,QAAO;AAC5C,UAAI,SAAS,GAAG,mBAAmB,IAAI,CAAC,IAAI,mBAAmB,OAAO,KAAK,CAAC,CAAC,UAAU,SAAS,QAAQ,GAAG;AAC3G,UAAI,SAAS,YAAY,QAAW;AAClC,cAAM,UACJ,OAAO,QAAQ,YAAY,WACvB,IAAI,KAAK,KAAK,IAAI,IAAI,QAAQ,UAAU,KAAK,IAC7C,QAAQ;AACd,kBAAU,aAAa,QAAQ,YAAY,CAAC;AAAA,MAC9C;AACA,UAAI,SAAS,OAAQ,WAAU,YAAY,QAAQ,MAAM;AACzD,UAAI,SAAS,OAAQ,WAAU;AAC/B,UAAI,SAAS,SAAU,WAAU,cAAc,QAAQ,QAAQ;AAC/D,eAAS,SAAS;AAClB,aAAO;AAAA,IACT;AAAA,IACA,OAAO,MAAM,SAAS;AACpB,WAAK,IAAI,MAAM,IAAI,EAAE,GAAG,SAAS,SAAS,GAAG,CAAC;AAAA,IAChD;AAAA,EACF;AACF;AAEA,SAAS,2BACP,QACiC;AACjC,MAAI,CAAC,OAAQ,QAAO;AACpB,MAAI,WAAW,UAAU;AACvB,WAAO,IAAI,iCAAiC,EAAE,UAAU,4BAA4B,EAAE,CAAC;AAAA,EACzF;AACA,MAAI,WAAW,eAAgB,QAAO,IAAI,gCAAgC;AAC1E,SAAO;AACT;AAMO,SAAS,kBAAkB,QAAwC;AACxE,QAAM,EAAE,WAAW,SAAS,YAAY,eAAe,kBAAkB,UAAU,IAAI;AAEvF,MAAI,CAAC,aAAa,CAAC,UAAU,WAAW,MAAM,GAAG;AAC/C,UAAM,IAAI,MAAM,uEAAuE;AAAA,EACzF;AAEA,SAAO,IAAI,WAAW;AAAA,IACpB,UAAU,WAAW,kBAAkB,QAAQ,OAAO,EAAE;AAAA,IACxD;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,gBAAgB,cAAc;AAAA,IAC9B,qBAAqB,2BAA2B,OAAO,eAAe;AAAA,EACxE,CAAC;AACH;AAUA,eAAsB,eAAe,QAA+C;AAClF,QAAM,QAAQ,OAAO,WAAW,kBAAkB,QAAQ,OAAO,EAAE;AACnE,MAAI;AACF,UAAM,WAAW,MAAM,MAAM,GAAG,IAAI,iBAAiB,OAAO,SAAS,eAAe;AAAA,MAClF,aAAa;AAAA,IACf,CAAC;AACD,QAAI,CAAC,SAAS,GAAI,QAAO,CAAC;AAC1B,UAAM,OAAQ,MAAM,SAAS,KAAK;AAClC,WAAO,MAAM,QAAQ,KAAK,SAAS,IAAI,KAAK,YAAY,CAAC;AAAA,EAC3D,QAAQ;AACN,WAAO,CAAC;AAAA,EACV;AACF;AAKA,eAAsB,UAAU,QAAiD;AAC/E,QAAM,KAAK,kBAAkB,MAAM;AAEnC,MAAI,OAAO,kBAAkB;AAE3B,UAAM,CAAC,SAAS,IAAI,MAAM,QAAQ,IAAI;AAAA,MACpC,eAAe,MAAM;AAAA,MACrB,GAAG,KAAK,EAAE,WAAW,OAAO,cAAc,KAAK,CAAC;AAAA,IAClD,CAAC;AACD,OAAG,cAAc,EAAE,GAAG,GAAG,cAAc,GAAG,UAAU,CAAC;AAAA,EACvD,OAAO;AACL,UAAM,GAAG,KAAK,EAAE,WAAW,OAAO,cAAc,KAAK,CAAC;AAAA,EACxD;AAEA,SAAO;AACT;","names":[]}

package/dist/index.d.mts

@@ -0,0 +1,67 @@
+import { TypeCMSClientConfig, TypeCMSClient, SortExpression } from './types/index.mjs';
+export { APIError, Address, Asset, AssetType, BaseComponent, BaseEntry, CollectionReference, ContentEntry, EntryList, EntryReference, ExtractComponent, GetEntriesOptions, GetEntryOptions, Link, RichTextNode, SearchHit, SearchOptions, SearchResult, TipTapMark, TipTapNode, isComponentType } from './types/index.mjs';
+
+/**
+ * Type CMS SDK Client
+ *
+ * Typed client for the Type CMS Content Delivery API
+ * (`POST /api/projects/:projectId/content` and `/content/search`).
+ *
+ * Design notes:
+ * - `getEntry` returns `null` (and `getEntries`/`search` return empty pages)
+ *   when nothing matches — the API's "empty result" 404 is not an exception.
+ * - Personalization is first-class: set a client-wide `variant` or pass one
+ *   per call; when the variant has no published row the base content is
+ *   served automatically (opt out with `variantFallback: false`).
+ * - Drafts: `draft: true` reads unpublished content through the same shapes,
+ *   gated server-side to preview-environment tokens.
+ */
+
+/**
+ * Error thrown when an API request fails (auth, validation, server errors).
+ * Empty results are NOT errors — the typed reads return `null`/empty pages.
+ */
+declare class TypeCMSError extends Error {
+    /** HTTP status code */
+    readonly status: number;
+    /** Validation error details from the API, when present */
+    readonly details?: unknown[];
+    constructor(message: string, status: number, details?: unknown[]);
+}
+/** `'-publishedAt'` → `'publishedAt:-1'`, `'title'` → `'title:1'`. */
+declare function toApiSort(sort: SortExpression): string;
+/**
+ * Create a Type CMS content client.
+ *
+ * @example
+ * ```typescript
+ * import { createClient } from '@typecms/sdk'
+ *
+ * const cms = createClient({
+ *   projectId: '665f00000000000000000001',
+ *   token: process.env.TYPECMS_TOKEN!,
+ * })
+ *
+ * // By URL path — null when nothing is published there
+ * const home = await cms.getEntry<HomePage>({ path: '/' })
+ *
+ * // Personalized, with automatic fallback to base content
+ * const vipHome = await cms.getEntry({ path: '/', variant: 'vip' })
+ *
+ * // Lists
+ * const { entries, count } = await cms.getEntries({
+ *   templateId: '665f00000000000000000002',
+ *   sort: '-publishedAt',
+ *   limit: 10,
+ * })
+ *
+ * // Drafts for live preview (preview-environment token)
+ * const draft = await cms.getEntry({ path: '/', draft: true })
+ *
+ * // Full-text search
+ * const hits = await cms.search('astronaut', { limit: 5 })
+ * ```
+ */
+declare function createClient(config: TypeCMSClientConfig): TypeCMSClient;
+
+export { SortExpression, TypeCMSClient, TypeCMSClientConfig, TypeCMSError, createClient, toApiSort };