@digiform/builder 0.1.7 → 0.2.4

package/config/types.d.ts

@@ -0,0 +1,94 @@
+/**
+ * Unified configuration types for the form builder system
+ * Single source of truth for all form configuration needs
+ */
+/**
+ * Database configuration for database storage strategy
+ * Simplified configuration - always uses PgLite with local-first approach and mandatory sync
+ */
+export interface DatabaseConfig {
+    /** Database connection string (required for database strategy) */
+    connectionString: string;
+    /** Optional service role key for authentication (only needed for some providers like Supabase) */
+    serviceRoleKey?: string;
+}
+/**
+ * Unified form storage configuration
+ * Supports filesystem and database (PgLite-based) storage strategies
+ */
+export interface FormStorageConfig {
+    /** Storage strategy to use. Use "none" when the app handles persistence externally. */
+    strategy: "filesystem" | "database" | "none";
+    /** Path configuration for filesystem storage */
+    paths?: {
+        /** Primary storage directory for forms */
+        primaryStorage: string;
+        /** Template directories */
+        templates?: {
+            /** Team templates directory */
+            team?: string;
+            /** Generic templates directory */
+            generic?: string;
+        };
+        /** Fallback paths for form loading */
+        fallbackPaths?: string[];
+        /** Static assets directory */
+        staticAssets?: string;
+    };
+    /** Database configuration (required when strategy is "database") */
+    databaseConfig?: DatabaseConfig;
+    /** File extension for form files (filesystem strategy) */
+    fileExtension?: string;
+    /** Whether to automatically create directories (filesystem strategy) */
+    createDirectories?: boolean;
+}
+/**
+ * Route configuration for form builder navigation
+ * Supports URL patterns with parameters like :project and :wizardId
+ */
+export interface RouteConfig {
+    /** Projects page route (e.g., "/forms", "/projects") */
+    projects?: string;
+    /** Forms list page route (e.g., "/forms/:project", "/projects/:project/forms") */
+    forms?: string;
+    /** Form builder page route (e.g., "/forms/:project/:wizardId", "/builder/:project/:wizardId") */
+    builder?: string;
+    /** Form preview page route (e.g., "/forms/:project/:wizardId/preview") */
+    preview?: string;
+}
+/**
+ * Complete form configuration with storage, URLs, metadata, and theme support
+ */
+export interface FormConfig {
+    /** Storage configuration */
+    storage: FormStorageConfig;
+    /** URL configuration for previews and navigation */
+    urls?: {
+        /** Base URL for form previews */
+        previewBase?: string;
+        /** Preview path template */
+        previewPath?: string;
+    };
+    /** Route configuration for navigation */
+    routes?: RouteConfig;
+    /** Configuration metadata */
+    metadata?: {
+        /** Configuration version */
+        version?: string;
+        /** Last update timestamp */
+        lastUpdated?: string;
+    };
+    /** Theme configuration */
+    theme?: {
+        /** Theme name */
+        name?: string;
+    };
+}
+/**
+ * Default configuration values
+ */
+export declare const DEFAULT_FORM_CONFIG: FormConfig;
+/**
+ * Creates configuration from environment variables
+ */
+export declare const createConfigFromEnvironment: () => FormConfig;