@grantjs/schema 1.20.1 → 1.21.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grantjs/schema",
-  "version": "1.20.1",
+  "version": "1.21.0",
   "license": "MIT",
   "repository": {
     "type": "git",

package/src/events/event-envelope.ts

@@ -48,6 +48,30 @@ export type EventIdentityKey = (typeof EVENT_IDENTITY_KEYS)[number];
 /** Identity-only projection of an internal `before` snapshot (see `EVENT_IDENTITY_KEYS`). */
 export type EventIdentity = Partial<Record<EventIdentityKey, string | number | boolean | null>>;
 
+/**
+ * The source-system key a CDM import attached to a user in one project, as carried in
+ * `data.before.externalKeys`. A pseudonymous identifier: it means something only next to
+ * the importing system's own data. Never an e-mail address, a name or a hash.
+ */
+export interface EventExternalKey {
+  projectId: string;
+  externalKey: string;
+}
+
+/**
+ * The event types whose external `data.before` carries `externalKeys`. The projection
+ * copies the list for these types only, and only the entries of the receiving
+ * subscription's project.
+ */
+export const EXTERNAL_KEY_EVENT_TYPES = ['user.deleted', 'project.user_removed'] as const;
+
+/**
+ * An external `data.before`: the identity keys, plus `externalKeys` on the types in
+ * `EXTERNAL_KEY_EVENT_TYPES` (`[]` when the user has no key in the receiving project;
+ * absent on Grant older than v1.20.2).
+ */
+export type ExternalEventBefore = EventIdentity & { externalKeys?: EventExternalKey[] };
+
 /**
  * `data` as delivered to webhook consumers: `after` and `delta` redacted, `before`
  * reduced to the identity of the entity or pivot the event is about. Absent when
@@ -55,7 +79,7 @@ export type EventIdentity = Partial<Record<EventIdentityKey, string | number | b
  */
 export interface ExternalEventData {
   after?: Record<string, unknown> | null;
-  before?: EventIdentity | null;
+  before?: ExternalEventBefore | null;
   delta?: Record<string, { from: unknown; to: unknown }> | null;
 }
 

package/src/generated/graphql.ts

@@ -1491,6 +1491,7 @@ export type ProjectSyncJobQuery = {
       passwordsUpdated: number;
       passwordsUnchanged: number;
       passwordsSkippedExisting: number;
+      usersSkippedTombstoned: number;
       warnings: Array<string>;
     } | null;
   };
@@ -8165,6 +8166,7 @@ export const ProjectSyncJobDocument = {
                       { kind: 'Field', name: { kind: 'Name', value: 'passwordsUpdated' } },
                       { kind: 'Field', name: { kind: 'Name', value: 'passwordsUnchanged' } },
                       { kind: 'Field', name: { kind: 'Name', value: 'passwordsSkippedExisting' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'usersSkippedTombstoned' } },
                       { kind: 'Field', name: { kind: 'Name', value: 'warnings' } },
                     ],
                   },

package/src/generated/resolvers.ts

@@ -3404,6 +3404,7 @@ export type SyncProjectResultResolvers<
   userRolesAssigned?: Resolver<ResolversTypes['Int'], ParentType, ContextType>;
   userTagsLinked?: Resolver<ResolversTypes['Int'], ParentType, ContextType>;
   usersCreated?: Resolver<ResolversTypes['Int'], ParentType, ContextType>;
+  usersSkippedTombstoned?: Resolver<ResolversTypes['Int'], ParentType, ContextType>;
   warnings?: Resolver<Array<ResolversTypes['String']>, ParentType, ContextType>;
 }>;
 

package/src/generated/schema-types.ts

@@ -453,6 +453,11 @@ export type CdmKeyResolverInput = {
    * import/export.
    */
   findBy?: InputMaybe<CdmFindBy>;
+  /**
+   * Only with `findBy: key`: an existing, live Grant user this key is, reused instead of creating one and marked
+   * with the key for this project. Refused for a missing, deleted or already-imported-under-another-key user.
+   */
+  grantUserId?: InputMaybe<Scalars['ID']['input']>;
   ifMissing?: InputMaybe<CdmIfMissing>;
   /**
    * Identifier value. For `findBy: email`, Grant normalizes this to lowercase
@@ -3797,6 +3802,11 @@ export type SyncProjectResult = {
   userRolesAssigned: Scalars['Int']['output'];
   userTagsLinked: Scalars['Int']['output'];
   usersCreated: Scalars['Int']['output'];
+  /**
+   * Document users not created because the person deleted this imported identity; their
+   * membership, credential and API keys were not written either.
+   */
+  usersSkippedTombstoned: Scalars['Int']['output'];
   warnings: Array<Scalars['String']['output']>;
 };
 

package/src/operations/projects/project-sync-job.graphql

@@ -29,6 +29,7 @@ query ProjectSyncJob($id: ID!, $scope: Scope!, $jobId: ID!) {
       passwordsUpdated
       passwordsUnchanged
       passwordsSkippedExisting
+      usersSkippedTombstoned
       warnings
     }
     warnings

package/src/schema/projects/inputs/sync-project-cdm.graphql

@@ -53,6 +53,11 @@ input CdmKeyResolverInput {
   """
   findBy: CdmFindBy
   ifMissing: CdmIfMissing
+  """
+  Only with `findBy: key`: an existing, live Grant user this key is, reused instead of creating one and marked
+  with the key for this project. Refused for a missing, deleted or already-imported-under-another-key user.
+  """
+  grantUserId: ID
 }
 
 """

package/src/schema/projects/types/sync-project-result.graphql

@@ -51,6 +51,11 @@ type SyncProjectResult {
   reset in Grant, not imported.
   """
   passwordsSkippedExisting: Int!
+  """
+  Document users not created because the person deleted this imported identity; their
+  membership, credential and API keys were not written either.
+  """
+  usersSkippedTombstoned: Int!
   resourcesCreated: Int!
   permissionsCreated: Int!
   tagsCreated: Int!