@vard-app/sdk 0.1.3 → 0.1.5

package/dist/types-eJuYa65b.d.mts

@@ -1,113 +0,0 @@
-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;
-}
-interface VardOptions {
-    /**
-     * 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.
-     */
-    workspaceId?: string;
-    /**
-     * 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).
-     */
-    store?: VardStore;
-}
-interface VardClient {
-    /**
-     * 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, VardOptions as V, VardClient as a, VardStore as b, VardListItemSchema as c, VardRole as d, VardVariableDefinition as e, VardVariableOptions as f, VardVariableType as g };

package/dist/types-eJuYa65b.d.ts

@@ -1,113 +0,0 @@
-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;
-}
-interface VardOptions {
-    /**
-     * 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.
-     */
-    workspaceId?: string;
-    /**
-     * 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).
-     */
-    store?: VardStore;
-}
-interface VardClient {
-    /**
-     * 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, VardOptions as V, VardClient as a, VardStore as b, VardListItemSchema as c, VardRole as d, VardVariableDefinition as e, VardVariableOptions as f, VardVariableType as g };