ecoportal-api-graphql 2.0.0 → 2.2.0

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

@@ -1,23 +1,23 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Compat
-        # Returned by Compat::Pages#create — mirrors the v2 reference object.
-        # Scripts access .page_id and .active_stage_id after page creation.
-        class PageReference
-          attr_reader :page_id, :active_stage_id, :page
-
-          def initialize(page)
-            @page            = page
-            @page_id         = page.id
-            @active_stage_id = page.respond_to?(:current_stage_id) ? page.current_stage_id : nil
-          end
-
-          def success?
-            !@page_id.nil?
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Compat
+        # Returned by Compat::Pages#create — mirrors the v2 reference object.
+        # Scripts access .page_id and .active_stage_id after page creation.
+        class PageReference
+          attr_reader :page_id, :active_stage_id, :page
+
+          def initialize(page)
+            @page            = page
+            @page_id         = page.id
+            @active_stage_id = page.respond_to?(:current_stage_id) ? page.current_stage_id : nil
+          end
+
+          def success?
+            !@page_id.nil?
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,84 +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
+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/search_results.rb

@@ -1,33 +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
+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.rb

@@ -1,17 +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'
+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

@@ -1,71 +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
+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/fragment_definitions.rb

@@ -1,68 +1,68 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Concerns
-        module FragmentDefinitions
-          class << self
-            private
-
-            def included(base)
-              super
-
-              base.send :include, Ecoportal::API::Common::GraphQL::ClassHelpers
-              base.extend ClassMethods
-              base.send :include, InstanceMethods
-            end
-          end
-
-          module ClassMethods
-            def fragment(sym, heredoc)
-              fragments[sym] = heredoc
-            end
-
-            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
-            attr_reader :client, :fragments
-
-            def initialize(client)
-              @client = client
-              parse
-            end
-
-            # 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 parse
-              @fragments = self.class.fragments.dup
-            end
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Concerns
+        module FragmentDefinitions
+          class << self
+            private
+
+            def included(base)
+              super
+
+              base.send :include, Ecoportal::API::Common::GraphQL::ClassHelpers
+              base.extend ClassMethods
+              base.send :include, InstanceMethods
+            end
+          end
+
+          module ClassMethods
+            def fragment(sym, heredoc)
+              fragments[sym] = heredoc
+            end
+
+            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
+            attr_reader :client, :fragments
+
+            def initialize(client)
+              @client = client
+              parse
+            end
+
+            # 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 parse
+              @fragments = self.class.fragments.dup
+            end
+          end
+        end
+      end
+    end
+  end
+end