@supabase/postgrest-typegen 0.2.5 → 0.3.0

package/README.md

@@ -113,19 +113,27 @@ breaks at read time.
 
 ```ts
 import {
-  generateTypescript, // async (uses prettier)
+  generateTypescript, // async (formats its output)
   generateGo,
   generatePython,
   generateSwift,
 } from "@supabase/postgrest-typegen/generation";
 ```
 
-| Function             | Options                                                                 |
-| -------------------- | ----------------------------------------------------------------------- |
-| `generateTypescript` | `{ detectOneToOneRelationships?, postgrestVersion?, defaultSchema? }`    |
-| `generateGo`         | —                                                                       |
-| `generatePython`     | —                                                                       |
-| `generateSwift`      | `{ accessControl?: 'internal' \| 'public' \| 'private' \| 'package' }`   |
+| Function             | Options                                                                        |
+| -------------------- | ------------------------------------------------------------------------------ |
+| `generateTypescript` | `{ detectOneToOneRelationships?, postgrestVersion?, defaultSchema?, format? }` |
+| `generateGo`         | —                                                                              |
+| `generatePython`     | —                                                                              |
+| `generateSwift`      | `{ accessControl?: 'internal' \| 'public' \| 'private' \| 'package' }`         |
+
+`generateTypescript` formats its output with `oxfmt` unless `format` is
+supplied. `oxfmt` is an optional peer dependency, imported only when that
+default runs: install it to use the default formatter, or pass your own
+`format` (an identity function, for byte-identical unformatted output, or a
+worker-pool-backed formatter) and it is never loaded or needed. Calling
+`generateTypescript` without `format` when `oxfmt` is missing throws an error
+saying so.
 
 ## Installation
 
@@ -134,6 +142,8 @@ Not yet published; consumed in-repo for now (`packages/postgrest-typegen`).
 ```bash
 # pg is a peer of your application, not bundled here
 npm install pg
+# only if you rely on generateTypescript's default formatter
+npm install oxfmt@0.66.0
 ```
 
 ## Releasing

package/dist/generation/typescript.d.ts

@@ -17,9 +17,11 @@ export interface GenerateTypescriptOptions {
      */
     defaultSchema?: string;
     /**
-     * Formatter used on the generated output. Defaults to `oxfmt`, called
-     * inline. Callers on a latency-sensitive request path (e.g. postgres-meta's
-     * hosted `/generators/typescript` route) can substitute a worker-pool-backed
+     * Formatter used on the generated output. Defaults to `oxfmt`, an optional
+     * peer dependency that is imported only when this default runs, so callers
+     * that always pass their own formatter need not install it. Callers on a
+     * latency-sensitive request path (e.g. postgres-meta's hosted
+     * `/generators/typescript` route) can substitute a worker-pool-backed
      * formatter here instead of blocking the event loop on every call.
      */
     format?: (code: string) => Promise<string>;

package/dist/generation/typescript.js

@@ -1,13 +1,16 @@
-// oxlint-disable typescript/restrict-template-expressions -- this is a verbatim port of
-// postgres-meta's template, which intentionally interpolates arrays/values into template
-// literals (relying on Array#toString) to build the output. Preserving that is required for
-// byte-parity, and the offending expressions sit inside template literals where a targeted
-// disable comment would corrupt the emitted string.
-import { format as oxfmtFormat } from "oxfmt";
 import { VALID_FUNCTION_ARGS_MODE, VALID_UNNAMED_FUNCTION_ARG_TYPES, } from "./constants.js";
 import { compareStrings } from "../collation.js";
+const loadOxfmt = async () => {
+    try {
+        return await import("oxfmt");
+    }
+    catch (error) {
+        throw new Error("oxfmt is not installed. It is an optional peer dependency that only the default formatter needs: install it, or pass a `format` option to generateTypescript.", { cause: error });
+    }
+};
 const defaultFormat = async (code) => {
-    const { code: formatted, errors } = await oxfmtFormat("output.ts", code, {
+    const { format } = await loadOxfmt();
+    const { code: formatted, errors } = await format("output.ts", code, {
         semi: false,
         printWidth: 80,
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supabase/postgrest-typegen",
-  "version": "0.2.5",
+  "version": "0.3.0",
   "description": "Type generation for PostgREST from PostgreSQL schemas",
   "keywords": [
     "codegen",
@@ -62,8 +62,7 @@
     "test": "bun scripts/run-tests.ts test/"
   },
   "dependencies": {
-    "arktype": "2.2.3",
-    "oxfmt": "0.66.0"
+    "arktype": "2.2.3"
   },
   "devDependencies": {
     "@testcontainers/postgresql": "^12.1.0",
@@ -74,12 +73,21 @@
     "@types/node": "^26.3.0",
     "@types/pg": "^8.23.1",
     "knip": "^6.32.3",
+    "oxfmt": "0.66.0",
     "oxlint": "1.83.0",
     "oxlint-tsgolint": "7.0.2002",
     "pg": "^8.23.0",
     "testcontainers": "^12.1.0",
     "typescript": "7.0.2"
   },
+  "peerDependencies": {
+    "oxfmt": "0.66.0"
+  },
+  "peerDependenciesMeta": {
+    "oxfmt": {
+      "optional": true
+    }
+  },
   "engines": {
     "node": ">=22.12.0"
   }

package/src/generation/typescript.ts

@@ -3,7 +3,6 @@
 // literals (relying on Array#toString) to build the output. Preserving that is required for
 // byte-parity, and the offending expressions sit inside template literals where a targeted
 // disable comment would corrupt the emitted string.
-import { format as oxfmtFormat } from "oxfmt";
 import type {
   GeneratorMetadata,
   PostgresColumn,
@@ -39,16 +38,30 @@ export interface GenerateTypescriptOptions {
    */
   defaultSchema?: string;
   /**
-   * Formatter used on the generated output. Defaults to `oxfmt`, called
-   * inline. Callers on a latency-sensitive request path (e.g. postgres-meta's
-   * hosted `/generators/typescript` route) can substitute a worker-pool-backed
+   * Formatter used on the generated output. Defaults to `oxfmt`, an optional
+   * peer dependency that is imported only when this default runs, so callers
+   * that always pass their own formatter need not install it. Callers on a
+   * latency-sensitive request path (e.g. postgres-meta's hosted
+   * `/generators/typescript` route) can substitute a worker-pool-backed
    * formatter here instead of blocking the event loop on every call.
    */
   format?: (code: string) => Promise<string>;
 }
 
+const loadOxfmt = async () => {
+  try {
+    return await import("oxfmt");
+  } catch (error) {
+    throw new Error(
+      "oxfmt is not installed. It is an optional peer dependency that only the default formatter needs: install it, or pass a `format` option to generateTypescript.",
+      { cause: error },
+    );
+  }
+};
+
 const defaultFormat = async (code: string): Promise<string> => {
-  const { code: formatted, errors } = await oxfmtFormat("output.ts", code, {
+  const { format } = await loadOxfmt();
+  const { code: formatted, errors } = await format("output.ts", code, {
     semi: false,
     printWidth: 80,
   });