Generated SDK

pbkit generates sdk.gen.ts with fully typed functions for every non-excluded collection. The generated functions use the client exported from client.gen.ts by default. Set sdk.baseUrl in pbkit.config.ts to initialize that client with your PocketBase URL.

CRUD functions

For each collection (e.g. articles), the following functions are generated based on enabled operations:

Read operations

// Get a single record by ID
getArticle(id: string, options?: RequestOptions, opts?: { client?: PbClient }): Promise<ArticlesRecord>

// Get the first record matching a filter
getFirstArticle(filter: string, options?: RequestOptions, opts?: { client?: PbClient }): Promise<ArticlesRecord>

// Paginated list
listArticles(params?: ListParams, opts?: { client?: PbClient }): Promise<ListResult<ArticlesRecord>>

// Get all records
getFullListArticles(params?: ListParams, opts?: { client?: PbClient }): Promise<ArticlesRecord[]>

Write operations

createArticle(data: ArticlesCreate, opts?: { client?: PbClient }): Promise<ArticlesRecord>
updateArticle(id: string, data: ArticlesUpdate, opts?: { client?: PbClient }): Promise<ArticlesRecord>
deleteArticle(id: string, opts?: { client?: PbClient }): Promise<true>

Pass { client } as the final argument to use a different PocketBase instance for a specific call.

Typed expand

When a collection has relations, the expand option is typed to the collection’s Expand type:

import { getArticle } from "./generated/sdk.gen"

// expand is typed to ArticlesExpand — you get autocomplete
const article = await getArticle("RECORD_ID", {
  expand: "author",
})

Auth functions

Auth collections (type: "auth") get additional functions:

// Authentication
authUserWithPassword(usernameOrEmail, password)
authUserWithOAuth2(provider, code, codeVerifier, redirectUrl)
authUserWithOTP(otpId, password)

// Password reset
requestUserPasswordReset(email)
confirmUserPasswordReset(token, password, passwordConfirm)

// Email verification
requestUserVerification(email)
confirmUserVerification(token)

// Email change
requestUserEmailChange(newEmail)
confirmUserEmailChange(token, password)

// Token refresh
refreshUser()

Shared types

The SDK file exports these utility types:

export type PbClient = PocketBase

export interface ListResult<T> {
  page: number
  perPage: number
  totalItems: number
  totalPages: number
  items: T[]
}

export interface ListParams {
  page?: number
  perPage?: number
  sort?: string
  filter?: string
  expand?: string
  fields?: string
}

export interface RequestOptions {
  expand?: string
  filter?: string
  sort?: string
  fields?: string
}

Disable SDK generation

Set sdk.enabled: false to skip SDK generation:

export default {
  input: "https://my-pb.example.com",
  output: "./src/generated",
  sdk: { enabled: false },
}