chore(deps): update dependency kysely-codegen to v0.20.0

[renovate]

This PR contains the following updates:

Package	Change	Age	Confidence
kysely-codegen	0.18.5 → 0.20.0

---

Release Notes

RobinBlomberg/kysely-codegen (kysely-codegen)

v0.20.0

Compare Source

Many great contributions, bug fixes and new features.

Resolves #​284, #​287, #​307, #​308, #​72, #​301, #​275, #​283.

defineConfig() and postprocess()

kysely-codegen@​0.20.0 adds a defineConfig function that makes it easy to configure kysely-codegen in a type-safe way. It also adds a new Config#postprocess function that makes it possible to process the introspected metadata before generating code. This function allows you to reuse the active kysely-codegen connection to further introspect the database and modify the metadata as needed.

Example of generating enum types from PostGraphile enum tables:

import { sql } from "kysely";
import { defineConfig } from "kysely-codegen";
import pluralize from "pluralize";

export default defineConfig({
  camelCase: false,
  dateParser: "timestamp",
  dialect: "postgres",
  excludePattern: "(graphile_migrate.*|graphile_worker._private_*)",
  outFile: "./types/database-types.ts",
  postprocess: async ({ db, metadata }) => {
    const rows = await db
      .selectFrom("pg_catalog.pg_constraint as foreign_key_constraint")
      .innerJoin(
        "pg_catalog.pg_class as from_table",
        "from_table.oid",
        "foreign_key_constraint.conrelid",
      )
      .innerJoin(
        "pg_catalog.pg_namespace as from_table_namespace",
        "from_table_namespace.oid",
        "from_table.relnamespace",
      )
      .innerJoin("pg_catalog.pg_attribute as from_column", (join) =>
        join
          .onRef("from_column.attrelid", "=", "from_table.oid")
          .on(sql`from_column.attnum = any(foreign_key_constraint.conkey)`),
      )
      .innerJoin(
        "pg_catalog.pg_class as to_table",
        "to_table.oid",
        "foreign_key_constraint.confrelid",
      )
      .innerJoin(
        "pg_catalog.pg_namespace as to_table_namespace",
        "to_table_namespace.oid",
        "to_table.relnamespace",
      )
      .innerJoin("pg_catalog.pg_attribute as to_column", (join) =>
        join
          .onRef("to_column.attrelid", "=", "to_table.oid")
          .on(sql`to_column.attnum = any(foreign_key_constraint.confkey)`),
      )
      .select([
        "from_table_namespace.nspname as fromSchema",
        "from_table.relname as fromTable",
        "from_column.attname as fromColumn",
        "to_table_namespace.nspname as enumSchema",
        "to_table.relname as enumTable",
        "to_column.attname as enumColumn",
      ])
      .where("foreign_key_constraint.contype", "=", "f")
      .where(sql<any>`obj_description(to_table.oid, 'pg_class') like '%@&#8203;enum%'`)
      .execute();

    await Promise.all(
      rows.map(
        async ({
          fromColumn,
          fromSchema,
          fromTable,
          enumColumn,
          enumSchema,
          enumTable,
        }) => {
          const fromTableMetadata = metadata.tables.find(
            (table) => table.schema === fromSchema && table.name === fromTable,
          );
          const fromColumnMetadata = fromTableMetadata?.columns.find(
            (column) => column.name === fromColumn,
          );
          const enumTableMetadata = metadata.tables.find(
            (table) => table.schema === enumSchema && table.name === enumTable,
          );
          const enumColumnMetadata = enumTableMetadata?.columns.find(
            (column) => column.name === enumColumn,
          );

          if (fromColumnMetadata || enumColumnMetadata) {
            const dataType = `${pluralize.singular(enumTable)}.${enumColumn}`;
            const enumValues = await db
              .selectFrom(`${enumSchema}.${enumTable}`)
              .select(enumColumn)
              .execute()
              .then((rows) =>
                rows.map((row) => (row as Record<string, string>)[enumColumn]),
              );

            metadata.enums.set(`${enumSchema}.${dataType}`, enumValues);

            if (fromColumnMetadata) {
              fromColumnMetadata.dataTypeSchema = enumSchema;
              fromColumnMetadata.dataType = dataType;
            }

            if (enumColumnMetadata) {
              enumColumnMetadata.dataTypeSchema = enumSchema;
              enumColumnMetadata.dataType = dataType;
            }
          }
        },
      ),
    );

    return metadata;
  },
  singularize: true,
  url: process.env.DATABASE_URL,
});

Example output:

+type EventTypeName = "TICKET_CREATED" | "TICKET_DELETED" | "TICKET_UPDATED";
+
 type Event = {
   createdAt: Generated<Timestamp>;
   data: JsonValue;
-  type: string;
+  type: EventTypeName;
 };

 type EventType = {
   description: string;
-  name: string;
+  name: EventTypeName;
 };

What's Changed

• feat: update @tediousjs/connection-string to 1.0.0 by @​bakasmarius in #​312
• replace git-diff with diff by @​paolostyle in #​306
• feat(generator): Add support for generate symbol with CJK character by @​lightrabbit in #​313
• allow 'sqlite://' prefix in database url by @​R4stafa in #​302
• fix: resolve flaky CLI tests and add GitHub Actions CI by @​elitan in #​297
• feat: add PostgreSQL materialized view support by @​elitan in #​298
• feat: add uuid as string in mariadb by @​AwaludinAR in #​308
• Add support for 'timetz' type in PostgresAdapter by @​bombillazo in #​291
• Support subpath imports for named imports by @​alex-kinokon in #​290
• fix(GH-287): Fix for generic type imports by @​kevinmichaelchen in #​288
• support nullable override types by @​itamar82 in #​286
• feat: Add defineConfig() function for type-safe TypeScript configs
• feat: Add Config#postprocess() function
• feat: Silence dotenv tips

New Contributors

• @​paolostyle made their first contribution in #​306
• @​lightrabbit made their first contribution in #​313
• @​R4stafa made their first contribution in #​302
• @​AwaludinAR made their first contribution in #​308
• @​alex-kinokon made their first contribution in #​290
• @​itamar82 made their first contribution in #​286

Full Changelog: RobinBlomberg/kysely-codegen@0.19.0...0.20.0

v0.19.0

New features

Thanks to amazing contributions from @​kevinmichaelchen in #​274, you can now override types on a global level:

.kysely-codegenrc.json

{
  "customImports": {
    "InstantRange": "./custom-types",
    "CustomDuration": "@​my-org/custom-types#Duration",
    "Temporal": "@​js-temporal/polyfill",
  },
  "typeMapping": {
    "timestamptz": "Temporal.Instant",
    "tstzrange": "InstantRange",
    "date": "Temporal.PlainDate",
    "interval": "CustomDuration"
  }
}

Example of generated output:

import type { InstantRange } from './custom-types';
import type { Duration as CustomDuration } from '@​my-org/custom-types';
import type { Temporal } from '@​js-temporal/polyfill';

export interface EventModel {
  createdAt: Temporal.Instant;
  dateRange: ColumnType<InstantRange, InstantRange, never>;
  eventDate: Temporal.PlainDate;
  interval: CustomDuration;
}

export interface DB {
  events: EventModel;
}

What's Changed

• fix(GH-240): crash caused by undeclared dependency by @​FaberVitale in #​241
• chore(deps): allow kysely 0.28.0 and tedious 19 by @​belgattitude in #​256
• feat: export config types by @​Omar-Awawdeh in #​252
• chore(pnpm): pnpm v10.9.0, set onlyBuiltDependencies by @​belgattitude in #​254
• README: Pin @​tediousjs/connection-string to 0.5.0 by @​yuriy-sng in #​279
• Fix peer dep range by @​joefatora in #​268
• Add missing cli arg "config-file" to documentation by @​SimonSimCity in #​263
• Fix inconsistencies between VS Code settings and Prettier configuration by @​anonpay-sh in #​265
• feat: Support imports for custom types by @​kevinmichaelchen in #​274

New Contributors

• @​FaberVitale made their first contribution in #​241
• @​belgattitude made their first contribution in #​256
• @​Omar-Awawdeh made their first contribution in #​252
• @​yuriy-sng made their first contribution in #​279
• @​joefatora made their first contribution in #​268
• @​SimonSimCity made their first contribution in #​263
• @​anonpay-sh made their first contribution in #​265
• @​kevinmichaelchen made their first contribution in #​274

Full Changelog: RobinBlomberg/kysely-codegen@0.18.0...0.19.0

---

Configuration

📅 Schedule: (UTC)

• Branch creation
  • At any time (no schedule defined)
• Automerge
  • At any time (no schedule defined)

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.