typegen

@proofkit/typegen

@proofkit/typegen is a tool for generating TypeScript types from FileMaker database schemas, making it easier to work with FileMaker data in modern TypeScript projects.

Run the tool directly from the command line:

npx @proofkit/typegen@latest

Programmatic usage is also available from the root package export:

import { buildSchema, type BuildSchemaArgs } from "@proofkit/typegen";
import { Project, ScriptKind } from "ts-morph";

const project = new Project();
const file = project.createSourceFile("customer.ts", "", { scriptKind: ScriptKind.TS });

const args: BuildSchemaArgs = {
  schemaName: "customer",
  schema: [{ name: "recordId", type: "string" }],
  type: "ts",
  layoutName: "Customer",
  envNames: {
    server: "FM_SERVER",
    db: "FM_DATABASE",
    auth: {
      apiKey: "OTTO_API_KEY",
      clarisIdUsername: "CLARIS_ID_USERNAME",
      clarisIdPassword: "CLARIS_ID_PASSWORD",
      username: undefined,
      password: undefined,
    },
  },
};

buildSchema(file, args);

For fmodata configs targeting FileMaker Cloud, envNames.auth also supports clarisIdUsername and clarisIdPassword. These map to Claris ID credentials used for OData auth. MFA-backed Claris ID accounts are not supported yet.

Check out the full documentation at proofkit.proof.sh.