ecoportal-api-graphql 1.3.5 → 1.3.9

data/lib/ecoportal/api/graphql/base/force/collection.rb

@@ -0,0 +1,47 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        class Force
+          # Wraps a page's forces array.  Provides the v2 scripting interface:
+          #   page.forces.get_by_name(name)  → [Force, ...]
+          class Collection
+            include Enumerable
+
+            def initialize(raw)
+              @forces = Array(raw).map { |f| Force.new(f) }
+            end
+
+            # Filter forces by name (case-insensitive).
+            def get_by_name(name)
+              target = name.to_s.downcase
+              @forces.select { |f| f.name.to_s.downcase == target }
+            end
+
+            # True if any force has uncommitted script changes or pending binding commands.
+            def dirty?
+              @forces.any?(&:dirty?)
+            end
+
+            # All pending commands across all forces (editForce, addBinding, removeBinding).
+            def pending_commands
+              @forces.flat_map(&:all_pending_commands)
+            end
+
+            def each(&block)
+              @forces.each(&block)
+            end
+
+            def size
+              @forces.size
+            end
+
+            def empty?
+              @forces.empty?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/force.rb

@@ -0,0 +1,65 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        # Represents a Force — a AngularJS/LISP snippet that implements conditional
+        # field behaviour on a page stage.  Forces are queried as part of a page
+        # when forces are explicitly included in the query fragment.
+        #
+        # Read access is via the page's force collection:
+        #   force = page.forces.get_by_name('Workflow (S1)').first
+        #   force.custom_script          # → current LISP script
+        #   force.bindings.get_by_name('top-txt')  # → [Binding, ...]
+        #
+        # Write access queues workflow commands executed after process_ooze:
+        #   force.custom_script = new_script  # → queues editForce command
+        #   force.bindings.add(field, name: 'bind-name')   # → queues addBinding
+        #   force.bindings.delete!(binding)                 # → queues removeBinding
+        class Force < Logic::BaseModel
+          passkey     :id
+          passthrough :name, :script, :customScript, :weight, :url
+          passarray   :globalBindingIds
+
+          require_relative 'force/binding'
+          require_relative 'force/binding_collection'
+          require_relative 'force/collection'
+
+          def bindings
+            @bindings ||= Force::BindingCollection.new(doc['bindings'] || [], force: self)
+          end
+
+          # v2 compat: scripts read and write custom_script directly.
+          # Writing queues an editForce workflow command consumed by ForceCompat.
+          def custom_script=(new_script)
+            return if doc['customScript'] == new_script
+
+            doc['customScript'] = new_script
+            @_custom_script_dirty = true
+          end
+
+          def dirty?
+            @_custom_script_dirty || pending_commands.any?
+          end
+
+          # Accumulate workflow commands (editForce, addBinding, removeBinding).
+          def queue_command(command_hash)
+            pending_commands << command_hash
+          end
+
+          # All pending commands for this force (editForce if script changed + binding ops).
+          def pending_commands
+            @pending_commands ||= []
+          end
+
+          # Collect all commands including the script edit if dirty.
+          def all_pending_commands
+            cmds = []
+            cmds << { editForce: { id: id, customScript: doc['customScript'] } } if @_custom_script_dirty
+            cmds.concat(pending_commands)
+            cmds
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/kickstand/job.rb

@@ -0,0 +1,17 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        module Kickstand
+          class Job < Logic::BaseModel
+            SCHEMA_VERSION = '20260605'.freeze
+
+            passkey :id
+            passthrough :status
+            passthrough :createdAt, :updatedAt
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/kickstand/workflow.rb

@@ -0,0 +1,18 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        module Kickstand
+          class Workflow < Logic::BaseModel
+            SCHEMA_VERSION = '20260605'.freeze
+
+            passkey :id
+            passthrough :name, :status
+            passthrough :createdAt, :updatedAt
+            passthrough :startedAt, :stoppedAt, :failedAt, :finishedAt
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/kickstand.rb

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        module Kickstand
+        end
+      end
+    end
+  end
+end
+
+require_relative 'kickstand/workflow'
+require_relative 'kickstand/job'

data/lib/ecoportal/api/graphql/base/page/basic.rb

@@ -0,0 +1,38 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        module Page
+          class Basic < Interface::BasePage
+            private
+
+            # v2-compat read flatten: a basic page's fields live nested under
+            # sections (CommonPageUnion fetches `sections { ...sectionUnion }` with the
+            # data fields inside each section — it does NOT select a top-level
+            # `dataFields`). v2 exposed fields flat at the page (page.components), so
+            # gather them from sections here, mirroring Model::Page::Phased#raw_data_fields.
+            # Field docs are shared by reference, so mutations forward to the section doc.
+            #
+            # `raw_sections` keeps the DataFieldAccess default (doc['sections']) — basic
+            # pages already store sections at the page root.
+            def raw_data_fields
+              from_sections = raw_sections.flat_map { |section| field_docs_in(section) }.compact.uniq { |fld| fld['id'] }
+              return from_sections unless from_sections.empty?
+
+              # Create/flat path: fields may be supplied at the page root (top-level
+              # `dataFields`, no sections) — fall back to the DataFieldAccess default
+              # so create input + flat-built basic pages still expose their fields.
+              doc['dataFields'] || []
+            end
+
+            def field_docs_in(section)
+              (section['dataFields'] || []) +
+                (section['leftDataFields'] || []) +
+                (section['rightDataFields'] || [])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/page/data_field/actions_list.rb

@@ -0,0 +1,9 @@
+module Ecoportal::API::GraphQL::Base::Page
+  class DataField
+    # Actions list field — embedded action items linked to this page.
+    # Actions are managed through Mutation::Action::*; not via DataFieldInput.
+    class ActionsList < DataField
+      passarray :actions # each: { id:, name:, status: }
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/page/data_field/ai_summary.rb

@@ -0,0 +1,18 @@
+module Ecoportal::API::GraphQL::Base::Page
+  class DataField
+    # AI-generated summary field.
+    # Content is generated server-side via generateAiSummary mutation (Bedrock Claude).
+    # Not settable via DataFieldInput — use the dedicated mutation instead.
+    #
+    # instructions: the AI prompt configured on this field in the template.
+    # trigger: "submitted" | "approved" — when generation fires.
+    # trigger_stage_ids: stages that trigger generation (empty = all stages).
+    # text_format: "simple_text" | "bullet_points" | "numbered_list" | "headings"
+    class AiSummary < DataField
+      passthrough :aiSummary, :generatedAt, :instructions
+      passthrough :trigger, :textFormat
+      passarray   :triggerStageIds, :fieldConfigurations
+      passboolean :alreadyRated
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/page/data_field/checklist.rb

@@ -0,0 +1,29 @@
+module Ecoportal::API::GraphQL::Base::Page
+  class DataField
+    class Checklist < DataField
+      passarray :items # each: { id:, label:, checked: }
+      passthrough :complete
+
+      # Check/uncheck an item by label or id.
+      def check(label_or_id, checked: true)
+        item = (doc['items'] || []).find { |i| i['label'] == label_or_id.to_s || i['id'] == label_or_id.to_s }
+        return unless item
+
+        item['checked'] = checked
+      end
+
+      def as_input
+        return nil unless dirty?
+
+        {
+          checklist: {
+            id:    id,
+            # rubocop:disable Style/DoubleNegation
+            items: (doc['items'] || []).map { |i| { id: i['id'], checked: !!i['checked'] } }
+            # rubocop:enable Style/DoubleNegation
+          }
+        }
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/page/data_field/collection.rb

@@ -0,0 +1,112 @@
+module Ecoportal::API::GraphQL::Base::Page
+  class DataField
+    # Wraps an array of raw data field docs as typed DataField objects.
+    # Provides v2-compatible access patterns used in eco-helpers scripts:
+    #   components.get_by_type(:plain_text)     — filter by field type
+    #   components.get_by_name('FieldLabel')    — find by label
+    #   components.doc                          — raw doc array
+    #   components.dirty_inputs                 — changed field hashes for mutation
+    class Collection
+      include Enumerable
+
+      # Accepts raw field docs (→ built via from_doc) OR already-built DataField objects
+      # (kept as-is). Preserving existing objects lets a phased page's Stage#components share
+      # the SAME field objects as the page's canonical field_collection (so stage-level
+      # mutations land in the page's data_fields_updates — phased write-path identity).
+      def initialize(fields)
+        @fields = Array(fields).map { |f| f.is_a?(DataField) ? f : DataField.from_doc(f) }
+      end
+
+      # Build from a raw docs array.
+      def self.from_doc(raw_array)
+        new(Array(raw_array))
+      end
+
+      # Filter by field type. Accepts symbol (:plain_text), string ('PlainText'), or
+      # the GraphQL __typename directly. Matching is case-insensitive.
+      def get_by_type(type_key)
+        target = normalise_type(type_key)
+        @fields.select { |f| normalise_type(f.type) == target }
+      end
+
+      # Find first field matching label (case-insensitive). Optional type: restricts to
+      # that field type first (v2 compat: components.get_by_name(name, type:) — used by
+      # the farmers cutover use case which calls it directly, not via OozeRedirect).
+      def get_by_name(label, type: nil)
+        pool = type ? get_by_type(type) : @fields
+        pool.find { |f| f.label.to_s.downcase == label.to_s.downcase }
+      end
+
+      # Raw doc array (v2 compat — scripts iterate secs_doc / flds_doc).
+      def doc
+        @fields.map(&:doc)
+      end
+
+      # Add a new field to this collection (v2 compat: components.add).
+      # The field must reference an existing server-side ID (from buildFromTemplate).
+      # Yields the new field object to the block for configuration.
+      # Returns the field object.
+      #
+      # Usage:
+      #   components.add(doc: raw_doc) { |f| f.value = 'X' }
+      #   components.add(id: 'f1', label: 'Name', type: 'PlainText') { |f| f.value = 'X' }
+      def add(doc: nil, id: nil, label: nil, type: nil, **opts)
+        raw = doc || opts.merge('id' => id, 'label' => label, '__typename' => type.to_s).compact
+        field = DataField.from_doc(raw)
+        @additions ||= []
+        @additions << field
+        yield field if block_given?
+        field
+      end
+
+      # Mark a field for deletion by field ID or field object.
+      # The field ID is sent in dataFields.deletions on the next update.
+      def mark_for_deletion(id_or_field)
+        field_id = id_or_field.respond_to?(:id) ? id_or_field.id : id_or_field.to_s
+        @deletions ||= []
+        @deletions |= [field_id]
+      end
+
+      # Returns DataFieldInput hashes for fields modified via value setters.
+      def dirty_inputs
+        @fields.filter_map(&:as_input)
+      end
+
+      # Returns DataFieldInput hashes for fields added via #add.
+      def dirty_additions
+        (@additions || []).filter_map(&:as_input)
+      end
+
+      # Returns field IDs queued for deletion via #mark_for_deletion.
+      def dirty_deletions
+        @deletions || []
+      end
+
+      def dirty?
+        @fields.any?(&:dirty?) ||
+          (@additions || []).any?(&:dirty?) ||
+          !dirty_deletions.empty?
+      end
+
+      def each(&block)
+        @fields.each(&block)
+      end
+
+      def empty?
+        @fields.empty?
+      end
+
+      def length
+        @fields.length
+      end
+
+      private
+
+      # Normalise type key to lowercase no-underscore string for comparison.
+      # :plain_text → 'plaintext', 'PlainText' → 'plaintext'
+      def normalise_type(type_key)
+        type_key.to_s.downcase.delete('_') if type_key
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/page/data_field/contractor_entities.rb

@@ -0,0 +1,28 @@
+module Ecoportal::API::GraphQL::Base::Page
+  class DataField
+    # Contractor entity selector field.
+    # Stores references to ContractorEntity records.
+    class ContractorEntities < DataField
+      passarray :contractors # each: { id:, name: }
+
+      def contractor_entity_ids
+        Array(contractors).map { |c| c.is_a?(Hash) ? c['id'] : c }.compact
+      end
+
+      def contractor_entity_ids=(ids)
+        doc['contractors'] = Array(ids).map { |id_val| { 'id' => id_val } }
+      end
+
+      # v2 compat alias
+      def value=(ids)
+        self.contractor_entity_ids = ids
+      end
+
+      def as_input
+        return nil unless dirty?
+
+        { contractorEntities: { id: id, contractorEntityIds: contractor_entity_ids } }
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/page/data_field/cross_reference.rb

@@ -0,0 +1,54 @@
+module Ecoportal::API::GraphQL::Base::Page
+  class DataField
+    # Cross-reference field — links to pages in another register.
+    class CrossReference < DataField
+      passarray :pages # staged writes; the READ response uses `references` (a connection)
+
+      # Current reference ids. The GraphQL response carries them under `references.nodes`
+      # (CommonPageUnion's crossReferenceField), NOT `pages` — so read from there. After a
+      # page_ids= write, prefer the staged `pages` value.
+      def page_ids
+        ref_ids_from(doc)
+      end
+
+      def page_ids=(ids)
+        doc['pages'] = Array(ids).map { |id_val| { 'id' => id_val } }
+      end
+
+      # Dirty only when the effective reference-id SET actually changed.
+      #
+      # The field is READ into `references.nodes` but WRITTEN via `pages` (page_ids=). The
+      # default key-level leaf diff therefore sees a brand-new `pages` key the moment any
+      # setter runs and flags a change — even when the set is unchanged. The common offender
+      # is `clear` on an already-empty field ([] -> []): eco-helpers scripts clear a reference
+      # whenever the source value is blank, which under APIv2 was a no-op but on GraphQL
+      # emitted a phantom `referenceIds: []` update. Compare id SETS against the server
+      # baseline (`original_doc`) instead — restoring v2 parity (empty->empty / same->same
+      # is not dirty).
+      def dirty?
+        ref_ids_from(doc).sort != ref_ids_from(original_doc).sort
+      end
+
+      def as_input
+        return nil unless dirty?
+
+        # CrossReferenceInput uses `referenceIds` (schema-confirmed) — NOT pageIds.
+        { crossReference: { id: id, referenceIds: page_ids } }
+      end
+
+      private
+
+      # Extract the reference id set from a doc snapshot. `original_doc` is the server baseline
+      # (the diff prev_doc — see Diffable::ClassicDiffService), `doc` carries client changes.
+      # Both prefer the staged `pages` (write shape) and fall back to `references.nodes` (read
+      # shape) — so the comparison is shape-agnostic and stays correct after `consolidate!`
+      # copies `doc` (with `pages`) into `original_doc`.
+      def ref_ids_from(source_doc)
+        return [] unless source_doc
+
+        src = source_doc.key?('pages') ? source_doc['pages'] : Array(source_doc.dig('references', 'nodes'))
+        Array(src).map { |r| r.is_a?(Hash) ? r['id'] : r }.compact
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/page/data_field/date_field.rb

@@ -0,0 +1,23 @@
+module Ecoportal::API::GraphQL::Base::Page
+  class DataField
+    # Wraps Date data field. Mapped from __typename 'Date'.
+    # value is an ISO8601DateTime string (e.g. "2024-11-25T08:30:00+13:00").
+    class DateField < DataField
+      # value is nested: { dateTime: "...", timeZone: "..." } or raw string
+      def value
+        v = doc['value']
+        v.is_a?(Hash) ? v['dateTime'] : v
+      end
+
+      def value=(iso8601_string)
+        doc['value'] = iso8601_string
+      end
+
+      def as_input
+        return nil unless dirty?
+
+        { date: { id: id, value: value } }
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/page/data_field/file_field.rb

@@ -0,0 +1,25 @@
+module Ecoportal::API::GraphQL::Base::Page
+  class DataField
+    # File attachment field.
+    # Writing requires a prior file upload to the REST upload endpoint
+    # to obtain fileContainerIds — see the file-upload TODO in projects/TODO.md.
+    # The file_container_ids= setter can be used once IDs are available.
+    class FileField < DataField
+      passarray :fileContainers # each: { id:, fileName:, ... }
+
+      def file_container_ids
+        Array(fileContainers).map { |c| c.is_a?(Hash) ? c['id'] : c }.compact
+      end
+
+      def file_container_ids=(ids)
+        doc['fileContainers'] = Array(ids).map { |id_val| { 'id' => id_val } }
+      end
+
+      def as_input
+        return nil unless dirty?
+
+        { file: { id: id, fileContainerIds: file_container_ids } }
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/page/data_field/gauge.rb

@@ -0,0 +1,19 @@
+module Ecoportal::API::GraphQL::Base::Page
+  class DataField
+    class Gauge < DataField
+      passthrough :value, :max
+
+      # Blank (empty / whitespace CSV cell) → nil, NOT 0.0 — see DataField#numeric_or_nil
+      # (mirrors Number; `"".to_f` would otherwise silently write a real zero).
+      def value=(numeric)
+        doc['value'] = numeric_or_nil(numeric)
+      end
+
+      def as_input
+        return nil unless dirty?
+
+        { gauge: { id: id, value: value } }
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/page/data_field/geo.rb

@@ -0,0 +1,24 @@
+module Ecoportal::API::GraphQL::Base::Page
+  class DataField
+    class Geo < DataField
+      passthrough :address, :coordinates # coordinates: { lat:, lon: }
+
+      def address=(new_address)
+        doc['address'] = new_address
+      end
+
+      def coordinates=(lat_lon_hash)
+        doc['coordinates'] = lat_lon_hash
+      end
+
+      def as_input
+        return nil unless dirty?
+
+        payload = { id: id }
+        payload[:address]     = address     if address
+        payload[:coordinates] = coordinates if coordinates
+        { geo: payload }
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/page/data_field/image_gallery.rb

@@ -0,0 +1,24 @@
+module Ecoportal::API::GraphQL::Base::Page
+  class DataField
+    # Image gallery field.
+    # Writing requires a prior file upload to the REST upload endpoint
+    # to obtain fileContainerIds — see the file-upload TODO in projects/TODO.md.
+    class ImageGallery < DataField
+      passarray :fileContainers # each: { id:, fileName:, url:, ... }
+
+      def file_container_ids
+        Array(fileContainers).map { |c| c.is_a?(Hash) ? c['id'] : c }.compact
+      end
+
+      def file_container_ids=(ids)
+        doc['fileContainers'] = Array(ids).map { |id_val| { 'id' => id_val } }
+      end
+
+      def as_input
+        return nil unless dirty?
+
+        { imageGallery: { id: id, fileContainerIds: file_container_ids } }
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/page/data_field/law.rb

@@ -0,0 +1,8 @@
+module Ecoportal::API::GraphQL::Base::Page
+  class DataField
+    # Legal obligation / law snippets field — read access only.
+    class Law < DataField
+      passarray :laws # each: { id:, content: }
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/page/data_field/mailbox.rb

@@ -0,0 +1,9 @@
+module Ecoportal::API::GraphQL::Base::Page
+  class DataField
+    # Mailbox field — email inbox linked to this field.
+    # Managed by the system; not settable via script.
+    class Mailbox < DataField
+      passthrough :email, :enabled
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/page/data_field/number.rb

@@ -0,0 +1,20 @@
+module Ecoportal::API::GraphQL::Base::Page
+  class DataField
+    class Number < DataField
+      passthrough :value
+
+      # Blank (empty / whitespace CSV cell) → nil, NOT 0.0 — see DataField#numeric_or_nil.
+      # Whether a blank should CLEAR the field or be LEFT UNTOUCHED is the caller's policy;
+      # this only guarantees a blank never becomes the value 0.0.
+      def value=(numeric)
+        doc['value'] = numeric_or_nil(numeric)
+      end
+
+      def as_input
+        return nil unless dirty?
+
+        { number: { id: id, value: value } }
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/page/data_field/people.rb

@@ -0,0 +1,35 @@
+module Ecoportal::API::GraphQL::Base::Page
+  class DataField
+    class People < DataField
+      passarray :peopleIds
+
+      def people_ids
+        ids = Array(peopleIds)
+        return ids unless ids.empty?
+
+        # Fallback: the read fragment populates `peopleIds`, but if a response ever returns it
+        # null/empty while the expanded `people { id }` nodes ARE present (a partial / non-
+        # $content read), seed from the nodes. The backend write replaces peopleIds wholesale,
+        # so a `people_ids << x` append must start from the existing set or it would WIPE the
+        # field. Mirrors CrossReference's references.nodes fallback. Read key == write key
+        # (peopleIds), so this only widens the read; it never creates phantom-dirty.
+        Array(doc['people']).map { |p| p.is_a?(Hash) ? p['id'] : p }.compact
+      end
+
+      def people_ids=(ids)
+        doc['peopleIds'] = Array(ids).compact
+      end
+
+      # v2 compat: scripts may set via people_ids= or direct assignment
+      def value=(ids)
+        self.people_ids = ids
+      end
+
+      def as_input
+        return nil unless dirty?
+
+        { people: { id: id, peopleIds: Array(peopleIds) } }
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/page/data_field/plain_text.rb

@@ -0,0 +1,17 @@
+module Ecoportal::API::GraphQL::Base::Page
+  class DataField
+    class PlainText < DataField
+      passthrough :value
+
+      def value=(new_value)
+        doc['value'] = new_value
+      end
+
+      def as_input
+        return nil unless dirty?
+
+        { plainText: { id: id, value: value } }
+      end
+    end
+  end
+end