ecoportal-api-graphql 1.3.13 → 1.3.16

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

@@ -1,57 +1,57 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Query
-        class LocationStructures < Logic::QueryArray
-          accepted_params :includeArchived, :includeUnpublished, default: false
-          accepted_params :includeArchivedNodes, default: true
-
-          field_name :structures
-
-          class_resolver :item_class, Model::LocationStructure
-
-          private
-
-          def basic_block(&block)
-            final_block = block || default_query_block
-            proc {
-              query(
-                includeArchived:      :boolean,
-                includeUnpublished:   :boolean,
-                includeArchivedNodes: :boolean
-              ) {
-                currentOrganization {
-                  locations {
-                    structures(
-                      includeArchived:    :includeArchived,
-                      includeUnpublished: :includeUnpublished,
-                      &final_block
-                    )
-                  }
-                }
-              }
-            }
-          end
-
-          # At the moment it always retrieves archived nodes!!
-          # @note this is on purpose, as via API
-          #   there isn't much sense in not including archived nodes.
-          def default_query_block
-            proc {
-              id
-              name
-              archived
-              weight
-              visitorManagementEnabled
-              nodes(
-                includeArchived: :includeArchivedNodes
-              ) {
-                spread :LocationNode
-              }
-            }
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Query
+        class LocationStructures < Logic::QueryArray
+          accepted_params :includeArchived, :includeUnpublished, default: false
+          accepted_params :includeArchivedNodes, default: true
+
+          field_name :structures
+
+          class_resolver :item_class, Model::LocationStructure
+
+          private
+
+          def basic_block(&block)
+            final_block = block || default_query_block
+            proc {
+              query(
+                includeArchived:      :boolean,
+                includeUnpublished:   :boolean,
+                includeArchivedNodes: :boolean
+              ) {
+                currentOrganization {
+                  locations {
+                    structures(
+                      includeArchived:    :includeArchived,
+                      includeUnpublished: :includeUnpublished,
+                      &final_block
+                    )
+                  }
+                }
+              }
+            }
+          end
+
+          # At the moment it always retrieves archived nodes!!
+          # @note this is on purpose, as via API
+          #   there isn't much sense in not including archived nodes.
+          def default_query_block
+            proc {
+              id
+              name
+              archived
+              weight
+              visitorManagementEnabled
+              nodes(
+                includeArchived: :includeArchivedNodes
+              ) {
+                spread :LocationNode
+              }
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,45 +1,45 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Query
-        class Page < Logic::Query
-          field_name :page
-          # Response nests under currentOrganization.page; needed when instantiated
-          # directly (e.g. Compat::Pages#get) rather than via the currentOrganization proxy.
-          base_path 'currentOrganization'
-
-          accepted_params :id
-          class_resolver :item_class, 'Ecoportal::API::GraphQL::Model::PageUnion'
-
-          private
-
-          def basic_block(&block)
-            page_block = block || default_block
-            # CommonPageUnion's directives ($content/$only_content/$fields) are declared
-            # here with the defaults for a single-page read (content + field definitions).
-            # showHiddenData defaults true so reads include hidden/deindexed fields — v2
-            # parity (scripts see every field) and matches the front-end edit load. The
-            # server omits hidden fields from `page(id:)` when this is false/absent.
-            proc {
-              query(
-                id:             :id!,
-                showHiddenData: 'Boolean = true',
-                content:        'Boolean = true',
-                only_content:   'Boolean = false',
-                fields:         'Boolean = true'
-              ) {
-                currentOrganization {
-                  page(id: :id, showHiddenData: :showHiddenData, &page_block)
-                }
-              }
-            }
-          end
-
-          def default_block
-            proc { spread :CommonPageUnion }
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Query
+        class Page < Logic::Query
+          field_name :page
+          # Response nests under currentOrganization.page; needed when instantiated
+          # directly (e.g. Compat::Pages#get) rather than via the currentOrganization proxy.
+          base_path 'currentOrganization'
+
+          accepted_params :id
+          class_resolver :item_class, 'Ecoportal::API::GraphQL::Model::PageUnion'
+
+          private
+
+          def basic_block(&block)
+            page_block = block || default_block
+            # CommonPageUnion's directives ($content/$only_content/$fields) are declared
+            # here with the defaults for a single-page read (content + field definitions).
+            # showHiddenData defaults true so reads include hidden/deindexed fields — v2
+            # parity (scripts see every field) and matches the front-end edit load. The
+            # server omits hidden fields from `page(id:)` when this is false/absent.
+            proc {
+              query(
+                id:             :id!,
+                showHiddenData: 'Boolean = true',
+                content:        'Boolean = true',
+                only_content:   'Boolean = false',
+                fields:         'Boolean = true'
+              ) {
+                currentOrganization {
+                  page(id: :id, showHiddenData: :showHiddenData, &page_block)
+                }
+              }
+            }
+          end
+
+          def default_block
+            proc { spread :CommonPageUnion }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -28,12 +28,18 @@ module Ecoportal
             }
           end
 
+          # `currentOrganization.page(id:)` returns a PageUnion — selecting `forces` on it
+          # directly is invalid GraphQL ("Selections can't be made directly on unions").
+          # `forces` lives on BasePageInterface (which every union member implements), so it
+          # goes through an inline type condition, same as `PageFields` does.
           def default_block
             proc {
               spread :PageFields
-              forces {
-                spread :ForceFields
-              }
+              spread on: :BasePageInterface do
+                forces {
+                  spread :ForceFields
+                }
+              end
             }
           end
         end

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

@@ -25,15 +25,21 @@ module Ecoportal
 
           private
 
+          # `page(id:)` returns a PageUnion — selecting `workflow` on it directly is invalid
+          # GraphQL ("Selections can't be made directly on unions"). `workflow` lives on
+          # BasePageInterface, so it goes through an inline type condition. The response shape
+          # is unchanged by the type condition, so `#path` still resolves the connection.
           def basic_block(&block)
             connection_block = block || default_connection_block
             proc {
               query(id: :id!, after: :string, before: :string, first: :int, last: :int) {
                 currentOrganization {
                   page(id: :id) {
-                    workflow {
-                      commands(after: :after, before: :before, first: :first, last: :last, &connection_block)
-                    }
+                    spread on: :BasePageInterface do
+                      workflow {
+                        commands(after: :after, before: :before, first: :first, last: :last, &connection_block)
+                      }
+                    end
                   }
                 }
               }

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

@@ -1,78 +1,78 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Query
-        # Lists preset views for a register.
-        # Returns an array of PresetView objects — not paginated (server returns all at once).
-        # Use the returned IDs as `presetViewId` in RegisterPreviewPages queries.
-        #
-        # Usage:
-        #   views = Query::RegisterPresetViews.new(client).query(registerId: 'REG_ID')
-        #   views.map { |v| { id: v.id, name: v.name, global: v.global? } }
-        class RegisterPresetViews < Logic::Query
-          field_name :presetViews
-
-          accepted_params :registerId, :searchConf
-
-          class_resolver :item_class, 'Ecoportal::API::GraphQL::Model::PresetView'
-
-          def path
-            %w[currentOrganization register presetViews]
-          end
-
-          def response_class
-            # presetViews returns an array — wrap in a simple array-like response
-            ArrayResponse
-          end
-
-          # Minimal array wrapper so callers can iterate results with .each / .map
-          class ArrayResponse
-            include Enumerable
-
-            def initialize(raw)
-              klass = Ecoportal::API::GraphQL::Model::PresetView
-              @items = Array(raw).map { |d| klass.new(d) }
-            end
-
-            def each(&block)
-              @items.each(&block)
-            end
-
-            def nodes
-              @items
-            end
-          end
-
-          private
-
-          def basic_block(&block)
-            view_block = block || default_block
-            proc {
-              query(
-                registerId: :id!,
-                searchConf: :Search
-              ) {
-                currentOrganization {
-                  register(id: :registerId) {
-                    presetViews(searchConf: :searchConf, &view_block)
-                  }
-                }
-              }
-            }
-          end
-
-          def default_block
-            proc {
-              id
-              name
-              global
-              registerId
-              sorter { key direction missing }
-              fieldConfigurations { id key name weight }
-            }
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Query
+        # Lists preset views for a register.
+        # Returns an array of PresetView objects — not paginated (server returns all at once).
+        # Use the returned IDs as `presetViewId` in RegisterPreviewPages queries.
+        #
+        # Usage:
+        #   views = Query::RegisterPresetViews.new(client).query(registerId: 'REG_ID')
+        #   views.map { |v| { id: v.id, name: v.name, global: v.global? } }
+        class RegisterPresetViews < Logic::Query
+          field_name :presetViews
+
+          accepted_params :registerId, :searchConf
+
+          class_resolver :item_class, 'Ecoportal::API::GraphQL::Model::PresetView'
+
+          def path
+            %w[currentOrganization register presetViews]
+          end
+
+          def response_class
+            # presetViews returns an array — wrap in a simple array-like response
+            ArrayResponse
+          end
+
+          # Minimal array wrapper so callers can iterate results with .each / .map
+          class ArrayResponse
+            include Enumerable
+
+            def initialize(raw)
+              klass = Ecoportal::API::GraphQL::Model::PresetView
+              @items = Array(raw).map { |d| klass.new(d) }
+            end
+
+            def each(&block)
+              @items.each(&block)
+            end
+
+            def nodes
+              @items
+            end
+          end
+
+          private
+
+          def basic_block(&block)
+            view_block = block || default_block
+            proc {
+              query(
+                registerId: :id!,
+                searchConf: :Search
+              ) {
+                currentOrganization {
+                  register(id: :registerId) {
+                    presetViews(searchConf: :searchConf, &view_block)
+                  }
+                }
+              }
+            }
+          end
+
+          def default_block
+            proc {
+              id
+              name
+              global
+              registerId
+              sorter { key direction missing }
+              fieldConfigurations { spread :FieldConfiguration }
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,27 +1,27 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Query
-      end
-    end
-  end
-end
-
-require_relative 'query/location_classifications'
-require_relative 'query/location_structure'
-require_relative 'query/location_structures'
-require_relative 'query/action_categories'
-require_relative 'query/action'
-require_relative 'query/actions'
-require_relative 'query/contractor_entities'
-require_relative 'query/page'
-require_relative 'query/pages'
-require_relative 'query/templates'
-require_relative 'query/register_preview_pages'
-require_relative 'query/page_delta'
-require_relative 'query/register_preset_views'
-
-require_relative 'query/file_upload_signature'
-
-require_relative 'query/page_with_forces'
-require_relative 'query/pages_workflow_commands'
+module Ecoportal
+  module API
+    class GraphQL
+      module Query
+      end
+    end
+  end
+end
+
+require_relative 'query/location_classifications'
+require_relative 'query/location_structure'
+require_relative 'query/location_structures'
+require_relative 'query/action_categories'
+require_relative 'query/action'
+require_relative 'query/actions'
+require_relative 'query/contractor_entities'
+require_relative 'query/page'
+require_relative 'query/pages'
+require_relative 'query/templates'
+require_relative 'query/register_preview_pages'
+require_relative 'query/page_delta'
+require_relative 'query/register_preset_views'
+
+require_relative 'query/file_upload_signature'
+
+require_relative 'query/page_with_forces'
+require_relative 'query/pages_workflow_commands'

data/lib/ecoportal/api/graphql.rb

@@ -13,7 +13,10 @@ module Ecoportal
       # @param org_id [String] the id of the target organization.
       #    It defaults to the environmental variable `ORGANIZATION_ID`, if defined
       # @param logger [Logger] an object with `Logger` interface to generate logs.
-      def initialize(email: nil, pass: nil, org_id: nil, host: "live.ecoportal.com")
+      # @param api_key [String] optional `X-ECOPORTAL-API-KEY`, required only for the v2 REST
+      #    endpoints `FileUpload::Client` calls to register/poll an uploaded file — the GraphQL
+      #    endpoint itself always authenticates via the email/pass OAuth bearer token.
+      def initialize(email: nil, pass: nil, org_id: nil, host: "live.ecoportal.com", api_key: nil)
         kargs = {
           email:     email,
           pass:      pass,
@@ -24,10 +27,11 @@ module Ecoportal
 
         @client = client_class.new(**kargs)
         @client.http_client = Ecoportal::API::Common::GraphQL::HttpClient.new(
-          email:  email,
-          pass:   pass,
-          org_id: org_id,
-          host:   host
+          email:   email,
+          pass:    pass,
+          org_id:  org_id,
+          host:    host,
+          api_key: api_key
         )
         @fragments = Ecoportal::API::GraphQL::Fragment.new(client)
       end

data/lib/ecoportal/api/graphql_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GRAPQL_VERSION = '1.3.13'.freeze
+    GRAPQL_VERSION = '1.3.16'.freeze
   end
 end