@vantreeseba/drizzle-graphql 7.1.0 → 7.2.0

package/README.md

@@ -124,6 +124,60 @@ const { schema } = buildSchema(db, {
     `mutations: false`
 -   List and single queries are always generated, so `Query` is never empty
 
+## Excluding tables and columns
+
+`features` decides which *kinds* of operation exist. `exclude` decides which tables and
+columns exist at all — for the table holding session tokens, or the column holding a
+password hash:
+
+```Typescript
+const { schema } = buildSchema(db, {
+    exclude: {
+        tables: ['magicLinks', 'sessions'],
+        columns: { apiKeys: ['keyHash'] },
+    },
+})
+```
+
+Both lists are keyed by the **Drizzle schema key**, not the database name and not the
+generated GraphQL name.
+
+An excluded **table** generates nothing: no object type, no queries, no mutations, no
+aggregates, and no relation field on any other table that points at it. `Users.sessions`
+is gone, and so is `users(where: { sessions: { … } })` — the table is unreachable, not
+merely unnamed.
+
+An excluded **column** disappears from every surface at once:
+
+| Surface | Effect |
+| --- | --- |
+| `<Type>` object type | field removed |
+| `Create<Type>Input` / `Update<Type>Input` | field removed (nested-write payloads too) |
+| `<Type>Filters` | field removed |
+| `<Type>OrderBy` | field removed |
+| `<Type>MinAggregate` / `<Type>MaxAggregate` / … | field removed |
+| `<Type>DistinctColumn` / `<Type>GroupByColumn` | value removed |
+| `<Type>ConflictColumn` (upsert targets) | value removed |
+
+Two details worth stating plainly:
+
+-   **The exclusion is all-or-nothing on purpose.** A column you can filter on but not
+    select is an oracle: `where: { keyHash: { eq: '…' } }` confirms a value without ever
+    returning it. Ordering and grouping leak the same way, more slowly. There is no
+    read-only or write-only variant of `exclude` for this reason.
+-   **Nothing changes below the schema.** An excluded column is still written by its
+    default, still read by the primary-key and cursor machinery, and still usable by your
+    own resolvers. Only the generated schema stops mentioning it.
+
+Names that match nothing throw at build time, so renaming a column fails the build instead
+of quietly un-hiding it. Excluding a `NOT NULL` column with no default is allowed — the
+table becomes readable but not insertable — and warns on the console, since that is more
+often a mistake than a plan.
+
+> `exclude` is a static decision: the column is absent for every caller. Deciding per
+> request who may see what is a job for [`graphql-shield`](https://the-guild.dev/graphql/shield)
+> or an equivalent layer above the schema, which has the request context this library
+> does not.
 ## Naming
 
 Type and field names are derived from the Drizzle schema keys. Three options change them.

package/dist/README.md

@@ -124,6 +124,60 @@ const { schema } = buildSchema(db, {
     `mutations: false`
 -   List and single queries are always generated, so `Query` is never empty
 
+## Excluding tables and columns
+
+`features` decides which *kinds* of operation exist. `exclude` decides which tables and
+columns exist at all — for the table holding session tokens, or the column holding a
+password hash:
+
+```Typescript
+const { schema } = buildSchema(db, {
+    exclude: {
+        tables: ['magicLinks', 'sessions'],
+        columns: { apiKeys: ['keyHash'] },
+    },
+})
+```
+
+Both lists are keyed by the **Drizzle schema key**, not the database name and not the
+generated GraphQL name.
+
+An excluded **table** generates nothing: no object type, no queries, no mutations, no
+aggregates, and no relation field on any other table that points at it. `Users.sessions`
+is gone, and so is `users(where: { sessions: { … } })` — the table is unreachable, not
+merely unnamed.
+
+An excluded **column** disappears from every surface at once:
+
+| Surface | Effect |
+| --- | --- |
+| `<Type>` object type | field removed |
+| `Create<Type>Input` / `Update<Type>Input` | field removed (nested-write payloads too) |
+| `<Type>Filters` | field removed |
+| `<Type>OrderBy` | field removed |
+| `<Type>MinAggregate` / `<Type>MaxAggregate` / … | field removed |
+| `<Type>DistinctColumn` / `<Type>GroupByColumn` | value removed |
+| `<Type>ConflictColumn` (upsert targets) | value removed |
+
+Two details worth stating plainly:
+
+-   **The exclusion is all-or-nothing on purpose.** A column you can filter on but not
+    select is an oracle: `where: { keyHash: { eq: '…' } }` confirms a value without ever
+    returning it. Ordering and grouping leak the same way, more slowly. There is no
+    read-only or write-only variant of `exclude` for this reason.
+-   **Nothing changes below the schema.** An excluded column is still written by its
+    default, still read by the primary-key and cursor machinery, and still usable by your
+    own resolvers. Only the generated schema stops mentioning it.
+
+Names that match nothing throw at build time, so renaming a column fails the build instead
+of quietly un-hiding it. Excluding a `NOT NULL` column with no default is allowed — the
+table becomes readable but not insertable — and warns on the console, since that is more
+often a mistake than a plan.
+
+> `exclude` is a static decision: the column is absent for every caller. Deciding per
+> request who may see what is a job for [`graphql-shield`](https://the-guild.dev/graphql/shield)
+> or an equivalent layer above the schema, which has the request context this library
+> does not.
 ## Naming
 
 Type and field names are derived from the Drizzle schema keys. Three options change them.

package/dist/index.cjs

@@ -1182,6 +1182,30 @@ var resolveLimitPolicy = (global, table) => {
   }
   return { defaultLimit, maxLimit, clampToMax: table?.clampToMax ?? global?.clampToMax ?? false };
 };
+var excludedColumnRegistry = /* @__PURE__ */ new WeakMap();
+var registerColumnExclusions = (tables, exclude) => {
+  for (const [tableName, table] of Object.entries(tables)) {
+    const hidden = exclude?.columns?.[tableName];
+    if (hidden?.length) {
+      excludedColumnRegistry.set(table, new Set(hidden));
+    } else {
+      excludedColumnRegistry.delete(table);
+    }
+  }
+};
+var hasExcludedColumns = (table) => excludedColumnRegistry.has(table);
+var excludedColumnsKey = (table) => {
+  const hidden = excludedColumnRegistry.get(table);
+  return hidden ? [...hidden].sort().join(",") : "";
+};
+var visibleColumns = (table) => {
+  const columns = (0, import_drizzle_orm4.getColumns)(table);
+  const hidden = excludedColumnRegistry.get(table);
+  if (!hidden) {
+    return columns;
+  }
+  return Object.fromEntries(Object.entries(columns).filter(([columnName]) => !hidden.has(columnName)));
+};
 var listFieldComplexity = (options, policy) => ({ args, childComplexity }) => {
   const limit = args["limit"];
   const requested = typeof limit === "number" && limit > 0 ? limit : void 0;
@@ -1491,17 +1515,20 @@ var generateColumnFilterValues = (column, tableName, columnName, cacheCtx) => {
 };
 var orderMap = /* @__PURE__ */ new WeakMap();
 var generateTableOrderCached = (table) => {
-  if (orderMap.has(table)) {
+  const cacheable = !hasExcludedColumns(table);
+  if (cacheable && orderMap.has(table)) {
     return orderMap.get(table);
   }
   let remapped = {};
   try {
-    const columns = (0, import_drizzle_orm4.getColumns)(table);
+    const columns = visibleColumns(table);
     const columnEntries = Object.entries(columns);
     remapped = Object.fromEntries(
       columnEntries.map(([columnName, _columnDescription]) => [columnName, { type: innerOrder }])
     );
-    orderMap.set(table, remapped);
+    if (cacheable) {
+      orderMap.set(table, remapped);
+    }
   } catch (_err) {
   }
   return remapped;
@@ -1510,7 +1537,7 @@ var generateTableFilterValuesCached = (table, tableName, cacheCtx) => {
   if (cacheCtx.filterFieldCache.has(table)) {
     return cacheCtx.filterFieldCache.get(table);
   }
-  const columns = (0, import_drizzle_orm4.getColumns)(table);
+  const columns = visibleColumns(table);
   const columnEntries = Object.entries(columns);
   const remapped = Object.fromEntries(
     columnEntries.map(([columnName, column]) => [
@@ -1531,7 +1558,7 @@ var generateTableSelectTypeFieldsCached = (table, tableName, cacheCtx) => {
   if (cacheCtx.selectFieldCache.has(table)) {
     return cacheCtx.selectFieldCache.get(table);
   }
-  const columns = (0, import_drizzle_orm4.getColumns)(table);
+  const columns = visibleColumns(table);
   const columnEntries = Object.entries(columns);
   const remapped = Object.fromEntries(
     columnEntries.map(([columnName, column]) => [
@@ -1889,7 +1916,7 @@ var generateTableTypes = (tableName, tables, relationMap, withReturning, relatio
     relationAggregateFactory
   );
   const table = tables[tableName];
-  const columns = (0, import_drizzle_orm4.getColumns)(table);
+  const columns = visibleColumns(table);
   const columnEntries = Object.entries(columns);
   const relaxedColumns = nestedWrites?.relaxedColumns(tableName);
   const insertFields = Object.fromEntries(
@@ -2564,7 +2591,7 @@ var attachRowCursors = (rows, entries) => {
 };
 var rowCursorResolver = (source) => source?.[ROW_CURSOR_PROP] ?? null;
 var getUniqueColumnSets = (table, getTableConfig4) => {
-  const cols = (0, import_drizzle_orm4.getColumns)(table);
+  const cols = visibleColumns(table);
   const propNameByColumnName = new Map(Object.entries(cols).map(([propName, col]) => [col.name, propName]));
   const toPropNames = (columnNames) => {
     const propNames = [];
@@ -2604,12 +2631,13 @@ var getUniqueColumnSets = (table, getTableConfig4) => {
 var DISTINCT_RN = "__drizzle_graphql_distinct_rn";
 var columnEnumCache = /* @__PURE__ */ new WeakMap();
 var generateColumnEnum = (table, enumName, description, predicate = () => true) => {
+  const cacheKey = `${enumName}\0${excludedColumnsKey(table)}`;
   let tableCache = columnEnumCache.get(table);
-  const cached = tableCache?.get(enumName);
+  const cached = tableCache?.get(cacheKey);
   if (cached) {
     return cached;
   }
-  const columnNames = Object.entries((0, import_drizzle_orm4.getColumns)(table)).filter(([columnName, column]) => predicate(column, columnName)).map(([columnName]) => columnName);
+  const columnNames = Object.entries(visibleColumns(table)).filter(([columnName, column]) => predicate(column, columnName)).map(([columnName]) => columnName);
   if (!columnNames.length) {
     return void 0;
   }
@@ -2622,7 +2650,7 @@ var generateColumnEnum = (table, enumName, description, predicate = () => true)
     tableCache = /* @__PURE__ */ new Map();
     columnEnumCache.set(table, tableCache);
   }
-  tableCache.set(enumName, enumType);
+  tableCache.set(cacheKey, enumType);
   return enumType;
 };
 var generateDistinctEnum = (table, typeName) => generateColumnEnum(table, `${typeName}DistinctColumn`, `Columns of ${typeName} that a query can be made distinct on`);
@@ -3210,7 +3238,7 @@ var classifyAggregateColumns = (table, tableName) => {
   const numeric = {};
   const orderable = {};
   const all = {};
-  for (const [columnName, column] of Object.entries((0, import_drizzle_orm5.getColumns)(table))) {
+  for (const [columnName, column] of Object.entries(visibleColumns(table))) {
     all[columnName] = column;
     const converted = drizzleColumnToGraphQLType(column, columnName, tableName, true, false, false);
     const gqlType = converted.type;
@@ -3454,7 +3482,7 @@ var HAVING_OPS = { eq: import_drizzle_orm5.eq, ne: import_drizzle_orm5.ne, gt: i
 var groupableColumns = (table, tableName) => {
   const { orderable } = classifyAggregateColumns(table, tableName);
   const groupable = { ...orderable };
-  for (const [columnName, column] of Object.entries((0, import_drizzle_orm5.getColumns)(table))) {
+  for (const [columnName, column] of Object.entries(visibleColumns(table))) {
     if (groupable[columnName]) {
       continue;
     }
@@ -3922,7 +3950,8 @@ var generateSchemaData = (db, schema, relations, options) => {
   const { relationsDepthLimit, prefixes, suffixes, typeNameMapper, shouldEagerLoad, features, complexity, limits } = options;
   const rawSchema = schema;
   const schemaEntries = Object.entries(rawSchema);
-  const tableEntries = schemaEntries.filter(([_key, value]) => (0, import_drizzle_orm6.is)(value, import_mysql_core2.MySqlTable));
+  const excludedTables = new Set(options.exclude?.tables ?? []);
+  const tableEntries = schemaEntries.filter(([key, value]) => (0, import_drizzle_orm6.is)(value, import_mysql_core2.MySqlTable) && !excludedTables.has(key));
   const tables = Object.fromEntries(tableEntries);
   if (!tableEntries.length) {
     throw new Error(
@@ -3936,7 +3965,11 @@ var generateSchemaData = (db, schema, relations, options) => {
   }
   registerScalarOverrides(tables, options);
   registerEnumConfig(options);
+  registerColumnExclusions(tables, options.exclude);
   const namedRelations = buildNamedRelations(relations ?? {}, tableEntries);
+  for (const excluded of excludedTables) {
+    delete namedRelations[excluded];
+  }
   attachTargetPrimaryKeys(namedRelations, tables, mysqlPrimaryKeyPropNames);
   const eagerRelations = pruneNonEagerRelations(namedRelations, shouldEagerLoad);
   const filterCtx = { tables, relationMap: namedRelations };
@@ -4404,7 +4437,7 @@ var createNestedWriteTypes = (params) => {
     }
     const omitted = plan.fkSide === "child" ? plan.foreignColPropName : void 0;
     const fields = Object.fromEntries(
-      Object.entries((0, import_drizzle_orm7.getColumns)(plan.targetTable)).filter(([columnName]) => columnName !== omitted).map(([columnName, column]) => [
+      Object.entries(visibleColumns(plan.targetTable)).filter(([columnName]) => columnName !== omitted).map(([columnName, column]) => [
         columnName,
         drizzleColumnToGraphQLType(column, columnName, plan.targetTableName, false, true, true)
       ])
@@ -5282,7 +5315,8 @@ function generateSchemaData2(db, schema, relations, options) {
     limits
   } = options;
   const schemaEntries = Object.entries(schema);
-  const tableEntries = schemaEntries.filter(([_key, value]) => (0, import_drizzle_orm8.is)(value, import_pg_core2.PgTable));
+  const excludedTables = new Set(options.exclude?.tables ?? []);
+  const tableEntries = schemaEntries.filter(([key, value]) => (0, import_drizzle_orm8.is)(value, import_pg_core2.PgTable) && !excludedTables.has(key));
   const tables = Object.fromEntries(tableEntries);
   if (!tableEntries.length) {
     throw new Error(
@@ -5291,7 +5325,11 @@ function generateSchemaData2(db, schema, relations, options) {
   }
   registerScalarOverrides(tables, options);
   registerEnumConfig(options);
+  registerColumnExclusions(tables, options.exclude);
   const namedRelations = buildNamedRelations(relations ?? {}, tableEntries);
+  for (const excluded of excludedTables) {
+    delete namedRelations[excluded];
+  }
   attachTargetPrimaryKeys(namedRelations, tables, pgPrimaryKeyPropNames);
   const eagerRelations = pruneNonEagerRelations(namedRelations, shouldEagerLoad);
   const filterCtx = { tables, relationMap: namedRelations };
@@ -6294,7 +6332,8 @@ var generateSchemaData3 = (db, schema, relations, options) => {
   } = options;
   const rawSchema = schema;
   const schemaEntries = Object.entries(rawSchema);
-  const tableEntries = schemaEntries.filter(([_key, value]) => (0, import_drizzle_orm9.is)(value, import_sqlite_core2.SQLiteTable));
+  const excludedTables = new Set(options.exclude?.tables ?? []);
+  const tableEntries = schemaEntries.filter(([key, value]) => (0, import_drizzle_orm9.is)(value, import_sqlite_core2.SQLiteTable) && !excludedTables.has(key));
   const tables = Object.fromEntries(tableEntries);
   if (!tableEntries.length) {
     throw new Error(
@@ -6303,7 +6342,11 @@ var generateSchemaData3 = (db, schema, relations, options) => {
   }
   registerScalarOverrides(tables, options);
   registerEnumConfig(options);
+  registerColumnExclusions(tables, options.exclude);
   const namedRelations = buildNamedRelations(relations ?? {}, tableEntries);
+  for (const excluded of excludedTables) {
+    delete namedRelations[excluded];
+  }
   attachTargetPrimaryKeys(namedRelations, tables, sqlitePrimaryKeyPropNames);
   const eagerRelations = pruneNonEagerRelations(namedRelations, shouldEagerLoad);
   const filterCtx = { tables, relationMap: namedRelations };
@@ -6850,6 +6893,49 @@ var buildSchema = (db, config) => {
     limitPolicyCache.set(tableName, resolved);
     return resolved;
   } : void 0;
+  const exclude = config?.exclude;
+  if (exclude) {
+    const tableNames = new Set(
+      Object.entries(schema).filter(([, value]) => (0, import_drizzle_orm10.is)(value, import_drizzle_orm10.Table)).map(([key]) => key)
+    );
+    const excludedTables = new Set(exclude.tables ?? []);
+    for (const tableName of excludedTables) {
+      if (!tableNames.has(tableName)) {
+        throw new Error(
+          `Drizzle-GraphQL Error: config.exclude.tables names '${tableName}', which is not a table in the Drizzle schema.`
+        );
+      }
+    }
+    if (excludedTables.size >= tableNames.size) {
+      throw new Error(
+        "Drizzle-GraphQL Error: config.exclude.tables excludes every table in the schema, leaving nothing to generate."
+      );
+    }
+    for (const [tableName, columnNames] of Object.entries(exclude.columns ?? {})) {
+      if (!tableNames.has(tableName)) {
+        throw new Error(
+          `Drizzle-GraphQL Error: config.exclude.columns names table '${tableName}', which is not a table in the Drizzle schema.`
+        );
+      }
+      if (excludedTables.has(tableName)) {
+        continue;
+      }
+      const columns = (0, import_drizzle_orm10.getColumns)(schema[tableName]);
+      for (const columnName of columnNames) {
+        const column = columns[columnName];
+        if (!column) {
+          throw new Error(
+            `Drizzle-GraphQL Error: config.exclude.columns names '${tableName}.${columnName}', which is not a column of that table.`
+          );
+        }
+        if (column.notNull && !column.hasDefault && !column.defaultFn) {
+          console.warn(
+            `Drizzle-GraphQL Warning: excluded column '${tableName}.${columnName}' is NOT NULL with no default, so generated inserts for '${tableName}' can never succeed.`
+          );
+        }
+      }
+    }
+  }
   const eagerOpt = config?.eagerLoadRelations;
   const shouldEagerLoad = eagerOpt === void 0 || eagerOpt === true ? () => true : eagerOpt === false ? () => false : eagerOpt;
   if (!typeNameMapper && suffixes.list === suffixes.single) {
@@ -6883,6 +6969,7 @@ var buildSchema = (db, config) => {
     enumNameMapper: config?.enumNameMapper,
     transactions,
     limits,
+    exclude,
     docs: {
       describeColumn: config?.describeColumn,
       describeTable: config?.describeTable,