feat: add option to ignore enum values when generating pg types (#339)

Author: ForbesLindesay

packages/pg-config/src/PgConfig.ts

@@ -313,6 +313,17 @@ export interface TypesConfig {
    * @default []
    */
   ignoreTables: string[];
+
+  /**
+   * Enum values to exclude from generated types.
+   * This can be useful when you know you have no records
+   * that use an enum value anymore, but cannot remove it
+   * from the database type because the migration would be
+   * too costly.
+   *
+   * @default {}
+   */
+  ignoreEnumValues: Record<string, string[] | undefined>;
 }
 
 export const TypesConfigSchema: ft.Runtype<TypesConfig> = ft
@@ -380,6 +391,11 @@ export const TypesConfigSchema: ft.Runtype<TypesConfig> = ft
     ),
 
     ignoreTables: withDefault<string[]>(ft.Array(ft.String), []),
+
+    ignoreEnumValues: withDefault<Record<string, string[] | undefined>>(
+      ft.Record(ft.String, ft.Array(ft.String)),
+      {},
+    ),
   })
   .withConstraint((value) => true, {name: `TypesConfig`});
 

packages/pg-config/src/__tests__/index.test.ts

@@ -19,6 +19,7 @@ test('get root config', () => {
       enumFileName: '_enums.ts',
       enumTypeMode: 'union_alias',
       enumTypeName: '{{ TYPE_NAME | pascal-case }}',
+      ignoreEnumValues: {},
       ignoreTables: [],
       includeTables: null,
       primaryKeyFileName: '{{ TABLE_NAME }}.ts',
@@ -62,6 +63,7 @@ test('valid config', () => {
       enumFileName: '_enums.ts',
       enumTypeMode: 'union_alias',
       enumTypeName: '{{ TYPE_NAME | pascal-case }}',
+      ignoreEnumValues: {},
       ignoreTables: [],
       includeTables: null,
       primaryKeyFileName: '{{ TABLE_NAME }}.ts',
@@ -102,6 +104,7 @@ test('valid config', () => {
       enumFileName: '_enums.ts',
       enumTypeMode: 'union_alias',
       enumTypeName: '{{ TYPE_NAME | pascal-case }}',
+      ignoreEnumValues: {},
       ignoreTables: [],
       includeTables: null,
       primaryKeyFileName: '{{ TABLE_NAME }}.ts',

packages/pg-schema-print-types/src/index.ts

@@ -1,6 +1,6 @@
 import PgConfig from '@databases/pg-config';
 import PgDataTypeID from '@databases/pg-data-type-id';
-import type {Schema} from '@databases/pg-schema-introspect';
+import {TypeKind, type Schema} from '@databases/pg-schema-introspect';
 import {getIgnoreTest, writeFiles} from '@databases/shared-print-types';
 import PgPrintContext from './PgPrintContext';
 import getTypeScriptType from './getTypeScriptType';
@@ -21,6 +21,15 @@ function filterSchema(unfilteredSchema: Schema, options: Options): Schema {
   );
   return {
     ...unfilteredSchema,
+    types: unfilteredSchema.types.map((t) => {
+      if (t.kind !== TypeKind.Enum) return t;
+      const ignoredValues = options.ignoreEnumValues?.[t.typeName];
+      if (!ignoredValues?.length) return t;
+      return {
+        ...t,
+        values: t.values.filter((v) => !ignoredValues.includes(v)),
+      };
+    }),
     classes: unfilteredSchema.classes
       .filter((c) => !ignoredClassIds.has(c.classID))
       .map((c) => ({