Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/patmood/pocketbase-typegen
Typescript generation for pocketbase records
https://github.com/patmood/pocketbase-typegen
pocketbase typegen typescript
Last synced: 24 days ago
JSON representation
Typescript generation for pocketbase records
- Host: GitHub
- URL: https://github.com/patmood/pocketbase-typegen
- Owner: patmood
- Created: 2022-10-14T03:03:47.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-30T04:54:58.000Z (about 1 year ago)
- Last Synced: 2024-09-30T22:11:58.713Z (about 2 months ago)
- Topics: pocketbase, typegen, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/pocketbase-typegen
- Size: 440 KB
- Stars: 513
- Watchers: 4
- Forks: 16
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-pocketbase - GitHub - | (Tools/Plugin / TypeScript)
- awesome-pocketbase - GitHub - | (Tools/Plugin / TypeScript)
- awesome-pocketbase - PocketBase Typegen - Generate TypeScript types from the SQLite db file.  (TypeScript tools)
README
# Pocketbase Typegen
Generate typescript definitions from your [pocketbase.io](https://pocketbase.io/) schema.
## Quickstart
`npx pocketbase-typegen --db ./pb_data/data.db --out pocketbase-types.ts`
This will produce types for all your PocketBase collections to use in your frontend typescript codebase.
## Versions
When using PocketBase > v0.8.x, use `pocketbase-typegen` v1.1.x
Users of PocketBase < v0.7.x should use `pocketbase-typegen` v1.0.x
## Usage
```
Options:
-V, --version output the version number
-d, --db path to the pocketbase SQLite database
-j, --json path to JSON schema exported from pocketbase admin UI
-u, --url URL to your hosted pocketbase instance. When using this options you must also provide email and password options.
-e, --email email for an admin pocketbase user. Use this with the --url option
-p, --password password for an admin pocketbase user. Use this with the --url option
-o, --out path to save the typescript output file (default: "pocketbase-types.ts")
--no-sdk remove the pocketbase package dependency. A typed version of the SDK will not be generated.
-e, --env [path] flag to use environment variables for configuration. Add PB_TYPEGEN_URL, PB_TYPEGEN_EMAIL, PB_TYPEGEN_PASSWORD to your .env file. Optionally provide a path to your .env file
-h, --help display help for command
```
DB example:
`npx pocketbase-typegen --db ./pb_data/data.db`
JSON example (export JSON schema from the pocketbase admin dashboard):
`npx pocketbase-typegen --json ./pb_schema.json`
URL example:
`npx pocketbase-typegen --url https://myproject.pockethost.io --email [email protected] --password 'secr3tp@ssword!'`
ENV example (add PB_TYPEGEN_URL, PB_TYPEGEN_EMAIL and PB_TYPEGEN_PASSWORD to your .env file):
`npx pocketbase-typegen --env`
.env:
```
PB_TYPEGEN_URL=https://myproject.pockethost.io
[email protected]
PB_TYPEGEN_PASSWORD=secr3tp@ssword!
```
Add it to your projects `package.json`:
```
"scripts": {
"typegen": "pocketbase-typegen --db ./pb_data/data.db",
},
```
## Example Output
The output is a typescript file `pocketbase-types.ts` ([example](./test/pocketbase-types-example.ts)) 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.
## Example Usage
Using PocketBase SDK v0.18.3+, collections can be [automatically typed](https://github.com/pocketbase/js-sdk#specify-typescript-definitions) 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](https://pocketbase.io/docs/expanding-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 Tmetadata = {
likes: number
}
type Texpand = {
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
```
## Status
 