@grantjs/schema 1.0.0 → 1.1.0

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

@@ -0,0 +1,132 @@
+enum CdmModeStrategy {
+  merge
+  replace
+}
+
+enum CdmOnConflict {
+  fail
+  skip
+  update
+}
+
+enum CdmFindBy {
+  key
+  id
+  email
+  name
+  slug
+}
+
+enum CdmIfMissing {
+  fail
+  skip
+  createNew
+}
+
+input CdmModeInput {
+  strategy: CdmModeStrategy!
+  onConflict: CdmOnConflict
+  confirmDestructive: Boolean
+}
+
+input CdmKeyResolverInput {
+  value: String!
+  findBy: CdmFindBy
+  ifMissing: CdmIfMissing
+}
+
+"""
+Project resource row for CDM import/export.
+"""
+input ResourceCdmInput {
+  key: String!
+  slug: String
+  name: String!
+  description: String
+  actions: [String!]!
+  tags: [String!]
+  primaryTag: String
+  metadata: JSON
+}
+
+"""
+Custom permission for this project; `resource` is an opaque key in the same document.
+"""
+input PermissionCdmInput {
+  key: String!
+  resource: String!
+  action: String!
+  name: String!
+  description: String
+  condition: JSON
+  groups: [String!]
+  tags: [String!]
+  primaryTag: String
+  metadata: JSON
+}
+
+input TagCdmInput {
+  key: String!
+  name: String!
+  color: String!
+  metadata: JSON
+}
+
+input GroupCdmInput {
+  key: String!
+  name: String!
+  description: String
+  permissions: [String!]
+  tags: [String!]
+  primaryTag: String
+  metadata: JSON
+}
+
+input RoleCdmInput {
+  key: String!
+  name: String!
+  description: String
+  groups: [String!]
+  permissions: [String!]
+  tags: [String!]
+  primaryTag: String
+  metadata: JSON
+}
+
+input UserApiKeyCdmInput {
+  key: String
+  clientId: String
+  clientSecret: String
+  name: String
+  description: String
+  expiresAt: Date
+  metadata: JSON
+}
+
+input UserCdmInput {
+  key: CdmKeyResolverInput!
+  name: String!
+  roles: [String!]
+  groups: [String!]
+  permissions: [String!]
+  tags: [String!]
+  primaryTag: String
+  apiKeys: [UserApiKeyCdmInput!]
+  metadata: JSON
+}
+
+"""
+Versioned canonical project document (CDM) for export/import: roles, users,
+resources, permissions, groups, and tags scoped to one project.
+"""
+input SyncProjectInput {
+  version: Int!
+  id: String
+  mode: CdmModeInput!
+  roles: [RoleCdmInput!]!
+  users: [UserCdmInput!]!
+  resources: [ResourceCdmInput!]
+  permissions: [PermissionCdmInput!]
+  groups: [GroupCdmInput!]
+  tags: [TagCdmInput!]
+}

package/src/schema/projects/mutations/cancel-project-sync.graphql

@@ -0,0 +1,9 @@
+extend type Mutation {
+  """
+  Cancel a pending or running project CDM sync job. Cancellation is
+  immediate when the job is still PENDING; if the job is already RUNNING, the
+  cancellation is recorded and the worker stops at the next checkpoint
+  (best-effort).
+  """
+  cancelProjectSync(id: ID!, scope: Scope!, jobId: ID!): ProjectSyncJob!
+}

package/src/schema/projects/mutations/start-project-export.graphql

@@ -0,0 +1,12 @@
+extend type Mutation {
+  """
+  Enqueue an asynchronous CDM **export** job for the given project. The worker
+  snapshots current permission state into a replay-ready `SyncProjectInput` and
+  stores it on the job row (`snapshot`); poll `projectSyncJob` for status.
+
+  Requires Project:update in the given project scope (same as starting import jobs).
+
+  Pass optional `input.jobName` for idempotency with the same rules as import `input.id`.
+  """
+  startProjectExport(id: ID!, scope: Scope!, input: StartProjectExportInput!): ProjectSyncJob!
+}

package/src/schema/projects/mutations/start-project-sync.graphql

@@ -0,0 +1,15 @@
+extend type Mutation {
+  """
+  Enqueue an asynchronous project CDM import job for the given project.
+  Applies a canonical data model document: roles, groups, resources, permissions,
+  tags, project pivots, and user assignments scoped to the project.
+  Requires Project:update in the given project scope.
+
+  Returns immediately with a job descriptor in the PENDING status; the actual
+  import runs in the background. Poll `projectSyncJob` for status.
+  Pass optional `input.id` as a stable **job name** for idempotency: if an active job
+  already exists for the same `(project, operation=IMPORT, jobName)`, that job is
+  returned instead of creating a new one.
+  """
+  startProjectSync(id: ID!, scope: Scope!, input: SyncProjectInput!): ProjectSyncJob!
+}

package/src/schema/projects/queries/project-sync-job.graphql

@@ -0,0 +1,7 @@
+extend type Query {
+  """
+  Read the current state of a project CDM sync job. Use this to poll
+  the lifecycle of a job started via `startProjectSync`.
+  """
+  projectSyncJob(id: ID!, scope: Scope!, jobId: ID!): ProjectSyncJob!
+}

package/src/schema/projects/queries/project-sync-jobs.graphql

@@ -0,0 +1,17 @@
+extend type Query {
+  """
+  List project CDM sync jobs for a project, with optional pagination,
+  search (matches jobName), status filter, and sort. Use this to populate the
+  job history view. Use `projectSyncJob` to read a single job's
+  current state for polling.
+  """
+  projectSyncJobs(
+    id: ID!
+    scope: Scope!
+    page: Int
+    limit: Int
+    search: String
+    sort: ProjectSyncJobSortInput
+    status: ProjectSyncJobStatus
+  ): ProjectSyncJobPage!
+}

package/src/schema/projects/types/project-sync-job-page.graphql

@@ -0,0 +1,8 @@
+"""
+Paginated list of project CDM sync jobs.
+"""
+type ProjectSyncJobPage implements PaginatedResults {
+  jobs: [ProjectSyncJob!]!
+  totalCount: Int!
+  hasNextPage: Boolean!
+}

package/src/schema/projects/types/project-sync-job-sortable-field.graphql

@@ -0,0 +1,7 @@
+enum ProjectSyncJobSortableField {
+  enqueuedAt
+  startedAt
+  completedAt
+  status
+  jobName
+}

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

@@ -0,0 +1,53 @@
+"""
+Lifecycle status of an asynchronous project CDM sync job.
+"""
+enum ProjectSyncJobStatus {
+  PENDING
+  RUNNING
+  COMPLETED
+  FAILED
+  CANCELLED
+}
+
+"""
+CDM import or export work for a project (`project_sync_jobs`).
+"""
+enum ProjectSyncJobOperation {
+  IMPORT
+  EXPORT
+}
+
+"""
+Asynchronous project CDM import or export job.
+"""
+type ProjectSyncJob {
+  id: ID!
+  projectId: ID!
+  status: ProjectSyncJobStatus!
+  cdmVersion: Int!
+  """
+  Client idempotency key from `SyncProjectInput.id` on import.
+  """
+  jobName: String
+  operation: ProjectSyncJobOperation!
+  """
+  Import merge/replace; null for export.
+  """
+  modeStrategy: CdmModeStrategy
+  """
+  Import counters when completed; null for export (CDM in snapshot download).
+  """
+  result: SyncProjectResult
+  warnings: [String!]!
+  errorMessage: String
+  enqueuedAt: Date!
+  startedAt: Date
+  completedAt: Date
+  cancelledAt: Date
+  """
+  Rollback snapshot (import) or exported CDM (export); REST `.../snapshot`.
+  """
+  hasSnapshot: Boolean!
+  snapshotTakenAt: Date
+  snapshotSizeBytes: Int
+}

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

@@ -0,0 +1,27 @@
+"""
+Counters and warnings from a completed CDM import.
+"""
+type SyncProjectResult {
+  projectId: ID!
+  importId: String
+  rolesCreated: Int!
+  groupsCreated: Int!
+  roleGroupsLinked: Int!
+  groupPermissionsLinked: Int!
+  projectRolesLinked: Int!
+  projectGroupsLinked: Int!
+  projectPermissionsLinked: Int!
+  projectResourcesLinked: Int!
+  projectUsersEnsured: Int!
+  usersCreated: Int!
+  userRolesAssigned: Int!
+  projectUserApiKeysCreated: Int!
+  resourcesCreated: Int!
+  permissionsCreated: Int!
+  tagsCreated: Int!
+  projectTagsLinked: Int!
+  roleTagsLinked: Int!
+  groupTagsLinked: Int!
+  userTagsLinked: Int!
+  warnings: [String!]!
+}

package/src/schema/resources/inputs/create-resource.graphql

@@ -7,4 +7,6 @@ input CreateResourceInput {
   isActive: Boolean
   tagIds: [ID!]
   primaryTagId: ID
+  createPermissions: Boolean
+  metadata: JSON
 }

package/src/schema/resources/inputs/update-resource.graphql

@@ -7,4 +7,5 @@ input UpdateResourceInput {
   isActive: Boolean
   tagIds: [ID!]
   primaryTagId: ID
+  metadata: JSON
 }

package/src/schema/resources/types/resource.graphql

@@ -5,7 +5,9 @@ type Resource implements Auditable {
   description: String
   actions: [String!]!
   isActive: Boolean!
+  metadata: JSON!
   tags: [Tag!]!
+  permissions: [Permission!]
   createdAt: Date!
   updatedAt: Date!
   deletedAt: Date

package/src/schema/tags/inputs/create-tag.graphql

@@ -1,5 +1,6 @@
 input CreateTagInput {
   name: String!
   color: String!
+  metadata: JSON
   scope: Scope!
 }

package/src/schema/tags/inputs/update-tag.graphql

@@ -2,4 +2,5 @@ input UpdateTagInput {
   scope: Scope!
   name: String
   color: String
+  metadata: JSON
 }

package/src/schema/tags/types/tag.graphql

@@ -3,6 +3,7 @@ type Tag implements Auditable {
   name: String!
   color: String!
   isPrimary: Boolean
+  metadata: JSON!
   createdAt: Date!
   updatedAt: Date!
   deletedAt: Date