pocketbase-to-zod 1.0.0

package/README.md

@@ -0,0 +1,55 @@
+# pocketbase-to-zod
+
+A lightweight CLI tool to automatically generate **Zod schemas** and **TypeScript types** directly from your **PocketBase** collections.
+
+## Features
+* ⚡ **Real-time Generation**: Connects to your PocketBase instance via URL.
+* 🛡️ **Type Safety**: Generates both Zod schemas for runtime validation and TS types for compile-time safety.
+* 🔄 **Smart Mapping**: Automatically maps PocketBase field types (Select, Relation, File, Date, etc.) to the appropriate Zod logic.
+* 📦 **Fullstack Ready**: Perfect for sharing schemas between your backend (Nitro/Node) and your frontend.
+* 🏎️ **Lightweight & Fast**: Minimal dependencies for quick setup and execution.
+
+## Installation
+
+```bash
+npm install -g pocketbase-to-zod
+# or use it via npx
+npx pocketbase-to-zod [options]
+```
+
+## Usage
+
+```bash
+pocketbase-to-zod --url http://localhost:8090 --email admin@example.com --password yourpassword --output ./schemas.ts
+```
+
+## Options
+- `--url <url>`: PocketBase instance URL (default: `http://localhost:8090`) [Required]
+- `--email <email>`: Admin email for authentication [Required]
+- `--password <password>`: Admin password for authentication [Required]
+- `--output <file>`: Output file path for generated schemas (default: `./pocketbase-schemas.ts`) [Optional]
+
+## Example Output
+
+```typescript
+import { z } from "zod";
+
+export const UserSchema = z.object({
+  id: z.string(),
+  created: z.string().refine((date) => !isNaN(Date.parse(date)), {
+    message: "Invalid date format",
+  }),
+  updated: z.string().refine((date) => !isNaN(Date.parse(date)), {
+    message: "Invalid date format",
+  }),
+  email: z.string().email(),
+  verified: z.boolean(),
+  username: z.string().min(3).max(50),
+  // ... other fields
+});
+
+export type User = z.infer<typeof UserSchema>;
+```
+
+## Contributing
+Contributions are welcome! Please open an issue or submit a pull request on GitHub.

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":""}

package/dist/index.js

@@ -0,0 +1,85 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const pocketbase_1 = __importDefault(require("pocketbase"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const program = new commander_1.Command();
+program
+    .name('pocketbase-to-zod')
+    .description('Generate Zod schemas from a PocketBase instance')
+    .requiredOption('-u, --url <char>', 'PocketBase URL')
+    .requiredOption('-e, --email <char>', 'Admin email')
+    .requiredOption('-p, --password <char>', 'Admin password')
+    .option('-o, --output <char>', 'Output file path', './pocketbase-schema.ts')
+    .action(async (options) => {
+    const pb = new pocketbase_1.default(options.url);
+    try {
+        console.log('--- Authenticating with PocketBase ---');
+        await pb.collection('_superusers').authWithPassword(options.email, options.password);
+        console.log('--- Fetching collections ---');
+        const collections = await pb.collections.getFullList();
+        let fileContent = `import { z } from 'zod';\n\n`;
+        for (const col of collections) {
+            fileContent += `// Schema for collection: ${col.name}\n`;
+            fileContent += `export const ${col.name}Schema = z.object({\n`;
+            // Base PocketBase fields
+            fileContent += `  id: z.string(),\n`;
+            fileContent += `  created: z.string(),\n`;
+            fileContent += `  updated: z.string(),\n`;
+            for (const field of col.schema) {
+                let zodType = 'z.any()';
+                switch (field.type) {
+                    case 'text':
+                    case 'editor':
+                    case 'url':
+                    case 'email':
+                        zodType = 'z.string()';
+                        break;
+                    case 'number':
+                        zodType = 'z.number()';
+                        break;
+                    case 'bool':
+                        zodType = 'z.boolean()';
+                        break;
+                    case 'date':
+                        zodType = 'z.string().datetime()'; // PocketBase sends dates as ISO strings
+                        break;
+                    case 'select':
+                        if (field.options.values) {
+                            const values = field.options.values.map((v) => `'${v}'`).join(', ');
+                            zodType = `z.enum([${values}])`;
+                        }
+                        break;
+                    case 'relation':
+                        zodType = field.options.maxSelect === 1 ? 'z.string()' : 'z.array(z.string())';
+                        break;
+                    case 'file':
+                        zodType = field.options.maxSelect === 1 ? 'z.string()' : 'z.array(z.string())';
+                        break;
+                    case 'json':
+                        zodType = 'z.unknown()';
+                        break;
+                }
+                if (!field.required) {
+                    zodType += '.optional().nullable()';
+                }
+                fileContent += `  ${field.name}: ${zodType},\n`;
+            }
+            fileContent += `});\n\n`;
+            fileContent += `export type ${col.name.charAt(0).toUpperCase() + col.name.slice(1)} = z.infer<typeof ${col.name}Schema>;\n\n`;
+        }
+        const outputPath = path_1.default.resolve(process.cwd(), options.output);
+        fs_1.default.writeFileSync(outputPath, fileContent);
+        console.log(`✅ Schemas generated successfully at: ${outputPath}`);
+    }
+    catch (error) {
+        console.error('❌ Error:', error.message);
+        process.exit(1);
+    }
+});
+program.parse();

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,mBAAmB,CAAC;KACzB,WAAW,CAAC,iDAAiD,CAAC;KAC9D,cAAc,CAAC,kBAAkB,EAAE,gBAAgB,CAAC;KACpD,cAAc,CAAC,oBAAoB,EAAE,aAAa,CAAC;KACnD,cAAc,CAAC,uBAAuB,EAAE,gBAAgB,CAAC;KACzD,MAAM,CAAC,qBAAqB,EAAE,kBAAkB,EAAE,wBAAwB,CAAC;KAC3E,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;IACxB,MAAM,EAAE,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAEvC,IAAI,CAAC;QACH,OAAO,CAAC,GAAG,CAAC,wCAAwC,CAAC,CAAC;QACtD,MAAM,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QAErF,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;QAC5C,MAAM,WAAW,GAAG,MAAM,EAAE,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC;QAEvD,IAAI,WAAW,GAAG,8BAA8B,CAAC;QAEjD,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;YAC9B,WAAW,IAAI,6BAA6B,GAAG,CAAC,IAAI,IAAI,CAAC;YACzD,WAAW,IAAI,gBAAgB,GAAG,CAAC,IAAI,uBAAuB,CAAC;YAE/D,yBAAyB;YACzB,WAAW,IAAI,qBAAqB,CAAC;YACrC,WAAW,IAAI,0BAA0B,CAAC;YAC1C,WAAW,IAAI,0BAA0B,CAAC;YAE1C,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;gBAC/B,IAAI,OAAO,GAAG,SAAS,CAAC;gBAExB,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;oBACnB,KAAK,MAAM,CAAC;oBACZ,KAAK,QAAQ,CAAC;oBACd,KAAK,KAAK,CAAC;oBACX,KAAK,OAAO;wBACV,OAAO,GAAG,YAAY,CAAC;wBACvB,MAAM;oBACR,KAAK,QAAQ;wBACX,OAAO,GAAG,YAAY,CAAC;wBACvB,MAAM;oBACR,KAAK,MAAM;wBACT,OAAO,GAAG,aAAa,CAAC;wBACxB,MAAM;oBACR,KAAK,MAAM;wBACT,OAAO,GAAG,uBAAuB,CAAC,CAAC,wCAAwC;wBAC3E,MAAM;oBACR,KAAK,QAAQ;wBACX,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;4BACzB,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;4BAC5E,OAAO,GAAG,WAAW,MAAM,IAAI,CAAC;wBAClC,CAAC;wBACD,MAAM;oBACR,KAAK,UAAU;wBACb,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,qBAAqB,CAAC;wBAC/E,MAAM;oBACR,KAAK,MAAM;wBACT,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,qBAAqB,CAAC;wBAC/E,MAAM;oBACR,KAAK,MAAM;wBACT,OAAO,GAAG,aAAa,CAAC;wBACxB,MAAM;gBACV,CAAC;gBAED,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;oBACpB,OAAO,IAAI,wBAAwB,CAAC;gBACtC,CAAC;gBAED,WAAW,IAAI,KAAK,KAAK,CAAC,IAAI,KAAK,OAAO,KAAK,CAAC;YAClD,CAAC;YAED,WAAW,IAAI,SAAS,CAAC;YACzB,WAAW,IAAI,eAAe,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,qBAAqB,GAAG,CAAC,IAAI,cAAc,CAAC;QAChI,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAC/D,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAC1C,OAAO,CAAC,GAAG,CAAC,wCAAwC,UAAU,EAAE,CAAC,CAAC;IAEpE,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,OAAO,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QACzC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,OAAO,CAAC,KAAK,EAAE,CAAC"}

package/index.ts

@@ -0,0 +1,95 @@
+#!/usr/bin/env node
+
+import { Command } from 'commander';
+import PocketBase from 'pocketbase';
+import fs from 'fs';
+import path from 'path';
+
+const program = new Command();
+
+program
+  .name('pocketbase-to-zod')
+  .description('Generate Zod schemas from a PocketBase instance')
+  .requiredOption('-u, --url <char>', 'PocketBase URL')
+  .requiredOption('-e, --email <char>', 'Admin email')
+  .requiredOption('-p, --password <char>', 'Admin password')
+  .option('-o, --output <char>', 'Output file path', './pocketbase-schema.ts')
+  .action(async (options) => {
+    const pb = new PocketBase(options.url);
+
+    try {
+      console.log('--- Authenticating with PocketBase ---');
+      await pb.collection('_superusers').authWithPassword(options.email, options.password);
+
+      console.log('--- Fetching collections ---');
+      const collections = await pb.collections.getFullList();
+
+      let fileContent = `import { z } from 'zod';\n\n`;
+
+      for (const col of collections) {
+        fileContent += `// Schema for collection: ${col.name}\n`;
+        fileContent += `export const ${col.name}Schema = z.object({\n`;
+        
+        // Base PocketBase fields
+        fileContent += `  id: z.string(),\n`;
+        fileContent += `  created: z.string(),\n`;
+        fileContent += `  updated: z.string(),\n`;
+
+        for (const field of col.schema) {
+          let zodType = 'z.any()';
+
+          switch (field.type) {
+            case 'text':
+            case 'editor':
+            case 'url':
+            case 'email':
+              zodType = 'z.string()';
+              break;
+            case 'number':
+              zodType = 'z.number()';
+              break;
+            case 'bool':
+              zodType = 'z.boolean()';
+              break;
+            case 'date':
+              zodType = 'z.string().datetime()'; // PocketBase sends dates as ISO strings
+              break;
+            case 'select':
+              if (field.options.values) {
+                const values = field.options.values.map((v: string) => `'${v}'`).join(', ');
+                zodType = `z.enum([${values}])`;
+              }
+              break;
+            case 'relation':
+              zodType = field.options.maxSelect === 1 ? 'z.string()' : 'z.array(z.string())';
+              break;
+            case 'file':
+              zodType = field.options.maxSelect === 1 ? 'z.string()' : 'z.array(z.string())';
+              break;
+            case 'json':
+              zodType = 'z.unknown()';
+              break;
+          }
+
+          if (!field.required) {
+            zodType += '.optional().nullable()';
+          }
+
+          fileContent += `  ${field.name}: ${zodType},\n`;
+        }
+
+        fileContent += `});\n\n`;
+        fileContent += `export type ${col.name.charAt(0).toUpperCase() + col.name.slice(1)} = z.infer<typeof ${col.name}Schema>;\n\n`;
+      }
+
+      const outputPath = path.resolve(process.cwd(), options.output);
+      fs.writeFileSync(outputPath, fileContent);
+      console.log(`✅ Schemas generated successfully at: ${outputPath}`);
+
+    } catch (error: any) {
+      console.error('❌ Error:', error.message);
+      process.exit(1);
+    }
+  });
+
+program.parse();

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "pocketbase-to-zod",
+  "version": "1.0.0",
+  "description": "This project is an utility to generate Zod schemas from Pocketbase instance ",
+  "main": "index.js",
+  "bin": {
+    "pb-to-zod": "dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc && chmod +x dist/index.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ajomuch92/pocketbase-to-zod.git"
+  },
+  "keywords": [
+    "Zod",
+    "schemas",
+    "pocketbase",
+    "pb",
+    "validations",
+    "instance"
+  ],
+  "author": "Aarón Montes",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/ajomuch92/pocketbase-to-zod/issues"
+  },
+  "homepage": "https://github.com/ajomuch92/pocketbase-to-zod#readme",
+  "dependencies": {
+    "commander": "^14.0.2",
+    "pocketbase": "^0.26.6",
+    "zod": "^4.3.5"
+  },
+  "devDependencies": {
+    "@types/node": "^25.0.9",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  // Visit https://aka.ms/tsconfig to read more about this file
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "outDir": "./dist",
+    "rootDir": "./",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "declaration": true
+  },
+  "include": ["index.ts"]
+}