Note: This is a work in progress, this should not be used until it close to release.
A simplified PocketBase SDK to ease the developer experience.
- Modular API
- Strongly typed schemas
- Finish rest of the PocketBase API
- Add authentication
- Clean up code significantly
- Add realtime records
- Add base schema for Users & Admins
- Add Settings collection
- Add Logs collection
- Add import collection
- Add good error handling
- Finish schema validation
- Potentially change from a singleton to instances?
This is using the demo on the pocketbase.io site.
import { init, collection, list, Schema, Type, authPassword, Admins } from "pocketbase-ts";
async function main() {
init("https://pocketbase.io");
await authPassword(Admins, "test@example.com", "123456");
const PostSchema = new Schema({
title: Type.text({ required: true }),
description: Type.text(),
active: Type.bool(),
options: Type.select(),
featuredImages: Type.file()
});
const Posts = collection("posts", PostSchema);
const posts = await list(Posts, { filter: "active=true" });
console.log(posts);
}
main();
The API is designed like action (...arguments)
.
This is uniform across the rest of the api.
To get a record by ID you use the get
function.
await get(Users, "id of record");
To find one record you use the find
function.
await find(Users, { filter: "likes>10" });
To create a record you use the create
function.
await create(Users, { name: "Solaris9" });
To list paginated records you use the list
function.
await list(Users, { sort: "created" });
Authenticating is similar using the authentications methods.
await authPassword(Users, "user@example.com", "123456");
await authPassword(Admins, "test@example.com", "123456");
await requestEmailChange(Admins, "test2@example.com");
await confirmEmailChange(Admins, token, password);
To subscribe to a Collection you use the subscribe
method.
// subscribe to the Collection for all create, delete, and update actions
subscribe(Posts, (action, record) => {
// code
});
// subscribe to the specific record for delete and update actions
subscribe(Posts, "record-id", (action, record) => {
// code
});
To unsubscribe from a subscription you can use unsubscribe
or the method returned from subscribe
// subscribe to the Collection for all create, delete, and update actions
const unsubscribe = await subscribe(Posts, (action, record) => {
// code
});
unsubscribe();