pocketbase-zod-schema 0.1.4 → 0.2.1

package/dist/index.cjs

@@ -105,7 +105,7 @@ function filesField(options) {
   return schema;
 }
 var RELATION_METADATA_KEY = "__pocketbase_relation__";
-function relationField(config) {
+function RelationField(config) {
   const metadata = {
     [RELATION_METADATA_KEY]: {
       type: "single",
@@ -117,7 +117,7 @@ function relationField(config) {
   };
   return zod.z.string().describe(JSON.stringify(metadata));
 }
-function relationsField(config) {
+function RelationsField(config) {
   const metadata = {
     [RELATION_METADATA_KEY]: {
       type: "multiple",
@@ -176,6 +176,22 @@ function withIndexes(schema, indexes) {
   };
   return schema.describe(JSON.stringify(metadata));
 }
+function defineCollection(config) {
+  const { collectionName, schema, permissions, indexes, ...futureOptions } = config;
+  const metadata = {
+    collectionName
+  };
+  if (permissions) {
+    metadata.permissions = permissions;
+  }
+  if (indexes) {
+    metadata.indexes = indexes;
+  }
+  if (Object.keys(futureOptions).length > 0) {
+    Object.assign(metadata, futureOptions);
+  }
+  return schema.describe(JSON.stringify(metadata));
+}
 
 // src/utils/permission-templates.ts
 var PermissionTemplates = {
@@ -402,12 +418,14 @@ var ProjectInputSchema = zod.z.object({
   content: zod.z.string(),
   status: StatusEnum,
   summary: zod.z.string().optional(),
-  OwnerUser: relationField({ collection: "Users" }),
-  SubscriberUsers: relationsField({ collection: "Users" })
+  OwnerUser: RelationField({ collection: "Users" }),
+  SubscriberUsers: RelationsField({ collection: "Users" })
 }).extend(inputImageFileSchema);
-var ProjectSchema = withPermissions(
-  ProjectInputSchema.omit(omitImageFilesSchema).extend(baseImageFileSchema),
-  {
+var ProjectSchema = ProjectInputSchema.omit(omitImageFilesSchema).extend(baseImageFileSchema);
+var ProjectCollection = defineCollection({
+  collectionName: "Projects",
+  schema: ProjectSchema,
+  permissions: {
     template: "owner-only",
     ownerField: "OwnerUser",
     customRules: {
@@ -415,7 +433,7 @@ var ProjectSchema = withPermissions(
       viewRule: '@request.auth.id != "" && (OwnerUser = @request.auth.id || SubscriberUsers ?= @request.auth.id)'
     }
   }
-);
+});
 var UserInputSchema = zod.z.object({
   name: zod.z.string().optional(),
   email: zod.z.string().email(),
@@ -423,14 +441,17 @@ var UserInputSchema = zod.z.object({
   passwordConfirm: zod.z.string(),
   avatar: zod.z.instanceof(File).optional()
 });
-var UserDatabaseSchema = zod.z.object({
+var UserCollectionSchema = zod.z.object({
   name: zod.z.string().optional(),
   email: zod.z.string().email(),
   password: zod.z.string().min(8, "Password must be at least 8 characters"),
   avatar: zod.z.instanceof(File).optional()
 });
-var UserSchema = withIndexes(
-  withPermissions(UserDatabaseSchema.extend(baseSchema), {
+var UserSchema = UserCollectionSchema.extend(baseSchema);
+var UserCollection = defineCollection({
+  collectionName: "Users",
+  schema: UserSchema,
+  permissions: {
     // Users can list their own profile
     listRule: "id = @request.auth.id",
     // Users can view their own profile
@@ -442,13 +463,13 @@ var UserSchema = withIndexes(
     // Users can only delete their own account
     deleteRule: "id = @request.auth.id"
     // manageRule is null in PocketBase default (not set)
-  }),
-  [
+  },
+  indexes: [
     // PocketBase's default indexes for auth collections
     "CREATE UNIQUE INDEX `idx_tokenKey__pb_users_auth_` ON `users` (`tokenKey`)",
     "CREATE UNIQUE INDEX `idx_email__pb_users_auth_` ON `users` (`email`) WHERE `email` != ''"
   ]
-);
+});
 var BaseMutator = class {
   pb;
   // Define a default property that subclasses will override
@@ -1970,6 +1991,16 @@ function getFieldTypeInfo(zodType, fieldName) {
 }
 
 // src/migration/analyzer.ts
+var tsxLoaderRegistered = false;
+async function ensureTsxLoader() {
+  if (tsxLoaderRegistered) return;
+  try {
+    await import('tsx/esm');
+    tsxLoaderRegistered = true;
+  } catch {
+    tsxLoaderRegistered = false;
+  }
+}
 var DEFAULT_CONFIG = {
   workspaceRoot: process.cwd(),
   excludePatterns: [
@@ -2067,24 +2098,37 @@ async function importSchemaModule(filePath, config) {
     } else {
       resolvedPath = jsPath;
     }
+    if (resolvedPath.endsWith(".ts")) {
+      await ensureTsxLoader();
+      if (!tsxLoaderRegistered) {
+        throw new SchemaParsingError(
+          `Failed to import TypeScript schema file. The 'tsx' package is required to load TypeScript files.
+Please install tsx: npm install tsx (or yarn add tsx, or pnpm add tsx)
+Alternatively, compile your schema files to JavaScript first.`,
+          filePath
+        );
+      }
+    }
     const fileUrl = new URL(`file://${path5__namespace.resolve(resolvedPath)}`);
     const module = await import(fileUrl.href);
     return module;
   } catch (error) {
     const tsPath = `${filePath}.ts`;
     const isTypeScriptFile = fs3__namespace.existsSync(tsPath);
+    if (isTypeScriptFile && error instanceof SchemaParsingError) {
+      throw error;
+    }
     if (isTypeScriptFile) {
       throw new SchemaParsingError(
-        `Failed to import TypeScript schema file. Node.js cannot import TypeScript files directly.
-Please either:
-  1. Compile your schema files to JavaScript first, or
-  2. Use tsx to run the migration tool (e.g., "npx tsx package/dist/cli/migrate.js status" or "tsx package/dist/cli/migrate.js status")`,
+        `Failed to import TypeScript schema file. The 'tsx' package is required to load TypeScript files.
+Please install tsx: npm install tsx (or yarn add tsx, or pnpm add tsx)
+Alternatively, compile your schema files to JavaScript first.`,
         filePath,
         error
       );
     }
     throw new SchemaParsingError(
-      `Failed to import schema module. Make sure the schema files are compiled to JavaScript.`,
+      `Failed to import schema module. Make sure the schema files exist and are valid.`,
       filePath,
       error
     );
@@ -2094,6 +2138,19 @@ function getCollectionNameFromFile(filePath) {
   const filename = path5__namespace.basename(filePath).replace(/\.(ts|js)$/, "");
   return toCollectionName(filename);
 }
+function extractCollectionNameFromSchema(zodSchema) {
+  if (!zodSchema.description) {
+    return null;
+  }
+  try {
+    const metadata = JSON.parse(zodSchema.description);
+    if (metadata.collectionName && typeof metadata.collectionName === "string") {
+      return metadata.collectionName;
+    }
+  } catch {
+  }
+  return null;
+}
 function extractSchemaDefinitions(module, patterns = ["Schema", "InputSchema"]) {
   const result = {};
   for (const [key, value] of Object.entries(module)) {
@@ -2168,11 +2225,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;
@@ -2269,7 +2323,8 @@ async function buildSchemaDefinition(config) {
         console.warn(`No valid schema found in ${filePath}, skipping...`);
         continue;
       }
-      const collectionName = getCollectionNameFromFile(filePath);
+      const collectionNameFromSchema = extractCollectionNameFromSchema(zodSchema);
+      const collectionName = collectionNameFromSchema ?? getCollectionNameFromFile(filePath);
       const collectionSchema = convertZodSchemaToCollectionSchema(collectionName, zodSchema);
       collections.set(collectionName, collectionSchema);
     } catch (error) {
@@ -5213,13 +5268,18 @@ exports.MigrationGenerationError = MigrationGenerationError;
 exports.MigrationGenerator = MigrationGenerator;
 exports.POCKETBASE_FIELD_TYPES = POCKETBASE_FIELD_TYPES;
 exports.PermissionTemplates = PermissionTemplates;
+exports.ProjectCollection = ProjectCollection;
 exports.ProjectInputSchema = ProjectInputSchema;
 exports.ProjectSchema = ProjectSchema;
+exports.RelationField = RelationField;
+exports.RelationsField = RelationsField;
 exports.SchemaAnalyzer = SchemaAnalyzer;
 exports.SchemaParsingError = SchemaParsingError;
 exports.SnapshotError = SnapshotError;
 exports.SnapshotManager = SnapshotManager;
 exports.StatusEnum = StatusEnum;
+exports.UserCollection = UserCollection;
+exports.UserCollectionSchema = UserCollectionSchema;
 exports.UserInputSchema = UserInputSchema;
 exports.UserMutator = UserMutator;
 exports.UserSchema = UserSchema;
@@ -5242,6 +5302,7 @@ exports.convertZodSchemaToCollectionSchema = convertZodSchemaToCollectionSchema;
 exports.createMigrationFileStructure = createMigrationFileStructure;
 exports.createPermissions = createPermissions;
 exports.dateField = dateField;
+exports.defineCollection = defineCollection;
 exports.detectDestructiveChanges = detectDestructiveChanges;
 exports.detectFieldChanges = detectFieldChanges;
 exports.discoverSchemaFiles = discoverSchemaFiles;
@@ -5332,8 +5393,6 @@ exports.numberField = numberField;
 exports.omitImageFilesSchema = omitImageFilesSchema;
 exports.parseSchemaFiles = parseSchemaFiles;
 exports.pluralize = pluralize;
-exports.relationField = relationField;
-exports.relationsField = relationsField;
 exports.requiresForceFlag = requiresForceFlag;
 exports.resolveTargetCollection = resolveTargetCollection;
 exports.resolveTemplate = resolveTemplate;