AirtableExtensions

3rd party extensions for airtable

Quickly create typesafe APIs for your airtable bases:

API requests are automatically rate-limited and queued if the request would exceed the requests limit of 5 per second.

Airtable client example:

import { createApi } from 'jbs-airtable-api-extensions';
import type { AirtableEntity } from 'jbs-airtable-api-extensions';

const modelSpec = {
  places: {
    name: 'string',
    lat: 'number',
    long: 'number',
    active: 'boolean',
  },
  people: {
    firstName: 'string',
    lastName: 'string',
    age: 'number',
  },
} as const;

export type Person = AirtableEntity<typeof modelSpec['people']>;
export type Place = AirtableEntity<typeof modelSpec['places']>;

export const api = createApi({
  // don't expose secrets in git or client app!
  apiKey: process.env.AIRTABLE_KEY,
  baseId: process.env.AIRTABLE_BASE,
  spec: modelSpec,
});

// api is typesafe and will autocomplete available tables and field names
(async () => {
  const places: Place[] = await api.places.findAll({
    // field names autocomplete based on the spec above
    fields: [
      'nam', // ts error! -  type '"nam"' is not assignable to type '"name" | "lat" | "long" | "active"'
      'active',
    ],

    sort: [
      {
        field: 'activ', // ts error! -  type '"activ"' is not assignable to type '"name" | "lat" | "long" | "active"'
        direction: 'asc',
      },
    ],
  });
})();

Airtable proxy example:

Navigate to http://localhost:3333/openapi to test api routes in the Swagger browser

import express from 'express';
import { createAirtableProxyRoutes } from 'jbs-airtable-express-proxy';
import * as dotenv from 'dotenv';

dotenv.config();

const app = express();

const airtableSpec = {
  places: {
    name: 'string',
    lat: 'number',
    long: 'number',
    active: 'boolean',
  },
  locations: {
    name: 'string',
    description: 'string',
    latitude: 'number',
    longitude: 'number',
  },
  people: {
    firstName: 'string',
    lastName: 'string',
    age: 'number',
  },
} as const;

createAirtableProxyRoutes(
  app,
  {
    globalRoutePrefix: '/api',
    airtableSpec,
    airtableApiKey: process.env.AIRTABLE_KEY,
    airtableBaseId: process.env.AIRTABLE_BASE,
  },
  {
    title: 'Express Airtable Proxy Example',
    version: '1.0.0',
  }
);

const port = process.env.port || 3333;
const server = app.listen(port, () => {
  console.log(`Listening at http://localhost:${port}/api`);
});
server.on('error', console.error);