ecoportal-api-graphql 1.3.17 → 2.0.0

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

@@ -5,6 +5,133 @@ module Ecoportal
         class Input < Logic::BaseModel
           passthrough :clientMutationId
 
+          # Declarative set-diff macro for id-list fields that the schema exposes as
+          # `IdDiffInput { additions: [ID!], removals: [ID!] }` on the *update* mutation.
+          #
+          # Mixed into any Input class (whether it inherits from {Logic::Input} or from a
+          # `Base::` data model) via `extend`. {Logic::Input} extends it for its own subclasses;
+          # data-model Input classes call `extend Logic::Input::IdDiffFields` explicitly.
+          #
+          # Usage:
+          #   class Update < Base::ContractorEntity
+          #     extend Logic::Input::IdDiffFields
+          #     id_diff_fields :associatedPeopleIds, :leadContractorIds
+          #   end
+          #
+          # It installs (or augments) a `from_model` that, for each declared field, computes the
+          # delta DIRECTLY from the READ model's `doc[key]` vs `original_doc[key]` arrays:
+          #   additions = current - original
+          #   removals  = original - current
+          # A field is omitted when unchanged. The delta is computed directly (NOT via the
+          # cascaded DiffService) because these array fields are dropped from the flat diff and
+          # the read model is `root!` (so its doc/original_doc resolve without cascade side effects).
+          module IdDiffFields
+            # @return [Array<Symbol>] the fields declared for set-diff on this class.
+            def id_diff_fields_list
+              @id_diff_fields_list ||= []
+            end
+
+            # Declares the id-list fields that must be reshaped into IdDiff `{ additions:, removals: }`.
+            # @param fields [Array<Symbol>] field names (as they appear in the read model's doc).
+            # @return [void]
+            def id_diff_fields(*fields)
+              id_diff_fields_list.concat(fields.flatten.map(&:to_sym)).uniq!
+            end
+
+            # Computes the IdDiff-shaped deltas for the declared fields and merges them into +diff+.
+            # @param model [Common::GraphQL::Model] the subject (read) model.
+            # @param diff [Hash, nil] the base mutation input hash to augment (may be nil).
+            # @return [Hash, nil] +diff+ with per-field `{ additions:, removals: }` merged in,
+            #   or the original value when nothing changed.
+            def merge_id_diffs(model, diff)
+              id_diff_fields_list.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 if model.respond_to?(:id)
+                diff[field]   = { additions: current - original, removals: original - current }
+              end
+              diff
+            end
+
+            # Reshaping `from_model`: base diff (via {Logic::Input.from_model}) + set-diff deltas.
+            # @param model [Common::GraphQL::Model] the subject model.
+            # @return [Hash, nil] the mutation input hash, or nil when there are no changes.
+            def from_model(model, **kargs)
+              diff = Logic::Input.from_model(model, **kargs)
+              merge_id_diffs(model, diff)
+            end
+          end
+
+          # Declarative FULL-ARRAY macro for id-list fields that the schema exposes as a plain
+          # `[ID!]` on the *update* mutation (NOT `IdDiffInput`). The server expects the COMPLETE
+          # current array, replacing the stored value wholesale — there is no additions/removals
+          # delta shape. This is the counterpart to {IdDiffFields}.
+          #
+          # Mixed into any Input class via `extend`, exactly like {IdDiffFields}. Data-model Input
+          # classes call `extend Logic::Input::FullArrayFields` explicitly.
+          #
+          # Usage:
+          #   class Update < Base::Action
+          #     extend Logic::Input::FullArrayFields
+          #     full_array_fields :assignedPersonMemberIds, :locationIds, :fileContainerIds
+          #   end
+          #
+          # It installs (or augments) a `from_model` that, for each declared field, emits the FULL
+          # current array taken DIRECTLY from the READ model's `doc[key]` whenever it differs from
+          # `original_doc[key]`. A field is omitted when unchanged. The value is read directly (NOT
+          # via the cascaded DiffService) because these array fields are dropped from the flat diff
+          # and the read model is `root!`.
+          #
+          # Schema evidence (live introspection 20260605, UpdateActionInput):
+          #   assignedPersonMemberIds : [ID!]
+          #   locationIds             : [ID!]
+          #   fileContainerIds        : [ID!]
+          # None are `IdDiffInput` — hence full-array, not delta.
+          module FullArrayFields
+            # @return [Array<Symbol>] the fields declared for full-array emission on this class.
+            def full_array_fields_list
+              @full_array_fields_list ||= []
+            end
+
+            # Declares the id-list fields that must be emitted as their COMPLETE current array.
+            # @param fields [Array<Symbol>] field names (as they appear in the read model's doc).
+            # @return [void]
+            def full_array_fields(*fields)
+              full_array_fields_list.concat(fields.flatten.map(&:to_sym)).uniq!
+            end
+
+            # Emits the full current array for each changed declared field and merges it into +diff+.
+            # @param model [Common::GraphQL::Model] the subject (read) model.
+            # @param diff [Hash, nil] the base mutation input hash to augment (may be nil).
+            # @return [Hash, nil] +diff+ with per-field full arrays merged in, or the original
+            #   value when nothing changed.
+            def merge_full_arrays(model, diff)
+              full_array_fields_list.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 if model.respond_to?(:id)
+                diff[field]   = current
+              end
+              diff
+            end
+
+            # Reshaping `from_model`: base diff (via {Logic::Input.from_model}) + full arrays.
+            # @param model [Common::GraphQL::Model] the subject model.
+            # @return [Hash, nil] the mutation input hash, or nil when there are no changes.
+            def from_model(model, **kargs)
+              diff = Logic::Input.from_model(model, **kargs)
+              merge_full_arrays(model, diff)
+            end
+          end
+
           class << self
             # Builds a mutation input hash from a model's diff.
             # Subclasses override this to reshape fields (e.g. array → IdDiffInput).

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

@@ -1,59 +1,59 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Logic
-        class Mutation < Logic::BaseQuery
-          class GenericPayload
-            def initialize(*_args, **_kargs)
-              raise 'Missuse error. You should define a payload_class for a class that inherits from Mutation class.'
-            end
-          end
-
-          class GenericInput
-            def initialize(*_args, **_kargs)
-              raise 'Missuse error. You should define a input_class for a class that inherits from Mutation class.'
-            end
-          end
-
-          class_resolver :payload_class, GenericPayload
-          class_resolver :input_class, GenericInput
-
-          accepted_params :input
-
-          # Query rely that manages the different blocks.
-          # @return [Class] an object of `response_class` with the results hanving from `path`.
-          def query(input:, path: self.path, **kargs, &block)
-            super(
-              input: as_input(input),
-              path:  path,
-              **kargs,
-              &block
-            )
-          end
-
-          def response_class
-            payload_class
-          end
-
-          private
-
-          def as_input(value)
-            case value
-            when input_class, Logic::BaseModel
-              value.as_input
-            when Hash
-              value
-            # when Hash
-            #   value = Helpers::Model::HashKeys.keys_to_sym_deep(value)
-            #   Ecoportal::API::Base::Model.as_input(value)
-            when Enumerable
-              value.map {|v| as_input(v)}
-            else
-              raise ArgumentError, "Expecting Hash, GraphQL::Base::Model or Enumerable. Unsupported type '#{value.class}'."
-            end
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Logic
+        class Mutation < Logic::BaseQuery
+          class GenericPayload
+            def initialize(*_args, **_kargs)
+              raise 'Missuse error. You should define a payload_class for a class that inherits from Mutation class.'
+            end
+          end
+
+          class GenericInput
+            def initialize(*_args, **_kargs)
+              raise 'Missuse error. You should define a input_class for a class that inherits from Mutation class.'
+            end
+          end
+
+          class_resolver :payload_class, GenericPayload
+          class_resolver :input_class, GenericInput
+
+          accepted_params :input
+
+          # Query rely that manages the different blocks.
+          # @return [Class] an object of `response_class` with the results hanving from `path`.
+          def query(input:, path: self.path, **kargs, &block)
+            super(
+              input: as_input(input),
+              path:  path,
+              **kargs,
+              &block
+            )
+          end
+
+          def response_class
+            payload_class
+          end
+
+          private
+
+          def as_input(value)
+            case value
+            when input_class, Logic::BaseModel
+              value.as_input
+            when Hash
+              value
+            # when Hash
+            #   value = Helpers::Model::HashKeys.keys_to_sym_deep(value)
+            #   Ecoportal::API::Base::Model.as_input(value)
+            when Enumerable
+              value.map {|v| as_input(v)}
+            else
+              raise ArgumentError, "Expecting Hash, GraphQL::Base::Model or Enumerable. Unsupported type '#{value.class}'."
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,42 +1,42 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Logic
-        class Payload < Logic::BaseModel
-          class GenericItem
-            def initialize(*_args, **_kargs)
-              raise "Missuse error. You should define a item_class for a class that inherits from GraphqlPayload class."
-            end
-          end
-
-          read_only!
-
-          passthrough :clientMutationId
-
-          class_resolver :item_class, GenericItem
-
-          embeds_one :item, klass: :item_class
-          embeds_one :errors, klass: Error::ValidationErrors, nullable: true
-
-          def success?
-            !error?
-          end
-
-          def error?
-            return false if errors.nil?
-
-            !errors.empty?
-          end
-
-          def error_doc
-            return unless (err_doc = errors&.doc)
-
-            {
-              errors: err_doc
-            }
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Logic
+        class Payload < Logic::BaseModel
+          class GenericItem
+            def initialize(*_args, **_kargs)
+              raise "Missuse error. You should define a item_class for a class that inherits from GraphqlPayload class."
+            end
+          end
+
+          read_only!
+
+          passthrough :clientMutationId
+
+          class_resolver :item_class, GenericItem
+
+          embeds_one :item, klass: :item_class
+          embeds_one :errors, klass: Error::ValidationErrors, nullable: true
+
+          def success?
+            !error?
+          end
+
+          def error?
+            return false if errors.nil?
+
+            !errors.empty?
+          end
+
+          def error_doc
+            return unless (err_doc = errors&.doc)
+
+            {
+              errors: err_doc
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,23 +1,23 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Logic
-        class Query < Logic::BaseQuery
-          class GenericItem
-            def initialize(*_args, **_kargs)
-              msg  = "Missuse error. "
-              msg << "You should define a item_class for a class that "
-              msg << "inherits from Query class."
-              raise msg
-            end
-          end
-          class_resolver :item_class, GenericItem
-
-          def response_class
-            item_class
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Logic
+        class Query < Logic::BaseQuery
+          class GenericItem
+            def initialize(*_args, **_kargs)
+              msg  = "Missuse error. "
+              msg << "You should define a item_class for a class that "
+              msg << "inherits from Query class."
+              raise msg
+            end
+          end
+          class_resolver :item_class, GenericItem
+
+          def response_class
+            item_class
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,30 +1,30 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Logic
-        class QueryArray < Logic::Query
-          include Enumerable
-
-          def each(item_block: nil, **kargs, &block)
-            return to_enum(:each, item_block: connection_block, **kargs) unless block
-
-            query(**kargs, &item_block).each do |item|
-              yield(item) if block_given?
-            end
-          end
-
-          def response_class
-            return array_class if respond_to?(:array_class)
-
-            @response_class ||= self.class.new_class(
-              item_class,
-              inherits: Ecoportal::API::Common::Content::CollectionModel
-            ) do |klass|
-              klass.klass = item_class
-            end
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Logic
+        class QueryArray < Logic::Query
+          include Enumerable
+
+          def each(item_block: nil, **kargs, &block)
+            return to_enum(:each, item_block: connection_block, **kargs) unless block
+
+            query(**kargs, &item_block).each do |item|
+              yield(item) if block_given?
+            end
+          end
+
+          def response_class
+            return array_class if respond_to?(:array_class)
+
+            @response_class ||= self.class.new_class(
+              item_class,
+              inherits: Ecoportal::API::Common::Content::CollectionModel
+            ) do |klass|
+              klass.klass = item_class
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,48 +1,48 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Logic
-        class QueryConnection < Logic::Query
-          accepted_params :searchConf, :after, :before, :first, :last
-          include Enumerable
-
-          def each(connection_block: nil, **kargs, &block)
-            return to_enum(:each, **kargs, connection_block: connection_block) unless block
-
-            connection_block ||= default_connection_block
-
-            cursor = nil
-            loop do
-              kargs.update(after: cursor) if cursor
-              connection = query(**kargs, &connection_block)
-              #total    = connection.totalCount
-              page_info = connection.pageInfo
-              connection.nodes.each(&block)
-
-              break unless (cursor = page_info.endCursor)
-              # break unless page_info.hasNextPage
-            end
-          end
-
-          def response_class
-            return connection_class if respond_to?(:connection_class)
-
-            @response_class ||= self.class.new_class(
-              item_class,
-              inherits:  Logic::Connection,
-              namespace: "Ecoportal::API::GraphQL::Connection"
-            ) do |klass|
-              klass.item_class = item_class
-            end
-          end
-
-          private
-
-          def default_connection_block
-            raise 'You should defined this method'
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Logic
+        class QueryConnection < Logic::Query
+          accepted_params :searchConf, :after, :before, :first, :last
+          include Enumerable
+
+          def each(connection_block: nil, **kargs, &block)
+            return to_enum(:each, **kargs, connection_block: connection_block) unless block
+
+            connection_block ||= default_connection_block
+
+            cursor = nil
+            loop do
+              kargs.update(after: cursor) if cursor
+              connection = query(**kargs, &connection_block)
+              #total    = connection.totalCount
+              page_info = connection.pageInfo
+              connection.nodes.each(&block)
+
+              break unless (cursor = page_info.endCursor)
+              # break unless page_info.hasNextPage
+            end
+          end
+
+          def response_class
+            return connection_class if respond_to?(:connection_class)
+
+            @response_class ||= self.class.new_class(
+              item_class,
+              inherits:  Logic::Connection,
+              namespace: "Ecoportal::API::GraphQL::Connection"
+            ) do |klass|
+              klass.item_class = item_class
+            end
+          end
+
+          private
+
+          def default_connection_block
+            raise 'You should defined this method'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,18 +1,18 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Logic
-      end
-    end
-  end
-end
-
-require_relative 'logic/base_model'
-require_relative 'logic/base_query'
-require_relative 'logic/query'
-require_relative 'logic/mutation'
-require_relative 'logic/connection'
-require_relative 'logic/query_array'
-require_relative 'logic/query_connection'
-require_relative 'logic/payload'
-require_relative 'logic/input'
+module Ecoportal
+  module API
+    class GraphQL
+      module Logic
+      end
+    end
+  end
+end
+
+require_relative 'logic/base_model'
+require_relative 'logic/base_query'
+require_relative 'logic/query'
+require_relative 'logic/mutation'
+require_relative 'logic/connection'
+require_relative 'logic/query_array'
+require_relative 'logic/query_connection'
+require_relative 'logic/payload'
+require_relative 'logic/input'

data/lib/ecoportal/api/graphql/model/account.rb

@@ -1,15 +1,15 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Model
-        class Account < Logic::BaseModel
-          root!
-
-          passkey :id
-          passthrough :default_tag
-          passboolean :active
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Model
+        class Account < Logic::BaseModel
+          root!
+
+          passkey :id
+          passthrough :default_tag
+          passboolean :active
+        end
+      end
+    end
+  end
+end

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

@@ -1,22 +1,22 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Model
-        class Action < Base::Action
-          embeds_one :actionCategory, klass: GraphQL::Base::ActionCategory
-          embeds_many :assignedTo, klass: Model::PersonMember
-          embeds_one :creator, klass: Model::PersonMember
-          embeds_one :creatorUser, klass: Model::User
-          embeds_one :updater, klass: Model::PersonMember
-          embeds_one :updaterUser, klass: Model::User
-          embeds_one :completer, klass: Model::PersonMember
-          embeds_many :fileContainers, klass: Model::FileContainer
-          embeds_many :linkedResources, klass: Model::Resource
-          embeds_many :locations, klass: Model::LocationNode
-          #embeds_many :activities, klass: GraphQL::Model::Action::Activity
-          #embeds_one :recurrence, klass: GraphQL::Model::Action::Recurrence
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Model
+        class Action < Base::Action
+          embeds_one :actionCategory, klass: GraphQL::Base::ActionCategory
+          embeds_many :assignedTo, klass: Model::PersonMember
+          embeds_one :creator, klass: Model::PersonMember
+          embeds_one :creatorUser, klass: Model::User
+          embeds_one :updater, klass: Model::PersonMember
+          embeds_one :updaterUser, klass: Model::User
+          embeds_one :completer, klass: Model::PersonMember
+          embeds_many :fileContainers, klass: Model::FileContainer
+          embeds_many :linkedResources, klass: Model::Resource
+          embeds_many :locations, klass: Model::LocationNode
+          #embeds_many :activities, klass: GraphQL::Model::Action::Activity
+          #embeds_one :recurrence, klass: GraphQL::Model::Action::Recurrence
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/model/action_event.rb

@@ -0,0 +1,14 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Model
+        class ActionEvent < Base::ActionEvent
+          # assignedPersonMembers: [PreviewPersonMember!]! — Model::PersonMember's
+          # read fields are a compatible superset.
+          embeds_many :assignedPersonMembers, klass: Model::PersonMember
+          embeds_many :pages, klass: "Ecoportal::API::GraphQL::Model::ActionEventPage"
+        end
+      end
+    end
+  end
+end