Integrations

import { defineIntegration } from "bijection/server";
import { v } from "bijection/values";

export const crm = defineIntegration({
  collections: {
    customers: {
      schema: { external_id: v.string(), name: v.string() },
      sync: { every: { minutes: 5 }, async read(ctx, input) { … } },
      …
    },
  },
  …
});

import { defineSchema, defineTable } from "bijection/server";
import { crm } from "./crm";

export default defineSchema({
  customers: defineTable(crm.customers.schema).source(crm.customers),
});

import { query } from "./_generated/server";

export const list = query({
  args: {},
  handler: async (ctx) => {
    return await ctx.db.query("customers").take(100);
  },
});

​

Concepts

• An integration groups what Bijection needs to know about one external system: the HTTP requests it may make, the collections it reads and the commands it can send.
• A collection is one kind of record the provider holds, such as customers or invoices. Each collection declares its schema, what the provider’s responses prove about it, and its sync: how often it is read and how a response becomes records.
• A synced table is a table bound to a collection with .source(...). Only the sync writes to it. Your mutations cannot.
• A connection installs an integration against one verified provider account in one deployment, with a private credential that your functions never see.

​

Kinds of integrations

• defineIntegration declares an integration over a provider’s HTTP API. Your code maps responses to records.
• definePostgresIntegration replicates selected PostgreSQL tables through logical replication.
• defineMailIntegration reads an IMAP mailbox.