miniextensions-firetable v1.0.7

Getting Started

Add the package

yarn add miniextensions-firetable

or

npm install miniextensions-firetable

Initialize Firetable

import { initializeApp } from 'miniextensions-firetable';

initializeApp({
    config: {
        publicKey: 'INSERT_YOUR_PUBLIC_KEY_HERE',
    },
});

Auth

User Sign up

const { user, sessionToken } = await signupWithEmail({
    email: 'a@example.com',
    password: '123456789',
});

const userUID = user.uid; // this is the Airtable record ID of the user record.

User Login

const { user, sessionToken } = await loginWithEmail({
    email: 'a@example.com',
    password: '123456789',
});

Persist Login

To persist login, store sessionToken in a cookie or local storage. You can resume a session by calling validateSession with the sessionToken.

const { user } = await validateSession({
    sessionToken,
});

User Logout

await logoutFromFiretable();

Get Current User

You can only get the current user when the user is logged in. Otherwise, it will throw an error.

const { user } = getCurrentUser();

Change user email

const { updatedUser, newSessionToken } = await changeUserEmail({
    password: '123456789', // ask the user to enter their password and pass it here.
    newEmail: 'newEmail@example.com',
});

const newEmail = updatedUser.email;

Make sure to persist newSessionToken. The old session token will no longer work.

Change user password

const { newSessionToken } = await changeUserPassword({
    existingPassword: '123456789', // ask the user to enter their existing password and pass it here.
    newPassword: '987654321', // ask the user to enter their new password and pass it here.
});

Make sure to persist newSessionToken. The old session token will no longer work.

Records

Create a record

type Task = {
    name: string;
    done: boolean;
};

const record = await createRecord<Task>({
    tableId: 'tblXXXXXXXXXXXXXX',
    fields: {
        name: 'My Task',
        done: false,
    },
});

const { name, done } = record.fields;

Fetch a record

const record = await fetchRecord<Task>({
    tableId: 'tblXXXXXXXXXXXXXX',
    recordId: 'recXXXXXXXXXXXXXX',
});

Update a record

Firetable automatically does a merge when updating records. You should only pass the fields you want to update. Fields that are not passed to updateRecord will not be removed. To remove a field, pass null as the value.

const record = await updateRecord<Task>({
    tableId: 'tblXXXXXXXXXXXXXX',
    record: {
        id: 'recXXXXXXXXXXXXXX',
        fields: {
            done: true,
        },
    },
});

Delete a record

await deleteRecord({
    tableId: 'tblXXXXXXXXXXXXXX',
    recordId: 'recXXXXXXXXXXXXXX',
});

List records

TODO