Skip to content

feat: Add option to add generic provider types #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
louis-pre merged 1 commit into from
Sep 13, 2025
Merged

feat: Add option to add generic provider types #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion src/lib/file-generators/custom/[schema_name]/[TableName]CustomTypes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,33 @@ export const createCustomTypesFile = (
moduleSpecifier: `../../generated/${schema.name}/${pascal_table_name}QueryTypes`,
isTypeOnly: true,
},
]

if (table.use_generic_provider) {
statements.push({
kind: StructureKind.ImportDeclaration,
moduleSpecifier: 'lib/spi/provider-model-types',
namedImports: ['ProviderTypes'],
isTypeOnly: true,
})
}

statements.push(
(writer) => writer.blankLine(),
{
kind: StructureKind.TypeAlias,
name: `${pascal_table_name}CustomTypes`,
...(table.use_generic_provider
? {
typeParameters: [
{
name: 'T',
constraint: 'ProviderTypes',
default: 'ProviderTypes',
},
],
}
: {}),
type: `CreateCustomTypes<Selectable${pascal_table_name}, {}>`,
isExported: true,
},
Expand All @@ -47,7 +70,7 @@ export const createCustomTypesFile = (
isExportEquals: false,
expression: `${pascal_table_name}CustomTypes`,
},
]
)

return project.createSourceFile(
`${output_dir}/custom/${schema.name}/${pascal_table_name}CustomTypes.ts`,
Expand Down
60 changes: 56 additions & 4 deletions src/lib/file-generators/generated/[schema_name]/[TableName].ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,14 @@ export const createResultingTypeFile = (
isTypeOnly: true,
},
)
if (table.use_generic_provider) {
statements.push({
kind: StructureKind.ImportDeclaration,
moduleSpecifier: 'lib/spi/provider-model-types',
namedImports: ['ProviderTypes'],
isTypeOnly: true,
})
}
}

statements.push(
Expand All @@ -65,16 +73,38 @@ export const createResultingTypeFile = (
kind: StructureKind.TypeAlias,
isExported: true,
name: pascal_table_name,
...(table.use_generic_provider
? {
typeParameters: [
{
name: 'T',
constraint: 'ProviderTypes',
default: 'ProviderTypes',
},
],
}
: {}),
type: table.is_customizable
? `CustomizeDbType<Selectable${pascal_table_name}, ${pascal_table_name}CustomTypes>`
? `CustomizeDbType<Selectable${pascal_table_name}, ${pascal_table_name}CustomTypes${table.use_generic_provider ? '<T>' : ''}>`
: `Selectable${pascal_table_name}`,
},
{
kind: StructureKind.TypeAlias,
isExported: true,
name: `${pascal_table_name}Initializer`,
...(table.use_generic_provider
? {
typeParameters: [
{
name: 'T',
constraint: 'ProviderTypes',
default: 'ProviderTypes',
},
],
}
: {}),
type: table.is_customizable
? `CustomizeDbTypeInitializer<Insertable${pascal_table_name}, ${pascal_table_name}CustomTypes>`
? `CustomizeDbTypeInitializer<Insertable${pascal_table_name}, ${pascal_table_name}CustomTypes${table.use_generic_provider ? '<T>' : ''}>`
: `Insertable${pascal_table_name}`,
},
)
Expand All @@ -84,7 +114,18 @@ export const createResultingTypeFile = (
kind: StructureKind.TypeAlias,
isExported: true,
name: `${pascal_table_name}WithPgtuiBugs`,
type: `ReproducePgtuiBugs<${pascal_table_name}>`,
...(table.use_generic_provider
? {
typeParameters: [
{
name: 'T',
constraint: 'ProviderTypes',
default: 'ProviderTypes',
},
],
}
: {}),
type: `ReproducePgtuiBugs<${pascal_table_name}${table.use_generic_provider ? '<T>' : ''}>`,
docs: [
{
description: `@deprecated Reproduces type bugs from the legacy \`pgtui\` library and should not be used in new code.\n\nSpecifically:\n- Columns ending in \`_id\` are incorrectly typed as \`string\`, regardless of their actual database type.\n- \`jsonb\` columns are typed as \`any\` instead of a more specific type.`,
Expand All @@ -95,7 +136,18 @@ export const createResultingTypeFile = (
kind: StructureKind.TypeAlias,
isExported: true,
name: `${pascal_table_name}InitializerWithPgtuiBugs`,
type: `ReproducePgtuiBugs<${pascal_table_name}Initializer>`,
...(table.use_generic_provider
? {
typeParameters: [
{
name: 'T',
constraint: 'ProviderTypes',
default: 'ProviderTypes',
},
],
}
: {}),
type: `ReproducePgtuiBugs<${pascal_table_name}Initializer${table.use_generic_provider ? '<T>' : ''}>`,
docs: [
{
description: `@deprecated Reproduces type bugs from the legacy \`pgtui\` library and should not be used in new code.\n\nSpecifically:\n- Columns ending in \`_id\` are incorrectly typed as \`string\`, regardless of their actual database type.\n- \`jsonb\` columns are typed as \`any\` instead of a more specific type.`,
Expand Down
7 changes: 7 additions & 0 deletions src/lib/read-database-tree.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ export const readDatabaseTree = (config: Config): DatabaseTree => {
is_customizable,
is_affected_by_pgtui_bugs,
uses_zapatos_column_type: false,
use_generic_provider: false,
}

table.selectable_columns = getColumns(
Expand All @@ -70,6 +71,12 @@ export const readDatabaseTree = (config: Config): DatabaseTree => {
table,
zapatos_custom_types,
)
if (config.is_generic_provider_enabled === true) {
table.use_generic_provider = Object.prototype.hasOwnProperty.call(
table.selectable_columns,
'provider_state',
)
}

tables[table_name] = table
}
Expand Down
2 changes: 2 additions & 0 deletions src/lib/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ export interface Config {
generate_knex_types?: boolean
main_schema?: string
file_header?: string
is_generic_provider_enabled?: boolean
}

export interface DatabaseTree {
Expand All @@ -24,6 +25,7 @@ export interface Table {
is_customizable: boolean
is_affected_by_pgtui_bugs: boolean
uses_zapatos_column_type: boolean
use_generic_provider: boolean
}

export interface Column {
Expand Down