@vard-app/sdk 0.1.2 → 0.1.4

package/dist/{types-eJuYa65b.d.ts → types-Dd-I7jwP.d.ts}

@@ -1,3 +1,58 @@
+interface VardFieldOptions<T = any> {
+    label?: string;
+    description?: string;
+    editableBy?: VardRole;
+    group?: string;
+    default?: T;
+}
+interface VardField<T = any> extends VardFieldOptions<T> {
+    type: VardVariableType;
+}
+interface VardCollection<S extends Record<string, VardField | any> = any> {
+    type: "collection";
+    schema: S;
+}
+type VardSchemaValue = VardField | VardCollection | {
+    [key: string]: VardSchemaValue;
+};
+type VardSchema = Record<string, VardSchemaValue>;
+/**
+ * A branded schema fragment created with `v.schema()`. Use with `vard.extend()`
+ * to compose schemas defined across multiple files.
+ */
+type VardSchemaFragment<S extends VardSchema> = S & {
+    readonly __fragment: true;
+};
+/**
+ * Merges two VardSchema types, with B's keys overriding A on collision.
+ */
+type MergeSchema<A extends VardSchema, B extends VardSchema> = Omit<A, keyof B> & B;
+declare const v: {
+    string: (defaultValue?: string, opts?: Omit<VardFieldOptions<string>, "default">) => VardField<string>;
+    richtext: (defaultValue?: string, opts?: Omit<VardFieldOptions<string>, "default">) => VardField<string>;
+    color: (defaultValue?: string, opts?: Omit<VardFieldOptions<string>, "default">) => VardField<string>;
+    image: (defaultValue?: string, opts?: Omit<VardFieldOptions<string>, "default">) => VardField<string>;
+    boolean: (defaultValue?: boolean, opts?: Omit<VardFieldOptions<boolean>, "default">) => VardField<boolean>;
+    collection: <S extends Record<string, VardField | any>>(schema: S) => VardCollection<S>;
+    /**
+     * Creates a reusable schema fragment that can be merged into a Vard client
+     * via `vard.extend(fragment)`. Co-locate this with your page/component.
+     *
+     * @example
+     * // app/therapists/schema.ts
+     * export const therapistSchema = v.schema({
+     *   therapists: v.collection({ name: v.string(), photo: v.image() }),
+     * });
+     *
+     * // app/therapists/page.tsx
+     * const { therapists } = await vard.extend(therapistSchema).get();
+     */
+    schema: <S extends VardSchema>(schema: S) => VardSchemaFragment<S>;
+};
+type InferSchema<T> = {
+    [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;
+};
+
 type VardVariableType = "string" | "richtext" | "color" | "image" | "boolean" | "list";
 type VardListItemSchema = Record<string, "string" | "richtext" | "color" | "image" | "boolean">;
 type InferListItem<S extends VardListItemSchema> = {
@@ -26,26 +81,57 @@ interface VardVariableDefinition<T = unknown> {
 interface VardStore {
     /** Returns a stored value for the given key, or undefined if not set */
     get(key: string): unknown;
+    /** Returns the full structured content object */
+    getStructured?(): any;
+    /** Ensures all values are loaded from the backend */
+    prefetch?(): Promise<void>;
 }
-interface VardOptions {
+interface VardOptions<S extends VardSchema = any> {
     /**
      * API Key for authentication. Read from VARD_API_KEY env var if not provided.
      * This is the preferred way to configure the SDK as it's tied to your workspace.
      */
     apiKey?: string;
     /**
-     * Workspace ID (Legacy). Required only if not using an API Key.
-     * Read from VARD_WORKSPACE_ID env var if not provided.
+     * Optional content schema for type-safe data access and auto-syncing.
      */
-    workspaceId?: string;
+    schema?: S;
     /**
      * Provide a custom store implementation. Used internally by the Next.js
      * adapter and for testing. Defaults to a no-op in environments where
-     * VARD_WORKSPACE_ID is unset (local dev without Vard).
+     * VARD_API_KEY is unset (local dev without Vard).
      */
     store?: VardStore;
 }
-interface VardClient {
+interface VardClient<S extends VardSchema = any> {
+    /**
+     * Define your content structure for type-safe data access and auto-syncing.
+     *
+     * @example
+     * const content = vard.define({
+     *   hero: { title: v.string("Welcome") }
+     * });
+     */
+    define<NS extends VardSchema>(schema: NS): InferSchema<NS>;
+    /**
+     * Returns a type-safe object containing all variable values matching the schema.
+     */
+    get(): Promise<InferSchema<S>>;
+    /**
+     * Returns a new scoped client with the given schema fragment merged in.
+     * Shares the same underlying store and registry as the parent client.
+     * Use this to co-locate page-specific schema definitions with their pages.
+     *
+     * @example
+     * // app/therapists/schema.ts
+     * export const therapistSchema = v.schema({
+     *   therapists: v.collection({ name: v.string() }),
+     * });
+     *
+     * // app/therapists/page.tsx
+     * const { therapists, global } = await vard.extend(therapistSchema).get();
+     */
+    extend<E extends VardSchema>(fragment: VardSchemaFragment<E>): VardClient<MergeSchema<S, E>>;
     /**
      * Access to global (project-wide) variables.
      * e.g., vard.global.string("contact.email", "...")
@@ -110,4 +196,4 @@ interface VardVariableOptions {
     group?: string;
 }
 
-export type { InferListItem as I, VardOptions as V, VardClient as a, VardStore as b, VardListItemSchema as c, VardRole as d, VardVariableDefinition as e, VardVariableOptions as f, VardVariableType as g };
+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 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vard-app/sdk",
-  "version": "0.1.2",
-  "description": "Vard SDK — annotate variables in your Next.js site for client-editable content",
+  "version": "0.1.4",
+  "description": "Vard SDK — modern, schema-first content layer for Next.js",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",