@digdir/dialogporten-schema 1.16.0 → 1.17.0-711fa6d

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digdir/dialogporten-schema",
-  "version": "1.16.0",
+  "version": "1.17.0-711fa6d",
   "description": "GraphQl schema and OpenAPI spec for Dialogporten",
   "engines": {
     "node": "20"

package/schema.verified.graphql

@@ -1,5 +1,6 @@
 schema {
   query: Queries
+  subscription: Subscriptions
 }
 
 interface DialogByIdError {
@@ -94,6 +95,8 @@ type Dialog {
   serviceResourceType: String!
   party: String!
   progress: Int
+  process: String
+  precedingProcess: String
   extendedStatus: String
   externalReference: String
   visibleFrom: DateTime
@@ -129,6 +132,10 @@ type DialogByIdPayload {
   errors: [DialogByIdError!]!
 }
 
+type DialogUpdatedPayload {
+  id: UUID!
+}
+
 type GuiAction {
   id: UUID!
   action: String!
@@ -167,6 +174,8 @@ type SearchDialog {
   serviceResourceType: String!
   party: String!
   progress: Int
+  process: String
+  precedingProcess: String
   guiAttachmentCount: Int
   extendedStatus: String
   createdAt: DateTime!
@@ -201,6 +210,10 @@ type SeenLog {
   isCurrentEndUser: Boolean!
 }
 
+type Subscriptions @authorize(policy: "enduser") {
+  dialogUpdated(dialogId: UUID!): DialogUpdatedPayload!
+}
+
 type Transmission {
   id: UUID!
   createdAt: DateTime!
@@ -263,6 +276,8 @@ enum ActivityType {
   PAYMENT_MADE
   "Indicates that a signature has been provided."
   SIGNATURE_PROVIDED
+  "Refers to a dialog that has been opened."
+  DIALOG_OPENED
 }
 
 enum ActorType {
@@ -286,10 +301,10 @@ enum DialogStatus {
   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 user-initiated dialogs not yet sent."
+  DRAFT
+  "Sent by the service owner. In a serial process, this is used after a submission is made."
+  SENT
   "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."

package/src/index.js

@@ -1,5 +1,6 @@
 export const schema_verified_graphql = `schema {
   query: Queries
+  subscription: Subscriptions
 }
 
 interface DialogByIdError {
@@ -94,6 +95,8 @@ type Dialog {
   serviceResourceType: String!
   party: String!
   progress: Int
+  process: String
+  precedingProcess: String
   extendedStatus: String
   externalReference: String
   visibleFrom: DateTime
@@ -129,6 +132,10 @@ type DialogByIdPayload {
   errors: [DialogByIdError!]!
 }
 
+type DialogUpdatedPayload {
+  id: UUID!
+}
+
 type GuiAction {
   id: UUID!
   action: String!
@@ -167,6 +174,8 @@ type SearchDialog {
   serviceResourceType: String!
   party: String!
   progress: Int
+  process: String
+  precedingProcess: String
   guiAttachmentCount: Int
   extendedStatus: String
   createdAt: DateTime!
@@ -201,6 +210,10 @@ type SeenLog {
   isCurrentEndUser: Boolean!
 }
 
+type Subscriptions @authorize(policy: "enduser") {
+  dialogUpdated(dialogId: UUID!): DialogUpdatedPayload!
+}
+
 type Transmission {
   id: UUID!
   createdAt: DateTime!
@@ -263,6 +276,8 @@ enum ActivityType {
   PAYMENT_MADE
   "Indicates that a signature has been provided."
   SIGNATURE_PROVIDED
+  "Refers to a dialog that has been opened."
+  DIALOG_OPENED
 }
 
 enum ActorType {
@@ -286,10 +301,10 @@ enum DialogStatus {
   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 user-initiated dialogs not yet sent."
+  DRAFT
+  "Sent by the service owner. In a serial process, this is used after a submission is made."
+  SENT
   "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."

package/swagger.verified.json

@@ -225,6 +225,16 @@
             "example": "urn:altinn:person:identifier-no:01125512345\nurn:altinn:organization:identifier-no:912345678",
             "type": "string"
           },
+          "precedingProcess": {
+            "description": "Optional preceding process identifier to indicate the business process that preceded the process indicated in the \u0022Process\u0022 field. Cannot be set without also \u0022Process\u0022 being set.",
+            "nullable": true,
+            "type": "string"
+          },
+          "process": {
+            "description": "Optional process identifier used to indicate a business process this dialog belongs to ",
+            "nullable": true,
+            "type": "string"
+          },
           "progress": {
             "description": "Advisory indicator of progress, represented as 1-100 percentage value. 100% representing a dialog that has come\nto a natural completion (successful or not).",
             "format": "int32",
@@ -842,7 +852,8 @@
           "Information",
           "TransmissionOpened",
           "PaymentMade",
-          "SignatureProvided"
+          "SignatureProvided",
+          "DialogOpened"
         ],
         "type": "string",
         "x-enumNames": [
@@ -851,7 +862,8 @@
           "Information",
           "TransmissionOpened",
           "PaymentMade",
-          "SignatureProvided"
+          "SignatureProvided",
+          "DialogOpened"
         ]
       },
       "DialogGuiActionPriority_Values": {
@@ -873,8 +885,8 @@
         "enum": [
           "New",
           "InProgress",
-          "Signing",
-          "Processing",
+          "Draft",
+          "Sent",
           "RequiresAttention",
           "Completed"
         ],
@@ -882,8 +894,8 @@
         "x-enumNames": [
           "New",
           "InProgress",
-          "Signing",
-          "Processing",
+          "Draft",
+          "Sent",
           "RequiresAttention",
           "Completed"
         ]
@@ -2035,6 +2047,16 @@
             "example": "urn:altinn:person:identifier-no:01125512345\nurn:altinn:organization:identifier-no:912345678",
             "type": "string"
           },
+          "precedingProcess": {
+            "description": "Optional preceding process identifier to indicate the business process that preceded the process indicated in the \u0022Process\u0022 field. Cannot be set without also \u0022Process\u0022 being set.",
+            "nullable": true,
+            "type": "string"
+          },
+          "process": {
+            "description": "Optional process identifier used to indicate a business process this dialog belongs to",
+            "nullable": true,
+            "type": "string"
+          },
           "progress": {
             "description": "Advisory indicator of progress, represented as 1-100 percentage value. 100% representing a dialog that has come\nto a natural completion (successful or not).",
             "format": "int32",
@@ -2178,6 +2200,16 @@
             "example": "urn:altinn:person:identifier-no:01125512345\nurn:altinn:organization:identifier-no:912345678",
             "type": "string"
           },
+          "precedingProcess": {
+            "description": "Optional preceding process identifier to indicate the business process that preceded the process indicated in the \u0022Process\u0022 field. Cannot be set without also \u0022Process\u0022 being set. ",
+            "nullable": true,
+            "type": "string"
+          },
+          "process": {
+            "description": "Optional process identifier used to indicate a business process this dialog belongs to ",
+            "nullable": true,
+            "type": "string"
+          },
           "progress": {
             "description": "Advisory indicator of progress, represented as 1-100 percentage value. 100% representing a dialog that has come\nto a natural completion (successful or not).",
             "format": "int32",
@@ -3108,6 +3140,16 @@
             "example": "urn:altinn:person:identifier-no:01125512345\nurn:altinn:organization:identifier-no:912345678",
             "type": "string"
           },
+          "precedingProcess": {
+            "description": "Optional preceding process identifier to indicate the business process that preceded the process indicated in the \u0022Process\u0022 field. Cannot be set without also \u0022Process\u0022 being set. ",
+            "nullable": true,
+            "type": "string"
+          },
+          "process": {
+            "description": "Optional process identifier used to indicate a business process this dialog belongs to ",
+            "nullable": true,
+            "type": "string"
+          },
           "progress": {
             "description": "Advisory indicator of progress, represented as 1-100 percentage value. 100% representing a dialog that has come\nto a natural completion (successful or not).",
             "format": "int32",
@@ -3207,6 +3249,16 @@
             "example": "urn:altinn:person:identifier-no:01125512345\nurn:altinn:organization:identifier-no:912345678",
             "type": "string"
           },
+          "precedingProcess": {
+            "description": "Optional preceding process identifier to indicate the business process that preceded the process indicated in the \u0022Process\u0022 field. Cannot be set without also \u0022Process\u0022 being set.",
+            "nullable": true,
+            "type": "string"
+          },
+          "process": {
+            "description": "Optional process identifier used to indicate a business process this dialog belongs to",
+            "nullable": true,
+            "type": "string"
+          },
           "progress": {
             "description": "Advisory indicator of progress, represented as 1-100 percentage value. 100% representing a dialog that has come\nto a natural completion (successful or not).",
             "format": "int32",
@@ -4170,6 +4222,15 @@
               "type": "string"
             }
           },
+          {
+            "description": "Filter by process",
+            "in": "query",
+            "name": "process",
+            "schema": {
+              "nullable": true,
+              "type": "string"
+            }
+          },
           {
             "description": "Search string for free text search. Will attempt to fuzzily match in all free text fields in the aggregate",
             "in": "query",
@@ -4821,6 +4882,15 @@
               "type": "string"
             }
           },
+          {
+            "description": "Filter by process",
+            "in": "query",
+            "name": "process",
+            "schema": {
+              "nullable": true,
+              "type": "string"
+            }
+          },
           {
             "description": "Search string for free text search. Will attempt to fuzzily match in all free text fields in the aggregate",
             "in": "query",
@@ -6107,4 +6177,4 @@
       "url": "https://altinn-dev-api.azure-api.net/dialogporten"
     }
   ]
-}
+}