@withpotter/lib 0.13.0-next.101

package/dist/template-context.d.ts

@@ -0,0 +1,111 @@
+import React from 'react';
+import { type TemplateConfigAPI, type TemplateConfig, type ContentTypeConfig, type TemplateCategory } from './template-types';
+export interface RegistryCategory {
+    id: string;
+    name: string;
+    icon: string;
+    count: number;
+}
+export interface RegistryTemplate {
+    id: string;
+    name: string;
+    description: string;
+    category: string;
+    icon: string;
+    thumbnail: string | null;
+    tags: string[];
+    relevantCategories?: string[];
+    sortOrder: number;
+    behaviors?: string[];
+    /**
+     * The pages this template ships, as surfaces — its own vocabulary stripped
+     * off. `/stay`, `/halls` and `/venues` are all `stayable-list`.
+     */
+    surfaces?: string[];
+    /**
+     * Which archetypes it can actually present, derived from `surfaces` by the
+     * registry. Prefer this over `behaviors` for matching: lagoon-house-01 and
+     * listening-room-01 declare identical behaviors and are nothing alike.
+     */
+    archetypes?: string[];
+    /** Who built the template (from the manifest); null when unspecified. */
+    author?: string | null;
+    /** Price in NGN for premium templates; null/0 = free. */
+    price?: number | null;
+}
+interface TemplateRegistry {
+    version: string;
+    generatedAt: string;
+    categories: RegistryCategory[];
+    templates: RegistryTemplate[];
+}
+export declare function fetchRegistry(): Promise<TemplateRegistry>;
+/** Warm the memo without caring about the answer. Safe to call anywhere. */
+export declare function prefetchRegistry(): void;
+/**
+ * The ids provisioning will actually accept.
+ *
+ * THE REGISTRY IS NOT THIS LIST. The renderer's registry is what a template
+ * looks like; the API's `templates` table is what a tenant can be created with,
+ * and provisioning validates against the table and nothing else:
+ *
+ *     Unknown template "standard-store-01".
+ *     Available: bella-cucina-01, ebe-events-01, glow-beauty-01, …
+ *
+ * The two have drifted — `provision-tenant.usecase.ts` says so in its own
+ * comment — and the gallery reads the registry, so it was cheerfully offering
+ * seven storefronts that could not be used. Choosing one lost the whole form at
+ * the last step, after every question had been answered.
+ *
+ * So the shelf is the INTERSECTION: the registry's presentation, filtered to
+ * what the API can vouch for. Returns null when the table cannot be read, which
+ * means "do not filter" rather than "filter everything away" — a failed lookup
+ * must not empty the shelf.
+ */
+export declare function fetchProvisionableTemplateIds(): Promise<Set<string> | null>;
+export type DashboardState = 'healthy' | 'loading' | 'degraded' | 'template-missing' | 'offline';
+export interface SchemaValidationResult {
+    valid: boolean;
+    warnings: string[];
+}
+/**
+ * Validate a template schema structure on load.
+ * Uses Zod-based validation for structural integrity checks.
+ * Returns warnings for non-blocking issues and errors for blocking ones.
+ */
+export declare function validateTemplateSchema(schema: TemplateConfigAPI): SchemaValidationResult;
+interface TemplateContextValue {
+    registry: TemplateRegistry | null;
+    categories: RegistryCategory[];
+    templateList: RegistryTemplate[];
+    loadedSchemas: Map<string, TemplateConfig>;
+    currentTemplate: TemplateConfig | null;
+    dashboardState: DashboardState;
+    schemaWarnings: string[];
+    registryLoading: boolean;
+    schemaLoading: boolean;
+    error: Error | null;
+    loadTemplateSchema: (templateId: string) => Promise<TemplateConfig | null>;
+    getTemplate: (id: string) => TemplateConfig | null;
+    getTemplatesByCategory: (category: TemplateCategory) => RegistryTemplate[];
+    getContentType: (templateId: string, contentTypeKey: string) => ContentTypeConfig | null;
+    setCurrentTemplate: (templateId: string) => Promise<void>;
+    refetchRegistry: () => Promise<void>;
+    retryCurrentTemplate: () => Promise<void>;
+}
+export declare function TemplateProvider({ children }: {
+    children: React.ReactNode;
+}): React.JSX.Element;
+export declare function useTemplates(): TemplateContextValue;
+/**
+ * Hook for components that need the current tenant's template
+ * Automatically loads schema if not already loaded
+ */
+export declare function useCurrentTemplate(templateId?: string): {
+    template: TemplateConfig | null;
+    loading: boolean;
+    dashboardState: DashboardState;
+    schemaWarnings: string[];
+    retryCurrentTemplate: () => Promise<void>;
+};
+export type { TemplateConfig, TemplateConfigAPI, ContentTypeConfig, ContentFieldConfig, DashboardModule, FieldGroup, FieldType, SelectOption, ValidationRule, ContentBehavior, CoreEndpoint, TemplateCategory, } from './template-types';