Skip to content

Add configurable suffixes for GraphQL naming #41

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add configurable suffixes for GraphQL naming #41

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
17 changes: 14 additions & 3 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,24 @@ export const buildSchema = <TDbClient extends AnyDrizzleDB<any>>(
}
}

const suffixes = {
list: config?.suffixes?.list ?? '',
single: config?.suffixes?.single ?? 'Single',
};

if (suffixes.list === suffixes.single) {
throw new Error(
'Drizzle-GraphQL Error: List and single query suffixes cannot be the same. This would create conflicting GraphQL field names.',
);
}

let generatorOutput;
if (is(db, MySqlDatabase)) {
generatorOutput = generateMySQL(db, schema, config?.relationsDepthLimit);
generatorOutput = generateMySQL(db, schema, config?.relationsDepthLimit, suffixes);
} else if (is(db, PgDatabase)) {
generatorOutput = generatePG(db, schema, config?.relationsDepthLimit);
generatorOutput = generatePG(db, schema, config?.relationsDepthLimit, suffixes);
} else if (is(db, BaseSQLiteDatabase)) {
generatorOutput = generateSQLite(db, schema, config?.relationsDepthLimit);
generatorOutput = generateSQLite(db, schema, config?.relationsDepthLimit, suffixes);
} else throw new Error('Drizzle-GraphQL Error: Unknown database instance type');

const { queries, mutations, inputs, types } = generatorOutput;
Expand Down
11 changes: 11 additions & 0 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,4 +414,15 @@ export type BuildSchemaConfig = {
* Value is treated as if set to `undefined` by default.
*/
relationsDepthLimit?: number;
/**
* Customizes query name suffixes for generated GraphQL operations.
*
* @default { list: '', single: 'Single' }
*/
suffixes?: {
/** Suffix for list queries (e.g., 'users' -> 'users' + suffix) */
list?: string;
/** Suffix for single queries (e.g., 'users' -> 'users' + suffix) */
single?: string;
};
};
9 changes: 7 additions & 2 deletions src/util/builders/mysql.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,9 @@ const generateSelectArray = (
relationMap: Record<string, Record<string, TableNamedRelations>>,
orderArgs: GraphQLInputObjectType,
filterArgs: GraphQLInputObjectType,
listSuffix: string,
): CreatedResolver => {
const queryName = `${uncapitalize(tableName)}`;
const queryName = `${uncapitalize(tableName)}${listSuffix}`;
const queryBase = db.query[tableName as keyof typeof db.query] as unknown as
| RelationalQueryBuilder<any, any, any>
| undefined;
Expand Down Expand Up @@ -114,8 +115,9 @@ const generateSelectSingle = (
relationMap: Record<string, Record<string, TableNamedRelations>>,
orderArgs: GraphQLInputObjectType,
filterArgs: GraphQLInputObjectType,
singleSuffix: string,
): CreatedResolver => {
const queryName = `${uncapitalize(tableName)}Single`;
const queryName = `${uncapitalize(tableName)}${singleSuffix}`;
const queryBase = db.query[tableName as keyof typeof db.query] as unknown as
| RelationalQueryBuilder<any, any, any>
| undefined;
Expand Down Expand Up @@ -346,6 +348,7 @@ export const generateSchemaData = <
db: TDrizzleInstance,
schema: TSchema,
relationsDepthLimit: number | undefined,
suffixes: { list: string; single: string },
): GeneratedEntities<TDrizzleInstance, TSchema> => {
const rawSchema = schema;
const schemaEntries = Object.entries(rawSchema);
Expand Down Expand Up @@ -424,6 +427,7 @@ export const generateSchemaData = <
namedRelations,
tableOrder,
tableFilters,
suffixes.list,
);
const selectSingleGenerated = generateSelectSingle(
db,
Expand All @@ -432,6 +436,7 @@ export const generateSchemaData = <
namedRelations,
tableOrder,
tableFilters,
suffixes.single,
);
const insertArrGenerated = generateInsertArray(db, tableName, schema[tableName] as MySqlTable, insertInput);
const insertSingleGenerated = generateInsertSingle(db, tableName, schema[tableName] as MySqlTable, insertInput);
Expand Down
9 changes: 7 additions & 2 deletions src/util/builders/pg.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,9 @@ const generateSelectArray = (
relationMap: Record<string, Record<string, TableNamedRelations>>,
orderArgs: GraphQLInputObjectType,
filterArgs: GraphQLInputObjectType,
listSuffix: string,
): CreatedResolver => {
const queryName = `${uncapitalize(tableName)}`;
const queryName = `${uncapitalize(tableName)}${listSuffix}`;
const queryBase = db.query[tableName as keyof typeof db.query] as unknown as
| RelationalQueryBuilder<any, any, any>
| undefined;
Expand Down Expand Up @@ -114,8 +115,9 @@ const generateSelectSingle = (
relationMap: Record<string, Record<string, TableNamedRelations>>,
orderArgs: GraphQLInputObjectType,
filterArgs: GraphQLInputObjectType,
singleSuffix: string,
): CreatedResolver => {
const queryName = `${uncapitalize(tableName)}Single`;
const queryName = `${uncapitalize(tableName)}${singleSuffix}`;
const queryBase = db.query[tableName as keyof typeof db.query] as unknown as
| RelationalQueryBuilder<any, any, any>
| undefined;
Expand Down Expand Up @@ -394,6 +396,7 @@ export const generateSchemaData = <
db: TDrizzleInstance,
schema: TSchema,
relationsDepthLimit: number | undefined,
suffixes: { list: string; single: string },
): GeneratedEntities<TDrizzleInstance, TSchema> => {
const rawSchema = schema;
const schemaEntries = Object.entries(rawSchema);
Expand Down Expand Up @@ -464,6 +467,7 @@ export const generateSchemaData = <
namedRelations,
tableOrder,
tableFilters,
suffixes.list,
);
const selectSingleGenerated = generateSelectSingle(
db,
Expand All @@ -472,6 +476,7 @@ export const generateSchemaData = <
namedRelations,
tableOrder,
tableFilters,
suffixes.single,
);
const insertArrGenerated = generateInsertArray(db, tableName, schema[tableName] as PgTable, insertInput);
const insertSingleGenerated = generateInsertSingle(db, tableName, schema[tableName] as PgTable, insertInput);
Expand Down
9 changes: 7 additions & 2 deletions src/util/builders/sqlite.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,9 @@ const generateSelectArray = (
relationMap: Record<string, Record<string, TableNamedRelations>>,
orderArgs: GraphQLInputObjectType,
filterArgs: GraphQLInputObjectType,
listSuffix: string,
): CreatedResolver => {
const queryName = `${uncapitalize(tableName)}`;
const queryName = `${uncapitalize(tableName)}${listSuffix}`;
const queryBase = db.query[tableName as keyof typeof db.query] as unknown as
| RelationalQueryBuilder<any, any, any>
| undefined;
Expand Down Expand Up @@ -114,8 +115,9 @@ const generateSelectSingle = (
relationMap: Record<string, Record<string, TableNamedRelations>>,
orderArgs: GraphQLInputObjectType,
filterArgs: GraphQLInputObjectType,
singleSuffix: string,
): CreatedResolver => {
const queryName = `${uncapitalize(tableName)}Single`;
const queryName = `${uncapitalize(tableName)}${singleSuffix}`;
const queryBase = db.query[tableName as keyof typeof db.query] as unknown as
| RelationalQueryBuilder<any, any, any>
| undefined;
Expand Down Expand Up @@ -395,6 +397,7 @@ export const generateSchemaData = <
db: TDrizzleInstance,
schema: TSchema,
relationsDepthLimit: number | undefined,
suffixes: { list: string; single: string },
): GeneratedEntities<TDrizzleInstance, TSchema> => {
const rawSchema = schema;
const schemaEntries = Object.entries(rawSchema);
Expand Down Expand Up @@ -465,6 +468,7 @@ export const generateSchemaData = <
namedRelations,
tableOrder,
tableFilters,
suffixes.list,
);
const selectSingleGenerated = generateSelectSingle(
db,
Expand All @@ -473,6 +477,7 @@ export const generateSchemaData = <
namedRelations,
tableOrder,
tableFilters,
suffixes.single,
);
const insertArrGenerated = generateInsertArray(db, tableName, schema[tableName] as SQLiteTable, insertInput);
const insertSingleGenerated = generateInsertSingle(db, tableName, schema[tableName] as SQLiteTable, insertInput);
Expand Down