pocketbase-zod-schema 0.7.0 → 0.7.2

package/dist/migration/analyzer.d.cts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { F as FieldDefinition, C as CollectionSchema, S as SchemaDefinition } from '../types-CWHV6ATd.cjs';
+import { F as FieldDefinition, C as CollectionSchema, S as SchemaDefinition } from '../types-CnzfX6JH.cjs';
 import '../fields-B96iGprI.cjs';
 
 /**
@@ -111,9 +111,17 @@ declare function extractCollectionNameFromSchema(zodSchema: z.ZodTypeAny): strin
  * 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
+ * @returns The collection type ("base" | "auth" | "view") if found in metadata, null otherwise
  */
-declare function extractCollectionTypeFromSchema(zodSchema: z.ZodTypeAny): "base" | "auth" | null;
+declare function extractCollectionTypeFromSchema(zodSchema: z.ZodTypeAny): "base" | "auth" | "view" | null;
+/**
+ * Extracts the SQL query backing a view collection from a Zod schema's metadata
+ * Set by defineView() (or defineCollection with type: "view")
+ *
+ * @param zodSchema - The Zod schema to extract the view query from
+ * @returns The SQL query if found in metadata, null otherwise
+ */
+declare function extractViewQueryFromSchema(zodSchema: z.ZodTypeAny): string | null;
 /**
  * Extracts Zod schema definitions from a module
  *
@@ -234,4 +242,4 @@ declare class SchemaAnalyzer {
     convertZodSchemaToCollectionSchema(name: string, schema: z.ZodObject<any>): CollectionSchema;
 }
 
-export { DEFAULT_CONFIG, SchemaAnalyzer, type SchemaAnalyzerConfig, buildFieldDefinition, buildSchemaDefinition, convertZodSchemaToCollectionSchema, discoverSchemaFiles, extractCollectionNameFromSchema, extractCollectionTypeFromSchema, extractFieldDefinitions, extractIndexes, extractSchemaDefinitions, getCollectionNameFromFile, importSchemaModule, isAuthCollection, mergeConfig, parseSchemaFiles, resolveSchemaDir, selectSchemaForCollection };
+export { DEFAULT_CONFIG, SchemaAnalyzer, type SchemaAnalyzerConfig, buildFieldDefinition, buildSchemaDefinition, convertZodSchemaToCollectionSchema, discoverSchemaFiles, extractCollectionNameFromSchema, extractCollectionTypeFromSchema, extractFieldDefinitions, extractIndexes, extractSchemaDefinitions, extractViewQueryFromSchema, getCollectionNameFromFile, importSchemaModule, isAuthCollection, mergeConfig, parseSchemaFiles, resolveSchemaDir, selectSchemaForCollection };

package/dist/migration/analyzer.d.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { F as FieldDefinition, C as CollectionSchema, S as SchemaDefinition } from '../types-C2nGWHLV.js';
+import { F as FieldDefinition, C as CollectionSchema, S as SchemaDefinition } from '../types-Do3jyFBm.js';
 import '../fields-B96iGprI.js';
 
 /**
@@ -111,9 +111,17 @@ declare function extractCollectionNameFromSchema(zodSchema: z.ZodTypeAny): strin
  * 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
+ * @returns The collection type ("base" | "auth" | "view") if found in metadata, null otherwise
  */
-declare function extractCollectionTypeFromSchema(zodSchema: z.ZodTypeAny): "base" | "auth" | null;
+declare function extractCollectionTypeFromSchema(zodSchema: z.ZodTypeAny): "base" | "auth" | "view" | null;
+/**
+ * Extracts the SQL query backing a view collection from a Zod schema's metadata
+ * Set by defineView() (or defineCollection with type: "view")
+ *
+ * @param zodSchema - The Zod schema to extract the view query from
+ * @returns The SQL query if found in metadata, null otherwise
+ */
+declare function extractViewQueryFromSchema(zodSchema: z.ZodTypeAny): string | null;
 /**
  * Extracts Zod schema definitions from a module
  *
@@ -234,4 +242,4 @@ declare class SchemaAnalyzer {
     convertZodSchemaToCollectionSchema(name: string, schema: z.ZodObject<any>): CollectionSchema;
 }
 
-export { DEFAULT_CONFIG, SchemaAnalyzer, type SchemaAnalyzerConfig, buildFieldDefinition, buildSchemaDefinition, convertZodSchemaToCollectionSchema, discoverSchemaFiles, extractCollectionNameFromSchema, extractCollectionTypeFromSchema, extractFieldDefinitions, extractIndexes, extractSchemaDefinitions, getCollectionNameFromFile, importSchemaModule, isAuthCollection, mergeConfig, parseSchemaFiles, resolveSchemaDir, selectSchemaForCollection };
+export { DEFAULT_CONFIG, SchemaAnalyzer, type SchemaAnalyzerConfig, buildFieldDefinition, buildSchemaDefinition, convertZodSchemaToCollectionSchema, discoverSchemaFiles, extractCollectionNameFromSchema, extractCollectionTypeFromSchema, extractFieldDefinitions, extractIndexes, extractSchemaDefinitions, extractViewQueryFromSchema, getCollectionNameFromFile, importSchemaModule, isAuthCollection, mergeConfig, parseSchemaFiles, resolveSchemaDir, selectSchemaForCollection };

package/dist/migration/analyzer.js

@@ -1040,6 +1040,36 @@ function unwrapZodType(zodType) {
   }
   return unwrapped;
 }
+function stripLeadingComments(query) {
+  let remaining = query.trim();
+  while (remaining.length > 0) {
+    if (remaining.startsWith("--")) {
+      const newline = remaining.indexOf("\n");
+      remaining = newline === -1 ? "" : remaining.slice(newline + 1).trim();
+      continue;
+    }
+    if (remaining.startsWith("/*")) {
+      const end = remaining.indexOf("*/");
+      remaining = end === -1 ? "" : remaining.slice(end + 2).trim();
+      continue;
+    }
+    break;
+  }
+  return remaining;
+}
+function validateViewQuery(collectionName, viewQuery) {
+  if (typeof viewQuery !== "string" || viewQuery.trim() === "") {
+    throw new Error(
+      `View collection "${collectionName}" requires a non-empty viewQuery. Provide the SQL SELECT statement backing the view.`
+    );
+  }
+  const body = stripLeadingComments(viewQuery);
+  if (!/^(select|with)\b/i.test(body)) {
+    throw new Error(
+      `View collection "${collectionName}" has an invalid viewQuery: it must start with SELECT or WITH. Received: ${body.slice(0, 40)}${body.length > 40 ? "..." : ""}`
+    );
+  }
+}
 function getCollectionNameFromFile(filePath) {
   const filename = path.basename(filePath).replace(/\.(ts|js)$/, "");
   return toCollectionName(filename);
@@ -1063,13 +1093,26 @@ function extractCollectionTypeFromSchema(zodSchema) {
   }
   try {
     const metadata = JSON.parse(zodSchema.description);
-    if (metadata.type === "base" || metadata.type === "auth") {
+    if (metadata.type === "base" || metadata.type === "auth" || metadata.type === "view") {
       return metadata.type;
     }
   } catch {
   }
   return null;
 }
+function extractViewQueryFromSchema(zodSchema) {
+  if (!zodSchema.description) {
+    return null;
+  }
+  try {
+    const metadata = JSON.parse(zodSchema.description);
+    if (typeof metadata.viewQuery === "string") {
+      return metadata.viewQuery;
+    }
+  } catch {
+  }
+  return null;
+}
 function extractSchemaDefinitions(module, patterns = ["Schema", "InputSchema", "Collection"]) {
   const result = {};
   if (module.default instanceof z.ZodObject) {
@@ -1228,6 +1271,15 @@ function convertZodSchemaToCollectionSchema(collectionName, zodSchema) {
   const rawFields = extractFieldDefinitions(zodSchema);
   const explicitType = extractCollectionTypeFromSchema(zodSchema);
   const collectionType = explicitType ?? (isAuthCollection(rawFields) ? "auth" : "base");
+  const isView = collectionType === "view";
+  const viewQuery = extractViewQueryFromSchema(zodSchema);
+  if (isView) {
+    validateViewQuery(collectionName, viewQuery);
+  } else if (viewQuery !== null) {
+    console.warn(
+      `[${collectionName}] viewQuery is only used by view collections and will be ignored. Use defineView() or set type: "view" to define a view collection.`
+    );
+  }
   const fields = rawFields.filter((f) => !["created", "updated"].includes(f.name)).map(({ name, zodType }) => buildFieldDefinition(name, zodType));
   if (collectionType === "auth") {
     const authSystemFields = [
@@ -1287,26 +1339,43 @@ function convertZodSchemaToCollectionSchema(collectionName, zodSchema) {
     }
   }
   const indexes = extractIndexes(zodSchema) || [];
+  if (isView && indexes.length > 0) {
+    throw new Error(
+      `View collection "${collectionName}" cannot declare indexes. PocketBase view collections are backed by a SQL query and do not support indexes.`
+    );
+  }
   const permissionAnalyzer = new PermissionAnalyzer();
   let permissions = void 0;
   const schemaDescription = zodSchema.description;
   const extractedPermissions = permissionAnalyzer.extractPermissions(schemaDescription);
   if (extractedPermissions) {
     const resolvedPermissions = permissionAnalyzer.resolvePermissions(extractedPermissions);
-    const validationResults = permissionAnalyzer.validatePermissions(
-      collectionName,
-      resolvedPermissions,
-      fields,
-      collectionType === "auth"
-    );
-    for (const [ruleType, result] of validationResults) {
-      if (!result.valid) {
-        console.error(`[${collectionName}] Permission validation failed for ${ruleType}:`);
-        result.errors.forEach((error) => console.error(`  - ${error}`));
+    if (isView) {
+      for (const ruleType of ["createRule", "updateRule", "deleteRule", "manageRule"]) {
+        if (resolvedPermissions[ruleType]) {
+          console.warn(
+            `[${collectionName}] ${ruleType} is not supported on view collections and will be set to null.`
+          );
+        }
+        resolvedPermissions[ruleType] = null;
       }
-      if (result.warnings.length > 0) {
-        console.warn(`[${collectionName}] Permission warnings for ${ruleType}:`);
-        result.warnings.forEach((warning) => console.warn(`  - ${warning}`));
+    }
+    if (!isView) {
+      const validationResults = permissionAnalyzer.validatePermissions(
+        collectionName,
+        resolvedPermissions,
+        fields,
+        collectionType === "auth"
+      );
+      for (const [ruleType, result] of validationResults) {
+        if (!result.valid) {
+          console.error(`[${collectionName}] Permission validation failed for ${ruleType}:`);
+          result.errors.forEach((error) => console.error(`  - ${error}`));
+        }
+        if (result.warnings.length > 0) {
+          console.warn(`[${collectionName}] Permission warnings for ${ruleType}:`);
+          result.warnings.forEach((warning) => console.warn(`  - ${warning}`));
+        }
       }
     }
     permissions = permissionAnalyzer.mergeWithDefaults(resolvedPermissions);
@@ -1327,6 +1396,9 @@ function convertZodSchemaToCollectionSchema(collectionName, zodSchema) {
     },
     permissions
   };
+  if (isView) {
+    collectionSchema.viewQuery = viewQuery;
+  }
   return collectionSchema;
 }
 var tsxLoaderRegistered = false;
@@ -1526,6 +1598,6 @@ var SchemaAnalyzer = class {
   }
 };
 
-export { DEFAULT_CONFIG, SchemaAnalyzer, buildFieldDefinition, buildSchemaDefinition, convertZodSchemaToCollectionSchema, discoverSchemaFiles, extractCollectionNameFromSchema, extractCollectionTypeFromSchema, extractFieldDefinitions, extractIndexes, extractSchemaDefinitions, getCollectionNameFromFile, importSchemaModule, isAuthCollection, mergeConfig, parseSchemaFiles, resolveSchemaDir, selectSchemaForCollection };
+export { DEFAULT_CONFIG, SchemaAnalyzer, buildFieldDefinition, buildSchemaDefinition, convertZodSchemaToCollectionSchema, discoverSchemaFiles, extractCollectionNameFromSchema, extractCollectionTypeFromSchema, extractFieldDefinitions, extractIndexes, extractSchemaDefinitions, extractViewQueryFromSchema, getCollectionNameFromFile, importSchemaModule, isAuthCollection, mergeConfig, parseSchemaFiles, resolveSchemaDir, selectSchemaForCollection };
 //# sourceMappingURL=analyzer.js.map
 //# sourceMappingURL=analyzer.js.map