@digdir/dialogporten-schema 1.7.1 → 1.8.1-2a6fe0f

package/package.json

@@ -1,10 +1,22 @@
 {
   "name": "@digdir/dialogporten-schema",
-  "version": "1.7.1",
+  "version": "1.8.1-2a6fe0f",
   "description": "GraphQl schema and OpenAPI spec for Dialogporten",
   "author": "DigDir",
+  "main": "src/index.js",
   "repository": {
     "url": "git+https://github.com/digdir/dialogporten.git"
   },
-  "license": "ISC"
+  "scripts": {
+    "build": "./gql-to-js.js",
+    "prepublishOnly": "npm run build",
+    "test": "npm run build && vitest run --test-timeout=10000"
+  },
+  "devDependencies": {
+    "vitest": "^1.2.2",
+    "glob": "^10.3.12",
+    "graphql-tag": "^2.12.6"
+  },
+  "license": "ISC",
+  "type": "module"
 }

package/schema.verified.graphql

@@ -16,17 +16,21 @@ type Activity {
   extendedType: URL
   type: ActivityType!
   relatedActivityId: UUID
-  dialogElementId: UUID
-  performedBy: [Localization!]
+  performedBy: Actor!
   description: [Localization!]!
 }
 
+type Actor {
+  actorType: ActorType
+  actorId: String
+  actorName: String
+}
+
 type ApiAction {
   id: UUID!
   action: String!
   authorizationAttribute: String
   isAuthorized: Boolean!
-  dialogElementId: UUID
   endpoints: [ApiActionEndpoint!]!
 }
 
@@ -42,6 +46,18 @@ type ApiActionEndpoint {
   sunsetAt: DateTime
 }
 
+type Attachment {
+  id: UUID!
+  displayName: [Localization!]!
+  urls: [AttachmentUrl!]!
+}
+
+type AttachmentUrl {
+  id: UUID!
+  url: URL!
+  consumerType: AttachmentUrlConsumer!
+}
+
 type AuthorizedParty {
   party: String!
   name: String!
@@ -57,6 +73,7 @@ type AuthorizedParty {
 type Content {
   type: ContentType!
   value: [Localization!]!
+  mediaType: String
 }
 
 type Dialog {
@@ -77,7 +94,7 @@ type Dialog {
   dialogToken: String
   status: DialogStatus!
   content: [Content!]!
-  elements: [Element!]!
+  attachments: [Attachment!]!
   guiActions: [GuiAction!]!
   apiActions: [ApiAction!]!
   activities: [Activity!]!
@@ -101,39 +118,22 @@ type DialogByIdPayload {
   errors: [DialogByIdError!]!
 }
 
-type Element {
-  id: UUID!
-  type: URL
-  externalReference: String
-  authorizationAttribute: String
-  isAuthorized: Boolean!
-  relatedDialogElementId: UUID
-  displayName: [Localization!]!
-  urls: [ElementUrl!]!
-}
-
-type ElementUrl {
-  id: UUID!
-  url: URL!
-  mimeType: String
-  consumerType: ElementUrlConsumer!
-}
-
 type GuiAction {
   id: UUID!
   action: String!
   url: URL!
   authorizationAttribute: String
   isAuthorized: Boolean!
-  isBackChannel: Boolean!
-  isDeleteAction: Boolean!
+  isDeleteDialogAction: Boolean!
   priority: GuiActionPriority!
+  httpMethod: HttpVerb!
   title: [Localization!]!
+  prompt: [Localization!]
 }
 
 type Localization {
   value: String!
-  cultureCode: String!
+  languageCode: String!
 }
 
 type Queries @authorize(policy: "enduser") {
@@ -179,8 +179,7 @@ type SearchDialogsPayload {
 type SeenLog {
   id: UUID!
   seenAt: DateTime!
-  endUserIdHash: String!
-  endUserName: String
+  seenBy: Actor!
   isCurrentEndUser: Boolean!
 }
 
@@ -211,8 +210,8 @@ input SearchDialogInput {
   dueBefore: DateTime
   "Search string for free text search. Will attempt to fuzzily match in all free text fields in the aggregate"
   search: String
-  "Limit free text search to texts with this culture code, e.g. \"nb-NO\". Default: search all culture codes"
-  searchCultureCode: String
+  "Limit free text search to texts with this language code, e.g. 'no', 'en'. Culture codes will be normalized to neutral language codes (ISO 639). Default: search all culture codes"
+  searchLanguageCode: String
 }
 
 enum ActivityType {
@@ -230,40 +229,46 @@ enum ActivityType {
   FORWARDED
 }
 
+enum ActorType {
+  PARTY_REPRESENTATIVE
+  SERVICE_OWNER
+}
+
 enum ApplyPolicy {
   BEFORE_RESOLVER
   AFTER_RESOLVER
   VALIDATION
 }
 
+enum AttachmentUrlConsumer {
+  GUI
+  API
+}
+
 enum ContentType {
   TITLE
   SENDER_NAME
   SUMMARY
   ADDITIONAL_INFO
   EXTENDED_STATUS
+  MAIN_CONTENT_REFERENCE
 }
 
 enum DialogStatus {
-  "New"
+  "The dialogue is considered new. Typically used for simple messages that do not require any interaction, or as an initial step for dialogues. This is the default."
   NEW
-  "In progress. General status used for dialog services where further user input is expected."
+  "Started. In a serial process, this is used to indicate that, for example, a form filling is ongoing."
   IN_PROGRESS
-  "Waiting for feedback from the service provider"
-  WAITING
-  "The dialog is in a state where it is waiting for signing. Typically the last step after all completion is carried out and validated."
+  "Equivalent to \"InProgress\", but will be used by the workspace\/frontend for display purposes."
   SIGNING
-  "The dialog was cancelled. This typically removes the dialog from normal GUI views."
-  CANCELLED
-  "The dialog was completed. This typically moves the dialog to a GUI archive or similar."
+  "For processing by the service owner. In a serial process, this is used after a submission is made."
+  PROCESSING
+  "Used to indicate that the dialogue is in progress\/under work, but is in a state where the user must do something - for example, correct an error, or other conditions that hinder further processing."
+  REQUIRES_ATTENTION
+  "The dialogue was completed. This typically means that the dialogue is moved to a GUI archive or similar."
   COMPLETED
 }
 
-enum ElementUrlConsumer {
-  GUI
-  API
-}
-
 enum GuiActionPriority {
   PRIMARY
   SECONDARY

package/src/index.js

@@ -0,0 +1,297 @@
+export const schema_verified_graphql = `schema {
+  query: Queries
+}
+
+interface DialogByIdError {
+  message: String!
+}
+
+interface SearchDialogError {
+  message: String!
+}
+
+type Activity {
+  id: UUID!
+  createdAt: DateTime
+  extendedType: URL
+  type: ActivityType!
+  relatedActivityId: UUID
+  performedBy: Actor!
+  description: [Localization!]!
+}
+
+type Actor {
+  actorType: ActorType
+  actorId: String
+  actorName: String
+}
+
+type ApiAction {
+  id: UUID!
+  action: String!
+  authorizationAttribute: String
+  isAuthorized: Boolean!
+  endpoints: [ApiActionEndpoint!]!
+}
+
+type ApiActionEndpoint {
+  id: UUID!
+  version: String
+  url: URL!
+  httpMethod: HttpVerb!
+  documentationUrl: URL
+  requestSchema: URL
+  responseSchema: URL
+  deprecated: Boolean!
+  sunsetAt: DateTime
+}
+
+type Attachment {
+  id: UUID!
+  displayName: [Localization!]!
+  urls: [AttachmentUrl!]!
+}
+
+type AttachmentUrl {
+  id: UUID!
+  url: URL!
+  consumerType: AttachmentUrlConsumer!
+}
+
+type AuthorizedParty {
+  party: String!
+  name: String!
+  partyType: String!
+  isDeleted: Boolean!
+  hasKeyRole: Boolean!
+  isMainAdministrator: Boolean!
+  isAccessManager: Boolean!
+  hasOnlyAccessToSubParties: Boolean!
+  subParties: [AuthorizedParty!]
+}
+
+type Content {
+  type: ContentType!
+  value: [Localization!]!
+  mediaType: String
+}
+
+type Dialog {
+  id: UUID!
+  revision: UUID!
+  org: String!
+  serviceResource: String!
+  serviceResourceType: String!
+  party: String!
+  progress: Int
+  extendedStatus: String
+  externalReference: String
+  visibleFrom: DateTime
+  dueAt: DateTime
+  expiresAt: DateTime
+  createdAt: DateTime!
+  updatedAt: DateTime!
+  dialogToken: String
+  status: DialogStatus!
+  content: [Content!]!
+  attachments: [Attachment!]!
+  guiActions: [GuiAction!]!
+  apiActions: [ApiAction!]!
+  activities: [Activity!]!
+  seenSinceLastUpdate: [SeenLog!]!
+}
+
+type DialogByIdDeleted implements DialogByIdError {
+  message: String!
+}
+
+type DialogByIdForbidden implements DialogByIdError {
+  message: String!
+}
+
+type DialogByIdNotFound implements DialogByIdError {
+  message: String!
+}
+
+type DialogByIdPayload {
+  dialog: Dialog
+  errors: [DialogByIdError!]!
+}
+
+type GuiAction {
+  id: UUID!
+  action: String!
+  url: URL!
+  authorizationAttribute: String
+  isAuthorized: Boolean!
+  isDeleteDialogAction: Boolean!
+  priority: GuiActionPriority!
+  httpMethod: HttpVerb!
+  title: [Localization!]!
+  prompt: [Localization!]
+}
+
+type Localization {
+  value: String!
+  languageCode: String!
+}
+
+type Queries @authorize(policy: "enduser") {
+  dialogById(dialogId: UUID!): DialogByIdPayload!
+  searchDialogs(input: SearchDialogInput!): SearchDialogsPayload!
+  parties: [AuthorizedParty!]!
+}
+
+type SearchDialog {
+  id: UUID!
+  org: String!
+  serviceResource: String!
+  serviceResourceType: String!
+  party: String!
+  progress: Int
+  guiAttachmentCount: Int
+  extendedStatus: String
+  createdAt: DateTime!
+  updatedAt: DateTime!
+  dueAt: DateTime
+  status: DialogStatus!
+  latestActivity: Activity
+  content: [Content!]!
+  seenSinceLastUpdate: [SeenLog!]!
+}
+
+type SearchDialogForbidden implements SearchDialogError {
+  message: String!
+}
+
+type SearchDialogValidationError implements SearchDialogError {
+  message: String!
+}
+
+type SearchDialogsPayload {
+  items: [SearchDialog!]
+  hasNextPage: Boolean!
+  continuationToken: String
+  orderBy: String
+  errors: [SearchDialogError!]!
+}
+
+type SeenLog {
+  id: UUID!
+  seenAt: DateTime!
+  seenBy: Actor!
+  isCurrentEndUser: Boolean!
+}
+
+input SearchDialogInput {
+  "Filter by one or more service owner codes"
+  org: [String!]
+  "Filter by one or more service resources"
+  serviceResource: [String!]
+  "Filter by one or more owning parties"
+  party: [String!]
+  "Filter by one or more extended statuses"
+  extendedStatus: [String!]
+  "Filter by external reference"
+  externalReference: String
+  "Filter by status"
+  status: [DialogStatus!]
+  "Only return dialogs created after this date"
+  createdAfter: DateTime
+  "Only return dialogs created before this date"
+  createdBefore: DateTime
+  "Only return dialogs updated after this date"
+  updatedAfter: DateTime
+  "Only return dialogs updated before this date"
+  updatedBefore: DateTime
+  "Only return dialogs with due date after this date"
+  dueAfter: DateTime
+  "Only return dialogs with due date before this date"
+  dueBefore: DateTime
+  "Search string for free text search. Will attempt to fuzzily match in all free text fields in the aggregate"
+  search: String
+  "Limit free text search to texts with this language code, e.g. 'no', 'en'. Culture codes will be normalized to neutral language codes (ISO 639). Default: search all culture codes"
+  searchLanguageCode: String
+}
+
+enum ActivityType {
+  "Refers to a submission made by a party that has been received by the service provider."
+  SUBMISSION
+  "Indicates feedback from the service provider on a submission. Contains a reference to the current submission."
+  FEEDBACK
+  "Information from the service provider, not (directly) related to any submission."
+  INFORMATION
+  "Used to indicate an error situation, typically on a submission. Contains a service-specific activityErrorCode."
+  ERROR
+  "Indicates that the dialog is closed for further changes. This typically happens when the dialog is completed or deleted."
+  CLOSED
+  "When the dialog is forwarded (delegated access) by someone with access to others."
+  FORWARDED
+}
+
+enum ActorType {
+  PARTY_REPRESENTATIVE
+  SERVICE_OWNER
+}
+
+enum ApplyPolicy {
+  BEFORE_RESOLVER
+  AFTER_RESOLVER
+  VALIDATION
+}
+
+enum AttachmentUrlConsumer {
+  GUI
+  API
+}
+
+enum ContentType {
+  TITLE
+  SENDER_NAME
+  SUMMARY
+  ADDITIONAL_INFO
+  EXTENDED_STATUS
+  MAIN_CONTENT_REFERENCE
+}
+
+enum DialogStatus {
+  "The dialogue is considered new. Typically used for simple messages that do not require any interaction, or as an initial step for dialogues. This is the default."
+  NEW
+  "Started. In a serial process, this is used to indicate that, for example, a form filling is ongoing."
+  IN_PROGRESS
+  "Equivalent to 'InProgress', but will be used by the workspace\/frontend for display purposes."
+  SIGNING
+  "For processing by the service owner. In a serial process, this is used after a submission is made."
+  PROCESSING
+  "Used to indicate that the dialogue is in progress\/under work, but is in a state where the user must do something - for example, correct an error, or other conditions that hinder further processing."
+  REQUIRES_ATTENTION
+  "The dialogue was completed. This typically means that the dialogue is moved to a GUI archive or similar."
+  COMPLETED
+}
+
+enum GuiActionPriority {
+  PRIMARY
+  SECONDARY
+  TERTIARY
+}
+
+enum HttpVerb {
+  GET
+  POST
+  PUT
+  PATCH
+  DELETE
+  HEAD
+  OPTIONS
+  TRACE
+  CONNECT
+}
+
+directive @authorize("The name of the authorization policy that determines access to the annotated resource." policy: String "Roles that are allowed to access the annotated resource." roles: [String!] "Defines when when the authorize directive shall be applied.By default the authorize directives are applied during the validation phase." apply: ApplyPolicy! = BEFORE_RESOLVER) repeatable on OBJECT | FIELD_DEFINITION
+
+"The 'DateTime' scalar represents an ISO-8601 compliant date time type."
+scalar DateTime @specifiedBy(url: "https:\/\/www.graphql-scalars.com\/date-time")
+
+scalar URL @specifiedBy(url: "https:\/\/tools.ietf.org\/html\/rfc3986")
+
+scalar UUID @specifiedBy(url: "https:\/\/tools.ietf.org\/html\/rfc4122")`