ecoportal-api-graphql 1.3.5 → 1.3.16

data/lib/ecoportal/api/graphql/compat/registers.rb

@@ -0,0 +1,84 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Compat
+        # v2-compatible registers API backed by GraphQL register search.
+        # Scripts call: apiv2.registers.search(register_id, options) { |result| ... }
+        #
+        # With a block: yields each PreviewPage result (cursor-paginated).
+        # Without a block (or only_first: true): returns a SearchResults object
+        #   with .total and .total_before_filtering.
+        #
+        # Filter translation:
+        #   v2 date_filter { lbound:, ubound: } → GraphQL date_filter { gte:, lte: }
+        #   v2 tag_filter  { tags:, mode: }     → passed through (same ES backend)
+        #   SearchConf filter objects            → passed through directly
+        class Registers
+          def initialize(client)
+            @client = client
+          end
+
+          # Options:
+          #   sort:             'created_at' | 'updated_at'
+          #   dir:              'asc' | 'desc'
+          #   query:            String (full-text search)
+          #   filters:          Array of filter objects or v2 filter hashes
+          #   batch_size:       Integer (results per request, default 20)
+          #   include_archived: Boolean (default false)
+          #   only_first:       Boolean — return after first page (no block needed)
+          def search(register_id, options = {}, &block)
+            conf  = build_search_conf(options)
+            first = options.fetch(:batch_size, 20)
+            query = Query::RegisterPreviewPages.new(@client)
+
+            args = {
+              registerId:      register_id,
+              searchConf:      conf.to_h,
+              includeArchived: options.fetch(:include_archived, false),
+              first:           first
+            }
+
+            if block || !options[:only_first]
+              # Block mode: yield each result, stop if only_first
+              query.each(**args) do |result|
+                block&.call(result)
+                break if options[:only_first]
+              end
+            else
+              # No-block mode: return SearchResults with .total etc.
+              raw = query.query(**args)
+              SearchResults.new(raw)
+            end
+          end
+
+          private
+
+          def build_search_conf(options)
+            conf = Input::SearchConf.new
+
+            if (sort_key = options[:sort])
+              direction = options.fetch(:dir, 'desc').to_sym
+              conf.sort(sort_key.to_sym, direction)
+            end
+
+            conf.query(options[:query]) if options[:query]
+
+            Array(options[:filters]).compact.each do |filter|
+              conf.filter(translate_filter(filter))
+            end
+
+            conf
+          end
+
+          # Translates a v2-style filter hash to a GraphQL-compatible filter hash.
+          # SearchConf filter objects (respond to to_h and are not Hash) pass through.
+          # v2 date_filter: lbound/ubound → gte/lte
+          # Other v2 types (tag_filter etc.): passed through — same ES backend.
+          def translate_filter(filter)
+            FilterTranslator.to_graphql(filter)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/compat/response.rb

@@ -0,0 +1,35 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Compat
+        # Wraps a GraphQL mutation payload to expose the v2-compatible response interface.
+        # Scripts check .success? and .status after update/create operations.
+        class Response
+          def initialize(payload)
+            @payload = payload
+          end
+
+          def success?
+            @payload.success?
+          end
+
+          def error?
+            @payload.error?
+          end
+
+          def status
+            @payload.error? ? :error : :ok
+          end
+
+          def body
+            @payload.error_doc
+          end
+
+          def item
+            @payload.item
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/compat/search_results.rb

@@ -0,0 +1,33 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Compat
+        # Wraps a GraphQL connection object to expose the v2-compatible search
+        # result interface. eco-helpers scripts access:
+        #   search_results.total                  — filtered count
+        #   search_results.total_before_filtering — pre-filter count (approximated)
+        #   (also Enumerable for iteration)
+        class SearchResults
+          include Enumerable
+
+          attr_reader :total, :total_before_filtering
+
+          def initialize(connection)
+            @total                  = connection.totalCount
+            # GraphQL does not expose a pre-filter count — use the same value.
+            @total_before_filtering = connection.totalCount
+            @nodes                  = connection.nodes
+          end
+
+          def each(&block)
+            @nodes.each(&block)
+          end
+
+          def empty?
+            @nodes.empty?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/compat/stage_collection.rb

@@ -0,0 +1,70 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Compat
+        # Wraps the stages array from a PhasedPage to expose the v2-compatible
+        # access patterns eco-helpers scripts rely on.
+        #
+        # Accepts either an array of Base::Page::Phased::Stage objects (the normal
+        # path via embeds_many) or raw stage hash docs (for direct construction in
+        # specs and legacy callers).
+        #
+        # v2 patterns supported:
+        #   page.stages[id_or_name]       — find stage by ID or name
+        #   page.stages.get_by_name(name) — find stage by name
+        #   page.stages.ordered           — stages sorted by ordering
+        #   page.stages.ordered.map(&:id) — map sorted stages to IDs
+        #   page.stages.any?              — whether the page has stages
+        #   page.stages.each { |s| ... }  — iterate stages
+        class StageCollection
+          include Enumerable
+
+          def initialize(stages_array)
+            @stages = Array(stages_array).map { |s| coerce_stage(s) }
+          end
+
+          # Find a stage by ID or name (hash-style access matching v2 pattern).
+          def [](id_or_name)
+            return nil unless id_or_name
+
+            @stages.find { |s| s.id == id_or_name.to_s || s.name == id_or_name.to_s }
+          end
+
+          # Find a stage by name (explicit v2 method).
+          def get_by_name(name)
+            return nil unless name
+
+            @stages.find { |s| s.name == name.to_s }
+          end
+
+          # Stages sorted by ordering (ascending).
+          def ordered
+            @stages.sort_by { |s| s.ordering.to_i }
+          end
+
+          def each(&block)
+            @stages.each(&block)
+          end
+
+          def empty?
+            @stages.empty?
+          end
+
+          def length
+            @stages.length
+          end
+
+          alias_method :size, :length
+
+          private
+
+          # Accept Base::Page::Phased::Stage model objects (from embeds_many) directly.
+          # Wrap raw hashes in a Stage model for backwards-compatible direct construction.
+          def coerce_stage(stage)
+            stage.is_a?(Hash) ? Base::Page::Phased::Stage.new(stage) : stage
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/compat/stage_view.rb

@@ -0,0 +1,76 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Compat
+        # Client-side stage-specific view over a full page.
+        # Returned by Compat::Pages#get when stage_id is provided.
+        #
+        # Mimics the v2 behaviour where pages.get(id, stage_id:) returns a page
+        # object showing only the specified stage's sections and components.
+        # All other page accessors (id, name, state, patchVer, as_update, etc.)
+        # delegate to the underlying full page.
+        #
+        # This allows eco-helpers stage iteration patterns to work unchanged:
+        #   stage_view = graphql.pages.get(page_id, stage_id: stg.id)
+        #   stage_view.sections.doc.each { |sec_doc| ... }
+        #   stage_view.components.doc.each { |comp_doc| ... }
+        class StageView
+          def initialize(page, stage_id)
+            @page     = page
+            @stage_id = stage_id
+            @stage    = find_stage(page, stage_id)
+            # Record the targeted stage on the underlying page. The base OozeSamples loop
+            # enqueues and updates the FULL page (first-wins by id — the StageView is never
+            # the queued object), so a later submit!/sign_off! on that page must still know
+            # which stage was viewed. Pin the RESOLVED stage id (@stage&.id) so a name-based
+            # view ('Coding') records the id the mutation needs; fall back to the raw arg.
+            return unless @page.respond_to?(:_compat_active_stage_id=)
+            @page._compat_active_stage_id = @stage&.id || stage_id
+          end
+
+          # The stage's sections only (not the full page's).
+          def sections
+            @stage&.sections || Base::Page::SectionCollection.from_doc([])
+          end
+
+          # All data fields across the stage's sections (not the full page's).
+          def components
+            @stage&.components || Base::Page::DataField::Collection.from_doc([])
+          end
+
+          # The ID of this stage view's stage.
+          def current_stage_id
+            @stage&.id
+          end
+
+          # Always true — this view is stage-specific.
+          def stages?
+            true
+          end
+
+          # Delegate all other accessors to the underlying full page.
+          def method_missing(method, *args, &block)
+            return @page.send(method, *args, &block) if @page.respond_to?(method)
+
+            super
+          end
+
+          def respond_to_missing?(method, include_private = false)
+            @page.respond_to?(method, include_private) || super
+          end
+
+          private
+
+          def find_stage(page, stage_id)
+            return nil unless page.respond_to?(:stages)
+
+            stages = page.stages
+            return nil unless stages.respond_to?(:[])
+
+            stages[stage_id] || (stages.respond_to?(:get_by_name) ? stages.get_by_name(stage_id) : nil)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Compat
+      end
+    end
+  end
+end
+
+require_relative 'compat/filter_translator'
+require_relative 'compat/stage_collection'
+require_relative 'compat/search_results'
+require_relative 'compat/page_reference'
+require_relative 'compat/response'
+require_relative 'compat/stage_view'
+require_relative 'compat/pages'
+require_relative 'compat/registers'

data/lib/ecoportal/api/graphql/concerns/data_field_access.rb

@@ -0,0 +1,71 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Concerns
+        # Provides typed data field access on page models.
+        # Include in Interface::BasePage so all concrete page classes inherit it.
+        #
+        # Exposes:
+        #   page.components             — DataField::Collection (v2 compat alias for dataFields)
+        #   page.field_collection       — same, memoized
+        #   page.data_fields_updates    — [DataFieldInput, ...] for dirty fields
+        #   page.data_fields_additions  — [DataFieldInput, ...] for added fields
+        #   page.data_fields_deletions  — [field_id, ...] queued for deletion
+        module DataFieldAccess
+          # Returns a DataField::Collection wrapping raw dataFields from doc.
+          # Memoized — mutating a field object persists across calls.
+          def field_collection
+            @field_collection ||= Base::Page::DataField::Collection.from_doc(raw_data_fields)
+          end
+
+          # v2 compat alias — eco-helpers scripts call entry.components
+          def components
+            field_collection
+          end
+
+          # Returns a SectionCollection wrapping sections from doc.
+          # For BasicPage: doc['sections']. For PhasedPage: merged from stages (override in Phased).
+          def section_collection
+            @section_collection ||= Base::Page::SectionCollection.from_doc(raw_sections)
+          end
+
+          # v2 compat alias — eco-helpers scripts call entry.sections
+          def sections
+            section_collection
+          end
+
+          # Returns DataFieldInput hashes for modified existing fields (updates).
+          def data_fields_updates
+            field_collection.dirty_inputs
+          end
+
+          # Returns DataFieldInput hashes for newly added fields (via components.add).
+          def data_fields_additions
+            field_collection.dirty_additions
+          end
+
+          # Returns field IDs queued for deletion (via components.mark_for_deletion).
+          def data_fields_deletions
+            field_collection.dirty_deletions
+          end
+
+          def data_fields_dirty?
+            field_collection.dirty?
+          end
+
+          private
+
+          # Override in subclasses if fields live elsewhere (e.g. nested in stages).
+          def raw_data_fields
+            doc['dataFields'] || []
+          end
+
+          # Override in subclasses for different section sources.
+          def raw_sections
+            doc['sections'] || []
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/concerns/deprecation.rb

@@ -0,0 +1,20 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Concerns
+        module Deprecation
+          SCHEMA_VERSION = '20260605'.freeze
+
+          WARNED = Set.new
+
+          def self.warn_once(key, message)
+            return if WARNED.include?(key)
+
+            WARNED << key
+            warn "[ecoportal-api-graphql] DEPRECATED (#{key}): #{message}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/concerns/fragment_definitions.rb

@@ -3,7 +3,6 @@ module Ecoportal
     class GraphQL
       module Concerns
         module FragmentDefinitions
-
           class << self
             private
 
@@ -24,6 +23,22 @@ module Ecoportal
             def fragments
               @fragments ||= {}
             end
+
+            # Register a sub-namespace class whose fragments are visible via assemble.
+            def register_namespace(klass)
+              namespaces << klass
+            end
+
+            def namespaces
+              @namespaces ||= []
+            end
+
+            # Returns concatenated fragment definition strings for the given symbols.
+            # Searches own fragments and all registered sub-namespaces.
+            def assemble(*syms)
+              all = namespaces.reduce(fragments.dup) { |h, ns| h.merge(ns.fragments) }
+              syms.map { |sym| all[sym] }.compact.join("\n\n")
+            end
           end
 
           module InstanceMethods
@@ -34,38 +49,16 @@ module Ecoportal
               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)
-                end
-              end
-            rescue ::GraphQL::Client::ValidationError, ::Graphlient::Errors::ClientError => err
-              raise err.class, "On fragment #{sym} -- #{err.message}", cause: nil
+            # Returns the raw fragment string for the given symbol.
+            # The namespace parameter is retained for API compatibility but has no effect.
+            def define(sym, heredoc, namespace: nil) # rubocop:disable Lint/UnusedMethodArgument
+              heredoc
             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
+              @fragments = self.class.fragments.dup
             end
           end
         end

data/lib/ecoportal/api/graphql/concerns/page_compat.rb

@@ -0,0 +1,51 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Concerns
+        # v2-compatibility accessors for page model objects.
+        # Include in Interface::BasePage so all concrete page classes inherit them.
+        # These aliases allow eco-helpers scripts to work against GraphQL page models
+        # using the same method names they used with ecoportal-api-v2.
+        module PageCompat
+          # v2 called this externalId (camelCase) or external_id (snake_case)
+          def external_id
+            externalId
+          end
+
+          # v2 called sourceTemplateId "template_id"
+          def template_id
+            sourceTemplateId
+          end
+
+          # v2 compatibility: dataFields were called "components" in APIv2
+          def components
+            respond_to?(:dataFields) ? dataFields : []
+          end
+
+          # Whether the page has any stages (PhasedPage check)
+          def stages?
+            respond_to?(:stages) && !stages.nil? && !stages.empty?
+          end
+
+          # Clears dirty tracking — call after a successful update.
+          # Mirrors v2's ooze.consolidate! which resets the change baseline.
+          def consolidate!
+            @original_doc = doc.dup if respond_to?(:doc)
+            self
+          end
+
+          # v2 validate stub — always returns nil (no client-side validation in GraphQL path).
+          # Server-side errors are returned in the mutation payload's errors field.
+          def validate
+            nil
+          end
+
+          # Dirty check — returns true if there are pending changes.
+          def dirty?
+            !as_update.nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/concerns/snake_camel_access.rb

@@ -0,0 +1,60 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Concerns
+        # Provides snake_case access to camelCase methods on GraphQL model objects.
+        # eco-helpers scripts (and v2 models) use snake_case, GraphQL uses camelCase.
+        #
+        # Converts any snake_case method call to its camelCase equivalent and delegates.
+        # Works for both readers (external_id → externalId) and writers (time_zone= → timeZone=).
+        #
+        # Examples:
+        #   page.external_id        → page.externalId
+        #   page.patch_ver          → page.patchVer
+        #   page.source_template_id → page.sourceTemplateId
+        #   page.other_tags = ['x'] → page.otherTags = ['x']
+        module SnakeCamelAccess
+          def method_missing(method_name, *args, &block)
+            str    = method_name.to_s
+            setter = str.end_with?('=')
+            base   = setter ? str[0..-2] : str
+            camel  = snake_to_camel(base)
+
+            # Only intercept if conversion actually changed something and target exists
+            if camel != base
+              target = setter ? :"#{camel}=" : camel.to_sym
+              return send(target, *args, &block) if respond_to?(target)
+            end
+
+            super
+          end
+
+          def respond_to_missing?(method_name, include_private = false)
+            str    = method_name.to_s
+            setter = str.end_with?('=')
+            base   = setter ? str[0..-2] : str
+            camel  = snake_to_camel(base)
+
+            if camel != base
+              target = setter ? :"#{camel}=" : camel.to_sym
+              return true if respond_to?(target, include_private)
+            end
+
+            super
+          end
+
+          private
+
+          # Convert snake_case to lowerCamelCase.
+          # external_id → externalId, source_template_id → sourceTemplateId
+          def snake_to_camel(snake_str)
+            parts = snake_str.split('_')
+            return snake_str if parts.length < 2
+
+            parts[0] + parts[1..].map(&:capitalize).join
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,10 +1,14 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Concerns
-      end
-    end
-  end
-end
-
-require_relative 'concerns/fragment_definitions'
+module Ecoportal
+  module API
+    class GraphQL
+      module Concerns
+      end
+    end
+  end
+end
+
+require_relative 'concerns/deprecation'
+require_relative 'concerns/fragment_definitions'
+require_relative 'concerns/snake_camel_access'
+require_relative 'concerns/page_compat'
+require_relative 'concerns/data_field_access'

data/lib/ecoportal/api/graphql/connection/action.rb

@@ -1,11 +1,11 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Connection
-        class Action < Logic::Connection
-          class_resolver :node_class, Model::Action
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Connection
+        class Action < Logic::Connection
+          class_resolver :node_class, Model::Action
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/connection/action_category.rb

@@ -1,11 +1,11 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Connection
-        class ActionCategory < Logic::Connection
-          class_resolver :node_class, Base::ActionCategory
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Connection
+        class ActionCategory < Logic::Connection
+          class_resolver :node_class, Base::ActionCategory
+        end
+      end
+    end
+  end
+end