Pocketbase Typegen

Generate typescript definitions from your pocketbase.io schema.

Quickstart

npx pocketbase-typegen --url https://myproject.pockethost.io --email admin@myproject.com --password 'secr3tp@ssword!'

This will produce types for all your PocketBase collections to use in your frontend typescript codebase.

Example Usage

Collections can be automatically typed using the generated TypedPocketBase type:

``typescript
import { TypedPocketBase } from "./pocketbase-types"

const pb = new PocketBase("http://127.0.0.1:8090") as TypedPocketBase

await pb.collection("tasks").getOne("RECORD_ID") // -> results in TaskResponse
await pb.collection("posts").getOne("RECORD_ID") // -> results in PostResponse
`

Alternatively, you can use generic types for each request, eg:

`typescript
import { Collections, TasksResponse } from "./pocketbase-types"

await pb.collection(Collections.Tasks).getOne("RECORD_ID") // -> results in TaskResponse
`

Example Advanced Usage

You can provide types for JSON fields and expanded relations by passing generic arguments to the Response types:

`typescript
import { Collections, CommentsResponse, UserResponse } from "./pocketbase-types"

/**
type CommentsRecord = {
text: string
metadata: null | Tmetadata // This is a json field
user: RecordIdString // This is a relation field
}
*/
type Metadata = {
likes: number
}
type Expand = {
user: UsersResponse
}
const result = await pb
.collection(Collections.Comments)
.getOne>("RECORD_ID", { expand: "user" })

// Now you can access the expanded relation with type safety and hints in your IDE
result.expand.user.username
`

Create/Update types

You can also type the create/update operations:

`typescript
import { Collections, Create, Update } from "./pocketbase-types"

// Create
const newUser: Create = {
name: "Name",
username: "username",
password: "password",
passwordConfirm: "password",
email: "user@mail.com",
emailVisibility: true,
verified: false,
}
await pb.collection(Collections.Users).create(newUser)

// Update
const updatedUser: Update = {
name: "Updated name",
email: "user@email.com",
verified: false,
}
await pb.collection(Collections.Users).update("RECORD_ID", updatedUser)
`

Generating Types

`
Options:
-V, --version output the version number
-u, --url URL to your hosted pocketbase instance. When using this options you must also provide email and
password options or auth token option.
--email Email for a pocketbase superuser. Use this with the --url option.
-p, --password Password for a pocketbase superuser. Use this with the --url option.
-t, --token Auth token for a pocketbase superuser. Use this with the --url option.
-d, --db Path to the pocketbase SQLite database.
-j, --json Path to JSON schema exported from pocketbase admin UI.
--env [dir] Use environment variables for configuration. Add PB_TYPEGEN_URL, PB_TYPEGEN_EMAIL, PB_TYPEGEN_PASSWORD
to your .env file. Optionally provide a path to a directory containing a .env file (default: true)
-o, --out Path to save the typescript output file. (default: "pocketbase-types.ts")
--no-sdk Removes the pocketbase package dependency. A typed version of the SDK will not be generated.
-h, --help display help for command
`

$3

npx pocketbase-typegen --url https://myproject.pockethost.io --email admin@myproject.com --password 'secr3tp@ssword!'

$3

You can generate such token via the above impersonate API or from the Dashboard > Collections > \_superusers > {select superuser} > "Impersonate" dropdown option.

npx pocketbase-typegen --url https://myproject.pockethost.io --token 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9'

$3

Also supports environment specific files such as .env.local (uses dotenv-flow)

npx pocketbase-typegen --env or npx pocketbase-typegen --env path/to/dir

.env variables include:

`
PB_TYPEGEN_URL=https://myproject.pockethost.io
PB_TYPEGEN_EMAIL=admin@myproject.com
PB_TYPEGEN_PASSWORD=secr3tp@ssword!
PB_TYPEGEN_TOKEN=eyJhbGciOiJI...ozhyQVfYm24
`

$3

npx pocketbase-typegen --db ./pb_data/data.db

$3

npx pocketbase-typegen --json ./pb_schema.json

$3

Pocketbase hooks can be used to generate new types every time a collections is created/updated/deleted. Create a file generateHooks.pb.js and place it in a directory called pb_hooks along side your pocketbase executable.

`javascript
///

const generateTypes = (e) => {
console.log("Collection changed - Running type generation...")
const cmd = $os.cmd(
"npx",
"pocketbase-typegen",
"--db",
"pb_data/data.db",
"--out",
"../client/src/pocketbase-types.ts"
)
const result = toString(cmd.output())
console.log(result)

e.next()
}

onCollectionAfterCreateSuccess(generateTypes)
onCollectionAfterUpdateSuccess(generateTypes)
onCollectionAfterDeleteSuccess(generateTypes)
`

$3

Add it to your projects package.json:

`
"scripts": {
"typegen": "pocketbase-typegen --env",
},
`

Example Output

The output is a typescript file pocketbase-types.ts (example) which will contain:

- Collections An enum of all collections.
- [CollectionName]Record One type for each collection (eg ProfilesRecord).
- [CollectionName]Response One response type for each collection (eg ProfilesResponse) which includes system fields. This is what is returned from the PocketBase API.
- [CollectionName][FieldName]Options If the collection contains a select field with set values, an enum of the options will be generated.
- CollectionRecords A type mapping each collection name to the record type.
- CollectionResponses A type mapping each collection name to the response type.
- TypedPocketBase` A type for usage with type asserted PocketBase instance.

Version Support

| PocketBase | pocketbase-typegen |
| ---------- | ------------------ |
| v0.23.x | v1.3.x |
| v0.18.x | v1.2.x |
| v0.8.x | v1.1.x |
| v0.7.x | v1.0.x |

Status