@vard-app/sdk 0.1.4 → 0.1.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vard-app/sdk",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "Vard SDK — modern, schema-first content layer for Next.js",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -37,9 +37,13 @@
       "optional": true
     }
   },
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "build": "tsup",
     "dev": "tsup --watch",
-    "type-check": "tsc --noEmit"
+    "type-check": "tsc --noEmit",
+    "test:types": "tsc --noEmit src/test-types.ts --esModuleInterop --skipLibCheck --target esnext --moduleResolution node"
   }
 }

package/dist/types-Dd-I7jwP.d.mts

@@ -1,199 +0,0 @@
-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> = {
-    [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;
-};
-type VardRole = "owner" | "developer" | "member" | "viewer";
-interface VardVariableDefinition<T = unknown> {
-    /** Dot-notation key, e.g. "hero.title" */
-    key: string;
-    /** Human-readable label shown in the client portal */
-    label: string;
-    type: VardVariableType;
-    /** The default value baked into the codebase */
-    defaultValue: T;
-    /** Minimum role required to edit this variable. Defaults to "member". */
-    editableBy: VardRole;
-    /** Optional description shown as a hint in the client portal */
-    description?: string;
-    /** For list variables — the schema of each item */
-    listItemSchema?: VardListItemSchema;
-    /** Optional grouping for the dashboard UI */
-    group?: string;
-    /** Indicates this is a reusable content pool/collection */
-    isCollection?: boolean;
-}
-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<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;
-    /**
-     * Optional content schema for type-safe data access and auto-syncing.
-     */
-    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_API_KEY is unset (local dev without Vard).
-     */
-    store?: VardStore;
-}
-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", "...")
-     */
-    global: VardGlobalClient;
-    /**
-     * Define a reusable content pool/collection.
-     */
-    collection<S extends VardListItemSchema>(key: string, schema: S, fallback: InferListItem<S>[], options?: Omit<VardVariableOptions, "type">): InferListItem<S>[];
-    /**
-     * A plain string variable. e.g. a hero headline, a CTA label.
-     *
-     * @param key       Dot-notation identifier, unique within the workspace
-     * @param fallback  Default value when no client value is stored
-     * @param options   Optional label, description, permission
-     */
-    string(key: string, fallback: string, options?: VardVariableOptions): string;
-    /**
-     * A rich text (markdown) variable. Rendered as HTML at build time.
-     */
-    richtext(key: string, fallback: string, options?: VardVariableOptions): string;
-    /**
-     * A CSS color string (hex, hsl, rgb).
-     */
-    color(key: string, fallback: string, options?: VardVariableOptions): string;
-    /**
-     * A URL pointing to an uploaded asset (image, video).
-     */
-    image(key: string, fallback: string, options?: VardVariableOptions): string;
-    /**
-     * A boolean feature flag. e.g. show/hide a section.
-     */
-    boolean(key: string, fallback: boolean, options?: Omit<VardVariableOptions, "type">): boolean;
-    /**
-     * An ordered list of typed objects. e.g. team members, testimonials.
-     *
-     * @param schema  Defines the shape of each list item
-     */
-    list<S extends VardListItemSchema>(key: string, schema: S, fallback: InferListItem<S>[], options?: Omit<VardVariableOptions, "type">): InferListItem<S>[];
-    /**
-     * Returns all registered variable definitions. Used by the CLI scanner
-     * and the build pipeline to sync definitions to the Vard API.
-     */
-    getDefinitions(): VardVariableDefinition[];
-    /**
-     * Access to the underlying store.
-     */
-    readonly store: VardStore;
-}
-interface VardGlobalClient {
-    string(key: string, fallback: string, options?: Omit<VardVariableOptions, "group">): string;
-    richtext(key: string, fallback: string, options?: Omit<VardVariableOptions, "group">): string;
-    color(key: string, fallback: string, options?: Omit<VardVariableOptions, "group">): string;
-    image(key: string, fallback: string, options?: Omit<VardVariableOptions, "group">): string;
-    boolean(key: string, fallback: boolean, options?: Omit<VardVariableOptions, "type" | "group">): boolean;
-    list<S extends VardListItemSchema>(key: string, schema: S, fallback: InferListItem<S>[], options?: Omit<VardVariableOptions, "type" | "group">): InferListItem<S>[];
-}
-interface VardVariableOptions {
-    label?: string;
-    description?: string;
-    editableBy?: VardRole;
-    group?: string;
-}
-
-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/dist/types-Dd-I7jwP.d.ts

@@ -1,199 +0,0 @@
-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> = {
-    [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;
-};
-type VardRole = "owner" | "developer" | "member" | "viewer";
-interface VardVariableDefinition<T = unknown> {
-    /** Dot-notation key, e.g. "hero.title" */
-    key: string;
-    /** Human-readable label shown in the client portal */
-    label: string;
-    type: VardVariableType;
-    /** The default value baked into the codebase */
-    defaultValue: T;
-    /** Minimum role required to edit this variable. Defaults to "member". */
-    editableBy: VardRole;
-    /** Optional description shown as a hint in the client portal */
-    description?: string;
-    /** For list variables — the schema of each item */
-    listItemSchema?: VardListItemSchema;
-    /** Optional grouping for the dashboard UI */
-    group?: string;
-    /** Indicates this is a reusable content pool/collection */
-    isCollection?: boolean;
-}
-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<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;
-    /**
-     * Optional content schema for type-safe data access and auto-syncing.
-     */
-    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_API_KEY is unset (local dev without Vard).
-     */
-    store?: VardStore;
-}
-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", "...")
-     */
-    global: VardGlobalClient;
-    /**
-     * Define a reusable content pool/collection.
-     */
-    collection<S extends VardListItemSchema>(key: string, schema: S, fallback: InferListItem<S>[], options?: Omit<VardVariableOptions, "type">): InferListItem<S>[];
-    /**
-     * A plain string variable. e.g. a hero headline, a CTA label.
-     *
-     * @param key       Dot-notation identifier, unique within the workspace
-     * @param fallback  Default value when no client value is stored
-     * @param options   Optional label, description, permission
-     */
-    string(key: string, fallback: string, options?: VardVariableOptions): string;
-    /**
-     * A rich text (markdown) variable. Rendered as HTML at build time.
-     */
-    richtext(key: string, fallback: string, options?: VardVariableOptions): string;
-    /**
-     * A CSS color string (hex, hsl, rgb).
-     */
-    color(key: string, fallback: string, options?: VardVariableOptions): string;
-    /**
-     * A URL pointing to an uploaded asset (image, video).
-     */
-    image(key: string, fallback: string, options?: VardVariableOptions): string;
-    /**
-     * A boolean feature flag. e.g. show/hide a section.
-     */
-    boolean(key: string, fallback: boolean, options?: Omit<VardVariableOptions, "type">): boolean;
-    /**
-     * An ordered list of typed objects. e.g. team members, testimonials.
-     *
-     * @param schema  Defines the shape of each list item
-     */
-    list<S extends VardListItemSchema>(key: string, schema: S, fallback: InferListItem<S>[], options?: Omit<VardVariableOptions, "type">): InferListItem<S>[];
-    /**
-     * Returns all registered variable definitions. Used by the CLI scanner
-     * and the build pipeline to sync definitions to the Vard API.
-     */
-    getDefinitions(): VardVariableDefinition[];
-    /**
-     * Access to the underlying store.
-     */
-    readonly store: VardStore;
-}
-interface VardGlobalClient {
-    string(key: string, fallback: string, options?: Omit<VardVariableOptions, "group">): string;
-    richtext(key: string, fallback: string, options?: Omit<VardVariableOptions, "group">): string;
-    color(key: string, fallback: string, options?: Omit<VardVariableOptions, "group">): string;
-    image(key: string, fallback: string, options?: Omit<VardVariableOptions, "group">): string;
-    boolean(key: string, fallback: boolean, options?: Omit<VardVariableOptions, "type" | "group">): boolean;
-    list<S extends VardListItemSchema>(key: string, schema: S, fallback: InferListItem<S>[], options?: Omit<VardVariableOptions, "type" | "group">): InferListItem<S>[];
-}
-interface VardVariableOptions {
-    label?: string;
-    description?: string;
-    editableBy?: VardRole;
-    group?: string;
-}
-
-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 };