ecoportal-api-graphql 1.3.5 → 1.3.16

data/lib/ecoportal/api/graphql/fragment/pages/common_page_union.rb

@@ -0,0 +1,396 @@
+# CommonPageUnion — unified page fragment for all customer integration patterns.
+#
+# Covers three core use cases via boolean query variables:
+#
+#   CREATE sequence (2-step):
+#     (a) buildFromTemplate → fetch built draft with ($fields: true) to get
+#         server-assigned data field IDs
+#     (b) fill in values → createFromTemplate
+#
+#   UPDATE sequence (2-step):
+#     (a) fetch current page with ($content: true, $fields: true) to get patchVer
+#         + current field IDs/values (IDs change after DB creation — must be read)
+#     (b) build update operations → updatePage
+#
+#   VERIFY after create/update:
+#     fetch with ($content: true, $only_content: true) to confirm result
+#
+# Variables:
+#   $content      — include field values, stage completions, files, people
+#   $only_content — exclude structural/config fields; content values only
+#   $fields       — include data field definitions (labels, options, structure)
+#
+# Documented in Jira API Docs space (Confluence APIDOCS).
+# Access: fragment.pages.assemble(:CommonPageUnion)
+module Ecoportal
+  module API
+    class GraphQL
+      class Fragment
+        class Pages
+          fragment :CommonPageUnion, <<~GRAPHQL
+            fragment CommonPageUnion on PageUnion {
+              ...corePageData
+              ... on PhasedPage {
+                stages { ...stageAttrs }
+                attachedFiles @include(if: $content) {
+                  id @skip(if: $only_content)
+                  activeFileAttachment { downloadUrl }
+                }
+                activeStages {
+                  id
+                  name
+                  ordering
+                }
+              }
+              ... on BasicPage {
+                sections { ...sectionUnion }
+              }
+            }
+
+            fragment taskInterface on TaskInterface {
+              id
+              fromPublicTemplate
+              complete
+              completedAt { dateTime   }
+              completedBy { name email }
+              due         { dateTime   }
+              overdue
+              users       { name email }
+            }
+
+            fragment stageAttrs on Stage {
+              id @skip(if: $only_content)
+              name
+              ...sectionsFragment
+              active
+              started
+              state
+              completedBy @include(if: $content) { name email }
+              activeTask  @include(if: $content) { ...taskInterface }
+            }
+
+            fragment locationNode on LocationNodeInterface {
+              id
+              name
+              archived
+              classifications { name    }
+              ancestors       { id name }
+            }
+
+            fragment corePageData on BasePageInterface {
+              __typename
+              id
+              patchVer
+              externalId
+              name
+              uid
+              locations { ...locationNode }
+              otherTags @include(if: $content)
+              timeZone
+              updatedAt { dateTime        }
+              createdAt { dateTime        }
+              creator   { name email      }
+              state
+              archived
+            }
+
+            fragment sectionsFragment on Stage {
+              ... on HasSectionsInterface {
+                sections { ...sectionUnion }
+              }
+            }
+
+            fragment sectionUnion on SectionUnion {
+              __typename
+              ... on ContentSection {
+                id
+                heading
+                dataFields @include(if: $fields) { ...dataField }
+              }
+              ... on SplitSection {
+                id
+                heading
+                leftDataFields  @include(if: $fields) { ...dataField }
+                rightDataFields @include(if: $fields) { ...dataField }
+              }
+            }
+
+            fragment dataFieldInterface on DataFieldsInterface {
+              __typename
+              id                @skip(if: $only_content)
+              label
+              genomeSignature   @skip(if: $only_content)
+              deindex           @include(if: $content)
+              linkedFieldConfig @skip(if: $only_content) {
+                crossReferenceId
+                crossReferenceField { label }
+                sourceFieldKey
+              }
+            }
+
+            fragment dataField on DataFieldUnion {
+              ...dataFieldInterface
+              ...locationField
+              ...geoField
+              ...numberField
+              ...gaugeField
+              ...dateField
+              ...plainTextField
+              ...richTextField
+              ...selectField
+              ...checklistField
+              ...signatureField
+              ...imageGalleryField
+              ...fileField
+              ...peopleField
+              ...contractorEntitiesField
+              ...crossReferenceField
+              ...mailboxField
+              ...lawField
+              ...aiSummaryField @include(if: $content)
+              ...actionsListField
+            }
+
+            fragment locationField on TagField {
+              required                 @skip(if: $only_content)
+              restrictByClassification @skip(if: $only_content)
+              allowedClassifications   @skip(if: $only_content)
+              singleSelect             @skip(if: $only_content)
+              locations @include(if: $content) { ...locationNode }
+            }
+
+            fragment geoField on Geo {
+              required    @skip(if: $only_content)
+              address     @include(if: $content)
+              coordinates @include(if: $content)
+            }
+
+            fragment numberField on Number {
+              required @skip(if: $only_content)
+              value    @include(if: $content)
+            }
+
+            fragment gaugeField on Gauge {
+              max   @skip(if: $only_content)
+              value @include(if: $content)
+            }
+
+            fragment dateField on Date {
+              required @skip(if: $only_content)
+              pastOnly @skip(if: $only_content)
+              showTime @skip(if: $only_content)
+              value    @include(if: $content) { dateTime }
+            }
+
+            fragment plainTextField on PlainText {
+              required  @skip(if: $only_content)
+              multiline @skip(if: $only_content)
+              value     @include(if: $content)
+            }
+
+            fragment richTextField on RichText {
+              required @skip(if: $only_content)
+              content  @include(if: $content)
+            }
+
+            fragment selectField on Select {
+              required @skip(if: $only_content)
+              multiple @skip(if: $only_content)
+              dataType
+              options {
+                id
+                selected @include(if: $content)
+                value
+                name
+              }
+              other
+              otherDesc @include(if: $content)
+            }
+
+            fragment checklistField on Checklist {
+              complete
+              items { checked label }
+            }
+
+            fragment signatureField on Signature {
+              required     @skip(if: $only_content)
+              signedByName @include(if: $content)
+              signatureUpdatedAt { dateTime }
+              signedById   @include(if: $content)
+            }
+
+            fragment imageGalleryField on ImageGallery {
+              images @include(if: $content) {
+                downloadUrl
+                caption
+                fileName
+                fileSize
+                uploadId @skip(if: $only_content)
+              }
+            }
+
+            fragment fileField on File {
+              required @skip(if: $only_content)
+              items    @include(if: $content) {
+                fileContainer { ...fileContainerAttrs }
+              }
+            }
+
+            fragment fileContainerAttrs on FileContainer {
+              id
+              activeFileAttachment {
+                downloadUrl
+                id @skip(if: $only_content)
+                fileSize
+                fileName
+                userName
+                fileUpdatedAt { dateTime }
+              }
+            }
+
+            fragment peopleField on People {
+              required     @skip(if: $only_content)
+              singular     @skip(if: $only_content)
+              attachMode
+              cachedPeople @include(if: $content) {
+                id
+                email
+                name
+                externalId
+                privateFields
+                publicFields
+              }
+              peopleIds @include(if: $content)
+              people    @include(if: $content) {
+                id
+                name
+                externalId
+                email
+              }
+            }
+
+            fragment contractorEntitiesField on ContractorEntities {
+              required @skip(if: $only_content)
+              contractorEntities(
+                includeDeleted: true
+              ) @include(if: $content) {
+                id
+                name
+                externalId
+                approved
+                active
+              }
+            }
+
+            fragment crossReferenceField on CrossReference {
+              required @skip(if: $only_content)
+              references(
+                first: 25
+              ) @include(if: $content) {
+                nodes    { ...referenceAttrs }
+                totalCount
+                pageInfo {
+                  hasNextPage
+                  endCursor
+                }
+              }
+            }
+
+            fragment referenceAttrs on Reference {
+              id
+              name
+              uid
+              state
+              locations { ...locationNode }
+              createdAt { dateTime        }
+              updatedAt { dateTime        }
+              creator   { name            }
+            }
+
+            fragment mailboxField on Mailbox {
+              address @skip(if: $only_content)
+              emails  @include(if: $content) {
+                nodes {
+                  subject
+                  body
+                  recipients
+                  cc
+                  bcc
+                  senderName
+                  senderEmail
+                  createdAt      { dateTime              }
+                  fileContainers { ...fileContainerAttrs }
+                }
+              }
+            }
+
+            fragment lawField on Law {
+              snippets @include(if: $content) {
+                category
+                content
+                legislation
+                product
+                title
+                topic
+                sources
+                updatedAt { dateTime }
+              }
+            }
+
+            fragment aiSummaryField on AiSummary {
+              alreadyRated
+              aiSummary
+              aiSummaryGeneratedAt { dateTime }
+              currentVersionId
+              triggerStageIds
+              textFormat
+              trigger
+              instructions @skip(if: $only_content)
+            }
+
+            fragment actionsListField on ActionsList {
+              required          @skip(if: $only_content)
+              requiredCompleted @skip(if: $only_content)
+              actions(
+                first:                   25,
+                includeRecurringActions: false
+              ) @include(if: $content) {
+                ...pageActionsList
+              }
+            }
+
+            fragment pageActionsList on DataFieldAssociatedActionsConnection {
+              nodes    { ...pageActionAttrs }
+              totalCount
+              pageInfo {
+                hasNextPage
+                endCursor
+              }
+              closedCount
+              openCount
+              overdueCount
+            }
+
+            fragment pageActionAttrs on Action {
+              id
+              name
+              description
+              assignedTo {
+                id
+                name
+                email
+              }
+              status
+              relativeStatus
+              age
+              createdAt       { dateTime }
+              completedAt     { dateTime }
+              dueDate         { dateTime }
+              dueOrClosedDate { dateTime }
+            }
+          GRAPHQL
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/fragment/pages.rb

@@ -0,0 +1,15 @@
+module Ecoportal
+  module API
+    class GraphQL
+      class Fragment
+        class Pages
+          include Ecoportal::API::GraphQL::Concerns::FragmentDefinitions
+        end
+
+        register_namespace Pages
+      end
+    end
+  end
+end
+
+require_relative 'pages/common_page_union'

data/lib/ecoportal/api/graphql/fragment/pages_workflow.rb

@@ -0,0 +1,172 @@
+module Ecoportal
+  module API
+    class GraphQL
+      class Fragment
+        SCHEMA_VERSION = '20260605'.freeze
+
+        fragment :PagesWorkflowFields, <<~GRAPHQL
+          fragment PagesWorkflowFields on PagesWorkflow {
+            autoPageCreationEnabled
+            fields {
+              key
+              name
+              type
+              total
+              missing
+              enableCrossRegisterReporting
+            }
+            stages {
+              id
+              name
+              ordering
+              state
+              active
+              started
+            }
+          }
+        GRAPHQL
+
+        fragment :PagesWorkflowCallbackFields, <<~GRAPHQL
+          fragment PagesWorkflowCallbackFields on PagesWorkflowCallbackType {
+            id
+            triggerCondition
+            triggers {
+              __typename
+              id
+              ... on PagesWorkflowTriggersConditionalLogic {
+                filters {
+                  id
+                  operation
+                  path
+                  key
+                  params
+                }
+              }
+            }
+            operations {
+              __typename
+              id
+              timeDelayPassed
+              timeDelayConfig {
+                enabled
+                frequencyValue
+                period
+                excludeWeekends
+              }
+              ... on PagesWorkflowOperationsAssignTo {
+                targetTaskType
+                lastFulfilled
+                escalationLevels {
+                  id
+                  order
+                  dueInValue
+                  dueInUnit
+                  dueExcludeWeekends
+                  elapsedSeconds
+                  timerPaused
+                }
+              }
+              ... on PagesWorkflowOperationsCreatePage {
+                templateId
+                crossReferenceFieldId
+              }
+              ... on PagesWorkflowOperationsSendNotification {
+                recurring
+                recurrenceActive
+                recurrenceEndType
+                recurrenceEndCount
+                emailConfig {
+                  enabled
+                  subject
+                  body
+                  attachPdf
+                  includeSmartSummary
+                  pdfRedacted
+                  sendAsGroupEmail
+                }
+                inSystemConfig {
+                  enabled
+                  title
+                  message
+                }
+                recipientConfig {
+                  allActiveUsers
+                  includePageCreator
+                  includePeopleFields
+                  includeTaskAssignees
+                  includeMailboxFields
+                  userSelections {
+                    id
+                    name
+                    email
+                    deleted
+                  }
+                  peopleFieldSelections {
+                    id
+                    name
+                    stageName
+                    deleted
+                  }
+                  taskConfigSelections {
+                    id
+                    type
+                    stageName
+                    deleted
+                  }
+                  mailboxFieldSelections {
+                    id
+                    name
+                    stageName
+                    deleted
+                  }
+                  actionTypeSelections {
+                    id
+                    name
+                    deleted
+                  }
+                }
+              }
+            }
+          }
+        GRAPHQL
+
+        fragment :PagesWorkflowCommandFields, <<~GRAPHQL
+          fragment PagesWorkflowCommandFields on PagesWorkflowCommandInterface {
+            __typename
+            id
+            commandAction
+            createdAt { dateTime }
+            patchVer
+            ownerId
+            stageId
+            stageName
+            taskId
+            taskType
+            ... on PagesWorkflowCommandChange {
+              changes {
+                field
+                from
+                to
+              }
+            }
+            ... on PagesWorkflowCommandChangeMessage {
+              changeMessages
+            }
+          }
+        GRAPHQL
+
+        # Stage-level fragment that adds workflowCallbacks to a Stage selection.
+        # Spread this on Stage (alongside or inside a page query) to populate
+        # stage.workflow_callbacks. Requires PagesWorkflowCallbackFields to be
+        # assembled in the same request.
+        fragment :StageWithCallbacksFields, <<~GRAPHQL
+          fragment StageWithCallbacksFields on Stage {
+            workflowCallbacks {
+              ...PagesWorkflowCallbackFields
+            }
+          }
+        GRAPHQL
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/fragment/pagination.rb

@@ -3,7 +3,7 @@ module Ecoportal
     class GraphQL
       class Fragment
         fragment :Pagination, <<~GRAPHQL
-          fragment on ActionConnection {
+          fragment Pagination on ActionConnection {
             totalCount
             pageInfo {
               endCursor

data/lib/ecoportal/api/graphql/fragment/template.rb

@@ -0,0 +1,51 @@
+module Ecoportal
+  module API
+    class GraphQL
+      class Fragment
+        # `createTemplateRelatedPage` / `destroyTemplateRelatedPage` return
+        # `item: RelatedPages` — a related-pages CONFIG entry, not a page. They used to select
+        # `item { ...PageFields }` (invalid: "can't be spread inside RelatedPages"), which made
+        # both mutations fail.
+        #
+        # Verified against the live schema (2026-07-30): RelatedPages exposes filters
+        # (StoredEsFilter), hasInaccessibleVariables, id, pages (PreviewPageConnection),
+        # register (MinimalRegister), registerId, title. Only the scalars are selected here —
+        # `pages` is a connection and `filters`/`register` are objects needing their own
+        # selections; query them explicitly when needed.
+        fragment :TemplateRelatedPages, <<~GRAPHQL
+          fragment TemplateRelatedPages on RelatedPages {
+            id
+            title
+            registerId
+            hasInaccessibleVariables
+          }
+        GRAPHQL
+
+        # `updateTemplateInformation` returns `UpdateInformationPayload { item: Template }`.
+        # ★ NOTE the type asymmetry: elsewhere in this gem a "template" is a PAGE
+        # (`Query::Templates` and the other template payloads legitimately resolve to
+        # `Model::PageUnion`, and validate clean), but THIS mutation returns the narrow
+        # `Template` type — hence `item { ...PageFields }` was invalid ("can't be spread
+        # inside Template").
+        #
+        # Verified against the live schema (2026-07-30): Template exposes active,
+        # aiDescription, commands (connection), creatorEditable, creatorEnabled, creatorFlags,
+        # description, folders, id, public, publicConfig, templateContainerUid, templateType.
+        fragment :TemplateInformation, <<~GRAPHQL
+          fragment TemplateInformation on Template {
+            id
+            description
+            aiDescription
+            templateType
+            templateContainerUid
+            active
+            public
+            folders
+            creatorEnabled
+            creatorEditable
+          }
+        GRAPHQL
+      end
+    end
+  end
+end