pocketbase-zod-schema 0.2.0 → 0.2.2

package/dist/migration/analyzer.d.cts

@@ -85,13 +85,36 @@ declare function getCollectionNameFromFile(filePath: string): string;
  * @returns The collection name if found in metadata, null otherwise
  */
 declare function extractCollectionNameFromSchema(zodSchema: z.ZodTypeAny): string | null;
+/**
+ * Extracts the collection type from a Zod schema's metadata
+ * Checks if the schema was created with defineCollection() which stores
+ * the collection type in the schema description
+ *
+ * @param zodSchema - The Zod schema to extract collection type from
+ * @returns The collection type ("base" | "auth") if found in metadata, null otherwise
+ */
+declare function extractCollectionTypeFromSchema(zodSchema: z.ZodTypeAny): "base" | "auth" | null;
 /**
  * Extracts Zod schema definitions from a module
- * Looks for schemas ending with configured patterns (default: "Schema" or "InputSchema")
+ *
+ * Detection priority (highest to lowest):
+ * 1. Default export - recommended pattern for clarity and explicitness
+ * 2. Named exports ending with "Collection" - contains metadata (indexes, permissions)
+ * 3. Named exports ending with "Schema" - basic schema definitions
+ * 4. Named exports ending with "InputSchema" - form input schemas
  *
  * @param module - The imported schema module
- * @param patterns - Schema name patterns to look for (default: ['Schema', 'InputSchema'])
+ * @param patterns - Schema name patterns to look for (default: ['Schema', 'InputSchema', 'Collection'])
  * @returns Object containing found schemas
+ *
+ * @example
+ * // Recommended: Use default export
+ * const UserCollection = defineCollection({ ... });
+ * export default UserCollection;
+ *
+ * @example
+ * // Also supported: Named export with pattern
+ * export const UserCollection = defineCollection({ ... });
  */
 declare function extractSchemaDefinitions(module: any, patterns?: string[]): {
     inputSchema?: z.ZodObject<any>;
@@ -193,4 +216,4 @@ declare class SchemaAnalyzer {
     convertZodSchemaToCollectionSchema(name: string, schema: z.ZodObject<any>): CollectionSchema;
 }
 
-export { SchemaAnalyzer, type SchemaAnalyzerConfig, buildFieldDefinition, buildSchemaDefinition, convertZodSchemaToCollectionSchema, discoverSchemaFiles, extractCollectionNameFromSchema, extractFieldDefinitions, extractIndexes, extractSchemaDefinitions, getCollectionNameFromFile, importSchemaModule, isAuthCollection, parseSchemaFiles, selectSchemaForCollection };
+export { SchemaAnalyzer, type SchemaAnalyzerConfig, buildFieldDefinition, buildSchemaDefinition, convertZodSchemaToCollectionSchema, discoverSchemaFiles, extractCollectionNameFromSchema, extractCollectionTypeFromSchema, extractFieldDefinitions, extractIndexes, extractSchemaDefinitions, getCollectionNameFromFile, importSchemaModule, isAuthCollection, parseSchemaFiles, selectSchemaForCollection };

package/dist/migration/analyzer.d.ts

@@ -85,13 +85,36 @@ declare function getCollectionNameFromFile(filePath: string): string;
  * @returns The collection name if found in metadata, null otherwise
  */
 declare function extractCollectionNameFromSchema(zodSchema: z.ZodTypeAny): string | null;
+/**
+ * Extracts the collection type from a Zod schema's metadata
+ * Checks if the schema was created with defineCollection() which stores
+ * the collection type in the schema description
+ *
+ * @param zodSchema - The Zod schema to extract collection type from
+ * @returns The collection type ("base" | "auth") if found in metadata, null otherwise
+ */
+declare function extractCollectionTypeFromSchema(zodSchema: z.ZodTypeAny): "base" | "auth" | null;
 /**
  * Extracts Zod schema definitions from a module
- * Looks for schemas ending with configured patterns (default: "Schema" or "InputSchema")
+ *
+ * Detection priority (highest to lowest):
+ * 1. Default export - recommended pattern for clarity and explicitness
+ * 2. Named exports ending with "Collection" - contains metadata (indexes, permissions)
+ * 3. Named exports ending with "Schema" - basic schema definitions
+ * 4. Named exports ending with "InputSchema" - form input schemas
  *
  * @param module - The imported schema module
- * @param patterns - Schema name patterns to look for (default: ['Schema', 'InputSchema'])
+ * @param patterns - Schema name patterns to look for (default: ['Schema', 'InputSchema', 'Collection'])
  * @returns Object containing found schemas
+ *
+ * @example
+ * // Recommended: Use default export
+ * const UserCollection = defineCollection({ ... });
+ * export default UserCollection;
+ *
+ * @example
+ * // Also supported: Named export with pattern
+ * export const UserCollection = defineCollection({ ... });
  */
 declare function extractSchemaDefinitions(module: any, patterns?: string[]): {
     inputSchema?: z.ZodObject<any>;
@@ -193,4 +216,4 @@ declare class SchemaAnalyzer {
     convertZodSchemaToCollectionSchema(name: string, schema: z.ZodObject<any>): CollectionSchema;
 }
 
-export { SchemaAnalyzer, type SchemaAnalyzerConfig, buildFieldDefinition, buildSchemaDefinition, convertZodSchemaToCollectionSchema, discoverSchemaFiles, extractCollectionNameFromSchema, extractFieldDefinitions, extractIndexes, extractSchemaDefinitions, getCollectionNameFromFile, importSchemaModule, isAuthCollection, parseSchemaFiles, selectSchemaForCollection };
+export { SchemaAnalyzer, type SchemaAnalyzerConfig, buildFieldDefinition, buildSchemaDefinition, convertZodSchemaToCollectionSchema, discoverSchemaFiles, extractCollectionNameFromSchema, extractCollectionTypeFromSchema, extractFieldDefinitions, extractIndexes, extractSchemaDefinitions, getCollectionNameFromFile, importSchemaModule, isAuthCollection, parseSchemaFiles, selectSchemaForCollection };

package/dist/migration/analyzer.js

@@ -7,7 +7,9 @@ import { z } from 'zod';
   id: z.string().describe("unique id"),
   collectionId: z.string().describe("collection id"),
   collectionName: z.string().describe("collection name"),
-  expand: z.record(z.any()).describe("expandable fields")
+  expand: z.record(z.any()).describe("expandable fields"),
+  created: z.string().describe("creation timestamp"),
+  updated: z.string().describe("last update timestamp")
 });
 ({
   created: z.string().describe("creation timestamp"),
@@ -980,7 +982,7 @@ var DEFAULT_CONFIG = {
     "permission-templates.js"
   ],
   includeExtensions: [".ts", ".js"],
-  schemaPatterns: ["Schema", "InputSchema"],
+  schemaPatterns: ["Schema", "InputSchema", "Collection"],
   useCompiledFiles: true
 };
 function mergeConfig(config) {
@@ -1117,14 +1119,35 @@ function extractCollectionNameFromSchema(zodSchema) {
   }
   return null;
 }
-function extractSchemaDefinitions(module, patterns = ["Schema", "InputSchema"]) {
+function extractCollectionTypeFromSchema(zodSchema) {
+  if (!zodSchema.description) {
+    return null;
+  }
+  try {
+    const metadata = JSON.parse(zodSchema.description);
+    if (metadata.type === "base" || metadata.type === "auth") {
+      return metadata.type;
+    }
+  } catch {
+  }
+  return null;
+}
+function extractSchemaDefinitions(module, patterns = ["Schema", "InputSchema", "Collection"]) {
   const result = {};
+  if (module.default instanceof z.ZodObject) {
+    result.schema = module.default;
+  }
   for (const [key, value] of Object.entries(module)) {
+    if (key === "default") continue;
     if (value instanceof z.ZodObject) {
       if (patterns.includes("InputSchema") && key.endsWith("InputSchema")) {
         result.inputSchema = value;
-      } else if (patterns.includes("Schema") && key.endsWith("Schema") && !key.endsWith("InputSchema")) {
-        result.schema = value;
+      } else if (!result.schema) {
+        if (patterns.includes("Collection") && key.endsWith("Collection")) {
+          result.schema = value;
+        } else if (patterns.includes("Schema") && key.endsWith("Schema") && !key.endsWith("InputSchema")) {
+          result.schema = value;
+        }
       }
     }
   }
@@ -1191,11 +1214,8 @@ function buildFieldDefinition(fieldName, zodType) {
       // Default to false, can be configured later
     };
     if (fieldDef.options) {
-      const { min, max, pattern, ...relationSafeOptions } = fieldDef.options;
-      console.log("min", min);
-      console.log("max", max);
-      console.log("pattern", pattern);
-      fieldDef.options = Object.keys(relationSafeOptions).length > 0 ? relationSafeOptions : void 0;
+      const { min: _min, max: _max, pattern: _pattern, ...relationSafeOptions } = fieldDef.options;
+      fieldDef.options = Object.keys(relationSafeOptions).length ? relationSafeOptions : void 0;
     }
   }
   return fieldDef;
@@ -1216,8 +1236,13 @@ function extractIndexes(schema) {
 }
 function convertZodSchemaToCollectionSchema(collectionName, zodSchema) {
   const rawFields = extractFieldDefinitions(zodSchema);
-  const collectionType = isAuthCollection(rawFields) ? "auth" : "base";
-  const fields = rawFields.map(({ name, zodType }) => buildFieldDefinition(name, zodType));
+  const explicitType = extractCollectionTypeFromSchema(zodSchema);
+  const collectionType = explicitType ?? (isAuthCollection(rawFields) ? "auth" : "base");
+  let fields = rawFields.map(({ name, zodType }) => buildFieldDefinition(name, zodType));
+  if (collectionType === "auth") {
+    const authSystemFieldNames = ["email", "emailVisibility", "verified", "password", "tokenKey"];
+    fields = fields.filter((field) => !authSystemFieldNames.includes(field.name));
+  }
   const indexes = extractIndexes(zodSchema) || [];
   const permissionAnalyzer = new PermissionAnalyzer();
   let permissions = void 0;
@@ -1337,6 +1362,6 @@ var SchemaAnalyzer = class {
   }
 };
 
-export { SchemaAnalyzer, buildFieldDefinition, buildSchemaDefinition, convertZodSchemaToCollectionSchema, discoverSchemaFiles, extractCollectionNameFromSchema, extractFieldDefinitions, extractIndexes, extractSchemaDefinitions, getCollectionNameFromFile, importSchemaModule, isAuthCollection, parseSchemaFiles, selectSchemaForCollection };
+export { SchemaAnalyzer, buildFieldDefinition, buildSchemaDefinition, convertZodSchemaToCollectionSchema, discoverSchemaFiles, extractCollectionNameFromSchema, extractCollectionTypeFromSchema, extractFieldDefinitions, extractIndexes, extractSchemaDefinitions, getCollectionNameFromFile, importSchemaModule, isAuthCollection, parseSchemaFiles, selectSchemaForCollection };
 //# sourceMappingURL=analyzer.js.map
 //# sourceMappingURL=analyzer.js.map