npm - @digdir/dialogporten-schema - Versions diffs - 1.8.1-5aea32b → 1.8.1-6301ef5 - Mend

@digdir/dialogporten-schema 1.8.1-5aea32b → 1.8.1-6301ef5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/package.json CHANGED Viewed

@@ -1,10 +1,25 @@
 {
   "name": "@digdir/dialogporten-schema",
-  "version": "1.8.1-5aea32b",
+  "version": "1.8.1-6301ef5",
   "description": "GraphQl schema and OpenAPI spec for Dialogporten",
+  "engines": {
+    "node": "20"
+  },
   "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": "2.0.4",
+    "glob": "11.0.0",
+    "graphql-tag": "2.12.6"
+  },
+  "license": "ISC",
+  "type": "module"
 }

package/schema.verified.graphql CHANGED Viewed

@@ -71,9 +71,17 @@ type AuthorizedParty {
 }
 type Content {
-  type: ContentType!
+  title: ContentValue!
+  summary: ContentValue!
+  senderName: ContentValue
+  additionalInfo: ContentValue
+  extendedStatus: ContentValue
+  mainContentReference: ContentValue
+}
+type ContentValue {
   value: [Localization!]!
-  mediaType: String
+  mediaType: String!
 }
 type Dialog {
@@ -93,7 +101,7 @@ type Dialog {
   updatedAt: DateTime!
   dialogToken: String
   status: DialogStatus!
-  content: [Content!]!
+  content: Content!
   attachments: [Attachment!]!
   guiActions: [GuiAction!]!
   apiActions: [ApiAction!]!
@@ -142,6 +150,13 @@ type Queries @authorize(policy: "enduser") {
   parties: [AuthorizedParty!]!
 }
+type SearchContent {
+  title: ContentValue!
+  summary: ContentValue!
+  senderName: ContentValue
+  extendedStatus: ContentValue
+}
 type SearchDialog {
   id: UUID!
   org: String!
@@ -156,7 +171,7 @@ type SearchDialog {
   dueAt: DateTime
   status: DialogStatus!
   latestActivity: Activity
-  content: [Content!]!
+  content: SearchContent!
   seenSinceLastUpdate: [SeenLog!]!
 }
@@ -245,15 +260,6 @@ enum AttachmentUrlConsumer {
   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

package/src/index.js ADDED Viewed

@@ -0,0 +1,303 @@
+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 {
+  title: ContentValue!
+  summary: ContentValue!
+  senderName: ContentValue
+  additionalInfo: ContentValue
+  extendedStatus: ContentValue
+  mainContentReference: ContentValue
+}
+type ContentValue {
+  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 SearchContent {
+  title: ContentValue!
+  summary: ContentValue!
+  senderName: ContentValue
+  extendedStatus: ContentValue
+}
+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: SearchContent!
+  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 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")`

package/swagger.verified.json CHANGED Viewed

@@ -221,19 +221,17 @@
                 "DueAt": "2084-04-04T12:13:10.01344+00:00",
                 "ExpiresAt": "2095-05-04T12:13:10.01344+00:00",
                 "Status": 1,
-                "Content": [
-                  {
-                    "Type": 1,
+                "Content": {
+                  "Title": {
                     "Value": [
                       {
-                        "Value": "Some Title",
+                        "Value": "Some title",
                         "LanguageCode": "en"
                       }
                     ],
                     "MediaType": "text/plain"
                   },
-                  {
-                    "Type": 3,
+                  "Summary": {
                     "Value": [
                       {
                         "Value": "Some Summary",
@@ -241,8 +239,20 @@
                       }
                     ],
                     "MediaType": "text/plain"
-                  }
-                ],
+                  },
+                  "SenderName": null,
+                  "AdditionalInfo": {
+                    "Value": [
+                      {
+                        "Value": "Some description with *markdown* support",
+                        "LanguageCode": "en"
+                      }
+                    ],
+                    "MediaType": "text/markdown"
+                  },
+                  "ExtendedStatus": null,
+                  "MainContentReference": null
+                },
                 "SearchTags": [
                   {
                     "Value": "searchTag"
@@ -1949,10 +1959,7 @@
             "$ref": "#/components/schemas/DialogStatus_Values"
           },
           "content": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/UpdateDialogContentDto"
-            }
+            "$ref": "#/components/schemas/UpdateDialogContentDto"
           },
           "searchTags": {
             "type": "array",
@@ -2010,9 +2017,50 @@
         "type": "object",
         "additionalProperties": false,
         "properties": {
-          "type": {
-            "$ref": "#/components/schemas/DialogContentType_Values"
+          "title": {
+            "$ref": "#/components/schemas/DialogContentValueDto"
+          },
+          "summary": {
+            "$ref": "#/components/schemas/DialogContentValueDto"
+          },
+          "senderName": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/DialogContentValueDto"
+              }
+            ]
+          },
+          "additionalInfo": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/DialogContentValueDto"
+              }
+            ]
+          },
+          "extendedStatus": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/DialogContentValueDto"
+              }
+            ]
           },
+          "mainContentReference": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/DialogContentValueDto"
+              }
+            ]
+          }
+        }
+      },
+      "DialogContentValueDto": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
           "value": {
             "type": "array",
             "items": {
@@ -2020,31 +2068,10 @@
             }
           },
           "mediaType": {
-            "type": "string",
-            "nullable": true
+            "type": "string"
           }
         }
       },
-      "DialogContentType_Values": {
-        "type": "string",
-        "description": "",
-        "x-enumNames": [
-          "Title",
-          "SenderName",
-          "Summary",
-          "AdditionalInfo",
-          "ExtendedStatus",
-          "MainContentReference"
-        ],
-        "enum": [
-          "Title",
-          "SenderName",
-          "Summary",
-          "AdditionalInfo",
-          "ExtendedStatus",
-          "MainContentReference"
-        ]
-      },
       "LocalizationDto": {
         "type": "object",
         "additionalProperties": false,
@@ -2457,17 +2484,14 @@
               }
             ]
           },
-          "content": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/SearchDialogContentDtoSO"
-            }
-          },
           "seenSinceLastUpdate": {
             "type": "array",
             "items": {
               "$ref": "#/components/schemas/SearchDialogDialogSeenLogDtoSO"
             }
+          },
+          "content": {
+            "$ref": "#/components/schemas/SearchDialogContentDtoSO"
           }
         }
       },
@@ -2525,21 +2549,6 @@
           }
         }
       },
-      "SearchDialogContentDtoSO": {
-        "type": "object",
-        "additionalProperties": false,
-        "properties": {
-          "type": {
-            "$ref": "#/components/schemas/DialogContentType_Values"
-          },
-          "value": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/LocalizationDto"
-            }
-          }
-        }
-      },
       "SearchDialogDialogSeenLogDtoSO": {
         "type": "object",
         "additionalProperties": false,
@@ -2576,6 +2585,34 @@
           }
         }
       },
+      "SearchDialogContentDtoSO": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "title": {
+            "$ref": "#/components/schemas/DialogContentValueDto"
+          },
+          "summary": {
+            "$ref": "#/components/schemas/DialogContentValueDto"
+          },
+          "senderName": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/DialogContentValueDto"
+              }
+            ]
+          },
+          "extendedStatus": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/DialogContentValueDto"
+              }
+            ]
+          }
+        }
+      },
       "GetDialogDtoSO": {
         "type": "object",
         "additionalProperties": false,
@@ -2645,10 +2682,7 @@
             "$ref": "#/components/schemas/DialogStatus_Values"
           },
           "content": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/GetDialogContentDtoSO"
-            }
+            "$ref": "#/components/schemas/GetDialogContentDtoSO"
           },
           "searchTags": {
             "type": "array",
@@ -2695,18 +2729,43 @@
         "type": "object",
         "additionalProperties": false,
         "properties": {
-          "type": {
-            "$ref": "#/components/schemas/DialogContentType_Values"
+          "title": {
+            "$ref": "#/components/schemas/DialogContentValueDto"
           },
-          "value": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/LocalizationDto"
-            }
+          "summary": {
+            "$ref": "#/components/schemas/DialogContentValueDto"
           },
-          "mediaType": {
-            "type": "string",
-            "nullable": true
+          "senderName": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/DialogContentValueDto"
+              }
+            ]
+          },
+          "additionalInfo": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/DialogContentValueDto"
+              }
+            ]
+          },
+          "extendedStatus": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/DialogContentValueDto"
+              }
+            ]
+          },
+          "mainContentReference": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/DialogContentValueDto"
+              }
+            ]
           }
         }
       },
@@ -3005,10 +3064,7 @@
             "$ref": "#/components/schemas/DialogStatus_Values"
           },
           "content": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/CreateDialogContentDto"
-            }
+            "$ref": "#/components/schemas/CreateDialogContentDto"
           },
           "searchTags": {
             "type": "array",
@@ -3046,18 +3102,43 @@
         "type": "object",
         "additionalProperties": false,
         "properties": {
-          "type": {
-            "$ref": "#/components/schemas/DialogContentType_Values"
+          "title": {
+            "$ref": "#/components/schemas/DialogContentValueDto"
           },
-          "value": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/LocalizationDto"
-            }
+          "summary": {
+            "$ref": "#/components/schemas/DialogContentValueDto"
           },
-          "mediaType": {
-            "type": "string",
-            "nullable": true
+          "senderName": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/DialogContentValueDto"
+              }
+            ]
+          },
+          "additionalInfo": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/DialogContentValueDto"
+              }
+            ]
+          },
+          "extendedStatus": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/DialogContentValueDto"
+              }
+            ]
+          },
+          "mainContentReference": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/DialogContentValueDto"
+              }
+            ]
           }
         }
       },
@@ -3505,17 +3586,14 @@
               }
             ]
           },
-          "content": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/SearchDialogContentDto"
-            }
-          },
           "seenSinceLastUpdate": {
             "type": "array",
             "items": {
               "$ref": "#/components/schemas/SearchDialogDialogSeenLogDto"
             }
+          },
+          "content": {
+            "$ref": "#/components/schemas/SearchDialogContentDto"
           }
         }
       },
@@ -3573,21 +3651,6 @@
           }
         }
       },
-      "SearchDialogContentDto": {
-        "type": "object",
-        "additionalProperties": false,
-        "properties": {
-          "type": {
-            "$ref": "#/components/schemas/DialogContentType_Values"
-          },
-          "value": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/LocalizationDto"
-            }
-          }
-        }
-      },
       "SearchDialogDialogSeenLogDto": {
         "type": "object",
         "additionalProperties": false,
@@ -3624,6 +3687,34 @@
           }
         }
       },
+      "SearchDialogContentDto": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "title": {
+            "$ref": "#/components/schemas/DialogContentValueDto"
+          },
+          "summary": {
+            "$ref": "#/components/schemas/DialogContentValueDto"
+          },
+          "senderName": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/DialogContentValueDto"
+              }
+            ]
+          },
+          "extendedStatus": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/DialogContentValueDto"
+              }
+            ]
+          }
+        }
+      },
       "GetDialogDto": {
         "type": "object",
         "additionalProperties": false,
@@ -3688,10 +3779,7 @@
             "$ref": "#/components/schemas/DialogStatus_Values"
           },
           "content": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/GetDialogContentDto"
-            }
+            "$ref": "#/components/schemas/GetDialogContentDto"
           },
           "dialogToken": {
             "type": "string",
@@ -3733,18 +3821,43 @@
         "type": "object",
         "additionalProperties": false,
         "properties": {
-          "type": {
-            "$ref": "#/components/schemas/DialogContentType_Values"
+          "title": {
+            "$ref": "#/components/schemas/DialogContentValueDto"
           },
-          "value": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/LocalizationDto"
-            }
+          "summary": {
+            "$ref": "#/components/schemas/DialogContentValueDto"
           },
-          "mediaType": {
-            "type": "string",
-            "nullable": true
+          "senderName": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/DialogContentValueDto"
+              }
+            ]
+          },
+          "additionalInfo": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/DialogContentValueDto"
+              }
+            ]
+          },
+          "extendedStatus": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/DialogContentValueDto"
+              }
+            ]
+          },
+          "mainContentReference": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/DialogContentValueDto"
+              }
+            ]
           }
         }
       },