@grantjs/schema 1.5.1 → 1.5.3

package/README.md

@@ -74,9 +74,23 @@ const resolvers: Resolvers = {
 pnpm generate
 
 # Watch for changes and regenerate
-pnpm generate:watch
+pnpm dev
 ```
 
+Generated output under `src/generated/` is committed and must stay in sync with its
+sources. CI runs `pnpm codegen:check` (regenerate, fail on any diff), so edit the
+`.graphql` files or `codegen.ts` — never `src/generated/` directly.
+
+### Test
+
+```bash
+pnpm test
+```
+
+Structural assertions on the merged SDL: it builds, every operation document
+validates against it, and the count of types unreachable from `Query`/`Mutation`
+is pinned. See `src/sdl-contract.test.ts`.
+
 ### Build Package
 
 ```bash
@@ -87,22 +101,25 @@ pnpm build
 
 ```
 src/
-├── schema/                    # GraphQL schema definitions
-│   ├── permissions/          # Permission-related types and operations
-│   ├── users/               # User-related types and operations
-│   ├── roles/               # Role-related types and operations
-│   ├── groups/              # Group-related types and operations
-│   ├── organizations/       # Organization-related types and operations
-│   ├── projects/            # Project-related types and operations
-│   └── tags/                # Tag-related types and operations
-├── generated/                # Generated TypeScript files
-│   ├── types.ts             # Generated types
-│   ├── operations.ts        # Generated operations
-│   └── resolvers.ts         # Generated resolvers
-└── types/                   # Additional TypeScript types
-    └── index.ts             # Context and additional types
+├── schema/                   # GraphQL SDL — one directory per domain, each with
+│   │                         # inputs/, types/ and (where the domain is on the graph)
+│   │                         # queries/ and mutations/
+│   ├── base.graphql          # Scalars, shared interfaces, Tenant/SortOrder, Scope
+│   └── root.graphql          # Query/Mutation roots the domains extend
+├── operations/               # Client operation documents, one directory per domain
+├── generated/                # Codegen output — committed, never hand-edited
+│   ├── schema-types.ts       # Schema types (owns every type name)
+│   ├── graphql.ts            # Operation types + typed document nodes
+│   └── resolvers.ts          # Resolver types; imports from schema-types
+├── events/                   # Event catalog and envelope types
+├── cdm/, notifications/,     # Hand-written contract types that are not codegen'd
+│   webhooks/
+└── index.ts                  # Public barrel
 ```
 
+`apps/api` loads every file under `src/schema/` into `makeExecutableSchema`, so
+anything declared there ships in the served schema whether or not a query reaches it.
+
 ## Contributing
 
 When modifying the GraphQL schema:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grantjs/schema",
-  "version": "1.5.1",
+  "version": "1.5.3",
   "description": "GraphQL schema and generated types for Grant",
   "main": "src/index.ts",
   "types": "src/index.ts",
@@ -13,14 +13,18 @@
     "@graphql-typed-document-node/core": "^3.2.0"
   },
   "devDependencies": {
+    "@graphql-codegen/add": "^7.1.0",
     "@graphql-codegen/cli": "^7.2.0",
-    "@graphql-codegen/client-preset": "^6.1.0",
+    "@graphql-codegen/typed-document-node": "^7.1.0",
     "@graphql-codegen/typescript": "^6.1.0",
+    "@graphql-codegen/typescript-operations": "^6.1.2",
     "@graphql-codegen/typescript-resolvers": "^6.1.0",
     "@parcel/watcher": "^2.6.0",
     "@types/node": "^26.1.1",
     "eslint": "^10.7.0",
-    "typescript": "^6.0.3"
+    "graphql": "^16.14.2",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.10"
   },
   "scripts": {
     "build": "tsc",
@@ -30,6 +34,8 @@
     "lint": "eslint src --ext .ts,.tsx",
     "lint:fix": "eslint src --ext .ts,.tsx --fix",
     "type-check": "tsc --noEmit",
-    "clean": "rm -rf dist"
+    "clean": "rm -rf dist",
+    "test": "vitest",
+    "test:coverage": "vitest run --coverage"
   }
 }

package/src/events/event-catalog.ts

@@ -11,28 +11,25 @@
 export const EVENT_CATEGORIES = ['security', 'iam', 'membership', 'integrations'] as const;
 export type EventCategory = (typeof EVENT_CATEGORIES)[number];
 
-export const EVENT_DELIVERY_CLASSES = ['transactional', 'notification'] as const;
-export type EventDeliveryClass = (typeof EVENT_DELIVERY_CLASSES)[number];
-
-/** Declarative audience primitives resolved by the notification audience resolver. */
-export const AUDIENCE_PRIMITIVES = [
-  'actor',
-  'subject',
-  'scopeMembers',
-  'roleHolders',
-  'owners',
-  'watchers',
-] as const;
-export type AudiencePrimitive = (typeof AUDIENCE_PRIMITIVES)[number];
+export type EventDeliveryClass = 'transactional' | 'notification';
+
+/**
+ * Declarative audience primitives resolved by the notification audience resolver.
+ * A union rather than an `as const` array: nothing enumerates these at runtime, so
+ * the array was shipped dead weight. Re-introduce the array if a caller ever needs
+ * to iterate them.
+ */
+export type AudiencePrimitive =
+  'actor' | 'subject' | 'scopeMembers' | 'roleHolders' | 'owners' | 'watchers';
 
-export interface AudienceRule {
+interface AudienceRule {
   /** Primitives whose resolved users are unioned to form the candidate set. */
   primitives: readonly AudiencePrimitive[];
   /** Exclude the acting user from the resolved audience (default true). */
   excludeActor?: boolean;
 }
 
-export interface EventCatalogEntry {
+interface EventCatalogEntry {
   category: EventCategory;
   deliveryClass: EventDeliveryClass;
   audienceRule: AudienceRule;

package/src/generated/graphql.ts

@@ -786,29 +786,6 @@ export type GetInvitationQuery = {
   } | null;
 };
 
-export type GetOrganizationInvitationsQueryVariables = Exact<{
-  scope: Types.Scope;
-  status?: Types.OrganizationInvitationStatus | null | undefined;
-}>;
-
-export type GetOrganizationInvitationsQuery = {
-  organizationInvitations: {
-    totalCount: number;
-    hasNextPage: boolean;
-    invitations: Array<{
-      id: string;
-      organizationId: string;
-      email: string;
-      roleId: string;
-      status: Types.OrganizationInvitationStatus;
-      expiresAt: Date;
-      invitedBy: string;
-      invitedAt: Date;
-      createdAt: Date;
-    }>;
-  };
-};
-
 export type InviteMemberMutationVariables = Exact<{
   input: Types.InviteMemberInput;
 }>;
@@ -1595,30 +1572,6 @@ export type RevokeRolePermissionMutation = {
   };
 };
 
-export type GetRoleDirectPermissionsQueryVariables = Exact<{
-  scope: Types.Scope;
-  roleId: string | number;
-}>;
-
-export type GetRoleDirectPermissionsQuery = {
-  roles: {
-    roles: Array<{
-      id: string;
-      permissionCount: number;
-      rolePermissions: Array<{
-        id: string;
-        permissionId: string;
-        permission: {
-          id: string;
-          name: string;
-          action: string;
-          resource: { slug: string } | null;
-        } | null;
-      }> | null;
-    }>;
-  };
-};
-
 export type CreateRoleMutationVariables = Exact<{
   input: Types.CreateRoleInput;
 }>;
@@ -1823,30 +1776,6 @@ export type RevokeUserPermissionMutation = {
   };
 };
 
-export type GetUserDirectPermissionsQueryVariables = Exact<{
-  scope: Types.Scope;
-  userId: string | number;
-}>;
-
-export type GetUserDirectPermissionsQuery = {
-  users: {
-    users: Array<{
-      id: string;
-      permissionCount: number;
-      userPermissions: Array<{
-        id: string;
-        permissionId: string;
-        permission: {
-          id: string;
-          name: string;
-          action: string;
-          resource: { slug: string } | null;
-        } | null;
-      }> | null;
-    }>;
-  };
-};
-
 export type CreateUserMutationVariables = Exact<{
   input: Types.CreateUserInput;
 }>;
@@ -5108,83 +5037,6 @@ export const GetInvitationDocument = {
     },
   ],
 } as unknown as DocumentNode<GetInvitationQuery, GetInvitationQueryVariables>;
-export const GetOrganizationInvitationsDocument = {
-  kind: 'Document',
-  definitions: [
-    {
-      kind: 'OperationDefinition',
-      operation: 'query',
-      name: { kind: 'Name', value: 'GetOrganizationInvitations' },
-      variableDefinitions: [
-        {
-          kind: 'VariableDefinition',
-          variable: { kind: 'Variable', name: { kind: 'Name', value: 'scope' } },
-          type: {
-            kind: 'NonNullType',
-            type: { kind: 'NamedType', name: { kind: 'Name', value: 'Scope' } },
-          },
-        },
-        {
-          kind: 'VariableDefinition',
-          variable: { kind: 'Variable', name: { kind: 'Name', value: 'status' } },
-          type: {
-            kind: 'NamedType',
-            name: { kind: 'Name', value: 'OrganizationInvitationStatus' },
-          },
-        },
-      ],
-      selectionSet: {
-        kind: 'SelectionSet',
-        selections: [
-          {
-            kind: 'Field',
-            name: { kind: 'Name', value: 'organizationInvitations' },
-            arguments: [
-              {
-                kind: 'Argument',
-                name: { kind: 'Name', value: 'scope' },
-                value: { kind: 'Variable', name: { kind: 'Name', value: 'scope' } },
-              },
-              {
-                kind: 'Argument',
-                name: { kind: 'Name', value: 'status' },
-                value: { kind: 'Variable', name: { kind: 'Name', value: 'status' } },
-              },
-            ],
-            selectionSet: {
-              kind: 'SelectionSet',
-              selections: [
-                {
-                  kind: 'Field',
-                  name: { kind: 'Name', value: 'invitations' },
-                  selectionSet: {
-                    kind: 'SelectionSet',
-                    selections: [
-                      { kind: 'Field', name: { kind: 'Name', value: 'id' } },
-                      { kind: 'Field', name: { kind: 'Name', value: 'organizationId' } },
-                      { kind: 'Field', name: { kind: 'Name', value: 'email' } },
-                      { kind: 'Field', name: { kind: 'Name', value: 'roleId' } },
-                      { kind: 'Field', name: { kind: 'Name', value: 'status' } },
-                      { kind: 'Field', name: { kind: 'Name', value: 'expiresAt' } },
-                      { kind: 'Field', name: { kind: 'Name', value: 'invitedBy' } },
-                      { kind: 'Field', name: { kind: 'Name', value: 'invitedAt' } },
-                      { kind: 'Field', name: { kind: 'Name', value: 'createdAt' } },
-                    ],
-                  },
-                },
-                { kind: 'Field', name: { kind: 'Name', value: 'totalCount' } },
-                { kind: 'Field', name: { kind: 'Name', value: 'hasNextPage' } },
-              ],
-            },
-          },
-        ],
-      },
-    },
-  ],
-} as unknown as DocumentNode<
-  GetOrganizationInvitationsQuery,
-  GetOrganizationInvitationsQueryVariables
->;
 export const InviteMemberDocument = {
   kind: 'Document',
   definitions: [
@@ -8331,122 +8183,6 @@ export const RevokeRolePermissionDocument = {
     },
   ],
 } as unknown as DocumentNode<RevokeRolePermissionMutation, RevokeRolePermissionMutationVariables>;
-export const GetRoleDirectPermissionsDocument = {
-  kind: 'Document',
-  definitions: [
-    {
-      kind: 'OperationDefinition',
-      operation: 'query',
-      name: { kind: 'Name', value: 'GetRoleDirectPermissions' },
-      variableDefinitions: [
-        {
-          kind: 'VariableDefinition',
-          variable: { kind: 'Variable', name: { kind: 'Name', value: 'scope' } },
-          type: {
-            kind: 'NonNullType',
-            type: { kind: 'NamedType', name: { kind: 'Name', value: 'Scope' } },
-          },
-        },
-        {
-          kind: 'VariableDefinition',
-          variable: { kind: 'Variable', name: { kind: 'Name', value: 'roleId' } },
-          type: {
-            kind: 'NonNullType',
-            type: { kind: 'NamedType', name: { kind: 'Name', value: 'ID' } },
-          },
-        },
-      ],
-      selectionSet: {
-        kind: 'SelectionSet',
-        selections: [
-          {
-            kind: 'Field',
-            name: { kind: 'Name', value: 'roles' },
-            arguments: [
-              {
-                kind: 'Argument',
-                name: { kind: 'Name', value: 'scope' },
-                value: { kind: 'Variable', name: { kind: 'Name', value: 'scope' } },
-              },
-              {
-                kind: 'Argument',
-                name: { kind: 'Name', value: 'ids' },
-                value: {
-                  kind: 'ListValue',
-                  values: [{ kind: 'Variable', name: { kind: 'Name', value: 'roleId' } }],
-                },
-              },
-              {
-                kind: 'Argument',
-                name: { kind: 'Name', value: 'limit' },
-                value: { kind: 'IntValue', value: '1' },
-              },
-            ],
-            selectionSet: {
-              kind: 'SelectionSet',
-              selections: [
-                {
-                  kind: 'Field',
-                  name: { kind: 'Name', value: 'roles' },
-                  selectionSet: {
-                    kind: 'SelectionSet',
-                    selections: [
-                      { kind: 'Field', name: { kind: 'Name', value: 'id' } },
-                      { kind: 'Field', name: { kind: 'Name', value: 'permissionCount' } },
-                      {
-                        kind: 'Field',
-                        name: { kind: 'Name', value: 'rolePermissions' },
-                        selectionSet: {
-                          kind: 'SelectionSet',
-                          selections: [
-                            { kind: 'Field', name: { kind: 'Name', value: 'id' } },
-                            { kind: 'Field', name: { kind: 'Name', value: 'permissionId' } },
-                            {
-                              kind: 'Field',
-                              name: { kind: 'Name', value: 'permission' },
-                              arguments: [
-                                {
-                                  kind: 'Argument',
-                                  name: { kind: 'Name', value: 'scope' },
-                                  value: {
-                                    kind: 'Variable',
-                                    name: { kind: 'Name', value: 'scope' },
-                                  },
-                                },
-                              ],
-                              selectionSet: {
-                                kind: 'SelectionSet',
-                                selections: [
-                                  { kind: 'Field', name: { kind: 'Name', value: 'id' } },
-                                  { kind: 'Field', name: { kind: 'Name', value: 'name' } },
-                                  { kind: 'Field', name: { kind: 'Name', value: 'action' } },
-                                  {
-                                    kind: 'Field',
-                                    name: { kind: 'Name', value: 'resource' },
-                                    selectionSet: {
-                                      kind: 'SelectionSet',
-                                      selections: [
-                                        { kind: 'Field', name: { kind: 'Name', value: 'slug' } },
-                                      ],
-                                    },
-                                  },
-                                ],
-                              },
-                            },
-                          ],
-                        },
-                      },
-                    ],
-                  },
-                },
-              ],
-            },
-          },
-        ],
-      },
-    },
-  ],
-} as unknown as DocumentNode<GetRoleDirectPermissionsQuery, GetRoleDirectPermissionsQueryVariables>;
 export const CreateRoleDocument = {
   kind: 'Document',
   definitions: [
@@ -9399,122 +9135,6 @@ export const RevokeUserPermissionDocument = {
     },
   ],
 } as unknown as DocumentNode<RevokeUserPermissionMutation, RevokeUserPermissionMutationVariables>;
-export const GetUserDirectPermissionsDocument = {
-  kind: 'Document',
-  definitions: [
-    {
-      kind: 'OperationDefinition',
-      operation: 'query',
-      name: { kind: 'Name', value: 'GetUserDirectPermissions' },
-      variableDefinitions: [
-        {
-          kind: 'VariableDefinition',
-          variable: { kind: 'Variable', name: { kind: 'Name', value: 'scope' } },
-          type: {
-            kind: 'NonNullType',
-            type: { kind: 'NamedType', name: { kind: 'Name', value: 'Scope' } },
-          },
-        },
-        {
-          kind: 'VariableDefinition',
-          variable: { kind: 'Variable', name: { kind: 'Name', value: 'userId' } },
-          type: {
-            kind: 'NonNullType',
-            type: { kind: 'NamedType', name: { kind: 'Name', value: 'ID' } },
-          },
-        },
-      ],
-      selectionSet: {
-        kind: 'SelectionSet',
-        selections: [
-          {
-            kind: 'Field',
-            name: { kind: 'Name', value: 'users' },
-            arguments: [
-              {
-                kind: 'Argument',
-                name: { kind: 'Name', value: 'scope' },
-                value: { kind: 'Variable', name: { kind: 'Name', value: 'scope' } },
-              },
-              {
-                kind: 'Argument',
-                name: { kind: 'Name', value: 'ids' },
-                value: {
-                  kind: 'ListValue',
-                  values: [{ kind: 'Variable', name: { kind: 'Name', value: 'userId' } }],
-                },
-              },
-              {
-                kind: 'Argument',
-                name: { kind: 'Name', value: 'limit' },
-                value: { kind: 'IntValue', value: '1' },
-              },
-            ],
-            selectionSet: {
-              kind: 'SelectionSet',
-              selections: [
-                {
-                  kind: 'Field',
-                  name: { kind: 'Name', value: 'users' },
-                  selectionSet: {
-                    kind: 'SelectionSet',
-                    selections: [
-                      { kind: 'Field', name: { kind: 'Name', value: 'id' } },
-                      { kind: 'Field', name: { kind: 'Name', value: 'permissionCount' } },
-                      {
-                        kind: 'Field',
-                        name: { kind: 'Name', value: 'userPermissions' },
-                        selectionSet: {
-                          kind: 'SelectionSet',
-                          selections: [
-                            { kind: 'Field', name: { kind: 'Name', value: 'id' } },
-                            { kind: 'Field', name: { kind: 'Name', value: 'permissionId' } },
-                            {
-                              kind: 'Field',
-                              name: { kind: 'Name', value: 'permission' },
-                              arguments: [
-                                {
-                                  kind: 'Argument',
-                                  name: { kind: 'Name', value: 'scope' },
-                                  value: {
-                                    kind: 'Variable',
-                                    name: { kind: 'Name', value: 'scope' },
-                                  },
-                                },
-                              ],
-                              selectionSet: {
-                                kind: 'SelectionSet',
-                                selections: [
-                                  { kind: 'Field', name: { kind: 'Name', value: 'id' } },
-                                  { kind: 'Field', name: { kind: 'Name', value: 'name' } },
-                                  { kind: 'Field', name: { kind: 'Name', value: 'action' } },
-                                  {
-                                    kind: 'Field',
-                                    name: { kind: 'Name', value: 'resource' },
-                                    selectionSet: {
-                                      kind: 'SelectionSet',
-                                      selections: [
-                                        { kind: 'Field', name: { kind: 'Name', value: 'slug' } },
-                                      ],
-                                    },
-                                  },
-                                ],
-                              },
-                            },
-                          ],
-                        },
-                      },
-                    ],
-                  },
-                },
-              ],
-            },
-          },
-        ],
-      },
-    },
-  ],
-} as unknown as DocumentNode<GetUserDirectPermissionsQuery, GetUserDirectPermissionsQueryVariables>;
 export const CreateUserDocument = {
   kind: 'Document',
   definitions: [