ecoportal-api-graphql 1.3.4 → 1.3.9

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

@@ -1,71 +1,37 @@
-# Namespace to create custom fragments from client scripts
-module Fragment
-  include Ecoportal::API::Common::GraphQL::ClassHelpers
-end
-
-# Class to define/parse fragments
-module Ecoportal
-  module API
-    class GraphQL
-      class Fragment
-        include Ecoportal::API::Common::GraphQL::ClassHelpers
-
-        class << self
-          def fragment(sym, heredoc)
-            fragments[sym] = heredoc
-          end
-
-          def fragments
-            @fragments ||= {}
-          end
-        end
-
-        attr_reader :client, :fragments
-
-        def initialize(client)
-          @client = client
-          parse
-        end
-
-        def define(sym, heredoc, namespace: ::Fragment)
-          namespace.send(:remove_const, sym) if namespace.const_defined?(sym)
-
-          client.parse(heredoc).tap do |fragment|
-            without_warnings do
-              namespace.const_set(sym, fragment)
-              ::Fragment.const_set(sym, fragment) unless namespace == ::Fragment
-            end
-          end
-        rescue ::GraphQL::Client::ValidationError, ::Graphlient::Errors::ClientError => err
-          raise err.class, "On fragment #{sym} -- #{err.message}", cause: nil
-        end
-
-        private
-
-        def without_warnings
-          original_verbose = $VERBOSE
-          $VERBOSE         = nil
-
-          yield if block_given?
-        ensure
-          $VERBOSE = original_verbose
-        end
-
-        def parse
-          @fragments = self.class.fragments.
-            each_with_object({}) do |(sym, heredoc), out|
-              out[sym] = define(sym, heredoc, namespace: self.class)
-            end
-        end
-      end
-    end
-  end
-end
-
-require 'ecoportal/api/graphql/fragment/pagination'
-require 'ecoportal/api/graphql/fragment/locations_error'
-require 'ecoportal/api/graphql/fragment/location_node'
-require 'ecoportal/api/graphql/fragment/location_draft'
-require 'ecoportal/api/graphql/fragment/action_category'
-require 'ecoportal/api/graphql/fragment/action'
-require 'ecoportal/api/graphql/fragment/contractor_entity'
+# Namespace to create custom fragments from client scripts
+module Fragment
+  include Ecoportal::API::Common::GraphQL::ClassHelpers
+end
+
+# Class to define/parse fragments
+module Ecoportal
+  module API
+    class GraphQL
+      class Fragment
+        include Ecoportal::API::GraphQL::Concerns::FragmentDefinitions
+
+        def initialize(...)
+          super
+
+          pages
+        end
+
+        def pages
+          @pages ||= Pages.new(client)
+        end
+      end
+    end
+  end
+end
+
+require_relative 'fragment/pagination'
+require_relative 'fragment/locations_error'
+require_relative 'fragment/location_node'
+require_relative 'fragment/location_draft'
+require_relative 'fragment/action_category'
+require_relative 'fragment/action'
+require_relative 'fragment/contractor_entity'
+require_relative 'fragment/page'
+require_relative 'fragment/pages'
+require_relative 'fragment/force'
+require_relative 'fragment/pages_workflow'

data/lib/ecoportal/api/graphql/helpers/locations_tree.rb

@@ -9,6 +9,7 @@ module Ecoportal
             parents = nodes.each_with_object({}) do |node, out|
               (out[node.parent_id_upcase] ||= []).push(node)
             end
+
             get_children(nil, parents)
           end
 

data/lib/ecoportal/api/graphql/helpers.rb

@@ -7,4 +7,4 @@ module Ecoportal
   end
 end
 
-require 'ecoportal/api/graphql/helpers/locations_tree'
+require_relative 'helpers/locations_tree'

data/lib/ecoportal/api/graphql/input/contractor_entity/update.rb

@@ -8,6 +8,31 @@ module Ecoportal
             class_resolver :id_diff_input, "Ecoportal::API::GraphQL::Input::IdDiff"
             embeds_one :associatedPeopleIds, klass: :id_diff_input
             embeds_one :leadContractorIds, klass: :id_diff_input
+
+            ID_DIFF_FIELDS = %i[associatedPeopleIds leadContractorIds].freeze
+
+            class << self
+              # Overrides Logic::Input.from_model to reshape array fields into
+              # IdDiffInput format: { additions: [...], removals: [...] }
+              # Array fields are stripped from the flat diff, so we compare
+              # doc vs original_doc directly rather than relying on the diff hash.
+              def from_model(model, **kargs)
+                diff = Logic::Input.from_model(model, **kargs)
+
+                ID_DIFF_FIELDS.each do |field|
+                  key      = field.to_s
+                  current  = Array(model.doc[key])
+                  original = Array(model.original_doc[key])
+                  next if current == original
+
+                  diff       ||= {}
+                  diff[:id]  ||= model.id
+                  diff[field]  = { additions: current - original, removals: original - current }
+                end
+
+                diff
+              end
+            end
           end
         end
       end

data/lib/ecoportal/api/graphql/input/delta_input.rb

@@ -0,0 +1,16 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        # Maps DeltaInput for the pageDelta query.
+        # Pass as an array: [{ id: 'pageId', deltaAt: 'ISO8601DateTime' }, ...]
+        # deltaAt: the last-known timestamp for this page ID.
+        # Server returns UPDATED if the page changed after deltaAt, NOT_FOUND if deleted, NEW if unknown.
+        class DeltaInput < Logic::Input
+          passkey :id
+          passthrough :deltaAt
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/page/archive.rb

@@ -0,0 +1,14 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        class Page
+          class Archive < Logic::Input
+            passkey :id
+            passthrough :patchVer
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/page/build_from_template.rb

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        class Page
+          class BuildFromTemplate < Logic::Input
+            passthrough :templateId, :showHiddenData, :clientMutationId
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/page/create_draft.rb

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        class Page
+          class CreateDraft < Logic::Input
+            passthrough :templateId
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/page/create_from_template.rb

@@ -0,0 +1,18 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        class Page
+          # Maps CreateFromTemplateInput.
+          # dataFields.updates is passed as a raw array — typed support is Phase E.
+          class CreateFromTemplate < Logic::Input
+            passthrough :templateId, :showHiddenData, :stageId, :submit, :attach, :draft
+            passthrough :clientMutationId
+            passthrough :dataFields # raw: { updates: [...typed field hashes...] }
+            embeds_one  :page, klass: 'Ecoportal::API::GraphQL::Input::Page'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/page/delete_draft.rb

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        class Page
+          class DeleteDraft < Logic::Input
+            passkey :id
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/page/publish_draft.rb

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        class Page
+          class PublishDraft < Logic::Input
+            passkey :id
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/page/review_task.rb

@@ -0,0 +1,14 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        class Page
+          class ReviewTask < Logic::Input
+            passkey :id
+            passthrough :stageId, :comment
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/page/unarchive.rb

@@ -0,0 +1,14 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        class Page
+          class Unarchive < Logic::Input
+            passkey :id
+            passthrough :patchVer
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/page/update.rb

@@ -0,0 +1,140 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        class Page
+          class Update < Logic::Input
+            passkey :id
+            passthrough :patchVer, :publish, :clientMutationId
+
+            PAGE_FIELD_KEYS = Input::Page::PAGE_FIELD_KEYS
+
+            class << self
+              # Builds UpdatePageInput from a page model.
+              # Returns nil when there are no changes and no operation is requested.
+              # patchVer is always included when present (required for concurrency control).
+              #
+              # Options:
+              #   stage_id:           ID      — target a specific stage (required for stage submit/close-out)
+              #   submit:             Boolean — submit the stage (triggers task transitions server-side)
+              #   publish:            Boolean — publish a draft page
+              #   show_hidden_data:   Boolean — include hidden data in the mutation response
+              #   task:               Hash    — raw page-task command, passed through verbatim. Variants:
+              #                                   { completePageTask: { forcedComplete:, signOff:, notes: } } — complete the page task
+              #                                   { reviewPageTask: { signOff:, notes: } }  — sign off / annotate a review task
+              #   complete_page_task: Boolean|Hash — sugar for task: { completePageTask: ... }.
+              #                                   true → { completePageTask: {} } (bare submit, no inline review).
+              #                                   Hash → inline CompletePageInput fields (snake_case keys):
+              #                                     { sign_off:, forced_complete:, notes: } →
+              #                                     { completePageTask: { signOff:, forcedComplete:, notes: } }.
+              #                                   Use { sign_off: true } to submit AND sign-off in ONE call —
+              #                                   this advances a stage whose config has a review task (the
+              #                                   server auto-approves the review inline). Distinct from the
+              #                                   sign_off:/review_notes: sugar below, which targets reviewPageTask
+              #                                   (the separate review-approval path).
+              #   sign_off:           Boolean — sugar: task: { reviewPageTask: { signOff: ... } }
+              #   review_notes:       String  — sugar: adds notes: to the reviewPageTask
+              #   location_ids:       [ID]    — set page locations (PageInput.locations); the
+              #                                 model's locations embed is read_only, so this is
+              #                                 the way to write them
+              #   client_mutation_id: String
+              def from_model(model, stage_id: nil, submit: nil, publish: nil, show_hidden_data: nil,
+                             task: nil, complete_page_task: false, sign_off: nil, review_notes: nil,
+                             location_ids: nil, client_mutation_id: '', **_kargs)
+                task = resolve_task(task, complete_page_task, sign_off, review_notes)
+                require_stage!(stage_id, submit, task)
+                page_input = (model.as_update || {}).slice(*PAGE_FIELD_KEYS)
+                # Page locations are read_only on the model (excluded from the as_update diff),
+                # so set them explicitly here → PageInput.locations = [LocationInput{ id }].
+                page_input = page_input.merge(locations: Array(location_ids).map { |lid| { id: lid } }) unless location_ids.nil?
+                data_fields = build_data_fields(model)
+
+                no_changes = page_input.empty? && data_fields.empty?
+                no_op      = publish.nil? && submit.nil? && stage_id.nil? && task.nil?
+                return nil if no_changes && no_op
+
+                operation = {
+                  stageId:          stage_id,
+                  submit:           submit,
+                  publish:          publish,
+                  showHiddenData:   show_hidden_data,
+                  task:             task,
+                  clientMutationId: (client_mutation_id.to_s.empty? ? nil : client_mutation_id)
+                }
+                build_input(model, page_input, data_fields, operation)
+              end
+
+              private
+
+              # Platform invariant: a stage submit / sign-off MUST target a specific stage.
+              # Page tasks (and the people-field permissions scoped to them) apply to ONE
+              # stage; without a stageId the server cannot route the submit to the stage the
+              # work was done on. Fail loudly here rather than silently omit stageId (the
+              # nil-guard in build_input would otherwise drop it — the exact bug that let an
+              # act-gov TOOCS submit go out stage-less). A plain field update or publish
+              # needs no stage and is unaffected.
+              def require_stage!(stage_id, submit, task)
+                return unless stage_id.nil?
+                return unless submit || task
+
+                raise ArgumentError,
+                      'stageId is required to submit or complete a stage task (people-field ' \
+                      'permissions are stage-scoped). Pass stage_id:, or operate via a stage ' \
+                      'view (Compat::Pages#get(id, stage_id:) / OozeRedirect#stage) so the ' \
+                      'submit targets the stage the work was done on.'
+              end
+
+              # Resolves the `task` command from an explicit hash or the convenience flags.
+              # An explicit `task:` always wins; otherwise complete_page_task / sign_off build it.
+              def resolve_task(task, complete_page_task, sign_off, review_notes)
+                return task unless task.nil?
+                return build_complete_page_task(complete_page_task) if complete_page_task
+                return nil if sign_off.nil? && review_notes.nil?
+
+                review = {}
+                review[:signOff] = sign_off     unless sign_off.nil?
+                review[:notes]   = review_notes unless review_notes.nil?
+                { reviewPageTask: review }
+              end
+
+              # completePageTask command. `flag` is either `true` (bare completion) or a Hash of
+              # inline CompletePageInput options with snake_case keys (sign_off:, forced_complete:,
+              # notes:). Inline signOff advances a stage whose config has a review task — the server
+              # auto-approves the review in the same updatePage call.
+              def build_complete_page_task(flag)
+                return { completePageTask: {} } unless flag.is_a?(Hash)
+
+                inner = {}
+                inner[:forcedComplete] = flag[:forced_complete] unless flag[:forced_complete].nil?
+                inner[:signOff]        = flag[:sign_off]        unless flag[:sign_off].nil?
+                inner[:notes]          = flag[:notes]           unless flag[:notes].nil?
+                { completePageTask: inner }
+              end
+
+              def build_input(model, page_input, data_fields, operation)
+                { id: model.id }.tap do |input|
+                  input[:patchVer] = model.patchVer if model.respond_to?(:patchVer) && !model.patchVer.nil?
+                  input[:page]     = page_input unless page_input.empty?
+                  operation.each { |key, value| input[key] = value unless value.nil? }
+                  input[:dataFields] = data_fields unless data_fields.empty?
+                end
+              end
+
+              def build_data_fields(model)
+                updates   = model.respond_to?(:data_fields_updates)   ? model.data_fields_updates   : []
+                additions = model.respond_to?(:data_fields_additions) ? model.data_fields_additions : []
+                deletions = model.respond_to?(:data_fields_deletions) ? model.data_fields_deletions : []
+
+                {}.tap do |h|
+                  h[:updates]   = updates   unless updates.empty?
+                  h[:additions] = additions unless additions.empty?
+                  h[:deletions] = deletions unless deletions.empty?
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/page.rb

@@ -0,0 +1,26 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        class Page < Logic::Input
+          # Fields that belong in PageInput (the nested sub-object of UpdatePageInput).
+          # Referenced by Input::Page::Update.from_model to extract the right keys from the diff.
+          PAGE_FIELD_KEYS = %i[name state taskPriority timeZone externalId locations otherTags].freeze
+
+          passthrough :name, :state, :taskPriority, :timeZone, :externalId
+          passarray :locations, :otherTags
+        end
+      end
+    end
+  end
+end
+
+require_relative 'page/update'
+require_relative 'page/archive'
+require_relative 'page/unarchive'
+require_relative 'page/build_from_template'
+require_relative 'page/create_from_template'
+require_relative 'page/create_draft'
+require_relative 'page/delete_draft'
+require_relative 'page/publish_draft'
+require_relative 'page/review_task'

data/lib/ecoportal/api/graphql/input/preset_view/create.rb

@@ -0,0 +1,18 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        class PresetView
+          # fieldConfigs: array of FieldConfigurationInput hashes
+          # { id:, key:, name:, weight:, type:, ... }
+          # sorter: { key:, direction:, missing: }
+          class Create < Logic::Input
+            passthrough :registerId, :name, :sorter
+            passboolean :customPresetView, :preview
+            passarray   :fieldConfigs
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/preset_view/permission.rb

@@ -0,0 +1,16 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        class PresetView
+          # permissions: array of PresetViewPermissionInput hashes
+          # Each: { id:, level: "view"|"edit", to: { userId: } | { userGroupId: }, destroy: }
+          class Permission < Logic::Input
+            passkey   :id
+            passarray :permissions
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/preset_view/update.rb

@@ -0,0 +1,16 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        class PresetView
+          class Update < Logic::Input
+            passkey     :id
+            passthrough :name, :sorter
+            passboolean :preview
+            passarray   :fieldConfigs
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/preset_view.rb

@@ -0,0 +1,14 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        class PresetView < Logic::Input
+        end
+      end
+    end
+  end
+end
+
+require_relative 'preset_view/create'
+require_relative 'preset_view/update'
+require_relative 'preset_view/permission'

data/lib/ecoportal/api/graphql/input/register/create.rb

@@ -0,0 +1,18 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        class Register
+          class Create < Logic::Input
+            passthrough :name, :iconName, :descriptionText, :moduleType, :registerStatus
+            passthrough :restrictedAmountOfTemplates
+            passboolean :shown, :creatable, :attachable, :permissioned
+            passboolean :contentShareable, :enableEmailOut, :isMobile
+            passboolean :restrictTemplatesAmount
+            passarray   :filterTags, :userPermissions, :userGroupPermissions
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/register/update.rb

@@ -0,0 +1,15 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        class Register
+          class Update < Create
+            passkey      :id
+            passthrough  :defaultDashboardId
+            passarray    :visibleTargetFields
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/input/register.rb

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Input
+        class Register < Logic::Input
+        end
+      end
+    end
+  end
+end
+
+require_relative 'register/create'
+require_relative 'register/update'