pocketbase-zod-schema 0.1.2

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+## [0.1.2](https://github.com/dastron/pocketbase-zod-schema/compare/pocketbase-zod-schema-v0.1.1...pocketbase-zod-schema-v0.1.2) (2025-12-19)
+
+
+### Bug Fixes
+
+* Update Readme ([b1194fe](https://github.com/dastron/pocketbase-zod-schema/commit/b1194fe518b0c124730071e8f91c7aa4111ab8d2))
+* Update README ([526f378](https://github.com/dastron/pocketbase-zod-schema/commit/526f37843ec4cdba0ddae06bf0156447671c1641))
+
+## [0.1.1](https://github.com/dastron/pocketbase-zod-schema/compare/pocketbase-zod-schema-v0.1.0...pocketbase-zod-schema-v0.1.1) (2025-12-19)
+
+
+### Bug Fixes
+
+* broken tests ([059ae92](https://github.com/dastron/pocketbase-zod-schema/commit/059ae92415c0705fa3c4372a27de98de047d150d))
+* github actions ([2e29d48](https://github.com/dastron/pocketbase-zod-schema/commit/2e29d4894f4ecb70acf0c2a613268df461c64acd))
+* Github Actions ([b0b6a54](https://github.com/dastron/pocketbase-zod-schema/commit/b0b6a54f9cae5e4fb6c573e5bddd9baba682b333))

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 dastron
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,167 @@
+# PocketBase Zod Migration Package
+
+This is the **published NPM package**: `pocketbase-zod-schema`.
+
+If you're here from NPM, you can ignore the monorepo details — everything you need to **install and use** the library/CLI is below.
+
+## Structure
+
+- `src/` - TypeScript source code
+- `dist/` - Built output (generated by tsup)
+- `package.json` - Package configuration and dependencies
+- `tsconfig.json` - TypeScript configuration
+- `tsup.config.ts` - Build configuration
+- `vitest.config.ts` - Test configuration
+- `.prettierrc` - Code formatting configuration
+- `nodemon.json` - Development server configuration
+- `.npmignore` - Files to exclude from npm package
+
+## Installation (NPM)
+
+```bash
+npm install pocketbase-zod-schema
+# or
+yarn add pocketbase-zod-schema
+# or
+pnpm add pocketbase-zod-schema
+```
+
+## Usage
+
+### CLI (`pocketbase-migrate`)
+
+The package ships a CLI named `pocketbase-migrate`.
+
+```bash
+# generate migrations from schema changes
+npx pocketbase-migrate generate
+
+# show migration status without writing files
+npx pocketbase-migrate status
+
+# force generation even if destructive changes are detected
+npx pocketbase-migrate generate --force
+```
+
+### Configuration
+
+Create a `pocketbase-migrate.config.js` at your project root:
+
+```js
+export default {
+  schema: {
+    directory: "./src/schema",
+    exclude: ["*.test.ts", "*.spec.ts"],
+  },
+  migrations: {
+    directory: "./pocketbase/pb_migrations",
+    format: "js",
+  },
+  diff: {
+    warnOnDelete: true,
+    requireForceForDestructive: true,
+  },
+};
+```
+
+### Defining schemas (Zod)
+
+```ts
+import { z } from "zod";
+import { baseSchema, withPermissions } from "pocketbase-zod-schema/schema";
+
+export const UserInputSchema = z.object({
+  name: z.string().min(1),
+  email: z.string().email(),
+  avatar: z.string().optional(),
+  role: z.enum(["user", "admin"]).default("user"),
+});
+
+export const UserSchema = withPermissions(
+  baseSchema.extend(UserInputSchema.shape),
+  {
+    listRule: '@request.auth.id != ""',
+    viewRule: '@request.auth.id != ""',
+    createRule: "",
+    updateRule: "@request.auth.id = id",
+    deleteRule: "@request.auth.id = id",
+  }
+);
+```
+
+### Programmatic usage
+
+```ts
+import {
+  parseSchemaFiles,
+  compare,
+  generate,
+  loadSnapshotIfExists,
+} from "pocketbase-zod-schema/migration";
+
+const migrationsDir = "./pocketbase/pb_migrations";
+
+const currentSchema = await parseSchemaFiles("./src/schema");
+const previousSnapshot = loadSnapshotIfExists({ migrationsPath: migrationsDir });
+
+const diff = compare(currentSchema, previousSnapshot);
+const migrationPath = generate(diff, migrationsDir);
+console.log({ migrationPath });
+```
+
+## Development (repo contributors)
+
+From the root directory, you can run:
+
+```bash
+# Build the package
+yarn build
+
+# Run tests
+yarn test
+
+# Start development mode
+yarn dev
+
+# Format code
+yarn format
+
+# Lint code
+yarn lint
+```
+
+All commands are proxied through the root package.json to this workspace.
+
+## Publishing
+
+Publishing is handled by GitHub Actions (Release Please).
+
+### Manual publish (maintainers)
+
+If you need to publish manually, use the **same command as CI**. It only requires `NPM_TOKEN`.
+
+```bash
+export NPM_TOKEN="***"
+yarn publish:npm
+```
+
+If you'd rather keep the token in a local `.env` file (gitignored), you can do:
+
+```bash
+echo 'NPM_TOKEN="***"' > .env
+yarn publish:npm:env
+```
+
+If your npm org/account requires publish-time 2FA, either:
+
+- use an **automation / granular token** configured to bypass 2FA for publishing (recommended for CI), or
+- set a one-time password for local publishing:
+
+```bash
+export NPM_OTP="123456"
+yarn publish:npm:env
+```
+
+Authentication options:
+
+- set `NPM_TOKEN` in your shell for the command