drizzle-graphql-plus 0.8.7 → 0.8.9

package/src/util/builders/types.ts

@@ -0,0 +1,317 @@
+import type { Column, Relation, SQL, Table } from "drizzle-orm";
+import type { PgArray } from "drizzle-orm/pg-core";
+import type {
+  GraphQLFieldConfigArgumentMap,
+  GraphQLFieldResolver,
+  GraphQLInputObjectType,
+  GraphQLInterfaceType,
+  GraphQLList,
+  GraphQLNonNull,
+  GraphQLObjectType,
+  GraphQLScalarType,
+} from "graphql";
+import type {
+  ConvertedColumn,
+  ConvertedRelationColumnWithArgs,
+} from "../type-converter";
+
+export type TableNamedRelations = {
+  relation: Relation;
+  targetTableName: string;
+};
+
+export type TableSelectArgs = {
+  offset: number;
+  limit: number;
+  where: Filters<Table>;
+  orderBy: OrderByArgs<Table>;
+};
+
+export type ProcessedTableSelectArgs = {
+  columns: Record<string, true>;
+  offset: number;
+  limit: number;
+  where: SQL;
+  orderBy: SQL[];
+  with?: Record<string, Partial<ProcessedTableSelectArgs>>;
+};
+
+export type SelectedColumnsRaw = [string, true][];
+
+export type SelectedSQLColumns = [string, Column][];
+
+export type SelectedColumns = {
+  [columnName in keyof Table["_"]["columns"]]: true;
+};
+
+export type CreatedResolver = {
+  name: string;
+  resolver: GraphQLFieldResolver<any, any>;
+  args: GraphQLFieldConfigArgumentMap;
+};
+
+export type ArgMapToArgsType<TArgMap extends GraphQLFieldConfigArgumentMap> = {
+  [Key in keyof TArgMap]?: TArgMap[Key] extends {
+    type: GraphQLScalarType<infer R, any>;
+  }
+    ? R
+    : never;
+};
+
+export type ColTypeIsNull<
+  TColumn extends Column,
+  TColType
+> = TColumn["_"]["notNull"] extends true ? TColType : TColType | null;
+
+export type ColTypeIsNullOrUndefined<
+  TColumn extends Column,
+  TColType
+> = TColumn["_"]["notNull"] extends true
+  ? TColType
+  : TColType | null | undefined;
+
+export type ColTypeIsNullOrUndefinedWithDefault<
+  TColumn extends Column,
+  TColType
+> = TColumn["_"]["notNull"] extends true
+  ? TColumn["_"]["hasDefault"] extends true
+    ? TColType | null | undefined
+    : TColumn["defaultFn"] extends undefined
+    ? TColType
+    : TColType | null | undefined
+  : TColType | null | undefined;
+
+export type GetColumnGqlDataType<TColumn extends Column> =
+  TColumn["dataType"] extends "boolean"
+    ? ColTypeIsNull<TColumn, boolean>
+    : TColumn["dataType"] extends "json"
+    ? TColumn["_"]["columnType"] extends "PgGeometryObject"
+      ? ColTypeIsNull<
+          TColumn,
+          {
+            x: number;
+            y: number;
+          }
+        >
+      : ColTypeIsNull<TColumn, string>
+    : TColumn["dataType"] extends "date" | "string" | "bigint"
+    ? TColumn["enumValues"] extends [string, ...string[]]
+      ? ColTypeIsNull<TColumn, TColumn["enumValues"][number]>
+      : ColTypeIsNull<TColumn, string>
+    : TColumn["dataType"] extends "number"
+    ? ColTypeIsNull<TColumn, number>
+    : TColumn["dataType"] extends "buffer"
+    ? ColTypeIsNull<TColumn, number[]>
+    : TColumn["dataType"] extends "array"
+    ? TColumn["columnType"] extends "PgVector"
+      ? ColTypeIsNull<TColumn, number[]>
+      : TColumn["columnType"] extends "PgGeometry"
+      ? ColTypeIsNullOrUndefinedWithDefault<TColumn, [number, number]>
+      : ColTypeIsNull<
+          TColumn,
+          Array<
+            GetColumnGqlDataType<
+              TColumn extends { baseColumn: Column }
+                ? TColumn["baseColumn"]
+                : never
+            > extends infer InnerColType
+              ? InnerColType extends null | undefined
+                ? never
+                : InnerColType
+              : never
+          >
+        >
+    : never;
+
+export type GetColumnGqlInsertDataType<TColumn extends Column> =
+  TColumn["dataType"] extends "boolean"
+    ? ColTypeIsNullOrUndefinedWithDefault<TColumn, boolean>
+    : TColumn["dataType"] extends "json"
+    ? TColumn["_"]["columnType"] extends "PgGeometryObject"
+      ? ColTypeIsNullOrUndefinedWithDefault<
+          TColumn,
+          {
+            x: number;
+            y: number;
+          }
+        >
+      : ColTypeIsNullOrUndefinedWithDefault<TColumn, string>
+    : TColumn["dataType"] extends "date" | "string" | "bigint"
+    ? TColumn["enumValues"] extends [string, ...string[]]
+      ? ColTypeIsNullOrUndefinedWithDefault<
+          TColumn,
+          TColumn["enumValues"][number]
+        >
+      : ColTypeIsNullOrUndefinedWithDefault<TColumn, string>
+    : TColumn["dataType"] extends "number"
+    ? ColTypeIsNullOrUndefinedWithDefault<TColumn, number>
+    : TColumn["dataType"] extends "buffer"
+    ? ColTypeIsNullOrUndefinedWithDefault<TColumn, number[]>
+    : TColumn["dataType"] extends "array"
+    ? TColumn["columnType"] extends "PgVector"
+      ? ColTypeIsNullOrUndefinedWithDefault<TColumn, number[]>
+      : TColumn["columnType"] extends "PgGeometry"
+      ? ColTypeIsNullOrUndefinedWithDefault<TColumn, [number, number]>
+      : ColTypeIsNullOrUndefinedWithDefault<
+          TColumn,
+          Array<
+            GetColumnGqlDataType<
+              TColumn extends { baseColumn: Column }
+                ? TColumn["baseColumn"]
+                : never
+            > extends infer InnerColType
+              ? InnerColType extends null | undefined
+                ? never
+                : InnerColType
+              : never
+          >
+        >
+    : never;
+
+export type GetColumnGqlUpdateDataType<TColumn extends Column> =
+  TColumn["dataType"] extends "boolean"
+    ? boolean | null | undefined
+    : TColumn["dataType"] extends "json"
+    ? TColumn["_"]["columnType"] extends "PgGeometryObject"
+      ?
+          | {
+              x: number;
+              y: number;
+            }
+          | null
+          | undefined
+      : string | null | undefined
+    : TColumn["dataType"] extends "date" | "string" | "bigint"
+    ? TColumn["enumValues"] extends [string, ...string[]]
+      ? TColumn["enumValues"][number] | null | undefined
+      : string | null | undefined
+    : TColumn["dataType"] extends "number"
+    ? number | null | undefined
+    : TColumn["dataType"] extends "buffer"
+    ? number[] | null | undefined
+    : TColumn["dataType"] extends "array"
+    ? TColumn["columnType"] extends "PgVector"
+      ? number[] | null | undefined
+      : TColumn["columnType"] extends "PgGeometry"
+      ? [number, number] | null | undefined
+      :
+          | Array<
+              GetColumnGqlDataType<
+                TColumn extends { baseColumn: Column }
+                  ? TColumn["baseColumn"]
+                  : never
+              > extends infer InnerColType
+                ? InnerColType extends null | undefined
+                  ? never
+                  : InnerColType
+                : never
+            >
+          | null
+          | undefined
+    : never;
+
+export type GetRemappedTableDataType<
+  TTable extends Table,
+  TColumns extends TTable["_"]["columns"] = TTable["_"]["columns"]
+> = {
+  [K in keyof TColumns]: GetColumnGqlDataType<TColumns[K]>;
+};
+
+export type GetRemappedTableInsertDataType<TTable extends Table> = {
+  [K in keyof TTable["_"]["columns"]]: GetColumnGqlInsertDataType<
+    TTable["_"]["columns"][K]
+  >;
+};
+
+export type GetRemappedTableUpdateDataType<TTable extends Table> = {
+  [K in keyof TTable["_"]["columns"]]: GetColumnGqlUpdateDataType<
+    TTable["_"]["columns"][K]
+  >;
+};
+
+export type FilterColumnOperatorsCore<
+  TColumn extends Column,
+  TColType = GetColumnGqlDataType<TColumn>
+> = Partial<{
+  eq: TColType;
+  ne: TColType;
+  lt: TColType;
+  lte: TColType;
+  gt: TColType;
+  gte: TColType;
+  like: string;
+  notLike: string;
+  ilike: string;
+  notIlike: string;
+  inArray: Array<TColType>;
+  notInArray: Array<TColType>;
+  isNull: boolean;
+  isNotNull: boolean;
+}>;
+
+export type FilterColumnOperators<
+  TColumn extends Column,
+  TOperators extends FilterColumnOperatorsCore<TColumn> = FilterColumnOperatorsCore<TColumn>
+> = TOperators & {
+  OR?: TOperators[];
+};
+
+export type FiltersCore<TTable extends Table> = Partial<{
+  [Column in keyof TTable["_"]["columns"]]: FilterColumnOperatorsCore<
+    TTable["_"]["columns"][Column]
+  >;
+}>;
+
+export type Filters<
+  TTable extends Table,
+  TFilterType = FiltersCore<TTable>
+> = TFilterType & {
+  OR?: TFilterType[];
+};
+
+export type OrderByArgs<TTable extends Table> = {
+  [Key in keyof TTable["_"]["columns"]]?: {
+    direction: "asc" | "desc";
+    priority: number;
+  };
+};
+
+export type GeneratedTableTypesInputs = {
+  insertInput: GraphQLInputObjectType;
+  updateInput: GraphQLInputObjectType;
+  tableOrder: GraphQLInputObjectType;
+  tableFilters: GraphQLInputObjectType;
+};
+
+export type GeneratedTableTypesOutputs<WithReturning extends boolean> =
+  WithReturning extends true
+    ? {
+        selectSingleOutput: GraphQLObjectType;
+        selectArrOutput: GraphQLNonNull<
+          GraphQLList<GraphQLNonNull<GraphQLObjectType>>
+        >;
+        singleTableItemOutput: GraphQLObjectType;
+        arrTableItemOutput: GraphQLNonNull<
+          GraphQLList<GraphQLNonNull<GraphQLObjectType>>
+        >;
+        tableFieldsInterface: GraphQLInterfaceType;
+      }
+    : {
+        selectSingleOutput: GraphQLObjectType;
+        selectArrOutput: GraphQLNonNull<
+          GraphQLList<GraphQLNonNull<GraphQLObjectType>>
+        >;
+        tableFieldsInterface: GraphQLInterfaceType;
+      };
+
+export type GeneratedTableTypes<WithReturning extends boolean> = {
+  inputs: GeneratedTableTypesInputs;
+  outputs: GeneratedTableTypesOutputs<WithReturning>;
+};
+
+export type SelectData<TWithOrder extends boolean> = {
+  filters: GraphQLInputObjectType;
+  tableFields: Record<string, ConvertedColumn>;
+  relationFields: Record<string, ConvertedRelationColumnWithArgs>;
+  order: TWithOrder extends true ? GraphQLInputObjectType : undefined;
+};

package/src/util/case-ops/index.ts

@@ -0,0 +1,9 @@
+export const uncapitalize = <T extends string>(input: T) =>
+	(input.length
+		? `${input[0]!.toLocaleLowerCase()}${input.length > 1 ? input.slice(1, input.length) : ''}`
+		: input) as Uncapitalize<T>;
+
+export const capitalize = <T extends string>(input: T) =>
+	(input.length
+		? `${input[0]!.toLocaleUpperCase()}${input.length > 1 ? input.slice(1, input.length) : ''}`
+		: input) as Capitalize<T>;

package/src/util/data-mappers/index.ts

@@ -0,0 +1,162 @@
+import { type Column, getTableColumns, type Table } from 'drizzle-orm';
+import { GraphQLError } from 'graphql';
+import { TableNamedRelations } from '../builders';
+
+export const remapToGraphQLCore = (
+	key: string,
+	value: any,
+	tableName: string,
+	column: Column,
+	relationMap?: Record<string, Record<string, TableNamedRelations>>,
+): any => {
+	if (value instanceof Date) return value.toISOString();
+
+	if (value instanceof Buffer) return Array.from(value);
+
+	if (typeof value === 'bigint') return value.toString();
+
+	if (Array.isArray(value)) {
+		const relations = relationMap?.[tableName];
+		if (relations?.[key]) {
+			return remapToGraphQLArrayOutput(
+				value,
+				relations[key]!.targetTableName,
+				relations[key]!.relation.referencedTable,
+				relationMap,
+			);
+		}
+		if (column.columnType === 'PgGeometry' || column.columnType === 'PgVector') return value;
+
+		return value.map((arrVal) => remapToGraphQLCore(key, arrVal, tableName, column, relationMap));
+	}
+
+	if (typeof value === 'object') {
+		const relations = relationMap?.[tableName];
+		if (relations?.[key]) {
+			return remapToGraphQLSingleOutput(
+				value,
+				relations[key]!.targetTableName,
+				relations[key]!.relation.referencedTable,
+				relationMap,
+			);
+		}
+		if (column.columnType === 'PgGeometryObject') return value;
+
+		return JSON.stringify(value);
+	}
+
+	return value;
+};
+
+export const remapToGraphQLSingleOutput = (
+	queryOutput: Record<string, any>,
+	tableName: string,
+	table: Table,
+	relationMap?: Record<string, Record<string, TableNamedRelations>>,
+) => {
+	for (const [key, value] of Object.entries(queryOutput)) {
+		if (value === undefined || value === null) {
+			delete queryOutput[key];
+		} else {
+			queryOutput[key] = remapToGraphQLCore(key, value, tableName, table[key as keyof Table]! as Column, relationMap);
+		}
+	}
+
+	return queryOutput;
+};
+
+export const remapToGraphQLArrayOutput = (
+	queryOutput: Record<string, any>[],
+	tableName: string,
+	table: Table,
+	relationMap?: Record<string, Record<string, TableNamedRelations>>,
+) => {
+	for (const entry of queryOutput) {
+		remapToGraphQLSingleOutput(entry, tableName, table, relationMap);
+	}
+
+	return queryOutput;
+};
+
+export const remapFromGraphQLCore = (value: any, column: Column, columnName: string) => {
+	switch (column.dataType) {
+		case 'date': {
+			const formatted = new Date(value);
+			if (Number.isNaN(formatted.getTime())) throw new GraphQLError(`Field '${columnName}' is not a valid date!`);
+
+			return formatted;
+		}
+
+		case 'buffer': {
+			if (!Array.isArray(value)) {
+				throw new GraphQLError(`Field '${columnName}' is not an array!`);
+			}
+
+			return Buffer.from(value);
+		}
+
+		case 'json': {
+			if (column.columnType === 'PgGeometryObject') return value;
+
+			try {
+				return JSON.parse(value);
+			} catch (e) {
+				throw new GraphQLError(
+					`Invalid JSON in field '${columnName}':\n${e instanceof Error ? e.message : 'Unknown error'}`,
+				);
+			}
+		}
+
+		case 'array': {
+			if (!Array.isArray(value)) {
+				throw new GraphQLError(`Field '${columnName}' is not an array!`);
+			}
+
+			if (column.columnType === 'PgGeometry' && value.length !== 2) {
+				throw new GraphQLError(
+					`Invalid float tuple in field '${columnName}': expected array with length of 2, received ${value.length}`,
+				);
+			}
+
+			return value;
+		}
+
+		case 'bigint': {
+			try {
+				return BigInt(value);
+			} catch (error) {
+				throw new GraphQLError(`Field '${columnName}' is not a BigInt!`);
+			}
+		}
+
+		default: {
+			return value;
+		}
+	}
+};
+
+export const remapFromGraphQLSingleInput = (queryInput: Record<string, any>, table: Table) => {
+	for (const [key, value] of Object.entries(queryInput)) {
+		if (value === undefined) {
+			delete queryInput[key];
+		} else {
+			const column = getTableColumns(table)[key];
+			if (!column) throw new GraphQLError(`Unknown column: ${key}`);
+
+			if (value === null && column.notNull) {
+				delete queryInput[key];
+				continue;
+			}
+
+			queryInput[key] = remapFromGraphQLCore(value, column, key);
+		}
+	}
+
+	return queryInput;
+};
+
+export const remapFromGraphQLArrayInput = (queryInput: Record<string, any>[], table: Table) => {
+	for (const entry of queryInput) remapFromGraphQLSingleInput(entry, table);
+
+	return queryInput;
+};

package/src/util/type-converter/index.ts

@@ -0,0 +1,148 @@
+import { is } from 'drizzle-orm';
+import { MySqlInt, MySqlSerial } from 'drizzle-orm/mysql-core';
+import { PgInteger, PgSerial } from 'drizzle-orm/pg-core';
+import { SQLiteInteger } from 'drizzle-orm/sqlite-core';
+import {
+	GraphQLBoolean,
+	GraphQLEnumType,
+	GraphQLFloat,
+	GraphQLInputObjectType,
+	GraphQLInt,
+	GraphQLList,
+	GraphQLNonNull,
+	GraphQLObjectType,
+	GraphQLScalarType,
+	GraphQLString,
+} from 'graphql';
+
+import type { Column } from 'drizzle-orm';
+import type { PgArray } from 'drizzle-orm/pg-core';
+import { capitalize } from '../case-ops';
+import type { ConvertedColumn } from './types';
+
+const allowedNameChars = /^[a-zA-Z0-9_]+$/;
+
+const enumMap = new WeakMap<Object, GraphQLEnumType>();
+const generateEnumCached = (column: Column, columnName: string, tableName: string): GraphQLEnumType => {
+	if (enumMap.has(column)) return enumMap.get(column)!;
+
+	const gqlEnum = new GraphQLEnumType({
+		name: `${capitalize(tableName)}${capitalize(columnName)}Enum`,
+		values: Object.fromEntries(column.enumValues!.map((e, index) => [allowedNameChars.test(e) ? e : `Option${index}`, {
+			value: e,
+			description: `Value: ${e}`,
+		}])),
+	});
+
+	enumMap.set(column, gqlEnum);
+
+	return gqlEnum;
+};
+
+const geoXyType = new GraphQLObjectType({
+	name: 'PgGeometryObject',
+	fields: {
+		x: { type: GraphQLFloat },
+		y: { type: GraphQLFloat },
+	},
+});
+
+const geoXyInputType = new GraphQLInputObjectType({
+	name: 'PgGeometryObjectInput',
+	fields: {
+		x: { type: GraphQLFloat },
+		y: { type: GraphQLFloat },
+	},
+});
+
+const columnToGraphQLCore = (
+	column: Column,
+	columnName: string,
+	tableName: string,
+	isInput: boolean,
+): ConvertedColumn<boolean> => {
+	switch (column.dataType) {
+		case 'boolean':
+			return { type: GraphQLBoolean, description: 'Boolean' };
+		case 'json':
+			return column.columnType === 'PgGeometryObject'
+				? {
+					type: isInput ? geoXyInputType : geoXyType,
+					description: 'Geometry points XY',
+				}
+				: { type: GraphQLString, description: 'JSON' };
+		case 'date':
+			return { type: GraphQLString, description: 'Date' };
+		case 'string':
+			if (column.enumValues?.length) return { type: generateEnumCached(column, columnName, tableName) };
+
+			return { type: GraphQLString, description: 'String' };
+		case 'bigint':
+			return { type: GraphQLString, description: 'BigInt' };
+		case 'number':
+			return is(column, PgInteger)
+					|| is(column, PgSerial)
+					|| is(column, MySqlInt)
+					|| is(column, MySqlSerial)
+					|| is(column, SQLiteInteger)
+				? { type: GraphQLInt, description: 'Integer' }
+				: { type: GraphQLFloat, description: 'Float' };
+		case 'buffer':
+			return { type: new GraphQLList(new GraphQLNonNull(GraphQLInt)), description: 'Buffer' };
+		case 'array': {
+			if (column.columnType === 'PgVector') {
+				return {
+					type: new GraphQLList(new GraphQLNonNull(GraphQLFloat)),
+					description: 'Array<Float>',
+				};
+			}
+
+			if (column.columnType === 'PgGeometry') {
+				return {
+					type: new GraphQLList(new GraphQLNonNull(GraphQLFloat)),
+					description: 'Tuple<[Float, Float]>',
+				};
+			}
+
+			const innerType = columnToGraphQLCore(
+				(column as Column as PgArray<any, any>).baseColumn,
+				columnName,
+				tableName,
+				isInput,
+			);
+
+			return {
+				type: new GraphQLList(new GraphQLNonNull(innerType.type as GraphQLScalarType)),
+				description: `Array<${innerType.description}>`,
+			};
+		}
+		case 'custom':
+		default:
+			throw new Error(`Drizzle-GraphQL Error: Type ${column.dataType} is not implemented!`);
+	}
+};
+
+export const drizzleColumnToGraphQLType = <TColumn extends Column, TIsInput extends boolean>(
+	column: TColumn,
+	columnName: string,
+	tableName: string,
+	forceNullable = false,
+	defaultIsNullable = false,
+	isInput: TIsInput = false as TIsInput,
+): ConvertedColumn<TIsInput> => {
+	const typeDesc = columnToGraphQLCore(column, columnName, tableName, isInput);
+	const noDesc = ['string', 'boolean', 'number'];
+	if (noDesc.find((e) => e === column.dataType)) delete typeDesc.description;
+
+	if (forceNullable) return typeDesc as ConvertedColumn<TIsInput>;
+	if (column.notNull && !(defaultIsNullable && (column.hasDefault || column.defaultFn))) {
+		return {
+			type: new GraphQLNonNull(typeDesc.type),
+			description: typeDesc.description,
+		} as ConvertedColumn<TIsInput>;
+	}
+
+	return typeDesc as ConvertedColumn<TIsInput>;
+};
+
+export * from './types';

package/src/util/type-converter/types.ts

@@ -0,0 +1,54 @@
+import type {
+	GraphQLEnumType,
+	GraphQLFieldConfig,
+	GraphQLInputObjectType,
+	GraphQLList,
+	GraphQLNonNull,
+	GraphQLObjectType,
+	GraphQLScalarType,
+} from 'graphql';
+
+export type ConvertedColumn<TIsInput extends boolean = false> = {
+	type:
+		| GraphQLScalarType
+		| GraphQLEnumType
+		| GraphQLNonNull<GraphQLScalarType>
+		| GraphQLNonNull<GraphQLEnumType>
+		| GraphQLList<GraphQLScalarType>
+		| GraphQLList<GraphQLNonNull<GraphQLScalarType>>
+		| GraphQLNonNull<GraphQLList<GraphQLScalarType>>
+		| GraphQLNonNull<GraphQLList<GraphQLNonNull<GraphQLScalarType>>>
+		| (TIsInput extends true ? 
+				| GraphQLInputObjectType
+				| GraphQLNonNull<GraphQLInputObjectType>
+				| GraphQLList<GraphQLInputObjectType>
+				| GraphQLNonNull<GraphQLList<GraphQLInputObjectType>>
+				| GraphQLNonNull<GraphQLList<GraphQLNonNull<GraphQLInputObjectType>>>
+			: 
+				| GraphQLObjectType
+				| GraphQLNonNull<GraphQLObjectType>
+				| GraphQLList<GraphQLObjectType>
+				| GraphQLNonNull<GraphQLList<GraphQLObjectType>>
+				| GraphQLNonNull<GraphQLList<GraphQLNonNull<GraphQLObjectType>>>);
+	description?: string;
+};
+
+export type ConvertedColumnWithArgs = ConvertedColumn & {
+	args?: GraphQLFieldConfig<any, any>['args'];
+};
+
+export type ConvertedInputColumn = {
+	type: GraphQLInputObjectType;
+	description?: string;
+};
+
+export type ConvertedRelationColumn = {
+	type:
+		| GraphQLObjectType
+		| GraphQLNonNull<GraphQLObjectType>
+		| GraphQLNonNull<GraphQLList<GraphQLNonNull<GraphQLObjectType>>>;
+};
+
+export type ConvertedRelationColumnWithArgs = ConvertedRelationColumn & {
+	args?: GraphQLFieldConfig<any, any>['args'];
+};