refine-pocketbase
TypeScript icon, indicating that this package has built-in type declarations

0.0.6 • Public • Published

refine-pocketbase

pb

PocketBase providers for Refine.

Features

  • [x] auth provider
    • [x] register
    • [x] login with password
    • [x] login with provider
    • [x] forgot password
    • [x] update password
  • [x] data provider
    • [x] filters
    • [x] sorters
    • [x] pagination
  • [x] live provider
    • [x] subscribe
    • [x] unsubscribe

Installation

yarn add refine-pocketbase
# or
npm install refine-pocketbase

Basic Usage

import PocketBase from "pocketbase";
import { authProvider, dataProvider, liveProvider } from "refine-pocketbase";

const pb = new PocketBase(POCKETBASE_URL);

<Refine
  authProvider={authProvider(pb)}
  dataProvider={dataProvider(pb)}
  liveProvider={liveProvider(pb)}
  ...
>
  ...
</Refine>

Auth Provider Options

import { authProvider, AuthOptions } from "refine-pocketbase";

const authOptions: AuthOptions = {
  loginRedirectTo: "/dashboard",
};

<Refine
  authProvider={authProvider(pb, authOptions)}
  ...
>
  ...
</Refine>

Tasks: PRs Welcome!

  • [x] happy path test specs
    • [x] authProvider
    • [x] dataProvider (except for deleteOne)
    • [x] liveProvider
  • [ ] test specs for authProvider error conditions
    • [x] register
    • [x] forgotPassword
    • [x] updatePassword
    • [ ] login
  • [ ] test specs for dataProvider error conditions
    • [ ] getList
    • [ ] create
    • [ ] update
    • [ ] getOne
    • [ ] deleteOne
  • [ ] test specs for deleteOne
  • [ ] test specs with expand
    • [ ] getList
    • [ ] getOne
  • [ ] test specs with fields
    • [ ] getList
    • [ ] getOne

Contribute

Buy Me A Coffee

Dependencies (0)

    Dev Dependencies (9)

    Package Sidebar

    Install

    npm i refine-pocketbase

    Weekly Downloads

    30

    Version

    0.0.6

    License

    MIT

    Unpacked Size

    85.7 kB

    Total Files

    18

    Last publish

    Collaborators

    • kruschid