# miniextensions-firetable

> Frontend JS SDK for Airtable

Latest version **1.0.7** (published 2023-07-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install miniextensions-firetable
pnpm add miniextensions-firetable
yarn add miniextensions-firetable
bun add miniextensions-firetable
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2023-07-27 |
| First published | 2023-07-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 53 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | miniExtensions |
| Maintainers | aalzanki |
| Keywords | typescript, npm, template, ts |

## Links

- npm: https://www.npmjs.com/package/miniextensions-firetable
- Repository: https://github.com/miniExtensions/miniextensions-firetable
- Homepage: https://github.com/miniExtensions/miniextensions-firetable#readme
- Issues: https://github.com/miniExtensions/miniextensions-firetable/issues
- npm.io page: https://npm.io/package/miniextensions-firetable

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^1.4.0
- [airtable](https://npm.io/package/airtable.md) ^0.12.1

## Alternatives

- [csv-to-markdown-table](https://npm.io/package/csv-to-markdown-table.md) — 47.0K weekly downloads
- [@sapphire/ratelimits](https://npm.io/package/@sapphire/ratelimits.md) — 4.4K weekly downloads
- [js-csvparser](https://npm.io/package/js-csvparser.md) — 2.0K weekly downloads
- [@adadapted/js-sdk](https://npm.io/package/@adadapted/js-sdk.md) — 251 weekly downloads
- [@grapecity/spread-sheets-sparklines](https://npm.io/package/@grapecity/spread-sheets-sparklines.md) — 103 weekly downloads

## Recent versions

- 1.0.7 (latest) — 2023-07-27
- 1.0.6 — 2023-07-27
- 1.0.5 — 2023-07-26
- 1.0.4 — 2023-07-26
- 1.0.2 — 2023-07-26
- 1.0.1 — 2023-07-26
- 1.0.0 — 2023-07-26

## README

## Getting Started

### Add the package

```bash
yarn add miniextensions-firetable
```

or

```bash
npm install miniextensions-firetable
```

### Initialize Firetable

```ts
import { initializeApp } from 'miniextensions-firetable';

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

## Auth

### User Sign up

```ts
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

```ts
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`.

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

### User Logout

```ts
await logoutFromFiretable();
```

### Get Current User

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

```ts
const { user } = getCurrentUser();
```

### Change user email

```ts
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

```ts
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

```ts
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

```ts
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.

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

### Delete a record

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

### List records

TODO

---
_Source: https://npm.io/package/miniextensions-firetable · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._