@grantjs/schema 1.5.1 → 1.5.3

package/src/generated/schema-types.ts

@@ -108,10 +108,6 @@ export type AccountRole = Auditable & {
   updatedAt: Scalars['Date']['output'];
 };
 
-export enum AccountSearchableField {
-  Type = 'type',
-}
-
 export type AccountSortInput = {
   field: AccountSortableField;
   order: SortOrder;
@@ -486,11 +482,6 @@ export type ChangeMyPasswordResult = {
   success: Scalars['Boolean']['output'];
 };
 
-export type Creatable = {
-  createdAt: Scalars['String']['output'];
-  updatedAt: Scalars['String']['output'];
-};
-
 export type CreateAccountInput = {
   ownerId: Scalars['String']['input'];
   provider: UserAuthenticationMethodProvider;
@@ -1626,11 +1617,6 @@ export type OrganizationMemberPage = {
   totalCount: Scalars['Int']['output'];
 };
 
-export enum OrganizationMemberSearchableField {
-  Email = 'email',
-  Name = 'name',
-}
-
 export type OrganizationMemberSortInput = {
   field: OrganizationMemberSortableField;
   order: SortOrder;
@@ -2594,12 +2580,6 @@ export type RegisterInput = {
   type: AccountType;
 };
 
-export type RemoveAccountProjectApiKeyInput = {
-  accountId: Scalars['ID']['input'];
-  apiKeyId: Scalars['ID']['input'];
-  projectId: Scalars['ID']['input'];
-};
-
 export type RemoveAccountProjectInput = {
   accountId: Scalars['ID']['input'];
   projectId: Scalars['ID']['input'];
@@ -2649,12 +2629,6 @@ export type RemoveOrganizationPermissionInput = {
   permissionId: Scalars['ID']['input'];
 };
 
-export type RemoveOrganizationProjectApiKeyInput = {
-  apiKeyId: Scalars['ID']['input'];
-  organizationId: Scalars['ID']['input'];
-  projectId: Scalars['ID']['input'];
-};
-
 export type RemoveOrganizationProjectInput = {
   organizationId: Scalars['ID']['input'];
   projectId: Scalars['ID']['input'];
@@ -3274,14 +3248,6 @@ export type UpdateMyProjectMembershipInput = {
   projectId: Scalars['ID']['input'];
 };
 
-export type UpdateMyUserAuthenticationMethodInput = {
-  isPrimary?: InputMaybe<Scalars['Boolean']['input']>;
-  isVerified?: InputMaybe<Scalars['Boolean']['input']>;
-  provider?: InputMaybe<UserAuthenticationMethodProvider>;
-  providerData?: InputMaybe<Scalars['JSON']['input']>;
-  providerId?: InputMaybe<Scalars['String']['input']>;
-};
-
 export type UpdateMyUserInput = {
   metadata?: InputMaybe<Scalars['JSON']['input']>;
   name?: InputMaybe<Scalars['String']['input']>;

package/src/index.ts

@@ -1,30 +1,7 @@
 export * from './cdm/cdm-export-sections';
 export * from './events';
 export * from './generated/graphql';
-export type {
-  AccountResolvers,
-  GroupResolvers,
-  MutationResolvers,
-  OrganizationInvitationResolvers,
-  OrganizationResolvers,
-  PermissionResolvers,
-  ProjectAppResolvers,
-  ProjectResolvers,
-  QueryResolvers,
-  RequireFields,
-  Resolver,
-  Resolvers,
-  ResolversObject,
-  ResolversParentTypes,
-  ResolversTypes,
-  ResolverTypeWrapper,
-  ResourceResolvers,
-  RolePermissionResolvers,
-  RoleResolvers,
-  TagResolvers,
-  UserPermissionResolvers,
-  UserResolvers,
-} from './generated/resolvers';
+export * from './generated/resolvers';
 export * from './generated/schema-types';
 export * from './notifications/notification.types';
 export type {

package/src/notifications/notification.types.ts

@@ -2,10 +2,6 @@ import type { EventCategory } from '../events/event-catalog';
 
 export const NOTIFICATION_CHANNELS = ['in_app', 'email'] as const;
 
-export const NOTIFICATION_STATUSES = ['pending', 'delivered', 'failed', 'dead'] as const;
-
-export const NOTIFICATION_PREFERENCE_SOURCES = ['user', 'org_enforced'] as const;
-
 export interface ListNotificationsInput {
   unreadOnly?: boolean;
   page?: number;

package/src/operations/role-permissions/role-permissions.graphql

@@ -16,24 +16,3 @@ mutation RevokeRolePermission($input: RevokeRolePermissionInput!) {
     deletedAt
   }
 }
-
-query GetRoleDirectPermissions($scope: Scope!, $roleId: ID!) {
-  roles(scope: $scope, ids: [$roleId], limit: 1) {
-    roles {
-      id
-      permissionCount
-      rolePermissions {
-        id
-        permissionId
-        permission(scope: $scope) {
-          id
-          name
-          action
-          resource {
-            slug
-          }
-        }
-      }
-    }
-  }
-}

package/src/operations/user-permissions/user-permissions.graphql

@@ -16,24 +16,3 @@ mutation RevokeUserPermission($input: RevokeUserPermissionInput!) {
     deletedAt
   }
 }
-
-query GetUserDirectPermissions($scope: Scope!, $userId: ID!) {
-  users(scope: $scope, ids: [$userId], limit: 1) {
-    users {
-      id
-      permissionCount
-      userPermissions {
-        id
-        permissionId
-        permission(scope: $scope) {
-          id
-          name
-          action
-          resource {
-            slug
-          }
-        }
-      }
-    }
-  }
-}

package/src/schema/base.graphql

@@ -15,11 +15,6 @@ interface Auditable {
   deletedAt: Date
 }
 
-interface Creatable {
-  createdAt: String!
-  updatedAt: String!
-}
-
 interface PaginatedResults {
   totalCount: Int!
   hasNextPage: Boolean!

package/src/sdl-contract.test.ts

@@ -0,0 +1,90 @@
+import { readFileSync } from 'node:fs';
+import { relative } from 'node:path';
+
+import { parse, validate } from 'graphql';
+import { describe, expect, it } from 'vitest';
+
+import {
+  buildMergedSchema,
+  declaredTypes,
+  operationFiles,
+  reachableTypeNames,
+  sdlFiles,
+} from './test-support/sdl-fixture';
+
+/**
+ * The schema is the package's real deliverable, and until now nothing executed it:
+ * `apps/api` was the first thing to find out whether the SDL builds, at boot.
+ * These are the structural assertions that belong to the package that owns the SDL.
+ */
+describe('merged SDL', () => {
+  const schema = buildMergedSchema();
+
+  it('builds from every file under src/schema', () => {
+    expect(sdlFiles().length).toBeGreaterThan(0);
+    expect(schema.getQueryType()).toBeDefined();
+    expect(schema.getMutationType()).toBeDefined();
+  });
+
+  it('exposes the root fields the API serves', () => {
+    // Guards against a merge that silently drops `extend type Query|Mutation` blocks:
+    // the schema would still build, with a near-empty root.
+    expect(Object.keys(schema.getQueryType()!.getFields()).length).toBeGreaterThanOrEqual(32);
+    expect(Object.keys(schema.getMutationType()!.getFields()).length).toBeGreaterThanOrEqual(84);
+  });
+});
+
+describe('operation documents', () => {
+  const schema = buildMergedSchema();
+  const files = operationFiles();
+
+  // Pinned, not a floor: pass 5 slice 5 removed one file and two query operations
+  // that were superseded by list queries, and a floor would have absorbed that
+  // silently. 116 before that slice.
+  it('finds every document under src/operations', () => {
+    expect(files).toHaveLength(115);
+  });
+
+  it.each(files.map((f) => [relative(process.cwd(), f), f]))('%s validates', (_label, file) => {
+    const errors = validate(schema, parse(readFileSync(file, 'utf8')));
+    expect(errors.map((e) => e.message)).toEqual([]);
+  });
+});
+
+describe('graph reachability', () => {
+  const schema = buildMergedSchema();
+
+  /**
+   * 175 of 382 declared types cannot be reached from Query or Mutation. They are
+   * not dead: most are consumed as generated TypeScript by apps/api, and the
+   * *SearchableField enums are runtime search configuration. But every one of them
+   * ships in the schema `makeExecutableSchema` serves.
+   *
+   * This number is the input to the Tier 3 decision in
+   * docs/contributing/code-quality/schema.md — pinned so it moves visibly.
+   * Deleting unreachable SDL lowers it; adding a type with no query or mutation
+   * raises it. Either way, update it deliberately.
+   *
+   * Was 181 of 388 before pass 5 slice 4 removed six declarations that were
+   * unreferenced in SDL and in all TypeScript. The reachable count did not change
+   * (207 before and after), which is what makes those six safe to have deleted.
+   */
+  const UNREACHABLE_FROM_ROOT = 175;
+
+  it('pins the count of types unreachable from Query/Mutation', () => {
+    const reachable = reachableTypeNames(schema);
+    const unreachable = declaredTypes(schema).filter((t) => !reachable.has(t.name));
+
+    expect(unreachable).toHaveLength(UNREACHABLE_FROM_ROOT);
+  });
+
+  it('keeps every operation document inside the reachable set', () => {
+    // A document can only select reachable types, so this is a consistency check on
+    // the traversal itself: if it under-reports, the validation suite above would
+    // still pass while this pins a wrong number.
+    const reachable = reachableTypeNames(schema);
+    expect(reachable.has('Query')).toBe(true);
+    expect(reachable.has('Mutation')).toBe(true);
+    expect(reachable.size).toBe(declaredTypes(schema).length - UNREACHABLE_FROM_ROOT);
+  });
+});

package/src/test-support/sdl-fixture.ts

@@ -0,0 +1,79 @@
+import { readdirSync, readFileSync, statSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+import {
+  buildSchema,
+  getNamedType,
+  type GraphQLNamedType,
+  type GraphQLSchema,
+  isInputObjectType,
+  isInterfaceType,
+  isObjectType,
+  isUnionType,
+} from 'graphql';
+
+const packageRoot = join(dirname(fileURLToPath(import.meta.url)), '..', '..');
+
+function graphqlFilesUnder(dir: string): string[] {
+  return readdirSync(dir)
+    .flatMap((entry) => {
+      const path = join(dir, entry);
+      if (statSync(path).isDirectory()) return graphqlFilesUnder(path);
+      return path.endsWith('.graphql') ? [path] : [];
+    })
+    .sort();
+}
+
+export const sdlFiles = (): string[] => graphqlFilesUnder(join(packageRoot, 'src', 'schema'));
+export const operationFiles = (): string[] =>
+  graphqlFilesUnder(join(packageRoot, 'src', 'operations'));
+
+export const readAll = (files: string[]): string =>
+  files.map((f) => readFileSync(f, 'utf8')).join('\n');
+
+/**
+ * Builds the merged schema from every file under `src/schema`, which is the same
+ * set `apps/api` feeds to `makeExecutableSchema` via `loadFilesSync` — see
+ * apps/api/src/graphql/resolvers/index.ts. Concatenation is equivalent here because
+ * the schema is one directory of SDL with no imports between files.
+ */
+export function buildMergedSchema(): GraphQLSchema {
+  return buildSchema(readAll(sdlFiles()));
+}
+
+/** Named types excluding GraphQL's introspection meta-types. */
+export function declaredTypes(schema: GraphQLSchema): GraphQLNamedType[] {
+  return Object.values(schema.getTypeMap()).filter((t) => !t.name.startsWith('__'));
+}
+
+/**
+ * Types reachable by traversing fields, arguments, interfaces, and union members
+ * from `Query` and `Mutation`. Anything outside this set is in the served schema
+ * and visible to introspection, but no operation can reach it.
+ */
+export function reachableTypeNames(schema: GraphQLSchema): Set<string> {
+  const seen = new Set<string>();
+
+  const visit = (type: unknown): void => {
+    const named = getNamedType(type as never) as GraphQLNamedType | undefined;
+    if (!named || seen.has(named.name) || named.name.startsWith('__')) return;
+    seen.add(named.name);
+
+    if (isObjectType(named) || isInterfaceType(named)) {
+      for (const field of Object.values(named.getFields())) {
+        visit(field.type);
+        for (const arg of field.args) visit(arg.type);
+      }
+      for (const iface of named.getInterfaces()) visit(iface);
+    } else if (isInputObjectType(named)) {
+      for (const field of Object.values(named.getFields())) visit(field.type);
+    } else if (isUnionType(named)) {
+      for (const member of named.getTypes()) visit(member);
+    }
+  };
+
+  visit(schema.getQueryType());
+  visit(schema.getMutationType());
+  return seen;
+}

package/src/webhooks/webhook.types.ts

@@ -1,13 +1,5 @@
 import type { EventType } from '../events/event-catalog';
 
-export const WEBHOOK_DELIVERY_STATUSES = [
-  'pending',
-  'running',
-  'delivered',
-  'failed',
-  'dead',
-] as const;
-
 /** Service-layer create payload (scope is passed separately). */
 export interface CreateWebhookSubscriptionInput {
   url: string;

package/src/operations/organization-invitations/getOrganizationInvitations.graphql

@@ -1,17 +0,0 @@
-query GetOrganizationInvitations($scope: Scope!, $status: OrganizationInvitationStatus) {
-  organizationInvitations(scope: $scope, status: $status) {
-    invitations {
-      id
-      organizationId
-      email
-      roleId
-      status
-      expiresAt
-      invitedBy
-      invitedAt
-      createdAt
-    }
-    totalCount
-    hasNextPage
-  }
-}

package/src/schema/account-project-api-keys/inputs/remove-account-project-api-key.graphql

@@ -1,5 +0,0 @@
-input RemoveAccountProjectApiKeyInput {
-  accountId: ID!
-  projectId: ID!
-  apiKeyId: ID!
-}

package/src/schema/accounts/types/account-searchable-field.graphql

@@ -1,3 +0,0 @@
-enum AccountSearchableField {
-  type
-}

package/src/schema/me/input/update-my-user-authentication-method.graphql

@@ -1,7 +0,0 @@
-input UpdateMyUserAuthenticationMethodInput {
-  providerId: String
-  provider: UserAuthenticationMethodProvider
-  providerData: JSON
-  isVerified: Boolean
-  isPrimary: Boolean
-}

package/src/schema/organization-members/types/organization-member-searchable-field.graphql

@@ -1,4 +0,0 @@
-enum OrganizationMemberSearchableField {
-  name
-  email
-}

package/src/schema/organization-project-api-keys/inputs/remove-organization-project-api-key.graphql

@@ -1,5 +0,0 @@
-input RemoveOrganizationProjectApiKeyInput {
-  organizationId: ID!
-  projectId: ID!
-  apiKeyId: ID!
-}