@vard-app/sdk 0.1.4 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/next.mjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/fetch-store.ts","../src/client.ts","../src/next.ts"],"sourcesContent":["import type { VardStore } from \"./types\";\n\nexport interface VardFetchStoreOptions {\n /**\n * Base URL of the Vard API. Defaults to https://api.vard.app\n */\n apiBase?: string;\n\n /**\n * API Key for authentication. Defaults to process.env.VARD_API_KEY.\n */\n apiKey?: string;\n\n /**\n * Custom fetch options (headers, etc.)\n */\n fetchOptions?: RequestInit;\n}\n\n/**\n * Creates a universal VardStore that fetches variable values from the Vard API.\n * Works in any environment with a global `fetch` (Browsers, Node 18+, Bun, Deno).\n */\nexport function createVardFetchStore(\n options: VardFetchStoreOptions = {}\n): VardStore & { prefetch(): Promise<void> } {\n const {\n apiBase = options.apiBase ??\n process.env.VARD_API_BASE ??\n process.env.NEXT_PUBLIC_VARD_API_BASE ??\n \"https://dash.vard.app\",\n apiKey = options.apiKey ?? process.env.VARD_API_KEY,\n fetchOptions = {},\n } = options;\n\n let resolvedValues: Map<string, unknown> | null = null;\n let structuredContent: any = null;\n let fetchPromise: Promise<{ variables: Map<string, unknown>; structured: any }> | null = null;\n\n async function fetchValues(): Promise<{ variables: Map<string, unknown>; structured: any }> {\n const isDevelopment = process.env.NODE_ENV === \"development\";\n\n if (!apiKey) {\n if (!isDevelopment) {\n console.error(\n \"\\x1b[31m[vard] Missing configuration! VARD_API_KEY is not set.\\x1b[0m\\n\" +\n \"Please set this environment variable in your production environment.\"\n );\n } else {\n console.warn(\n \"[vard] No API Key found. Running in local fallback mode (using default values).\"\n );\n }\n return { variables: new Map(), structured: {} };\n }\n\n const url = `${apiBase}/api/content/variables?structured=true`;\n\n try {\n const res = await fetch(url, {\n ...fetchOptions,\n headers: {\n ...fetchOptions.headers,\n \"X-Vard-API-Key\": apiKey,\n },\n });\n\n if (!res.ok) {\n console.warn(`[vard] Failed to fetch variables: ${res.status}`);\n return { variables: new Map(), structured: {} };\n }\n\n const data = (await res.json()) as any;\n\n // Handle both legacy (array) and new (object with structured) responses\n if (Array.isArray(data)) {\n return {\n variables: new Map(data.map((v: any) => [v.key, v.value])),\n structured: {},\n };\n }\n\n return {\n variables: new Map(data.variables.map((v: any) => [v.key, v.value])),\n structured: data.structured || {},\n };\n } catch (err) {\n return { variables: new Map(), structured: {} };\n }\n }\n\n return {\n get(key: string): unknown {\n return resolvedValues?.get(key);\n },\n\n getStructured(): any {\n return structuredContent;\n },\n\n async prefetch(): Promise<void> {\n if (resolvedValues) return;\n if (!fetchPromise) {\n fetchPromise = fetchValues();\n }\n const result = await fetchPromise;\n resolvedValues = result.variables;\n structuredContent = result.structured;\n },\n };\n}\n","import {\n VardClient,\n VardOptions,\n VardStore,\n VardVariableDefinition,\n VardVariableOptions,\n VardListItemSchema,\n InferListItem,\n VardRole,\n VardVariableType,\n} from \"./types\";\nimport {\n VardSchema,\n InferSchema,\n VardField,\n VardCollection,\n VardSchemaFragment,\n MergeSchema,\n} from \"./schema\";\nimport { createVardFetchStore } from \"./fetch-store\";\n\n// ─────────────────────────────────────────────\n// No-op store (used in local dev when no apiKey is set)\n// ─────────────────────────────────────────────\n\nlet hasLoggedNoop = false;\nconst noopStore: VardStore = {\n get: () => {\n if (!hasLoggedNoop && process.env.NODE_ENV !== \"test\") {\n console.warn(\n \"[vard] Using default values for all variables because no Store was provided to createVard().\"\n );\n hasLoggedNoop = true;\n }\n return undefined;\n },\n};\n\n// ─────────────────────────────────────────────\n// createVard — the main SDK factory\n// ─────────────────────────────────────────────\n\n/**\n * Creates a Vard client instance. Call this once at the top of your site\n * (e.g. in `lib/vard.ts`) and export the result.\n */\nexport function createVard<S extends VardSchema = any>(\n options: VardOptions<S> = {}\n): VardClient<S> {\n const store: VardStore =\n options.store ?? (options.apiKey ? createVardFetchStore(options) : noopStore);\n\n // Registry of all declared variables — used by CLI + build pipeline\n const registry: VardVariableDefinition[] = [];\n\n function register<T>(def: VardVariableDefinition<T>): T {\n if (!registry.find((d) => d.key === def.key)) {\n registry.push(def as VardVariableDefinition);\n }\n\n const stored = store.get(def.key);\n if (stored !== undefined && stored !== null) {\n return stored as T;\n }\n\n return def.defaultValue;\n }\n\n // ─────────────────────────────────────────────\n // Schema Traversal\n // ─────────────────────────────────────────────\n\n function flattenSchema(schema: VardSchema, prefix = \"\"): any {\n const result: any = {};\n\n for (const [key, value] of Object.entries(schema)) {\n const fullKey = prefix ? `${prefix}.${key}` : key;\n\n if (typeof value === \"object\" && value !== null && \"type\" in value) {\n // It's a field or collection\n const field = value as VardField | VardCollection;\n\n if (field.type === \"collection\") {\n // Flatten collection schema but keep it as a 'list' type for the registry\n const collection = field as VardCollection;\n const listItemSchema: Record<string, string> = {};\n for (const [fKey, fVal] of Object.entries(collection.schema)) {\n listItemSchema[fKey] = (fVal as VardField).type;\n }\n\n register({\n key: fullKey,\n label: labelFromKey(key),\n type: \"list\",\n defaultValue: [],\n editableBy: \"member\",\n listItemSchema: listItemSchema as VardListItemSchema,\n isCollection: true,\n });\n\n // In the returned object, this remains a placeholder or is proxied to the store\n Object.defineProperty(result, key, {\n get: () => store.get(fullKey) ?? [],\n enumerable: true,\n });\n } else {\n // It's a plain field\n const vardField = field as VardField;\n register({\n key: fullKey,\n label: vardField.label ?? labelFromKey(key),\n description: vardField.description,\n type: vardField.type,\n defaultValue: vardField.default,\n editableBy: vardField.editableBy ?? \"member\",\n group: vardField.group,\n });\n\n Object.defineProperty(result, key, {\n get: () => store.get(fullKey) ?? vardField.default,\n enumerable: true,\n });\n }\n } else if (typeof value === \"object\" && value !== null) {\n // It's a nested object\n result[key] = flattenSchema(value as VardSchema, fullKey);\n }\n }\n\n return result;\n }\n\n // Auto-sync schema in development\n if (options.schema && process.env.NODE_ENV === \"development\" && options.apiKey) {\n flattenSchema(options.schema);\n const definitions = [...registry];\n const apiBase =\n process.env.VARD_API_BASE ?? process.env.NEXT_PUBLIC_VARD_API_BASE ?? \"https://dash.vard.app\";\n\n fetch(`${apiBase}/api/content/variables/sync`, {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n \"X-Vard-API-Key\": options.apiKey,\n },\n body: JSON.stringify({\n definitions,\n schema: options.schema,\n }),\n }).catch((err) => console.warn(\"[vard] Auto-sync failed:\", err));\n }\n\n const client: VardClient<S> = {\n define<NS extends VardSchema>(schema: NS): InferSchema<NS> {\n return flattenSchema(schema) as InferSchema<NS>;\n },\n\n async get(): Promise<InferSchema<S>> {\n if (store.prefetch) {\n await store.prefetch();\n }\n if (store.getStructured) {\n const structured = store.getStructured();\n if (structured && Object.keys(structured).length > 0) {\n return structured as InferSchema<S>;\n }\n }\n return flattenSchema(options.schema ?? {}) as InferSchema<S>;\n },\n\n string(key, fallback, opts: VardVariableOptions = {}) {\n return register<string>({\n key,\n label: opts.label ?? labelFromKey(key),\n description: opts.description,\n type: \"string\",\n defaultValue: fallback,\n editableBy: opts.editableBy ?? \"member\",\n group: opts.group,\n });\n },\n\n richtext(key, fallback, opts: VardVariableOptions = {}) {\n return register<string>({\n key,\n label: opts.label ?? labelFromKey(key),\n description: opts.description,\n type: \"richtext\",\n defaultValue: fallback,\n editableBy: opts.editableBy ?? \"member\",\n group: opts.group,\n });\n },\n\n color(key, fallback, opts: VardVariableOptions = {}) {\n return register<string>({\n key,\n label: opts.label ?? labelFromKey(key),\n description: opts.description,\n type: \"color\",\n defaultValue: fallback,\n editableBy: opts.editableBy ?? \"member\",\n group: opts.group,\n });\n },\n\n image(key, fallback, opts: VardVariableOptions = {}) {\n return register<string>({\n key,\n label: opts.label ?? labelFromKey(key),\n description: opts.description,\n type: \"image\",\n defaultValue: fallback,\n editableBy: opts.editableBy ?? \"member\",\n group: opts.group,\n });\n },\n\n boolean(key, fallback, opts: VardVariableOptions = {}) {\n return register<boolean>({\n key,\n label: opts.label ?? labelFromKey(key),\n description: opts.description,\n type: \"boolean\",\n defaultValue: fallback,\n editableBy: (opts.editableBy as VardRole) ?? \"member\",\n group: opts.group,\n });\n },\n\n list<LS extends VardListItemSchema>(\n key: string,\n schema: LS,\n fallback: InferListItem<LS>[],\n opts: VardVariableOptions = {}\n ): InferListItem<LS>[] {\n return register<InferListItem<LS>[]>({\n key,\n label: opts.label ?? labelFromKey(key),\n description: opts.description,\n type: \"list\",\n defaultValue: fallback,\n editableBy: (opts.editableBy as VardRole) ?? \"member\",\n listItemSchema: schema,\n group: opts.group,\n });\n },\n\n collection<LS extends VardListItemSchema>(\n key: string,\n schema: LS,\n fallback: InferListItem<LS>[],\n opts: Omit<VardVariableOptions, \"type\"> = {}\n ): InferListItem<LS>[] {\n return register<InferListItem<LS>[]>({\n key,\n label: opts.label ?? labelFromKey(key),\n description: opts.description,\n type: \"list\",\n defaultValue: fallback,\n editableBy: (opts.editableBy as VardRole) ?? \"member\",\n listItemSchema: schema,\n group: opts.group,\n isCollection: true,\n });\n },\n\n global: {\n string(key, fallback, opts = {}) {\n return client.string(key, fallback, { ...opts, group: \"Global\" } as VardVariableOptions);\n },\n richtext(key, fallback, opts = {}) {\n return client.richtext(key, fallback, { ...opts, group: \"Global\" } as VardVariableOptions);\n },\n color(key, fallback, opts = {}) {\n return client.color(key, fallback, { ...opts, group: \"Global\" } as VardVariableOptions);\n },\n image(key, fallback, opts = {}) {\n return client.image(key, fallback, { ...opts, group: \"Global\" } as VardVariableOptions);\n },\n boolean(key, fallback, opts = {}) {\n return client.boolean(key, fallback, { ...opts, group: \"Global\" } as Omit<\n VardVariableOptions,\n \"type\"\n >);\n },\n list(key, schema, fallback, opts = {}) {\n return client.list(key, schema, fallback, { ...opts, group: \"Global\" } as Omit<\n VardVariableOptions,\n \"type\"\n >);\n },\n },\n\n extend<E extends VardSchema>(fragment: VardSchemaFragment<E>): VardClient<MergeSchema<S, E>> {\n // Merge the base schema with the fragment — the fragment keys win on collision\n const mergedSchema = { ...(options.schema ?? {}), ...fragment } as unknown as MergeSchema<\n S,\n E\n >;\n // Return a new client with the merged schema, sharing the same store & registry.\n // We pass the in-memory store directly so there is no second fetch.\n return createVard<MergeSchema<S, E>>({\n ...options,\n schema: mergedSchema,\n store,\n });\n },\n\n getDefinitions() {\n return [...registry];\n },\n store,\n };\n\n return client;\n}\n\n// ─────────────────────────────────────────────\n// Helpers\n// ─────────────────────────────────────────────\n\nfunction labelFromKey(key: string): string {\n const lastSegment = key.split(\".\").pop() ?? key;\n return lastSegment\n .replace(/([A-Z])/g, \" $1\")\n .replace(/^./, (c) => c.toUpperCase())\n .trim();\n}\n","/**\n * @vard/sdk — Next.js adapter\n *\n * This module provides a VardStore implementation that reads variable values\n * from the Vard API at request time (App Router) or build time (static export).\n *\n * Usage in your Next.js site:\n *\n * // lib/vard.ts\n * import { createVardNextAdapter } from \"@vard/sdk/next\"\n * import { createVard } from \"@vard/sdk\"\n *\n * export const vard = createVard({\n * apiKey: process.env.VARD_API_KEY,\n * store: createVardNextAdapter(),\n * })\n */\n\nimport type { VardStore } from \"./types\";\n\nexport interface VardNextAdapterOptions {\n /**\n * Base URL of the Vard API. Defaults to https://api.vard.app\n */\n apiBase?: string;\n\n /**\n * API Key for authentication. Falls back to process.env.VARD_API_KEY.\n */\n apiKey?: string;\n\n /**\n * Next.js fetch cache strategy. Defaults to \"force-cache\" (SSG-friendly).\n * Use \"no-store\" for fully dynamic pages.\n */\n cache?: RequestCache;\n\n /**\n * Next.js ISR revalidation interval in seconds.\n * Only applies when cache is \"force-cache\".\n */\n revalidate?: number;\n}\n\nimport { createVardFetchStore, VardFetchStoreOptions } from \"./fetch-store\";\n\n/**\n * Creates a VardStore that fetches live variable values from the Vard API.\n * Designed for use inside Next.js App Router (server components, server actions).\n */\nexport function createVardNextAdapter(\n options: VardNextAdapterOptions = {}\n): VardStore & { prefetch(): Promise<void> } {\n const { cache = \"no-store\", revalidate, ...rest } = options;\n\n return createVardFetchStore({\n ...rest,\n fetchOptions: {\n cache,\n ...(revalidate !== undefined && cache === \"force-cache\"\n ? ({ next: { revalidate, tags: [\"variables\"] } } as any)\n : {}),\n },\n });\n}\n\n/**\n * A convenience wrapper that creates a Vard client pre-loaded with live values.\n * Call this once in your Next.js layout before rendering any server component\n * that uses vard variables.\n *\n * @example\n * // app/layout.tsx\n * import { prefetchVardValues } from \"@vard/sdk/next\"\n * import { vard } from \"@/lib/vard\"\n *\n * export default async function RootLayout({ children }) {\n * await prefetchVardValues(vard)\n * return <html>...</html>\n * }\n */\nimport { createVard } from \"./client\";\nimport type { VardClient, VardOptions } from \"./types\";\n\n/**\n * A convenience wrapper for createVard that automatically uses the Next.js adapter.\n *\n * @example\n * // lib/vard.ts\n * import { createVardNext } from \"@vard/sdk/next\"\n * export const vard = createVardNext({ revalidate: 60 })\n */\nexport function createVardNext(options: VardNextAdapterOptions & VardOptions = {}): VardClient {\n const adapter = createVardNextAdapter(options);\n return createVard({\n ...options,\n store: adapter,\n });\n}\n\nexport async function prefetchVardValues(\n target: { prefetch(): Promise<void> } | VardClient\n): Promise<void> {\n const adapter = (target as any).prefetch ? target : (target as VardClient).store;\n if (adapter && typeof (adapter as any).prefetch === \"function\") {\n await (adapter as any).prefetch();\n }\n}\n"],"mappings":";AAuBO,SAAS,qBACd,UAAiC,CAAC,GACS;AAC3C,QAAM;AAAA,IACJ,UAAU,QAAQ,WAChB,QAAQ,IAAI,iBACZ,QAAQ,IAAI,6BACZ;AAAA,IACF,SAAS,QAAQ,UAAU,QAAQ,IAAI;AAAA,IACvC,eAAe,CAAC;AAAA,EAClB,IAAI;AAEJ,MAAI,iBAA8C;AAClD,MAAI,oBAAyB;AAC7B,MAAI,eAAqF;AAEzF,iBAAe,cAA6E;AAC1F,UAAM,gBAAgB,QAAQ,IAAI,aAAa;AAE/C,QAAI,CAAC,QAAQ;AACX,UAAI,CAAC,eAAe;AAClB,gBAAQ;AAAA,UACN;AAAA,QAEF;AAAA,MACF,OAAO;AACL,gBAAQ;AAAA,UACN;AAAA,QACF;AAAA,MACF;AACA,aAAO,EAAE,WAAW,oBAAI,IAAI,GAAG,YAAY,CAAC,EAAE;AAAA,IAChD;AAEA,UAAM,MAAM,GAAG,OAAO;AAEtB,QAAI;AACF,YAAM,MAAM,MAAM,MAAM,KAAK;AAAA,QAC3B,GAAG;AAAA,QACH,SAAS;AAAA,UACP,GAAG,aAAa;AAAA,UAChB,kBAAkB;AAAA,QACpB;AAAA,MACF,CAAC;AAED,UAAI,CAAC,IAAI,IAAI;AACX,gBAAQ,KAAK,qCAAqC,IAAI,MAAM,EAAE;AAC9D,eAAO,EAAE,WAAW,oBAAI,IAAI,GAAG,YAAY,CAAC,EAAE;AAAA,MAChD;AAEA,YAAM,OAAQ,MAAM,IAAI,KAAK;AAG7B,UAAI,MAAM,QAAQ,IAAI,GAAG;AACvB,eAAO;AAAA,UACL,WAAW,IAAI,IAAI,KAAK,IAAI,CAAC,MAAW,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AAAA,UACzD,YAAY,CAAC;AAAA,QACf;AAAA,MACF;AAEA,aAAO;AAAA,QACL,WAAW,IAAI,IAAI,KAAK,UAAU,IAAI,CAAC,MAAW,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AAAA,QACnE,YAAY,KAAK,cAAc,CAAC;AAAA,MAClC;AAAA,IACF,SAAS,KAAK;AACZ,aAAO,EAAE,WAAW,oBAAI,IAAI,GAAG,YAAY,CAAC,EAAE;AAAA,IAChD;AAAA,EACF;AAEA,SAAO;AAAA,IACL,IAAI,KAAsB;AACxB,aAAO,gBAAgB,IAAI,GAAG;AAAA,IAChC;AAAA,IAEA,gBAAqB;AACnB,aAAO;AAAA,IACT;AAAA,IAEA,MAAM,WAA0B;AAC9B,UAAI,eAAgB;AACpB,UAAI,CAAC,cAAc;AACjB,uBAAe,YAAY;AAAA,MAC7B;AACA,YAAM,SAAS,MAAM;AACrB,uBAAiB,OAAO;AACxB,0BAAoB,OAAO;AAAA,IAC7B;AAAA,EACF;AACF;;;ACrFA,IAAI,gBAAgB;AACpB,IAAM,YAAuB;AAAA,EAC3B,KAAK,MAAM;AACT,QAAI,CAAC,iBAAiB,QAAQ,IAAI,aAAa,QAAQ;AACrD,cAAQ;AAAA,QACN;AAAA,MACF;AACA,sBAAgB;AAAA,IAClB;AACA,WAAO;AAAA,EACT;AACF;AAUO,SAAS,WACd,UAA0B,CAAC,GACZ;AACf,QAAM,QACJ,QAAQ,UAAU,QAAQ,SAAS,qBAAqB,OAAO,IAAI;AAGrE,QAAM,WAAqC,CAAC;AAE5C,WAAS,SAAY,KAAmC;AACtD,QAAI,CAAC,SAAS,KAAK,CAAC,MAAM,EAAE,QAAQ,IAAI,GAAG,GAAG;AAC5C,eAAS,KAAK,GAA6B;AAAA,IAC7C;AAEA,UAAM,SAAS,MAAM,IAAI,IAAI,GAAG;AAChC,QAAI,WAAW,UAAa,WAAW,MAAM;AAC3C,aAAO;AAAA,IACT;AAEA,WAAO,IAAI;AAAA,EACb;AAMA,WAAS,cAAc,QAAoB,SAAS,IAAS;AAC3D,UAAM,SAAc,CAAC;AAErB,eAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,MAAM,GAAG;AACjD,YAAM,UAAU,SAAS,GAAG,MAAM,IAAI,GAAG,KAAK;AAE9C,UAAI,OAAO,UAAU,YAAY,UAAU,QAAQ,UAAU,OAAO;AAElE,cAAM,QAAQ;AAEd,YAAI,MAAM,SAAS,cAAc;AAE/B,gBAAM,aAAa;AACnB,gBAAM,iBAAyC,CAAC;AAChD,qBAAW,CAAC,MAAM,IAAI,KAAK,OAAO,QAAQ,WAAW,MAAM,GAAG;AAC5D,2BAAe,IAAI,IAAK,KAAmB;AAAA,UAC7C;AAEA,mBAAS;AAAA,YACP,KAAK;AAAA,YACL,OAAO,aAAa,GAAG;AAAA,YACvB,MAAM;AAAA,YACN,cAAc,CAAC;AAAA,YACf,YAAY;AAAA,YACZ;AAAA,YACA,cAAc;AAAA,UAChB,CAAC;AAGD,iBAAO,eAAe,QAAQ,KAAK;AAAA,YACjC,KAAK,MAAM,MAAM,IAAI,OAAO,KAAK,CAAC;AAAA,YAClC,YAAY;AAAA,UACd,CAAC;AAAA,QACH,OAAO;AAEL,gBAAM,YAAY;AAClB,mBAAS;AAAA,YACP,KAAK;AAAA,YACL,OAAO,UAAU,SAAS,aAAa,GAAG;AAAA,YAC1C,aAAa,UAAU;AAAA,YACvB,MAAM,UAAU;AAAA,YAChB,cAAc,UAAU;AAAA,YACxB,YAAY,UAAU,cAAc;AAAA,YACpC,OAAO,UAAU;AAAA,UACnB,CAAC;AAED,iBAAO,eAAe,QAAQ,KAAK;AAAA,YACjC,KAAK,MAAM,MAAM,IAAI,OAAO,KAAK,UAAU;AAAA,YAC3C,YAAY;AAAA,UACd,CAAC;AAAA,QACH;AAAA,MACF,WAAW,OAAO,UAAU,YAAY,UAAU,MAAM;AAEtD,eAAO,GAAG,IAAI,cAAc,OAAqB,OAAO;AAAA,MAC1D;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAGA,MAAI,QAAQ,UAAU,QAAQ,IAAI,aAAa,iBAAiB,QAAQ,QAAQ;AAC9E,kBAAc,QAAQ,MAAM;AAC5B,UAAM,cAAc,CAAC,GAAG,QAAQ;AAChC,UAAM,UACJ,QAAQ,IAAI,iBAAiB,QAAQ,IAAI,6BAA6B;AAExE,UAAM,GAAG,OAAO,+BAA+B;AAAA,MAC7C,QAAQ;AAAA,MACR,SAAS;AAAA,QACP,gBAAgB;AAAA,QAChB,kBAAkB,QAAQ;AAAA,MAC5B;AAAA,MACA,MAAM,KAAK,UAAU;AAAA,QACnB;AAAA,QACA,QAAQ,QAAQ;AAAA,MAClB,CAAC;AAAA,IACH,CAAC,EAAE,MAAM,CAAC,QAAQ,QAAQ,KAAK,4BAA4B,GAAG,CAAC;AAAA,EACjE;AAEA,QAAM,SAAwB;AAAA,IAC5B,OAA8B,QAA6B;AACzD,aAAO,cAAc,MAAM;AAAA,IAC7B;AAAA,IAEA,MAAM,MAA+B;AACnC,UAAI,MAAM,UAAU;AAClB,cAAM,MAAM,SAAS;AAAA,MACvB;AACA,UAAI,MAAM,eAAe;AACvB,cAAM,aAAa,MAAM,cAAc;AACvC,YAAI,cAAc,OAAO,KAAK,UAAU,EAAE,SAAS,GAAG;AACpD,iBAAO;AAAA,QACT;AAAA,MACF;AACA,aAAO,cAAc,QAAQ,UAAU,CAAC,CAAC;AAAA,IAC3C;AAAA,IAEA,OAAO,KAAK,UAAU,OAA4B,CAAC,GAAG;AACpD,aAAO,SAAiB;AAAA,QACtB;AAAA,QACA,OAAO,KAAK,SAAS,aAAa,GAAG;AAAA,QACrC,aAAa,KAAK;AAAA,QAClB,MAAM;AAAA,QACN,cAAc;AAAA,QACd,YAAY,KAAK,cAAc;AAAA,QAC/B,OAAO,KAAK;AAAA,MACd,CAAC;AAAA,IACH;AAAA,IAEA,SAAS,KAAK,UAAU,OAA4B,CAAC,GAAG;AACtD,aAAO,SAAiB;AAAA,QACtB;AAAA,QACA,OAAO,KAAK,SAAS,aAAa,GAAG;AAAA,QACrC,aAAa,KAAK;AAAA,QAClB,MAAM;AAAA,QACN,cAAc;AAAA,QACd,YAAY,KAAK,cAAc;AAAA,QAC/B,OAAO,KAAK;AAAA,MACd,CAAC;AAAA,IACH;AAAA,IAEA,MAAM,KAAK,UAAU,OAA4B,CAAC,GAAG;AACnD,aAAO,SAAiB;AAAA,QACtB;AAAA,QACA,OAAO,KAAK,SAAS,aAAa,GAAG;AAAA,QACrC,aAAa,KAAK;AAAA,QAClB,MAAM;AAAA,QACN,cAAc;AAAA,QACd,YAAY,KAAK,cAAc;AAAA,QAC/B,OAAO,KAAK;AAAA,MACd,CAAC;AAAA,IACH;AAAA,IAEA,MAAM,KAAK,UAAU,OAA4B,CAAC,GAAG;AACnD,aAAO,SAAiB;AAAA,QACtB;AAAA,QACA,OAAO,KAAK,SAAS,aAAa,GAAG;AAAA,QACrC,aAAa,KAAK;AAAA,QAClB,MAAM;AAAA,QACN,cAAc;AAAA,QACd,YAAY,KAAK,cAAc;AAAA,QAC/B,OAAO,KAAK;AAAA,MACd,CAAC;AAAA,IACH;AAAA,IAEA,QAAQ,KAAK,UAAU,OAA4B,CAAC,GAAG;AACrD,aAAO,SAAkB;AAAA,QACvB;AAAA,QACA,OAAO,KAAK,SAAS,aAAa,GAAG;AAAA,QACrC,aAAa,KAAK;AAAA,QAClB,MAAM;AAAA,QACN,cAAc;AAAA,QACd,YAAa,KAAK,cAA2B;AAAA,QAC7C,OAAO,KAAK;AAAA,MACd,CAAC;AAAA,IACH;AAAA,IAEA,KACE,KACA,QACA,UACA,OAA4B,CAAC,GACR;AACrB,aAAO,SAA8B;AAAA,QACnC;AAAA,QACA,OAAO,KAAK,SAAS,aAAa,GAAG;AAAA,QACrC,aAAa,KAAK;AAAA,QAClB,MAAM;AAAA,QACN,cAAc;AAAA,QACd,YAAa,KAAK,cAA2B;AAAA,QAC7C,gBAAgB;AAAA,QAChB,OAAO,KAAK;AAAA,MACd,CAAC;AAAA,IACH;AAAA,IAEA,WACE,KACA,QACA,UACA,OAA0C,CAAC,GACtB;AACrB,aAAO,SAA8B;AAAA,QACnC;AAAA,QACA,OAAO,KAAK,SAAS,aAAa,GAAG;AAAA,QACrC,aAAa,KAAK;AAAA,QAClB,MAAM;AAAA,QACN,cAAc;AAAA,QACd,YAAa,KAAK,cAA2B;AAAA,QAC7C,gBAAgB;AAAA,QAChB,OAAO,KAAK;AAAA,QACZ,cAAc;AAAA,MAChB,CAAC;AAAA,IACH;AAAA,IAEA,QAAQ;AAAA,MACN,OAAO,KAAK,UAAU,OAAO,CAAC,GAAG;AAC/B,eAAO,OAAO,OAAO,KAAK,UAAU,EAAE,GAAG,MAAM,OAAO,SAAS,CAAwB;AAAA,MACzF;AAAA,MACA,SAAS,KAAK,UAAU,OAAO,CAAC,GAAG;AACjC,eAAO,OAAO,SAAS,KAAK,UAAU,EAAE,GAAG,MAAM,OAAO,SAAS,CAAwB;AAAA,MAC3F;AAAA,MACA,MAAM,KAAK,UAAU,OAAO,CAAC,GAAG;AAC9B,eAAO,OAAO,MAAM,KAAK,UAAU,EAAE,GAAG,MAAM,OAAO,SAAS,CAAwB;AAAA,MACxF;AAAA,MACA,MAAM,KAAK,UAAU,OAAO,CAAC,GAAG;AAC9B,eAAO,OAAO,MAAM,KAAK,UAAU,EAAE,GAAG,MAAM,OAAO,SAAS,CAAwB;AAAA,MACxF;AAAA,MACA,QAAQ,KAAK,UAAU,OAAO,CAAC,GAAG;AAChC,eAAO,OAAO,QAAQ,KAAK,UAAU,EAAE,GAAG,MAAM,OAAO,SAAS,CAG/D;AAAA,MACH;AAAA,MACA,KAAK,KAAK,QAAQ,UAAU,OAAO,CAAC,GAAG;AACrC,eAAO,OAAO,KAAK,KAAK,QAAQ,UAAU,EAAE,GAAG,MAAM,OAAO,SAAS,CAGpE;AAAA,MACH;AAAA,IACF;AAAA,IAEA,OAA6B,UAAgE;AAE3F,YAAM,eAAe,EAAE,GAAI,QAAQ,UAAU,CAAC,GAAI,GAAG,SAAS;AAM9D,aAAO,WAA8B;AAAA,QACnC,GAAG;AAAA,QACH,QAAQ;AAAA,QACR;AAAA,MACF,CAAC;AAAA,IACH;AAAA,IAEA,iBAAiB;AACf,aAAO,CAAC,GAAG,QAAQ;AAAA,IACrB;AAAA,IACA;AAAA,EACF;AAEA,SAAO;AACT;AAMA,SAAS,aAAa,KAAqB;AACzC,QAAM,cAAc,IAAI,MAAM,GAAG,EAAE,IAAI,KAAK;AAC5C,SAAO,YACJ,QAAQ,YAAY,KAAK,EACzB,QAAQ,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,EACpC,KAAK;AACV;;;ACtRO,SAAS,sBACd,UAAkC,CAAC,GACQ;AAC3C,QAAM,EAAE,QAAQ,YAAY,YAAY,GAAG,KAAK,IAAI;AAEpD,SAAO,qBAAqB;AAAA,IAC1B,GAAG;AAAA,IACH,cAAc;AAAA,MACZ;AAAA,MACA,GAAI,eAAe,UAAa,UAAU,gBACrC,EAAE,MAAM,EAAE,YAAY,MAAM,CAAC,WAAW,EAAE,EAAE,IAC7C,CAAC;AAAA,IACP;AAAA,EACF,CAAC;AACH;AA4BO,SAAS,eAAe,UAAgD,CAAC,GAAe;AAC7F,QAAM,UAAU,sBAAsB,OAAO;AAC7C,SAAO,WAAW;AAAA,IAChB,GAAG;AAAA,IACH,OAAO;AAAA,EACT,CAAC;AACH;AAEA,eAAsB,mBACpB,QACe;AACf,QAAM,UAAW,OAAe,WAAW,SAAU,OAAsB;AAC3E,MAAI,WAAW,OAAQ,QAAgB,aAAa,YAAY;AAC9D,UAAO,QAAgB,SAAS;AAAA,EAClC;AACF;","names":[]}
1
+ {"version":3,"sources":["../src/fetch-store.ts","../src/client.ts","../src/next.ts"],"sourcesContent":["import type { VardStore } from \"./types\";\n\nexport interface VardFetchStoreOptions {\n /**\n * Base URL of the Vard API. Defaults to https://api.vard.app\n */\n apiBase?: string;\n\n /**\n * API Key for authentication. Defaults to process.env.VARD_API_KEY.\n */\n apiKey?: string;\n\n /**\n * Custom fetch options (headers, etc.)\n */\n fetchOptions?: RequestInit;\n}\n\n/**\n * Creates a universal VardStore that fetches variable values from the Vard API.\n * Works in any environment with a global `fetch` (Browsers, Node 18+, Bun, Deno).\n */\nexport function createVardFetchStore(\n options: VardFetchStoreOptions = {}\n): VardStore & { prefetch(): Promise<void> } {\n const {\n apiBase = options.apiBase ??\n process.env.VARD_API_BASE ??\n process.env.NEXT_PUBLIC_VARD_API_BASE ??\n \"https://dash.vard.app\",\n apiKey = options.apiKey ?? process.env.VARD_API_KEY,\n fetchOptions = {},\n } = options;\n\n let resolvedValues: Map<string, unknown> | null = null;\n let structuredContent: any = null;\n let fetchPromise: Promise<{ variables: Map<string, unknown>; structured: any }> | null = null;\n\n async function fetchValues(): Promise<{ variables: Map<string, unknown>; structured: any }> {\n const isDevelopment = process.env.NODE_ENV === \"development\";\n\n if (!apiKey) {\n if (!isDevelopment) {\n console.error(\n \"\\x1b[31m[vard] Missing configuration! VARD_API_KEY is not set.\\x1b[0m\\n\" +\n \"Please set this environment variable in your production environment.\"\n );\n } else {\n console.warn(\n \"[vard] No API Key found. Running in local fallback mode (using default values).\"\n );\n }\n return { variables: new Map(), structured: {} };\n }\n\n const url = `${apiBase}/api/content/variables?structured=true`;\n\n try {\n const res = await fetch(url, {\n ...fetchOptions,\n headers: {\n ...fetchOptions.headers,\n \"X-Vard-API-Key\": apiKey,\n },\n });\n\n if (!res.ok) {\n console.warn(`[vard] Failed to fetch variables: ${res.status}`);\n return { variables: new Map(), structured: {} };\n }\n\n const data = (await res.json()) as any;\n\n // Handle both legacy (array) and new (object with structured) responses\n if (Array.isArray(data)) {\n return {\n variables: new Map(data.map((v: any) => [v.key, v.value])),\n structured: {},\n };\n }\n\n return {\n variables: new Map(data.variables.map((v: any) => [v.key, v.value])),\n structured: data.structured || {},\n };\n } catch (err) {\n return { variables: new Map(), structured: {} };\n }\n }\n\n return {\n get(key: string): unknown {\n return resolvedValues?.get(key);\n },\n\n getStructured(): any {\n return structuredContent;\n },\n\n async prefetch(): Promise<void> {\n if (resolvedValues) return;\n if (!fetchPromise) {\n fetchPromise = fetchValues();\n }\n const result = await fetchPromise;\n resolvedValues = result.variables;\n structuredContent = result.structured;\n },\n };\n}\n","import {\n VardClient,\n VardOptions,\n VardStore,\n VardVariableDefinition,\n VardVariableOptions,\n VardListItemSchema,\n InferListItem,\n VardRole,\n VardVariableType,\n} from \"./types\";\nimport {\n VardSchema,\n InferSchema,\n VardField,\n VardCollection,\n VardSchemaFragment,\n MergeSchema,\n} from \"./schema\";\nimport { createVardFetchStore } from \"./fetch-store\";\n\n// ─────────────────────────────────────────────\n// No-op store (used in local dev when no apiKey is set)\n// ─────────────────────────────────────────────\n\nlet hasLoggedNoop = false;\nconst noopStore: VardStore = {\n get: () => {\n if (!hasLoggedNoop && process.env.NODE_ENV !== \"test\") {\n console.warn(\n \"[vard] Using default values for all variables because no Store was provided to createVard().\"\n );\n hasLoggedNoop = true;\n }\n return undefined;\n },\n};\n\n// ─────────────────────────────────────────────\n// createVard — the main SDK factory\n// ─────────────────────────────────────────────\n\n/**\n * Creates a Vard client instance. Call this once at the top of your site\n * (e.g. in `lib/vard.ts`) and export the result.\n */\nexport function createVard<S extends VardSchema = any>(\n options: VardOptions<S> = {}\n): VardClient<S> {\n const store: VardStore =\n options.store ?? (options.apiKey ? createVardFetchStore(options) : noopStore);\n\n // Registry of all declared variables — used by CLI + build pipeline\n const registry: VardVariableDefinition[] = [];\n\n function register<T>(def: VardVariableDefinition<T>): T {\n if (!registry.find((d) => d.key === def.key)) {\n registry.push(def as VardVariableDefinition);\n }\n\n const stored = store.get(def.key);\n if (stored !== undefined && stored !== null) {\n return stored as T;\n }\n\n return def.defaultValue;\n }\n\n // ─────────────────────────────────────────────\n // Schema Traversal\n // ─────────────────────────────────────────────\n\n function flattenSchema(schema: VardSchema, prefix = \"\"): any {\n const result: any = {};\n\n for (const [key, value] of Object.entries(schema)) {\n const fullKey = prefix ? `${prefix}.${key}` : key;\n\n if (typeof value === \"object\" && value !== null && \"type\" in value) {\n // It's a field or collection\n const field = value as VardField | VardCollection;\n\n if (field.type === \"collection\") {\n // Flatten collection schema but keep it as a 'list' type for the registry\n const collection = field as VardCollection;\n const listItemSchema: Record<string, string> = {};\n for (const [fKey, fVal] of Object.entries(collection.schema)) {\n listItemSchema[fKey] = (fVal as VardField).type;\n }\n\n register({\n key: fullKey,\n label: labelFromKey(key),\n type: \"list\",\n defaultValue: [],\n editableBy: \"member\",\n listItemSchema: listItemSchema as VardListItemSchema,\n isCollection: true,\n });\n\n // In the returned object, this remains a placeholder or is proxied to the store\n Object.defineProperty(result, key, {\n get: () => store.get(fullKey) ?? [],\n enumerable: true,\n });\n } else {\n // It's a plain field\n const vardField = field as VardField;\n register({\n key: fullKey,\n label: vardField.label ?? labelFromKey(key),\n description: vardField.description,\n type: vardField.type,\n defaultValue: vardField.default,\n editableBy: vardField.editableBy ?? \"member\",\n group: vardField.group,\n });\n\n Object.defineProperty(result, key, {\n get: () => store.get(fullKey) ?? vardField.default,\n enumerable: true,\n });\n }\n } else if (typeof value === \"object\" && value !== null) {\n // It's a nested object\n result[key] = flattenSchema(value as VardSchema, fullKey);\n }\n }\n\n return result;\n }\n\n // Auto-sync schema in development\n if (options.schema && process.env.NODE_ENV === \"development\" && options.apiKey) {\n flattenSchema(options.schema);\n const definitions = [...registry];\n const apiBase =\n process.env.VARD_API_BASE ?? process.env.NEXT_PUBLIC_VARD_API_BASE ?? \"https://dash.vard.app\";\n\n fetch(`${apiBase}/api/content/variables/sync`, {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n \"X-Vard-API-Key\": options.apiKey,\n },\n body: JSON.stringify({\n definitions,\n schema: options.schema,\n }),\n }).catch((err) => console.warn(\"[vard] Auto-sync failed:\", err));\n }\n\n const client: VardClient<S> = {\n define<NS extends VardSchema>(schema: NS): InferSchema<NS> {\n return flattenSchema(schema) as InferSchema<NS>;\n },\n\n async get(): Promise<InferSchema<S>> {\n if (store.prefetch) {\n await store.prefetch();\n }\n if (store.getStructured) {\n const structured = store.getStructured();\n if (structured && Object.keys(structured).length > 0) {\n return structured as InferSchema<S>;\n }\n }\n return flattenSchema(options.schema ?? {}) as InferSchema<S>;\n },\n\n string(key, fallback, opts: VardVariableOptions = {}) {\n return register<string>({\n key,\n label: opts.label ?? labelFromKey(key),\n description: opts.description,\n type: \"string\",\n defaultValue: fallback,\n editableBy: opts.editableBy ?? \"member\",\n group: opts.group,\n });\n },\n\n richtext(key, fallback, opts: VardVariableOptions = {}) {\n return register<string>({\n key,\n label: opts.label ?? labelFromKey(key),\n description: opts.description,\n type: \"richtext\",\n defaultValue: fallback,\n editableBy: opts.editableBy ?? \"member\",\n group: opts.group,\n });\n },\n\n color(key, fallback, opts: VardVariableOptions = {}) {\n return register<string>({\n key,\n label: opts.label ?? labelFromKey(key),\n description: opts.description,\n type: \"color\",\n defaultValue: fallback,\n editableBy: opts.editableBy ?? \"member\",\n group: opts.group,\n });\n },\n\n image(key, fallback, opts: VardVariableOptions = {}) {\n return register<string>({\n key,\n label: opts.label ?? labelFromKey(key),\n description: opts.description,\n type: \"image\",\n defaultValue: fallback,\n editableBy: opts.editableBy ?? \"member\",\n group: opts.group,\n });\n },\n\n boolean(key, fallback, opts: VardVariableOptions = {}) {\n return register<boolean>({\n key,\n label: opts.label ?? labelFromKey(key),\n description: opts.description,\n type: \"boolean\",\n defaultValue: fallback,\n editableBy: (opts.editableBy as VardRole) ?? \"member\",\n group: opts.group,\n });\n },\n\n list<LS extends VardListItemSchema>(\n key: string,\n schema: LS,\n fallback: InferListItem<LS>[],\n opts: VardVariableOptions = {}\n ): InferListItem<LS>[] {\n return register<InferListItem<LS>[]>({\n key,\n label: opts.label ?? labelFromKey(key),\n description: opts.description,\n type: \"list\",\n defaultValue: fallback,\n editableBy: (opts.editableBy as VardRole) ?? \"member\",\n listItemSchema: schema,\n group: opts.group,\n });\n },\n\n collection<LS extends VardListItemSchema>(\n key: string,\n schema: LS,\n fallback: InferListItem<LS>[],\n opts: Omit<VardVariableOptions, \"type\"> = {}\n ): InferListItem<LS>[] {\n return register<InferListItem<LS>[]>({\n key,\n label: opts.label ?? labelFromKey(key),\n description: opts.description,\n type: \"list\",\n defaultValue: fallback,\n editableBy: (opts.editableBy as VardRole) ?? \"member\",\n listItemSchema: schema,\n group: opts.group,\n isCollection: true,\n });\n },\n\n global: {\n string(key, fallback, opts = {}) {\n return client.string(key, fallback, { ...opts, group: \"Global\" } as VardVariableOptions);\n },\n richtext(key, fallback, opts = {}) {\n return client.richtext(key, fallback, { ...opts, group: \"Global\" } as VardVariableOptions);\n },\n color(key, fallback, opts = {}) {\n return client.color(key, fallback, { ...opts, group: \"Global\" } as VardVariableOptions);\n },\n image(key, fallback, opts = {}) {\n return client.image(key, fallback, { ...opts, group: \"Global\" } as VardVariableOptions);\n },\n boolean(key, fallback, opts = {}) {\n return client.boolean(key, fallback, { ...opts, group: \"Global\" } as Omit<\n VardVariableOptions,\n \"type\"\n >);\n },\n list(key, schema, fallback, opts = {}) {\n return client.list(key, schema, fallback, { ...opts, group: \"Global\" } as Omit<\n VardVariableOptions,\n \"type\"\n >);\n },\n },\n\n extend<E extends VardSchema>(fragment: VardSchemaFragment<E>): VardClient<MergeSchema<S, E>> {\n // Merge the base schema with the fragment — the fragment keys win on collision\n const mergedSchema = { ...(options.schema ?? {}), ...fragment } as unknown as MergeSchema<\n S,\n E\n >;\n // Return a new client with the merged schema, sharing the same store & registry.\n // We pass the in-memory store directly so there is no second fetch.\n return createVard<MergeSchema<S, E>>({\n ...options,\n schema: mergedSchema,\n store,\n });\n },\n\n getDefinitions() {\n return [...registry];\n },\n store,\n };\n\n return client;\n}\n\n// ─────────────────────────────────────────────\n// Helpers\n// ─────────────────────────────────────────────\n\nfunction labelFromKey(key: string): string {\n const lastSegment = key.split(\".\").pop() ?? key;\n return lastSegment\n .replace(/([A-Z])/g, \" $1\")\n .replace(/^./, (c) => c.toUpperCase())\n .trim();\n}\n","/**\n * @vard/sdk — Next.js adapter\n *\n * This module provides a VardStore implementation that reads variable values\n * from the Vard API at request time (App Router) or build time (static export).\n *\n * Usage in your Next.js site:\n *\n * // lib/vard.ts\n * import { createVardNextAdapter } from \"@vard/sdk/next\"\n * import { createVard } from \"@vard/sdk\"\n *\n * export const vard = createVard({\n * apiKey: process.env.VARD_API_KEY,\n * store: createVardNextAdapter(),\n * })\n */\n\nimport type { VardStore } from \"./types\";\n\nexport interface VardNextAdapterOptions {\n /**\n * Base URL of the Vard API. Defaults to https://api.vard.app\n */\n apiBase?: string;\n\n /**\n * API Key for authentication. Falls back to process.env.VARD_API_KEY.\n */\n apiKey?: string;\n\n /**\n * Next.js fetch cache strategy. Defaults to \"force-cache\" (SSG-friendly).\n * Use \"no-store\" for fully dynamic pages.\n */\n cache?: RequestCache;\n\n /**\n * Next.js ISR revalidation interval in seconds.\n * Only applies when cache is \"force-cache\".\n */\n revalidate?: number;\n}\n\nimport { createVardFetchStore, VardFetchStoreOptions } from \"./fetch-store\";\n\n/**\n * Creates a VardStore that fetches live variable values from the Vard API.\n * Designed for use inside Next.js App Router (server components, server actions).\n */\nexport function createVardNextAdapter(\n options: VardNextAdapterOptions = {}\n): VardStore & { prefetch(): Promise<void> } {\n const { cache = \"no-store\", revalidate, ...rest } = options;\n\n return createVardFetchStore({\n ...rest,\n fetchOptions: {\n cache,\n ...(revalidate !== undefined && cache === \"force-cache\"\n ? ({ next: { revalidate, tags: [\"variables\"] } } as any)\n : {}),\n },\n });\n}\n\n/**\n * A convenience wrapper that creates a Vard client pre-loaded with live values.\n * Call this once in your Next.js layout before rendering any server component\n * that uses vard variables.\n *\n * @example\n * // app/layout.tsx\n * import { prefetchVardValues } from \"@vard/sdk/next\"\n * import { vard } from \"@/lib/vard\"\n *\n * export default async function RootLayout({ children }) {\n * await prefetchVardValues(vard)\n * return <html>...</html>\n * }\n */\nimport { createVard } from \"./client\";\nimport type { VardClient, VardOptions } from \"./types\";\n\nimport { VardSchema } from \"./schema\";\n\n/**\n * A convenience wrapper for createVard that automatically uses the Next.js adapter.\n *\n * @example\n * // lib/vard.ts\n * import { createVardNext } from \"@vard/sdk/next\"\n * export const vard = createVardNext({ revalidate: 60 })\n */\nexport function createVardNext<S extends VardSchema = any>(\n options: VardNextAdapterOptions & VardOptions<S> = {}\n): VardClient<S> {\n const adapter = createVardNextAdapter(options);\n return createVard<S>({\n ...options,\n store: adapter,\n });\n}\n\nexport async function prefetchVardValues(\n target: { prefetch(): Promise<void> } | VardClient\n): Promise<void> {\n const adapter = (target as any).prefetch ? target : (target as VardClient).store;\n if (adapter && typeof (adapter as any).prefetch === \"function\") {\n await (adapter as any).prefetch();\n }\n}\n"],"mappings":";AAuBO,SAAS,qBACd,UAAiC,CAAC,GACS;AAC3C,QAAM;AAAA,IACJ,UAAU,QAAQ,WAChB,QAAQ,IAAI,iBACZ,QAAQ,IAAI,6BACZ;AAAA,IACF,SAAS,QAAQ,UAAU,QAAQ,IAAI;AAAA,IACvC,eAAe,CAAC;AAAA,EAClB,IAAI;AAEJ,MAAI,iBAA8C;AAClD,MAAI,oBAAyB;AAC7B,MAAI,eAAqF;AAEzF,iBAAe,cAA6E;AAC1F,UAAM,gBAAgB,QAAQ,IAAI,aAAa;AAE/C,QAAI,CAAC,QAAQ;AACX,UAAI,CAAC,eAAe;AAClB,gBAAQ;AAAA,UACN;AAAA,QAEF;AAAA,MACF,OAAO;AACL,gBAAQ;AAAA,UACN;AAAA,QACF;AAAA,MACF;AACA,aAAO,EAAE,WAAW,oBAAI,IAAI,GAAG,YAAY,CAAC,EAAE;AAAA,IAChD;AAEA,UAAM,MAAM,GAAG,OAAO;AAEtB,QAAI;AACF,YAAM,MAAM,MAAM,MAAM,KAAK;AAAA,QAC3B,GAAG;AAAA,QACH,SAAS;AAAA,UACP,GAAG,aAAa;AAAA,UAChB,kBAAkB;AAAA,QACpB;AAAA,MACF,CAAC;AAED,UAAI,CAAC,IAAI,IAAI;AACX,gBAAQ,KAAK,qCAAqC,IAAI,MAAM,EAAE;AAC9D,eAAO,EAAE,WAAW,oBAAI,IAAI,GAAG,YAAY,CAAC,EAAE;AAAA,MAChD;AAEA,YAAM,OAAQ,MAAM,IAAI,KAAK;AAG7B,UAAI,MAAM,QAAQ,IAAI,GAAG;AACvB,eAAO;AAAA,UACL,WAAW,IAAI,IAAI,KAAK,IAAI,CAAC,MAAW,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AAAA,UACzD,YAAY,CAAC;AAAA,QACf;AAAA,MACF;AAEA,aAAO;AAAA,QACL,WAAW,IAAI,IAAI,KAAK,UAAU,IAAI,CAAC,MAAW,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AAAA,QACnE,YAAY,KAAK,cAAc,CAAC;AAAA,MAClC;AAAA,IACF,SAAS,KAAK;AACZ,aAAO,EAAE,WAAW,oBAAI,IAAI,GAAG,YAAY,CAAC,EAAE;AAAA,IAChD;AAAA,EACF;AAEA,SAAO;AAAA,IACL,IAAI,KAAsB;AACxB,aAAO,gBAAgB,IAAI,GAAG;AAAA,IAChC;AAAA,IAEA,gBAAqB;AACnB,aAAO;AAAA,IACT;AAAA,IAEA,MAAM,WAA0B;AAC9B,UAAI,eAAgB;AACpB,UAAI,CAAC,cAAc;AACjB,uBAAe,YAAY;AAAA,MAC7B;AACA,YAAM,SAAS,MAAM;AACrB,uBAAiB,OAAO;AACxB,0BAAoB,OAAO;AAAA,IAC7B;AAAA,EACF;AACF;;;ACrFA,IAAI,gBAAgB;AACpB,IAAM,YAAuB;AAAA,EAC3B,KAAK,MAAM;AACT,QAAI,CAAC,iBAAiB,QAAQ,IAAI,aAAa,QAAQ;AACrD,cAAQ;AAAA,QACN;AAAA,MACF;AACA,sBAAgB;AAAA,IAClB;AACA,WAAO;AAAA,EACT;AACF;AAUO,SAAS,WACd,UAA0B,CAAC,GACZ;AACf,QAAM,QACJ,QAAQ,UAAU,QAAQ,SAAS,qBAAqB,OAAO,IAAI;AAGrE,QAAM,WAAqC,CAAC;AAE5C,WAAS,SAAY,KAAmC;AACtD,QAAI,CAAC,SAAS,KAAK,CAAC,MAAM,EAAE,QAAQ,IAAI,GAAG,GAAG;AAC5C,eAAS,KAAK,GAA6B;AAAA,IAC7C;AAEA,UAAM,SAAS,MAAM,IAAI,IAAI,GAAG;AAChC,QAAI,WAAW,UAAa,WAAW,MAAM;AAC3C,aAAO;AAAA,IACT;AAEA,WAAO,IAAI;AAAA,EACb;AAMA,WAAS,cAAc,QAAoB,SAAS,IAAS;AAC3D,UAAM,SAAc,CAAC;AAErB,eAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,MAAM,GAAG;AACjD,YAAM,UAAU,SAAS,GAAG,MAAM,IAAI,GAAG,KAAK;AAE9C,UAAI,OAAO,UAAU,YAAY,UAAU,QAAQ,UAAU,OAAO;AAElE,cAAM,QAAQ;AAEd,YAAI,MAAM,SAAS,cAAc;AAE/B,gBAAM,aAAa;AACnB,gBAAM,iBAAyC,CAAC;AAChD,qBAAW,CAAC,MAAM,IAAI,KAAK,OAAO,QAAQ,WAAW,MAAM,GAAG;AAC5D,2BAAe,IAAI,IAAK,KAAmB;AAAA,UAC7C;AAEA,mBAAS;AAAA,YACP,KAAK;AAAA,YACL,OAAO,aAAa,GAAG;AAAA,YACvB,MAAM;AAAA,YACN,cAAc,CAAC;AAAA,YACf,YAAY;AAAA,YACZ;AAAA,YACA,cAAc;AAAA,UAChB,CAAC;AAGD,iBAAO,eAAe,QAAQ,KAAK;AAAA,YACjC,KAAK,MAAM,MAAM,IAAI,OAAO,KAAK,CAAC;AAAA,YAClC,YAAY;AAAA,UACd,CAAC;AAAA,QACH,OAAO;AAEL,gBAAM,YAAY;AAClB,mBAAS;AAAA,YACP,KAAK;AAAA,YACL,OAAO,UAAU,SAAS,aAAa,GAAG;AAAA,YAC1C,aAAa,UAAU;AAAA,YACvB,MAAM,UAAU;AAAA,YAChB,cAAc,UAAU;AAAA,YACxB,YAAY,UAAU,cAAc;AAAA,YACpC,OAAO,UAAU;AAAA,UACnB,CAAC;AAED,iBAAO,eAAe,QAAQ,KAAK;AAAA,YACjC,KAAK,MAAM,MAAM,IAAI,OAAO,KAAK,UAAU;AAAA,YAC3C,YAAY;AAAA,UACd,CAAC;AAAA,QACH;AAAA,MACF,WAAW,OAAO,UAAU,YAAY,UAAU,MAAM;AAEtD,eAAO,GAAG,IAAI,cAAc,OAAqB,OAAO;AAAA,MAC1D;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAGA,MAAI,QAAQ,UAAU,QAAQ,IAAI,aAAa,iBAAiB,QAAQ,QAAQ;AAC9E,kBAAc,QAAQ,MAAM;AAC5B,UAAM,cAAc,CAAC,GAAG,QAAQ;AAChC,UAAM,UACJ,QAAQ,IAAI,iBAAiB,QAAQ,IAAI,6BAA6B;AAExE,UAAM,GAAG,OAAO,+BAA+B;AAAA,MAC7C,QAAQ;AAAA,MACR,SAAS;AAAA,QACP,gBAAgB;AAAA,QAChB,kBAAkB,QAAQ;AAAA,MAC5B;AAAA,MACA,MAAM,KAAK,UAAU;AAAA,QACnB;AAAA,QACA,QAAQ,QAAQ;AAAA,MAClB,CAAC;AAAA,IACH,CAAC,EAAE,MAAM,CAAC,QAAQ,QAAQ,KAAK,4BAA4B,GAAG,CAAC;AAAA,EACjE;AAEA,QAAM,SAAwB;AAAA,IAC5B,OAA8B,QAA6B;AACzD,aAAO,cAAc,MAAM;AAAA,IAC7B;AAAA,IAEA,MAAM,MAA+B;AACnC,UAAI,MAAM,UAAU;AAClB,cAAM,MAAM,SAAS;AAAA,MACvB;AACA,UAAI,MAAM,eAAe;AACvB,cAAM,aAAa,MAAM,cAAc;AACvC,YAAI,cAAc,OAAO,KAAK,UAAU,EAAE,SAAS,GAAG;AACpD,iBAAO;AAAA,QACT;AAAA,MACF;AACA,aAAO,cAAc,QAAQ,UAAU,CAAC,CAAC;AAAA,IAC3C;AAAA,IAEA,OAAO,KAAK,UAAU,OAA4B,CAAC,GAAG;AACpD,aAAO,SAAiB;AAAA,QACtB;AAAA,QACA,OAAO,KAAK,SAAS,aAAa,GAAG;AAAA,QACrC,aAAa,KAAK;AAAA,QAClB,MAAM;AAAA,QACN,cAAc;AAAA,QACd,YAAY,KAAK,cAAc;AAAA,QAC/B,OAAO,KAAK;AAAA,MACd,CAAC;AAAA,IACH;AAAA,IAEA,SAAS,KAAK,UAAU,OAA4B,CAAC,GAAG;AACtD,aAAO,SAAiB;AAAA,QACtB;AAAA,QACA,OAAO,KAAK,SAAS,aAAa,GAAG;AAAA,QACrC,aAAa,KAAK;AAAA,QAClB,MAAM;AAAA,QACN,cAAc;AAAA,QACd,YAAY,KAAK,cAAc;AAAA,QAC/B,OAAO,KAAK;AAAA,MACd,CAAC;AAAA,IACH;AAAA,IAEA,MAAM,KAAK,UAAU,OAA4B,CAAC,GAAG;AACnD,aAAO,SAAiB;AAAA,QACtB;AAAA,QACA,OAAO,KAAK,SAAS,aAAa,GAAG;AAAA,QACrC,aAAa,KAAK;AAAA,QAClB,MAAM;AAAA,QACN,cAAc;AAAA,QACd,YAAY,KAAK,cAAc;AAAA,QAC/B,OAAO,KAAK;AAAA,MACd,CAAC;AAAA,IACH;AAAA,IAEA,MAAM,KAAK,UAAU,OAA4B,CAAC,GAAG;AACnD,aAAO,SAAiB;AAAA,QACtB;AAAA,QACA,OAAO,KAAK,SAAS,aAAa,GAAG;AAAA,QACrC,aAAa,KAAK;AAAA,QAClB,MAAM;AAAA,QACN,cAAc;AAAA,QACd,YAAY,KAAK,cAAc;AAAA,QAC/B,OAAO,KAAK;AAAA,MACd,CAAC;AAAA,IACH;AAAA,IAEA,QAAQ,KAAK,UAAU,OAA4B,CAAC,GAAG;AACrD,aAAO,SAAkB;AAAA,QACvB;AAAA,QACA,OAAO,KAAK,SAAS,aAAa,GAAG;AAAA,QACrC,aAAa,KAAK;AAAA,QAClB,MAAM;AAAA,QACN,cAAc;AAAA,QACd,YAAa,KAAK,cAA2B;AAAA,QAC7C,OAAO,KAAK;AAAA,MACd,CAAC;AAAA,IACH;AAAA,IAEA,KACE,KACA,QACA,UACA,OAA4B,CAAC,GACR;AACrB,aAAO,SAA8B;AAAA,QACnC;AAAA,QACA,OAAO,KAAK,SAAS,aAAa,GAAG;AAAA,QACrC,aAAa,KAAK;AAAA,QAClB,MAAM;AAAA,QACN,cAAc;AAAA,QACd,YAAa,KAAK,cAA2B;AAAA,QAC7C,gBAAgB;AAAA,QAChB,OAAO,KAAK;AAAA,MACd,CAAC;AAAA,IACH;AAAA,IAEA,WACE,KACA,QACA,UACA,OAA0C,CAAC,GACtB;AACrB,aAAO,SAA8B;AAAA,QACnC;AAAA,QACA,OAAO,KAAK,SAAS,aAAa,GAAG;AAAA,QACrC,aAAa,KAAK;AAAA,QAClB,MAAM;AAAA,QACN,cAAc;AAAA,QACd,YAAa,KAAK,cAA2B;AAAA,QAC7C,gBAAgB;AAAA,QAChB,OAAO,KAAK;AAAA,QACZ,cAAc;AAAA,MAChB,CAAC;AAAA,IACH;AAAA,IAEA,QAAQ;AAAA,MACN,OAAO,KAAK,UAAU,OAAO,CAAC,GAAG;AAC/B,eAAO,OAAO,OAAO,KAAK,UAAU,EAAE,GAAG,MAAM,OAAO,SAAS,CAAwB;AAAA,MACzF;AAAA,MACA,SAAS,KAAK,UAAU,OAAO,CAAC,GAAG;AACjC,eAAO,OAAO,SAAS,KAAK,UAAU,EAAE,GAAG,MAAM,OAAO,SAAS,CAAwB;AAAA,MAC3F;AAAA,MACA,MAAM,KAAK,UAAU,OAAO,CAAC,GAAG;AAC9B,eAAO,OAAO,MAAM,KAAK,UAAU,EAAE,GAAG,MAAM,OAAO,SAAS,CAAwB;AAAA,MACxF;AAAA,MACA,MAAM,KAAK,UAAU,OAAO,CAAC,GAAG;AAC9B,eAAO,OAAO,MAAM,KAAK,UAAU,EAAE,GAAG,MAAM,OAAO,SAAS,CAAwB;AAAA,MACxF;AAAA,MACA,QAAQ,KAAK,UAAU,OAAO,CAAC,GAAG;AAChC,eAAO,OAAO,QAAQ,KAAK,UAAU,EAAE,GAAG,MAAM,OAAO,SAAS,CAG/D;AAAA,MACH;AAAA,MACA,KAAK,KAAK,QAAQ,UAAU,OAAO,CAAC,GAAG;AACrC,eAAO,OAAO,KAAK,KAAK,QAAQ,UAAU,EAAE,GAAG,MAAM,OAAO,SAAS,CAGpE;AAAA,MACH;AAAA,IACF;AAAA,IAEA,OAA6B,UAAgE;AAE3F,YAAM,eAAe,EAAE,GAAI,QAAQ,UAAU,CAAC,GAAI,GAAG,SAAS;AAM9D,aAAO,WAA8B;AAAA,QACnC,GAAG;AAAA,QACH,QAAQ;AAAA,QACR;AAAA,MACF,CAAC;AAAA,IACH;AAAA,IAEA,iBAAiB;AACf,aAAO,CAAC,GAAG,QAAQ;AAAA,IACrB;AAAA,IACA;AAAA,EACF;AAEA,SAAO;AACT;AAMA,SAAS,aAAa,KAAqB;AACzC,QAAM,cAAc,IAAI,MAAM,GAAG,EAAE,IAAI,KAAK;AAC5C,SAAO,YACJ,QAAQ,YAAY,KAAK,EACzB,QAAQ,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,EACpC,KAAK;AACV;;;ACtRO,SAAS,sBACd,UAAkC,CAAC,GACQ;AAC3C,QAAM,EAAE,QAAQ,YAAY,YAAY,GAAG,KAAK,IAAI;AAEpD,SAAO,qBAAqB;AAAA,IAC1B,GAAG;AAAA,IACH,cAAc;AAAA,MACZ;AAAA,MACA,GAAI,eAAe,UAAa,UAAU,gBACrC,EAAE,MAAM,EAAE,YAAY,MAAM,CAAC,WAAW,EAAE,EAAE,IAC7C,CAAC;AAAA,IACP;AAAA,EACF,CAAC;AACH;AA8BO,SAAS,eACd,UAAmD,CAAC,GACrC;AACf,QAAM,UAAU,sBAAsB,OAAO;AAC7C,SAAO,WAAc;AAAA,IACnB,GAAG;AAAA,IACH,OAAO;AAAA,EACT,CAAC;AACH;AAEA,eAAsB,mBACpB,QACe;AACf,QAAM,UAAW,OAAe,WAAW,SAAU,OAAsB;AAC3E,MAAI,WAAW,OAAQ,QAAgB,aAAa,YAAY;AAC9D,UAAO,QAAgB,SAAS;AAAA,EAClC;AACF;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vard-app/sdk",
3
- "version": "0.1.4",
3
+ "version": "0.1.5",
4
4
  "description": "Vard SDK — modern, schema-first content layer for Next.js",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",
@@ -37,9 +37,13 @@
37
37
  "optional": true
38
38
  }
39
39
  },
40
+ "publishConfig": {
41
+ "access": "public"
42
+ },
40
43
  "scripts": {
41
44
  "build": "tsup",
42
45
  "dev": "tsup --watch",
43
- "type-check": "tsc --noEmit"
46
+ "type-check": "tsc --noEmit",
47
+ "test:types": "tsc --noEmit src/test-types.ts --esModuleInterop --skipLibCheck --target esnext --moduleResolution node"
44
48
  }
45
49
  }
@@ -1,199 +0,0 @@
1
- interface VardFieldOptions<T = any> {
2
- label?: string;
3
- description?: string;
4
- editableBy?: VardRole;
5
- group?: string;
6
- default?: T;
7
- }
8
- interface VardField<T = any> extends VardFieldOptions<T> {
9
- type: VardVariableType;
10
- }
11
- interface VardCollection<S extends Record<string, VardField | any> = any> {
12
- type: "collection";
13
- schema: S;
14
- }
15
- type VardSchemaValue = VardField | VardCollection | {
16
- [key: string]: VardSchemaValue;
17
- };
18
- type VardSchema = Record<string, VardSchemaValue>;
19
- /**
20
- * A branded schema fragment created with `v.schema()`. Use with `vard.extend()`
21
- * to compose schemas defined across multiple files.
22
- */
23
- type VardSchemaFragment<S extends VardSchema> = S & {
24
- readonly __fragment: true;
25
- };
26
- /**
27
- * Merges two VardSchema types, with B's keys overriding A on collision.
28
- */
29
- type MergeSchema<A extends VardSchema, B extends VardSchema> = Omit<A, keyof B> & B;
30
- declare const v: {
31
- string: (defaultValue?: string, opts?: Omit<VardFieldOptions<string>, "default">) => VardField<string>;
32
- richtext: (defaultValue?: string, opts?: Omit<VardFieldOptions<string>, "default">) => VardField<string>;
33
- color: (defaultValue?: string, opts?: Omit<VardFieldOptions<string>, "default">) => VardField<string>;
34
- image: (defaultValue?: string, opts?: Omit<VardFieldOptions<string>, "default">) => VardField<string>;
35
- boolean: (defaultValue?: boolean, opts?: Omit<VardFieldOptions<boolean>, "default">) => VardField<boolean>;
36
- collection: <S extends Record<string, VardField | any>>(schema: S) => VardCollection<S>;
37
- /**
38
- * Creates a reusable schema fragment that can be merged into a Vard client
39
- * via `vard.extend(fragment)`. Co-locate this with your page/component.
40
- *
41
- * @example
42
- * // app/therapists/schema.ts
43
- * export const therapistSchema = v.schema({
44
- * therapists: v.collection({ name: v.string(), photo: v.image() }),
45
- * });
46
- *
47
- * // app/therapists/page.tsx
48
- * const { therapists } = await vard.extend(therapistSchema).get();
49
- */
50
- schema: <S extends VardSchema>(schema: S) => VardSchemaFragment<S>;
51
- };
52
- type InferSchema<T> = {
53
- [K in keyof T]: T[K] extends VardField<infer U> ? U : T[K] extends VardCollection<infer S> ? InferSchema<S>[] : T[K] extends object ? InferSchema<T[K]> : never;
54
- };
55
-
56
- type VardVariableType = "string" | "richtext" | "color" | "image" | "boolean" | "list";
57
- type VardListItemSchema = Record<string, "string" | "richtext" | "color" | "image" | "boolean">;
58
- type InferListItem<S extends VardListItemSchema> = {
59
- [K in keyof S]: S[K] extends "string" ? string : S[K] extends "richtext" ? string : S[K] extends "color" ? string : S[K] extends "image" ? string : S[K] extends "boolean" ? boolean : never;
60
- };
61
- type VardRole = "owner" | "developer" | "member" | "viewer";
62
- interface VardVariableDefinition<T = unknown> {
63
- /** Dot-notation key, e.g. "hero.title" */
64
- key: string;
65
- /** Human-readable label shown in the client portal */
66
- label: string;
67
- type: VardVariableType;
68
- /** The default value baked into the codebase */
69
- defaultValue: T;
70
- /** Minimum role required to edit this variable. Defaults to "member". */
71
- editableBy: VardRole;
72
- /** Optional description shown as a hint in the client portal */
73
- description?: string;
74
- /** For list variables — the schema of each item */
75
- listItemSchema?: VardListItemSchema;
76
- /** Optional grouping for the dashboard UI */
77
- group?: string;
78
- /** Indicates this is a reusable content pool/collection */
79
- isCollection?: boolean;
80
- }
81
- interface VardStore {
82
- /** Returns a stored value for the given key, or undefined if not set */
83
- get(key: string): unknown;
84
- /** Returns the full structured content object */
85
- getStructured?(): any;
86
- /** Ensures all values are loaded from the backend */
87
- prefetch?(): Promise<void>;
88
- }
89
- interface VardOptions<S extends VardSchema = any> {
90
- /**
91
- * API Key for authentication. Read from VARD_API_KEY env var if not provided.
92
- * This is the preferred way to configure the SDK as it's tied to your workspace.
93
- */
94
- apiKey?: string;
95
- /**
96
- * Optional content schema for type-safe data access and auto-syncing.
97
- */
98
- schema?: S;
99
- /**
100
- * Provide a custom store implementation. Used internally by the Next.js
101
- * adapter and for testing. Defaults to a no-op in environments where
102
- * VARD_API_KEY is unset (local dev without Vard).
103
- */
104
- store?: VardStore;
105
- }
106
- interface VardClient<S extends VardSchema = any> {
107
- /**
108
- * Define your content structure for type-safe data access and auto-syncing.
109
- *
110
- * @example
111
- * const content = vard.define({
112
- * hero: { title: v.string("Welcome") }
113
- * });
114
- */
115
- define<NS extends VardSchema>(schema: NS): InferSchema<NS>;
116
- /**
117
- * Returns a type-safe object containing all variable values matching the schema.
118
- */
119
- get(): Promise<InferSchema<S>>;
120
- /**
121
- * Returns a new scoped client with the given schema fragment merged in.
122
- * Shares the same underlying store and registry as the parent client.
123
- * Use this to co-locate page-specific schema definitions with their pages.
124
- *
125
- * @example
126
- * // app/therapists/schema.ts
127
- * export const therapistSchema = v.schema({
128
- * therapists: v.collection({ name: v.string() }),
129
- * });
130
- *
131
- * // app/therapists/page.tsx
132
- * const { therapists, global } = await vard.extend(therapistSchema).get();
133
- */
134
- extend<E extends VardSchema>(fragment: VardSchemaFragment<E>): VardClient<MergeSchema<S, E>>;
135
- /**
136
- * Access to global (project-wide) variables.
137
- * e.g., vard.global.string("contact.email", "...")
138
- */
139
- global: VardGlobalClient;
140
- /**
141
- * Define a reusable content pool/collection.
142
- */
143
- collection<S extends VardListItemSchema>(key: string, schema: S, fallback: InferListItem<S>[], options?: Omit<VardVariableOptions, "type">): InferListItem<S>[];
144
- /**
145
- * A plain string variable. e.g. a hero headline, a CTA label.
146
- *
147
- * @param key Dot-notation identifier, unique within the workspace
148
- * @param fallback Default value when no client value is stored
149
- * @param options Optional label, description, permission
150
- */
151
- string(key: string, fallback: string, options?: VardVariableOptions): string;
152
- /**
153
- * A rich text (markdown) variable. Rendered as HTML at build time.
154
- */
155
- richtext(key: string, fallback: string, options?: VardVariableOptions): string;
156
- /**
157
- * A CSS color string (hex, hsl, rgb).
158
- */
159
- color(key: string, fallback: string, options?: VardVariableOptions): string;
160
- /**
161
- * A URL pointing to an uploaded asset (image, video).
162
- */
163
- image(key: string, fallback: string, options?: VardVariableOptions): string;
164
- /**
165
- * A boolean feature flag. e.g. show/hide a section.
166
- */
167
- boolean(key: string, fallback: boolean, options?: Omit<VardVariableOptions, "type">): boolean;
168
- /**
169
- * An ordered list of typed objects. e.g. team members, testimonials.
170
- *
171
- * @param schema Defines the shape of each list item
172
- */
173
- list<S extends VardListItemSchema>(key: string, schema: S, fallback: InferListItem<S>[], options?: Omit<VardVariableOptions, "type">): InferListItem<S>[];
174
- /**
175
- * Returns all registered variable definitions. Used by the CLI scanner
176
- * and the build pipeline to sync definitions to the Vard API.
177
- */
178
- getDefinitions(): VardVariableDefinition[];
179
- /**
180
- * Access to the underlying store.
181
- */
182
- readonly store: VardStore;
183
- }
184
- interface VardGlobalClient {
185
- string(key: string, fallback: string, options?: Omit<VardVariableOptions, "group">): string;
186
- richtext(key: string, fallback: string, options?: Omit<VardVariableOptions, "group">): string;
187
- color(key: string, fallback: string, options?: Omit<VardVariableOptions, "group">): string;
188
- image(key: string, fallback: string, options?: Omit<VardVariableOptions, "group">): string;
189
- boolean(key: string, fallback: boolean, options?: Omit<VardVariableOptions, "type" | "group">): boolean;
190
- list<S extends VardListItemSchema>(key: string, schema: S, fallback: InferListItem<S>[], options?: Omit<VardVariableOptions, "type" | "group">): InferListItem<S>[];
191
- }
192
- interface VardVariableOptions {
193
- label?: string;
194
- description?: string;
195
- editableBy?: VardRole;
196
- group?: string;
197
- }
198
-
199
- export { type InferListItem as I, type MergeSchema as M, type VardSchema as V, type VardOptions as a, type VardClient as b, type VardStore as c, type InferSchema as d, type VardListItemSchema as e, type VardRole as f, type VardSchemaFragment as g, type VardVariableDefinition as h, type VardVariableOptions as i, type VardVariableType as j, v };
@@ -1,199 +0,0 @@
1
- interface VardFieldOptions<T = any> {
2
- label?: string;
3
- description?: string;
4
- editableBy?: VardRole;
5
- group?: string;
6
- default?: T;
7
- }
8
- interface VardField<T = any> extends VardFieldOptions<T> {
9
- type: VardVariableType;
10
- }
11
- interface VardCollection<S extends Record<string, VardField | any> = any> {
12
- type: "collection";
13
- schema: S;
14
- }
15
- type VardSchemaValue = VardField | VardCollection | {
16
- [key: string]: VardSchemaValue;
17
- };
18
- type VardSchema = Record<string, VardSchemaValue>;
19
- /**
20
- * A branded schema fragment created with `v.schema()`. Use with `vard.extend()`
21
- * to compose schemas defined across multiple files.
22
- */
23
- type VardSchemaFragment<S extends VardSchema> = S & {
24
- readonly __fragment: true;
25
- };
26
- /**
27
- * Merges two VardSchema types, with B's keys overriding A on collision.
28
- */
29
- type MergeSchema<A extends VardSchema, B extends VardSchema> = Omit<A, keyof B> & B;
30
- declare const v: {
31
- string: (defaultValue?: string, opts?: Omit<VardFieldOptions<string>, "default">) => VardField<string>;
32
- richtext: (defaultValue?: string, opts?: Omit<VardFieldOptions<string>, "default">) => VardField<string>;
33
- color: (defaultValue?: string, opts?: Omit<VardFieldOptions<string>, "default">) => VardField<string>;
34
- image: (defaultValue?: string, opts?: Omit<VardFieldOptions<string>, "default">) => VardField<string>;
35
- boolean: (defaultValue?: boolean, opts?: Omit<VardFieldOptions<boolean>, "default">) => VardField<boolean>;
36
- collection: <S extends Record<string, VardField | any>>(schema: S) => VardCollection<S>;
37
- /**
38
- * Creates a reusable schema fragment that can be merged into a Vard client
39
- * via `vard.extend(fragment)`. Co-locate this with your page/component.
40
- *
41
- * @example
42
- * // app/therapists/schema.ts
43
- * export const therapistSchema = v.schema({
44
- * therapists: v.collection({ name: v.string(), photo: v.image() }),
45
- * });
46
- *
47
- * // app/therapists/page.tsx
48
- * const { therapists } = await vard.extend(therapistSchema).get();
49
- */
50
- schema: <S extends VardSchema>(schema: S) => VardSchemaFragment<S>;
51
- };
52
- type InferSchema<T> = {
53
- [K in keyof T]: T[K] extends VardField<infer U> ? U : T[K] extends VardCollection<infer S> ? InferSchema<S>[] : T[K] extends object ? InferSchema<T[K]> : never;
54
- };
55
-
56
- type VardVariableType = "string" | "richtext" | "color" | "image" | "boolean" | "list";
57
- type VardListItemSchema = Record<string, "string" | "richtext" | "color" | "image" | "boolean">;
58
- type InferListItem<S extends VardListItemSchema> = {
59
- [K in keyof S]: S[K] extends "string" ? string : S[K] extends "richtext" ? string : S[K] extends "color" ? string : S[K] extends "image" ? string : S[K] extends "boolean" ? boolean : never;
60
- };
61
- type VardRole = "owner" | "developer" | "member" | "viewer";
62
- interface VardVariableDefinition<T = unknown> {
63
- /** Dot-notation key, e.g. "hero.title" */
64
- key: string;
65
- /** Human-readable label shown in the client portal */
66
- label: string;
67
- type: VardVariableType;
68
- /** The default value baked into the codebase */
69
- defaultValue: T;
70
- /** Minimum role required to edit this variable. Defaults to "member". */
71
- editableBy: VardRole;
72
- /** Optional description shown as a hint in the client portal */
73
- description?: string;
74
- /** For list variables — the schema of each item */
75
- listItemSchema?: VardListItemSchema;
76
- /** Optional grouping for the dashboard UI */
77
- group?: string;
78
- /** Indicates this is a reusable content pool/collection */
79
- isCollection?: boolean;
80
- }
81
- interface VardStore {
82
- /** Returns a stored value for the given key, or undefined if not set */
83
- get(key: string): unknown;
84
- /** Returns the full structured content object */
85
- getStructured?(): any;
86
- /** Ensures all values are loaded from the backend */
87
- prefetch?(): Promise<void>;
88
- }
89
- interface VardOptions<S extends VardSchema = any> {
90
- /**
91
- * API Key for authentication. Read from VARD_API_KEY env var if not provided.
92
- * This is the preferred way to configure the SDK as it's tied to your workspace.
93
- */
94
- apiKey?: string;
95
- /**
96
- * Optional content schema for type-safe data access and auto-syncing.
97
- */
98
- schema?: S;
99
- /**
100
- * Provide a custom store implementation. Used internally by the Next.js
101
- * adapter and for testing. Defaults to a no-op in environments where
102
- * VARD_API_KEY is unset (local dev without Vard).
103
- */
104
- store?: VardStore;
105
- }
106
- interface VardClient<S extends VardSchema = any> {
107
- /**
108
- * Define your content structure for type-safe data access and auto-syncing.
109
- *
110
- * @example
111
- * const content = vard.define({
112
- * hero: { title: v.string("Welcome") }
113
- * });
114
- */
115
- define<NS extends VardSchema>(schema: NS): InferSchema<NS>;
116
- /**
117
- * Returns a type-safe object containing all variable values matching the schema.
118
- */
119
- get(): Promise<InferSchema<S>>;
120
- /**
121
- * Returns a new scoped client with the given schema fragment merged in.
122
- * Shares the same underlying store and registry as the parent client.
123
- * Use this to co-locate page-specific schema definitions with their pages.
124
- *
125
- * @example
126
- * // app/therapists/schema.ts
127
- * export const therapistSchema = v.schema({
128
- * therapists: v.collection({ name: v.string() }),
129
- * });
130
- *
131
- * // app/therapists/page.tsx
132
- * const { therapists, global } = await vard.extend(therapistSchema).get();
133
- */
134
- extend<E extends VardSchema>(fragment: VardSchemaFragment<E>): VardClient<MergeSchema<S, E>>;
135
- /**
136
- * Access to global (project-wide) variables.
137
- * e.g., vard.global.string("contact.email", "...")
138
- */
139
- global: VardGlobalClient;
140
- /**
141
- * Define a reusable content pool/collection.
142
- */
143
- collection<S extends VardListItemSchema>(key: string, schema: S, fallback: InferListItem<S>[], options?: Omit<VardVariableOptions, "type">): InferListItem<S>[];
144
- /**
145
- * A plain string variable. e.g. a hero headline, a CTA label.
146
- *
147
- * @param key Dot-notation identifier, unique within the workspace
148
- * @param fallback Default value when no client value is stored
149
- * @param options Optional label, description, permission
150
- */
151
- string(key: string, fallback: string, options?: VardVariableOptions): string;
152
- /**
153
- * A rich text (markdown) variable. Rendered as HTML at build time.
154
- */
155
- richtext(key: string, fallback: string, options?: VardVariableOptions): string;
156
- /**
157
- * A CSS color string (hex, hsl, rgb).
158
- */
159
- color(key: string, fallback: string, options?: VardVariableOptions): string;
160
- /**
161
- * A URL pointing to an uploaded asset (image, video).
162
- */
163
- image(key: string, fallback: string, options?: VardVariableOptions): string;
164
- /**
165
- * A boolean feature flag. e.g. show/hide a section.
166
- */
167
- boolean(key: string, fallback: boolean, options?: Omit<VardVariableOptions, "type">): boolean;
168
- /**
169
- * An ordered list of typed objects. e.g. team members, testimonials.
170
- *
171
- * @param schema Defines the shape of each list item
172
- */
173
- list<S extends VardListItemSchema>(key: string, schema: S, fallback: InferListItem<S>[], options?: Omit<VardVariableOptions, "type">): InferListItem<S>[];
174
- /**
175
- * Returns all registered variable definitions. Used by the CLI scanner
176
- * and the build pipeline to sync definitions to the Vard API.
177
- */
178
- getDefinitions(): VardVariableDefinition[];
179
- /**
180
- * Access to the underlying store.
181
- */
182
- readonly store: VardStore;
183
- }
184
- interface VardGlobalClient {
185
- string(key: string, fallback: string, options?: Omit<VardVariableOptions, "group">): string;
186
- richtext(key: string, fallback: string, options?: Omit<VardVariableOptions, "group">): string;
187
- color(key: string, fallback: string, options?: Omit<VardVariableOptions, "group">): string;
188
- image(key: string, fallback: string, options?: Omit<VardVariableOptions, "group">): string;
189
- boolean(key: string, fallback: boolean, options?: Omit<VardVariableOptions, "type" | "group">): boolean;
190
- list<S extends VardListItemSchema>(key: string, schema: S, fallback: InferListItem<S>[], options?: Omit<VardVariableOptions, "type" | "group">): InferListItem<S>[];
191
- }
192
- interface VardVariableOptions {
193
- label?: string;
194
- description?: string;
195
- editableBy?: VardRole;
196
- group?: string;
197
- }
198
-
199
- export { type InferListItem as I, type MergeSchema as M, type VardSchema as V, type VardOptions as a, type VardClient as b, type VardStore as c, type InferSchema as d, type VardListItemSchema as e, type VardRole as f, type VardSchemaFragment as g, type VardVariableDefinition as h, type VardVariableOptions as i, type VardVariableType as j, v };