ecoportal-api-graphql 1.3.17 → 2.0.0

data/lib/ecoportal/api/graphql/interface/base_page.rb

@@ -6,6 +6,12 @@ module Ecoportal
           include Concerns::PageCompat
           include Concerns::DataFieldAccess
 
+          # Page-level leaf arrays (`otherTags`, whole-set `locations`) are cascaded
+          # attributes the default DiffService cannot see. LeafDiffService diffs them
+          # inline (full-set replace) while still cascading into real nested models
+          # (e.g. a phased page's `stages`). See Diffable::LeafDiffService.
+          DIFF_CLASS = Ecoportal::API::Common::GraphQL::Model::Diffable::LeafDiffService
+
           passkey :id
           passthrough :name, :uid
           passthrough :icon
@@ -15,7 +21,6 @@ module Ecoportal
           # class_resolver :force_class, 'Ecoportal::API::GraphQL::Base::Force'
           # class_resolver :task_class, 'Ecoportal::API::GraphQL::Interface::Task'
           # class_resolver :theme_class, 'Ecoportal::API::GraphQL::Base::Theme'
-          # class_resolver :template_class, 'Ecoportal::API::GraphQL::Base::Template'
           # class_resolver :register_class, 'Ecoportal::API::GraphQL::Base::Register'
           class_resolver :organization_class, 'Ecoportal::API::GraphQL::Base::Organization'
 
@@ -41,7 +46,6 @@ module Ecoportal
           # embeds_one :taskPriority, klass: 'BasePage::TaskPriorityEnum', read_only: true
           passthrough :taskPriority
 
-
           passthrough :patchVer
 
           passboolean :draft, :archived
@@ -78,7 +82,36 @@ module Ecoportal
           # the CreateFromTemplateInput preview. nil for fetched/persisted pages.
           attr_accessor :_compat_source_template_id
 
-          # embeds_one :template, klass: :template_class, read_only: true
+          # The narrow `Template` type (NOT the template page — see Base::Template for the
+          # asymmetry). Populated only for template pages; nil for records. Carries
+          # `templateContainerUid`, the cross-version series key.
+          class_resolver :template_class, 'Ecoportal::API::GraphQL::Model::Template::Information'
+
+          # Deliberately NOT `embeds_one ..., read_only: true`, and this is not a style choice:
+          # `read_only` does not keep a mutated child out of the parent's diff. With `embeds_one`,
+          # `page.template.templateContainerUid = 'x'` yields
+          # `as_update => { id:, template: { templateContainerUid: 'x' } }` — but `UpdatePageInput`
+          # has NO `template` member, so that would push a key `updatePage` cannot accept. The
+          # only writer for the series key is the `editTemplateContainerUid` workflow command.
+          #
+          # So this follows the same on-demand read-only pattern as `#forces` above, over a COPY of
+          # the sub-doc: the returned model is a genuine dead end — writes to it cannot reach
+          # `doc`, cannot dirty the page, and cannot leak into an update.
+          def template
+            return nil unless (raw = doc['template'])
+
+            @template ||= template_class.new(
+              Ecoportal::API::Common::GraphQL::HashHelpers.deep_dup(raw)
+            )
+          end
+
+          # Convenience reader for the cross-version series key — nil unless this page is a
+          # template AND the read selected `template { templateContainerUid }` (CommonPageUnion
+          # does). Many versions may share one uid; only one may be published at a time.
+          def templateContainerUid
+            template&.templateContainerUid
+          end
+
           # embeds_many :registers, klass: :register_class, read_only: true
           # embeds_one :organization, klass: :organization_class, read_only: true
 

data/lib/ecoportal/api/graphql/interface/location_structure/command.rb

@@ -17,7 +17,8 @@ module Ecoportal
 
             def set_values(**kargs)
               kargs.each do |key, value|
-                send(key, value) if respond_to?(key, true)
+                writer = "#{key}="
+                send(writer, value) if respond_to?(writer, true)
               end
 
               self

data/lib/ecoportal/api/graphql/interface/location_structure/node.rb

@@ -1,43 +1,43 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Interface
-        module LocationStructure
-          class Node < Logic::BaseModel
-            root!
-
-            class_resolver :location_classification_class, 'Ecoportal::API::GraphQL::Base::LocationClassificationType'
-            class_resolver :location_node_class, self
-
-            passkey :id
-            passthrough :name
-            embeds_many :classifications, klass: :location_classification_class
-            passarray :classificationObjectIds
-
-            passthrough :weight
-
-            passboolean :archived
-            passthrough :archivedToken
-
-            passthrough :structureId
-
-            embeds_one :parent, klass: :location_node_class, nullable: true
-            passthrough :parentObjectId
-
-            def parentId
-              parent&.id
-            end
-            alias_method :parent_id, :parentId
-
-            def parent_id_upcase
-              parent_id&.upcase
-            end
-
-            embeds_many :ancestors, klass: :location_node_class, read_only: true
-            embeds_many :children, klass: :location_node_class, read_only: true
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Interface
+        module LocationStructure
+          class Node < Logic::BaseModel
+            root!
+
+            class_resolver :location_classification_class, 'Ecoportal::API::GraphQL::Base::LocationClassificationType'
+            class_resolver :location_node_class, self
+
+            passkey :id
+            passthrough :name
+            embeds_many :classifications, klass: :location_classification_class
+            passarray :classificationObjectIds
+
+            passthrough :weight
+
+            passboolean :archived
+            passthrough :archivedToken
+
+            passthrough :structureId
+
+            embeds_one :parent, klass: :location_node_class, nullable: true
+            passthrough :parentObjectId
+
+            def parentId
+              parent&.id
+            end
+            alias_method :parent_id, :parentId
+
+            def parent_id_upcase
+              parent_id&.upcase
+            end
+
+            embeds_many :ancestors, klass: :location_node_class, read_only: true
+            embeds_many :children, klass: :location_node_class, read_only: true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/interface/location_structure.rb

@@ -1,14 +1,14 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Interface
-        module LocationStructure
-        end
-      end
-    end
-  end
-end
-
-require_relative 'location_structure/node'
-require_relative 'location_structure/nodes'
-require_relative 'location_structure/command'
+module Ecoportal
+  module API
+    class GraphQL
+      module Interface
+        module LocationStructure
+        end
+      end
+    end
+  end
+end
+
+require_relative 'location_structure/node'
+require_relative 'location_structure/nodes'
+require_relative 'location_structure/command'

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

@@ -1,11 +1,11 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Interface
-      end
-    end
-  end
-end
-
-require_relative 'interface/location_structure'
-require_relative 'interface/base_page'
+module Ecoportal
+  module API
+    class GraphQL
+      module Interface
+      end
+    end
+  end
+end
+
+require_relative 'interface/location_structure'
+require_relative 'interface/base_page'

data/lib/ecoportal/api/graphql/logic/base_model.rb

@@ -1,15 +1,15 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Logic
-        class BaseModel < Ecoportal::API::Common::GraphQL::Model
-          include Ecoportal::API::GraphQL::Concerns::SnakeCamelAccess
-
-          class << self
-            attr_accessor :client
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Logic
+        class BaseModel < Ecoportal::API::Common::GraphQL::Model
+          include Ecoportal::API::GraphQL::Concerns::SnakeCamelAccess
+
+          class << self
+            attr_accessor :client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/logic/base_query.rb

@@ -1,193 +1,193 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Logic
-        class BaseQuery
-          include Ecoportal::API::Common::GraphQL::ClassHelpers
-
-          inheritable_attrs :accepted_params, :param_defaults
-
-          DETAIL_ERRORS = [
-            Ecoportal::API::Common::GraphQL::ResponseError,
-            Ecoportal::API::Common::Client::Error::UnexpectedServerError,
-            Faraday::ParsingError,
-            Graphlient::Errors::FaradayServerError,
-            Graphlient::Errors::GraphQLError,
-            Graphlient::Errors::ClientError
-          ].freeze
-
-          class << self
-            def param_defaults
-              @param_defaults ||= {}
-            end
-
-            def accepted_params(*keys, default: :unused)
-              @accepted_params ||= []
-              return @accepted_params if keys.empty?
-
-              keys.map(&:to_sym).uniq.each do |key|
-                @accepted_params   |= [key]
-                param_defaults[key] = default unless default == :unused
-              end
-
-              @accepted_params.push(*keys).tap(&:uniq!)
-              @accepted_params
-            end
-
-            def clear_accepted_params
-              @param_defaults  = {}
-              @accepted_params = []
-            end
-
-            def slice_params(kargs)
-              kargs.slice(*accepted_params)
-            end
-
-            # Used to obtain the full `path` in the GraphQL query by using `base_path`
-            # @note it is meant for reusability of queries from different end-points
-            def field_name(str = nil)
-              return @field_name unless str
-
-              @field_name = nil
-              @field_name = str.to_s if str
-              @field_name
-            end
-
-            def base_path(path = :unused)
-              return @base_path if path == :unused
-
-              path ||= []
-              path   = path.to_s.split('.') if path.is_a?(String)
-              path   = path.map(&:to_s).compact
-
-              @base_path = path
-            end
-          end
-
-          include Ecoportal::API::Common::Concerns::Benchmarkable
-
-          attr_reader :client, :base_path
-
-          def initialize(client, path: nil, base_path: self.class.base_path)
-            @path      = path
-            @base_path = base_path
-            @client    = client
-          end
-
-          # Resolves the `path` by using `path` or `base_path` + `class.field_name`.
-          def path(field_name = self.class.field_name)
-            result   = @path
-            result ||= default_path if respond_to?(:default_path, true)
-            result ||= (base_path + [field_name]) if base_path && field_name
-            result ||= [field_name]
-            result
-          end
-
-          # Query rely that manages the different blocks.
-          # @return [Class] an object of `response_class` with the results hanging from `path`.
-          def query(path: self.path, raw_response: {}, **kargs, &block)
-            print = !is_a?(Mutation)
-
-            benchmarking("#{self.class}##{__method__}", print: print) do
-              graphql_query(
-                path:         path,
-                raw_response: raw_response,
-                **kargs,
-                &basic_block(&block)
-              )
-            end
-          end
-
-          def response_class
-            raise "You should override this method in #{self.class}"
-          end
-
-          def access_point(path = [])
-            path.last
-          end
-
-          private
-
-          def basic_block
-            raise "This method should be implemented in the child class #{self.class}"
-          end
-
-          # Types that should be passed through as-is as GraphQL variable values.
-          # Anything else that responds to to_h is treated as a serialisable value object.
-          VARIABLE_PRIMITIVES = [
-            ::NilClass, ::TrueClass, ::FalseClass,
-            ::Integer, ::Float, ::String, ::Symbol,
-            ::Hash, ::Array
-          ].freeze
-          private_constant :VARIABLE_PRIMITIVES
-
-          def normalize_variables(kargs)
-            kargs.transform_values do |v|
-              VARIABLE_PRIMITIVES.any? { |t| v.is_a?(t) } || !v.respond_to?(:to_h) ? v : v.to_h
-            end
-          end
-
-          def graphql_query(path: self.path, raw_response: {}, **kargs, &block)
-            default_params = self.class.param_defaults.dup
-            query_params   = self.class.slice_params(normalize_variables(default_params.merge(kargs)))
-
-            query_str    = client.to_query_string(&block)
-            fragment_str = assemble_fragments(query_str)
-            full_query   = fragment_str.empty? ? query_str : "#{query_str}\n\n#{fragment_str}"
-
-            request(*path) do
-              client.http_client.execute(full_query, variables: query_params).tap do |response|
-                raw_response[:data] = response
-              end
-            end
-          rescue *DETAIL_ERRORS => _err
-            pp kargs
-            puts "Internal Error with these params:\n"
-            pp query_params
-            pp block
-            raise
-          end
-
-          def request(*path)
-            response = yield
-            wrap_response(response, path)
-          end
-
-          # Resolves all fragment spreads in query_str, recursively following
-          # spreads inside assembled fragment bodies until no new names are found.
-          # Names that don't resolve to a registered fragment are skipped safely.
-          def assemble_fragments(query_str)
-            tried     = {}
-            assembled = {}
-            pending   = query_str.scan(/\.\.\.(\w+)/).flatten.map(&:to_sym).uniq
-
-            until (unresolved = pending.reject { |n| tried.key?(n) }).empty?
-              unresolved.each do |name|
-                tried[name] = true
-                frag        = Ecoportal::API::GraphQL::Fragment.assemble(name)
-                next if frag.empty?
-
-                assembled[name] = frag
-                pending |= frag.scan(/\.\.\.(\w+)/).flatten.map(&:to_sym)
-              end
-            end
-
-            assembled.values.join("\n\n")
-          end
-
-          def wrap_response(response, path = [])
-            # we use the Hash, because fragments are persmissioned
-            # see Use of Fragments at https://github.com/ashkan18/graphlient/tree/master?tab=readme-ov-file#use-of-fragments
-            unless (res = response.to_h.dig(*path.dup.unshift('data')))
-              msg = "Complete failure on request. Path: #{path}\n#{response.to_h.pretty_inspect}"
-              raise msg
-            end
-
-            data = Ecoportal::API::Common::GraphQL::HashHelpers.deep_dup(res)
-            response_class.new(data)
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Logic
+        class BaseQuery
+          include Ecoportal::API::Common::GraphQL::ClassHelpers
+
+          inheritable_attrs :accepted_params, :param_defaults
+
+          DETAIL_ERRORS = [
+            Ecoportal::API::Common::GraphQL::ResponseError,
+            Ecoportal::API::Common::Client::Error::UnexpectedServerError,
+            Faraday::ParsingError,
+            Graphlient::Errors::FaradayServerError,
+            Graphlient::Errors::GraphQLError,
+            Graphlient::Errors::ClientError
+          ].freeze
+
+          class << self
+            def param_defaults
+              @param_defaults ||= {}
+            end
+
+            def accepted_params(*keys, default: :unused)
+              @accepted_params ||= []
+              return @accepted_params if keys.empty?
+
+              keys.map(&:to_sym).uniq.each do |key|
+                @accepted_params   |= [key]
+                param_defaults[key] = default unless default == :unused
+              end
+
+              @accepted_params.push(*keys).tap(&:uniq!)
+              @accepted_params
+            end
+
+            def clear_accepted_params
+              @param_defaults  = {}
+              @accepted_params = []
+            end
+
+            def slice_params(kargs)
+              kargs.slice(*accepted_params)
+            end
+
+            # Used to obtain the full `path` in the GraphQL query by using `base_path`
+            # @note it is meant for reusability of queries from different end-points
+            def field_name(str = nil)
+              return @field_name unless str
+
+              @field_name = nil
+              @field_name = str.to_s if str
+              @field_name
+            end
+
+            def base_path(path = :unused)
+              return @base_path if path == :unused
+
+              path ||= []
+              path   = path.to_s.split('.') if path.is_a?(String)
+              path   = path.map(&:to_s).compact
+
+              @base_path = path
+            end
+          end
+
+          include Ecoportal::API::Common::Concerns::Benchmarkable
+
+          attr_reader :client, :base_path
+
+          def initialize(client, path: nil, base_path: self.class.base_path)
+            @path      = path
+            @base_path = base_path
+            @client    = client
+          end
+
+          # Resolves the `path` by using `path` or `base_path` + `class.field_name`.
+          def path(field_name = self.class.field_name)
+            result   = @path
+            result ||= default_path if respond_to?(:default_path, true)
+            result ||= (base_path + [field_name]) if base_path && field_name
+            result ||= [field_name]
+            result
+          end
+
+          # Query rely that manages the different blocks.
+          # @return [Class] an object of `response_class` with the results hanging from `path`.
+          def query(path: self.path, raw_response: {}, **kargs, &block)
+            print = !is_a?(Mutation)
+
+            benchmarking("#{self.class}##{__method__}", print: print) do
+              graphql_query(
+                path:         path,
+                raw_response: raw_response,
+                **kargs,
+                &basic_block(&block)
+              )
+            end
+          end
+
+          def response_class
+            raise "You should override this method in #{self.class}"
+          end
+
+          def access_point(path = [])
+            path.last
+          end
+
+          private
+
+          def basic_block
+            raise "This method should be implemented in the child class #{self.class}"
+          end
+
+          # Types that should be passed through as-is as GraphQL variable values.
+          # Anything else that responds to to_h is treated as a serialisable value object.
+          VARIABLE_PRIMITIVES = [
+            ::NilClass, ::TrueClass, ::FalseClass,
+            ::Integer, ::Float, ::String, ::Symbol,
+            ::Hash, ::Array
+          ].freeze
+          private_constant :VARIABLE_PRIMITIVES
+
+          def normalize_variables(kargs)
+            kargs.transform_values do |v|
+              VARIABLE_PRIMITIVES.any? { |t| v.is_a?(t) } || !v.respond_to?(:to_h) ? v : v.to_h
+            end
+          end
+
+          def graphql_query(path: self.path, raw_response: {}, **kargs, &block)
+            default_params = self.class.param_defaults.dup
+            query_params   = self.class.slice_params(normalize_variables(default_params.merge(kargs)))
+
+            query_str    = client.to_query_string(&block)
+            fragment_str = assemble_fragments(query_str)
+            full_query   = fragment_str.empty? ? query_str : "#{query_str}\n\n#{fragment_str}"
+
+            request(*path) do
+              client.http_client.execute(full_query, variables: query_params).tap do |response|
+                raw_response[:data] = response
+              end
+            end
+          rescue *DETAIL_ERRORS => _err
+            pp kargs
+            puts "Internal Error with these params:\n"
+            pp query_params
+            pp block
+            raise
+          end
+
+          def request(*path)
+            response = yield
+            wrap_response(response, path)
+          end
+
+          # Resolves all fragment spreads in query_str, recursively following
+          # spreads inside assembled fragment bodies until no new names are found.
+          # Names that don't resolve to a registered fragment are skipped safely.
+          def assemble_fragments(query_str)
+            tried     = {}
+            assembled = {}
+            pending   = query_str.scan(/\.\.\.(\w+)/).flatten.map(&:to_sym).uniq
+
+            until (unresolved = pending.reject { |n| tried.key?(n) }).empty?
+              unresolved.each do |name|
+                tried[name] = true
+                frag        = Ecoportal::API::GraphQL::Fragment.assemble(name)
+                next if frag.empty?
+
+                assembled[name] = frag
+                pending |= frag.scan(/\.\.\.(\w+)/).flatten.map(&:to_sym)
+              end
+            end
+
+            assembled.values.join("\n\n")
+          end
+
+          def wrap_response(response, path = [])
+            # we use the Hash, because fragments are persmissioned
+            # see Use of Fragments at https://github.com/ashkan18/graphlient/tree/master?tab=readme-ov-file#use-of-fragments
+            unless (res = response.to_h.dig(*path.dup.unshift('data')))
+              msg = "Complete failure on request. Path: #{path}\n#{response.to_h.pretty_inspect}"
+              raise msg
+            end
+
+            data = Ecoportal::API::Common::GraphQL::HashHelpers.deep_dup(res)
+            response_class.new(data)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -18,6 +18,23 @@ module Ecoportal
           embeds_many :nodes, klass: :node_class
           embeds_one :pageInfo, klass: Base::PageInfo
 
+          # Bind a connection subclass to its concrete node type.
+          #
+          # The base `embeds_many :nodes, klass: :node_class` builds a SINGLE dynamic
+          # `CollectionModel` ("nodes::node_class") that every subclass inherits and shares.
+          # The v2 collection layer memoizes the resolved class on that shared collection
+          # (items_klass.rb:62-63), so the FIRST connection instantiated in a process poisons
+          # every other connection's instance `nodes` typing (e.g. a MinimalDashboard connection
+          # returning AuthLog nodes). Declaring `embeds_many :nodes` per subclass with the concrete
+          # class gives each subclass its OWN collection ("nodes::Model::X") bound to a real Class —
+          # no shared symbol, nothing to memoize wrongly.
+          #
+          # Use `nodes_of Model::X` in a subclass instead of `class_resolver :node_class, Model::X`.
+          def self.nodes_of(klass)
+            class_resolver :node_class, klass
+            embeds_many :nodes, klass: klass
+          end
+
           def empty?
             count < 1
           end