@supabase/postgrest-typegen 0.2.5 → 0.3.1

package/README.md

@@ -113,19 +113,30 @@ 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' }`         |
+
+Every generator returns the complete contents of the generated file, ending
+with a single newline, so consumers write the result as-is.
+
+`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,11 +145,13 @@ 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
 
-Unlike the rest of this repo, merging a change here does not open a release pull request on its own. Releases are cut on demand: run the `Release postgrest-typegen` workflow from the Actions tab, which runs release-please against `release-please-config.postgrest-typegen.json` and opens (or updates) the release pull request for this package. Merging that pull request tags the release and publishes to npm.
+Unlike the rest of this repo, merging a change here does not open a release pull request on its own. Releases are cut on demand: run the `Release postgrest-typegen` workflow from the Actions tab, which runs release-please against `release-please-config.postgrest-typegen.json` and opens (or updates) the release pull request for this package. Merging that pull request tags the release and publishes to npm. Once npm serves the new version, the same workflow opens a pull request that bumps the exact pin in `packages/typegen`.
 
 ## License
 

package/dist/generation/go.js

@@ -8,8 +8,7 @@ export const generateGo = ({ schemas, tables, views, materializedViews, columns,
         return acc;
     }, {});
     const compositeTypes = types.filter((type) => type.attributes.length > 0);
-    let output = `
-package database
+    let output = `package database
 
 ${tables
         .filter((table) => schemas.some((schema) => schema.name === table.schema))
@@ -30,8 +29,8 @@ ${compositeTypes
         .filter((compositeType) => schemas.some((schema) => schema.name === compositeType.schema))
         .map((compositeType) => generateCompositeTypeStruct(schemas.find((schema) => schema.name === compositeType.schema), compositeType, types))
         .join("\n\n")}
-`.trim();
-    return output;
+`.trimEnd();
+    return `${output}\n`;
 };
 /**
  * Converts a Postgres name to PascalCase.

package/dist/generation/python.js

@@ -16,8 +16,7 @@ export const generatePython = ({ schemas, tables, views, materializedViews, colu
         .map((type) => ctx.typeToClass(type));
     const py_views = views.map((view) => ctx.viewToClass(view));
     const py_matviews = materializedViews.map((matview) => ctx.matViewToClass(matview));
-    let output = `
-from __future__ import annotations
+    let output = `from __future__ import annotations
 
 import datetime
 import uuid
@@ -43,8 +42,8 @@ ${concatLines(py_matviews)}
 
 ${concatLines(composite_types)}
 
-`.trim();
-    return output;
+`.trimEnd();
+    return `${output}\n`;
 };
 class PythonContext {
     types;

package/dist/generation/swift.js

@@ -216,7 +216,7 @@ export const generateSwift = (metadata, opts = {}) => {
             ];
         }),
     ];
-    return output.join("\n");
+    return `${output.join("\n")}\n`;
 };
 // TODO: Make this more robust. Currently doesn't handle range types - returns them as string.
 const pgTypeToSwiftType = (pgType, nullable, { types, views, tables, }) => {

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.1",
   "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",
-    "oxlint": "1.83.0",
+    "oxfmt": "0.66.0",
+    "oxlint": "1.85.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/go.ts

@@ -32,8 +32,7 @@ export const generateGo = ({
 
   const compositeTypes = types.filter((type) => type.attributes.length > 0);
 
-  let output = `
-package database
+  let output = `package database
 
 ${tables
   .filter((table) => schemas.some((schema) => schema.name === table.schema))
@@ -88,9 +87,9 @@ ${compositeTypes
     ),
   )
   .join("\n\n")}
-`.trim();
+`.trimEnd();
 
-  return output;
+  return `${output}\n`;
 };
 
 /**

package/src/generation/python.ts

@@ -38,8 +38,7 @@ export const generatePython = ({
     ctx.matViewToClass(matview),
   );
 
-  let output = `
-from __future__ import annotations
+  let output = `from __future__ import annotations
 
 import datetime
 import uuid
@@ -65,9 +64,9 @@ ${concatLines(py_matviews)}
 
 ${concatLines(composite_types)}
 
-`.trim();
+`.trimEnd();
 
-  return output;
+  return `${output}\n`;
 };
 
 interface Serializable {

package/src/generation/swift.ts

@@ -375,7 +375,7 @@ export const generateSwift = (
     }),
   ];
 
-  return output.join("\n");
+  return `${output.join("\n")}\n`;
 };
 
 // TODO: Make this more robust. Currently doesn't handle range types - returns them as string.

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,
   });