pocketbase-zod-schema 0.1.2

package/dist/migration/analyzer.d.ts

@@ -0,0 +1,186 @@
+import { z } from 'zod';
+import { S as SchemaDefinition, C as CollectionSchema, F as FieldDefinition } from '../types-z1Dkjg8m.js';
+import '../permissions-ZHafVSIx.js';
+
+/**
+ * Schema Analyzer - Parses Zod schemas and extracts field definitions
+ *
+ * This module provides a standalone, configurable schema analyzer that can be used
+ * by consumer projects to parse Zod schemas and convert them to PocketBase collection schemas.
+ */
+
+/**
+ * Configuration options for schema discovery and parsing
+ */
+interface SchemaAnalyzerConfig {
+    /**
+     * Directory containing schema files (source or compiled)
+     * Can be absolute or relative to workspaceRoot
+     */
+    schemaDir: string;
+    /**
+     * Workspace root directory for resolving relative paths
+     * Defaults to process.cwd()
+     */
+    workspaceRoot?: string;
+    /**
+     * File patterns to exclude from schema discovery
+     * Defaults to ['base.ts', 'index.ts', 'permissions.ts', 'permission-templates.ts']
+     */
+    excludePatterns?: string[];
+    /**
+     * File extensions to include in schema discovery
+     * Defaults to ['.ts', '.js']
+     */
+    includeExtensions?: string[];
+    /**
+     * Schema export name patterns to look for
+     * Defaults to ['Schema', 'InputSchema']
+     */
+    schemaPatterns?: string[];
+    /**
+     * Whether to use compiled JavaScript files instead of TypeScript source
+     * When true, looks for .js files; when false, looks for .ts files
+     * Defaults to true (use compiled files for dynamic import)
+     */
+    useCompiledFiles?: boolean;
+    /**
+     * Custom path transformation function for converting source paths to import paths
+     * Useful for monorepo setups where source and dist directories differ
+     * If not provided, uses the schemaDir directly
+     */
+    pathTransformer?: (sourcePath: string) => string;
+}
+/**
+ * Discovers schema files in the specified directory
+ * Filters based on configuration patterns
+ *
+ * @param config - Schema analyzer configuration
+ * @returns Array of schema file paths (without extension)
+ */
+declare function discoverSchemaFiles(config: SchemaAnalyzerConfig | string): string[];
+/**
+ * Dynamically imports a schema module
+ *
+ * @param filePath - Path to the schema file (without extension)
+ * @param config - Optional configuration for path transformation
+ * @returns The imported module
+ */
+declare function importSchemaModule(filePath: string, config?: SchemaAnalyzerConfig): Promise<any>;
+/**
+ * Gets the collection name from a schema file path
+ * Converts the filename (without extension) to a pluralized collection name
+ *
+ * @param filePath - Path to the schema file (with or without extension)
+ * @returns The collection name
+ */
+declare function getCollectionNameFromFile(filePath: string): string;
+/**
+ * Extracts Zod schema definitions from a module
+ * Looks for schemas ending with configured patterns (default: "Schema" or "InputSchema")
+ *
+ * @param module - The imported schema module
+ * @param patterns - Schema name patterns to look for (default: ['Schema', 'InputSchema'])
+ * @returns Object containing found schemas
+ */
+declare function extractSchemaDefinitions(module: any, patterns?: string[]): {
+    inputSchema?: z.ZodObject<any>;
+    schema?: z.ZodObject<any>;
+};
+/**
+ * Identifies whether to use InputSchema or Schema pattern
+ * Prefers Schema over InputSchema as it includes base fields
+ *
+ * @param schemas - Object containing inputSchema and/or schema
+ * @returns The schema to use for collection definition
+ */
+declare function selectSchemaForCollection(schemas: {
+    inputSchema?: z.ZodObject<any>;
+    schema?: z.ZodObject<any>;
+}): z.ZodObject<any> | null;
+/**
+ * Extracts field definitions from a Zod object schema
+ * Filters out base schema fields (id, collectionId, created, updated, expand)
+ *
+ * @param zodSchema - The Zod object schema
+ * @param excludeFields - Additional fields to exclude (default: base schema fields)
+ * @returns Array of field names and their Zod types
+ */
+declare function extractFieldDefinitions(zodSchema: z.ZodObject<any>, excludeFields?: string[]): Array<{
+    name: string;
+    zodType: z.ZodTypeAny;
+}>;
+/**
+ * Detects if a collection is an auth collection
+ * Auth collections have email and password fields
+ *
+ * @param fields - Array of field definitions
+ * @returns True if the collection is an auth collection
+ */
+declare function isAuthCollection(fields: Array<{
+    name: string;
+    zodType: z.ZodTypeAny;
+}>): boolean;
+/**
+ * Extracts validation constraints from Zod type
+ * Includes min, max, required, unique, and other options
+ *
+ * @param fieldName - The field name
+ * @param zodType - The Zod type
+ * @returns Field definition with constraints
+ */
+declare function buildFieldDefinition(fieldName: string, zodType: z.ZodTypeAny): FieldDefinition;
+/**
+ * Extracts index definitions from a Zod schema
+ * Parses the schema description metadata to find index definitions
+ *
+ * @param schema - Zod schema with index metadata
+ * @returns Array of index SQL statements or undefined
+ */
+declare function extractIndexes(schema: z.ZodTypeAny): string[] | undefined;
+/**
+ * Converts a Zod schema to a CollectionSchema interface
+ *
+ * @param collectionName - The name of the collection
+ * @param zodSchema - The Zod object schema
+ * @returns CollectionSchema definition
+ */
+declare function convertZodSchemaToCollectionSchema(collectionName: string, zodSchema: z.ZodObject<any>): CollectionSchema;
+/**
+ * Builds a complete SchemaDefinition from schema files
+ * Main entry point for the Schema Analyzer
+ *
+ * @param config - Schema analyzer configuration or path to schema directory
+ * @returns Complete SchemaDefinition with all collections
+ */
+declare function buildSchemaDefinition(config: SchemaAnalyzerConfig | string): Promise<SchemaDefinition>;
+/**
+ * Parses schema files and returns SchemaDefinition
+ * Alias for buildSchemaDefinition for better semantic clarity
+ *
+ * @param config - Schema analyzer configuration or path to schema directory
+ * @returns Complete SchemaDefinition with all collections
+ */
+declare function parseSchemaFiles(config: SchemaAnalyzerConfig | string): Promise<SchemaDefinition>;
+/**
+ * Creates a SchemaAnalyzer instance with the given configuration
+ * Provides an object-oriented interface for schema analysis
+ */
+declare class SchemaAnalyzer {
+    private config;
+    constructor(config: SchemaAnalyzerConfig);
+    /**
+     * Discovers schema files in the configured directory
+     */
+    discoverSchemaFiles(): string[];
+    /**
+     * Parses all schema files and returns a SchemaDefinition
+     */
+    parseSchemaFiles(): Promise<SchemaDefinition>;
+    /**
+     * Converts a single Zod schema to a CollectionSchema
+     */
+    convertZodSchemaToCollectionSchema(name: string, schema: z.ZodObject<any>): CollectionSchema;
+}
+
+export { SchemaAnalyzer, type SchemaAnalyzerConfig, buildFieldDefinition, buildSchemaDefinition, convertZodSchemaToCollectionSchema, discoverSchemaFiles, extractFieldDefinitions, extractIndexes, extractSchemaDefinitions, getCollectionNameFromFile, importSchemaModule, isAuthCollection, parseSchemaFiles, selectSchemaForCollection };