ecoportal-api-graphql 1.3.9 → 1.3.11

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

@@ -1,62 +1,62 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Query
-        class LocationStructure
-          class Draft < Logic::Query
-            accepted_params :id
-            accepted_params :structureId
-            accepted_params :includeArchivedNodes, default: true
-
-            field_name :draft
-
-            class_resolver :item_class, Model::LocationStructure::Draft
-
-            private
-
-            def basic_block(&block)
-              final_block = block || default_query_block
-              proc {
-                query(
-                  id:                   :id!,
-                  structureId:          :id!,
-                  includeArchivedNodes: :boolean
-                ) {
-                  currentOrganization {
-                    locations {
-                      structure(
-                        id: :structureId
-                      ) {
-                        id
-                        name
-                        archived
-                        updatedAt
-                        draft(
-                          id: :id,
-                          &final_block
-                        )
-                      }
-                    }
-                  }
-                }
-              }
-            end
-
-            def default_query_block
-              proc {
-                spread :LocationDraft
-                structure {
-                  nodes(
-                    includeArchived: :includeArchivedNodes
-                  ) {
-                    spread :LocationNode
-                  }
-                }
-              }
-            end
-          end
-        end
-      end # Query
-    end # GraphQL
-  end # API
-end # Ecoportal
+module Ecoportal
+  module API
+    class GraphQL
+      module Query
+        class LocationStructure
+          class Draft < Logic::Query
+            accepted_params :id
+            accepted_params :structureId
+            accepted_params :includeArchivedNodes, default: true
+
+            field_name :draft
+
+            class_resolver :item_class, Model::LocationStructure::Draft
+
+            private
+
+            def basic_block(&block)
+              final_block = block || default_query_block
+              proc {
+                query(
+                  id:                   :id!,
+                  structureId:          :id!,
+                  includeArchivedNodes: :boolean
+                ) {
+                  currentOrganization {
+                    locations {
+                      structure(
+                        id: :structureId
+                      ) {
+                        id
+                        name
+                        archived
+                        updatedAt { dateTime timeZone }
+                        draft(
+                          id: :id,
+                          &final_block
+                        )
+                      }
+                    }
+                  }
+                }
+              }
+            end
+
+            def default_query_block
+              proc {
+                spread :LocationDraft
+                structure {
+                  nodes(
+                    includeArchived: :includeArchivedNodes
+                  ) {
+                    spread :LocationNode
+                  }
+                }
+              }
+            end
+          end
+        end
+      end # Query
+    end # GraphQL
+  end # API
+end # Ecoportal

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

@@ -1,61 +1,61 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Query
-        class LocationStructure < Logic::Query
-          accepted_params :id
-          accepted_params :includeArchivedNodes, default: true
-
-          field_name :structure
-
-          class_resolver :item_class, Model::LocationStructure
-
-          private
-
-          def basic_block(&block)
-            final_block = block || default_query_block
-            proc {
-              query(
-                id:                   :id!,
-                includeArchivedNodes: :boolean
-              ) {
-                currentOrganization {
-                  locations {
-                    structure(id: :id, &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
-              updatedAt
-              visitorManagementEnabled
-              nodes(
-                includeArchived: :includeArchivedNodes
-              ) {
-                spread :LocationNode
-              }
-              drafts {
-                id
-                createdAt
-                name
-                notes
-              }
-            }
-          end
-        end
-      end
-    end
-  end
-end
-
-require_relative 'location_structure/draft'
+module Ecoportal
+  module API
+    class GraphQL
+      module Query
+        class LocationStructure < Logic::Query
+          accepted_params :id
+          accepted_params :includeArchivedNodes, default: true
+
+          field_name :structure
+
+          class_resolver :item_class, Model::LocationStructure
+
+          private
+
+          def basic_block(&block)
+            final_block = block || default_query_block
+            proc {
+              query(
+                id:                   :id!,
+                includeArchivedNodes: :boolean
+              ) {
+                currentOrganization {
+                  locations {
+                    structure(id: :id, &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
+              updatedAt { dateTime timeZone }
+              visitorManagementEnabled
+              nodes(
+                includeArchived: :includeArchivedNodes
+              ) {
+                spread :LocationNode
+              }
+              drafts {
+                id
+                createdAt
+                name
+                notes
+              }
+            }
+          end
+        end
+      end
+    end
+  end
+end
+
+require_relative 'location_structure/draft'

data/lib/ecoportal/api/graphql.rb

@@ -1,138 +1,139 @@
-module Ecoportal
-  module API
-    # @attr_reader client [Common::GraphQL::Client] a client object that holds the configuration of the api connection.
-    # @attr_reader logger [Logger] the logger.
-    class GraphQL
-      include Ecoportal::API::Common::GraphQL::ClassHelpers
-
-      class_resolver :client_class, Ecoportal::API::Common::GraphQL::Client
-
-      attr_reader :client, :fragments
-
-      # Creates a `GraphQL` object to interact with the ecoPortal `GraphQL API`.
-      # @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")
-        kargs = {
-          email:     email,
-          pass:      pass,
-          host:      host,
-          org_id:    org_id,
-          no_schema: true
-        }
-
-        @client = client_class.new(**kargs)
-        @client.http_client = Ecoportal::API::Common::GraphQL::HttpClient.new(
-          email:  email,
-          pass:   pass,
-          org_id: org_id,
-          host:   host
-        )
-        @fragments = Ecoportal::API::GraphQL::Fragment.new(client)
-      end
-
-      def currentOrganizationClass
-        API::GraphQL::Model::Organization.tap do |org_class|
-          org_class.client = client
-        end
-      end
-
-      def currentOrganization
-        currentOrganizationClass
-      end
-
-      def createContractorEntity(input:, &block)
-        createContractorEntityMutation.query(input: input, &block)
-      end
-
-      def contractorEntity
-        Ecoportal::API::GraphQL::Builder::ContractorEntity.new(client)
-      end
-
-      # Gives a builder to use different options to modify a reporting structure
-      def locationStructure
-        Ecoportal::API::GraphQL::Builder::LocationStructure.new(client)
-      end
-
-      # Gives a builder to use different options to play with action
-      def action
-        Ecoportal::API::GraphQL::Builder::Action.new(client)
-      end
-
-      # Gives a builder to use different options to work with pages
-      def page
-        Ecoportal::API::GraphQL::Builder::Page.new(client)
-      end
-
-      # v2-compatible pages API — exposes get/get_new/create/update/get_body
-      # matching the interface eco-helpers scripts use against ecoportal-api-v2.
-      def pages
-        Compat::Pages.new(client)
-      end
-
-      # v2-compatible registers API — exposes search with cursor pagination.
-      def registers
-        Compat::Registers.new(client)
-      end
-
-      # Mutation builder for register CRUD + preset view management.
-      # Distinct from #registers (compat search layer).
-      #
-      # Usage:
-      #   api.register.create(input: { name: 'Safety', moduleType: 'form', filterTags: [] })
-      #   api.register.preset_view.list('REG_ID')
-      #   api.register.preset_view.create(input: { registerId: 'R', name: 'Active', fieldConfigs: [] })
-      def register
-        Ecoportal::API::GraphQL::Builder::Register.new(client)
-      end
-
-      # Kickstand workflow engine controls — start/stop/fail individual workflows
-      # or bulk-update a set. Internal back-end automation; not for customer scripts.
-      def kickstand
-        Builder::Kickstand.new(client)
-      end
-
-      # Template management — create/update/publish/unpublish templates and manage
-      # template information and related pages.
-      def template
-        Builder::Template.new(client)
-      end
-
-      # File upload orchestrator — get S3 credentials, upload to S3, register, poll.
-      # Returns a fileContainerId string usable in FileField/ImageGallery mutations.
-      #
-      # Usage:
-      #   id = api.file_upload.upload('/path/to/report.pdf')
-      #   page.components.get_by_name('Report').file_container_ids = [id]
-      #   api.pages.update(page)
-      def file_upload
-        Ecoportal::API::GraphQL::FileUpload::Client.new(self)
-      end
-
-      private
-
-      def createContractorEntityMutation
-        Ecoportal::API::GraphQL::Mutation::ContractorEntity::Create.new(client)
-      end
-    end
-  end
-end
-
-require_relative 'graphql/helpers'
-require_relative 'graphql/concerns'
-require_relative 'graphql/logic/base_model'
-require_relative 'graphql/error'
-require_relative 'graphql/interface'
-require_relative 'graphql/base'
-require_relative 'graphql/model'
-require_relative 'graphql/logic'
-require_relative 'graphql/connection'
-require_relative 'graphql/payload'
-require_relative 'graphql/input'
-require_relative 'graphql/fragment'
-require_relative 'graphql/query'
-require_relative 'graphql/mutation'
-require_relative 'graphql/builder'
-require_relative 'graphql/compat'
-require_relative 'graphql/file_upload'
+module Ecoportal
+  module API
+    # @attr_reader client [Common::GraphQL::Client] a client object that holds the configuration of the api connection.
+    # @attr_reader logger [Logger] the logger.
+    class GraphQL
+      include Ecoportal::API::Common::GraphQL::ClassHelpers
+
+      class_resolver :client_class, Ecoportal::API::Common::GraphQL::Client
+
+      attr_reader :client, :fragments
+
+      # Creates a `GraphQL` object to interact with the ecoPortal `GraphQL API`.
+      # @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")
+        kargs = {
+          email:     email,
+          pass:      pass,
+          host:      host,
+          org_id:    org_id,
+          no_schema: true
+        }
+
+        @client = client_class.new(**kargs)
+        @client.http_client = Ecoportal::API::Common::GraphQL::HttpClient.new(
+          email:  email,
+          pass:   pass,
+          org_id: org_id,
+          host:   host
+        )
+        @fragments = Ecoportal::API::GraphQL::Fragment.new(client)
+      end
+
+      def currentOrganizationClass
+        API::GraphQL::Model::Organization.tap do |org_class|
+          org_class.client = client
+        end
+      end
+
+      def currentOrganization
+        currentOrganizationClass
+      end
+
+      def createContractorEntity(input:, &block)
+        createContractorEntityMutation.query(input: input, &block)
+      end
+
+      def contractorEntity
+        Ecoportal::API::GraphQL::Builder::ContractorEntity.new(client)
+      end
+
+      # Gives a builder to use different options to modify a reporting structure
+      def locationStructure
+        Ecoportal::API::GraphQL::Builder::LocationStructure.new(client)
+      end
+
+      # Gives a builder to use different options to play with action
+      def action
+        Ecoportal::API::GraphQL::Builder::Action.new(client)
+      end
+
+      # Gives a builder to use different options to work with pages
+      def page
+        Ecoportal::API::GraphQL::Builder::Page.new(client)
+      end
+
+      # v2-compatible pages API — exposes get/get_new/create/update/get_body
+      # matching the interface eco-helpers scripts use against ecoportal-api-v2.
+      def pages
+        Compat::Pages.new(client)
+      end
+
+      # v2-compatible registers API — exposes search with cursor pagination.
+      def registers
+        Compat::Registers.new(client)
+      end
+
+      # Mutation builder for register CRUD + preset view management.
+      # Distinct from #registers (compat search layer).
+      #
+      # Usage:
+      #   api.register.create(input: { name: 'Safety', moduleType: 'form', filterTags: [] })
+      #   api.register.preset_view.list('REG_ID')
+      #   api.register.preset_view.create(input: { registerId: 'R', name: 'Active', fieldConfigs: [] })
+      def register
+        Ecoportal::API::GraphQL::Builder::Register.new(client)
+      end
+
+      # Kickstand workflow engine controls — start/stop/fail individual workflows
+      # or bulk-update a set. Internal back-end automation; not for customer scripts.
+      def kickstand
+        Builder::Kickstand.new(client)
+      end
+
+      # Template management — create/update/publish/unpublish templates and manage
+      # template information and related pages.
+      def template
+        Builder::Template.new(client)
+      end
+
+      # File upload orchestrator — get S3 credentials, upload to S3, register, poll.
+      # Returns a fileContainerId string usable in FileField/ImageGallery mutations.
+      #
+      # Usage:
+      #   id = api.file_upload.upload('/path/to/report.pdf')
+      #   page.components.get_by_name('Report').file_container_ids = [id]
+      #   api.pages.update(page)
+      def file_upload
+        Ecoportal::API::GraphQL::FileUpload::Client.new(self)
+      end
+
+      private
+
+      def createContractorEntityMutation
+        Ecoportal::API::GraphQL::Mutation::ContractorEntity::Create.new(client)
+      end
+    end
+  end
+end
+
+require_relative 'graphql/helpers'
+require_relative 'graphql/concerns'
+require_relative 'graphql/logic/base_model'
+require_relative 'graphql/error'
+require_relative 'graphql/interface'
+require_relative 'graphql/base'
+require_relative 'graphql/model'
+require_relative 'graphql/logic'
+require_relative 'graphql/connection'
+require_relative 'graphql/payload'
+require_relative 'graphql/input'
+require_relative 'graphql/fragment'
+require_relative 'graphql/query'
+require_relative 'graphql/mutation'
+require_relative 'graphql/builder'
+require_relative 'graphql/compat'
+require_relative 'graphql/file_upload'
+require_relative 'graphql/diff'

data/lib/ecoportal/api/graphql_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GRAPQL_VERSION = '1.3.9'.freeze
+    GRAPQL_VERSION = '1.3.11'.freeze
   end
 end

data/tests/dump_template_model.rb

@@ -0,0 +1,90 @@
+require_relative 'local_libs'
+require 'json'
+require 'fileutils'
+
+# Dump a TEMPLATE's GraphQL model to JSON, so a real template can be captured as the golden
+# fixture for the template-editing pipeline (build-from-scratch + diff-and-update).
+#
+# A template IS a page in this API (Query::Templates returns PageUnion nodes), so its structural
+# skeleton — stages -> sections -> components(fields) — comes from the ordinary page model, exactly
+# like tests/dump_page_model.rb. On top of that, this tool also captures the page's *workflow
+# command log* (Query::PagesWorkflowCommands) — the applied command history that drives the
+# workflow builder (callbacks / operations / strategies / recipients config).
+#
+# Two artefacts are written per template:
+#   spec/fixtures/templates/<id>[_<label>].json           -> structural page doc (golden master)
+#   spec/fixtures/templates/<id>[_<label>].commands.json  -> workflow command log (if readable)
+#
+# Usage (run where the GraphQL connection is configured, like the other tests/):
+#   ruby tests/dump_template_model.rb <TEMPLATE_ID> [--out PATH] [--label before|after]
+#
+# Reference target (see .ai-assistance/projects/template-maintenance/DESIGN.md):
+#   ruby tests/dump_template_model.rb 6a3fa5b8f89e07c758df622b --label golden
+#
+# Run --label before / --label after around an executeWorkflowCommands batch to diff exactly
+# what a command sequence changed — the same before/after workflow dump_page_model.rb enables.
+
+def parse_args(argv)
+  opts = { template_id: nil, out: nil, label: nil }
+  rest = argv.dup
+  opts[:template_id] = rest.shift
+  until rest.empty?
+    flag = rest.shift
+    case flag
+    when '--out'   then opts[:out]   = rest.shift
+    when '--label' then opts[:label] = rest.shift
+    else
+      warn "Unknown argument: #{flag}"
+    end
+  end
+  opts
+end
+
+opts = parse_args(ARGV)
+
+unless opts[:template_id]
+  warn 'Usage: ruby tests/dump_template_model.rb <TEMPLATE_ID> [--out PATH] [--label before|after]'
+  exit 1
+end
+
+default_dir  = File.expand_path('../spec/fixtures/templates', __dir__)
+default_name = [opts[:template_id], opts[:label]].compact.join('_')
+struct_path  = opts[:out] || File.join(default_dir, "#{default_name}.json")
+commands_path = File.join(File.dirname(struct_path), "#{File.basename(struct_path, '.json')}.commands.json")
+
+api = Ecoportal::API::GraphQL.new
+
+# 1) Structural skeleton — a template is a page, so fetch it via the page model.
+page = api.pages.get(opts[:template_id])
+
+if page.nil?
+  warn "Could not fetch template '#{opts[:template_id]}' as a page"
+  exit 2
+end
+
+doc = page.respond_to?(:doc) ? page.doc : page.instance_variable_get(:@page)&.doc
+
+FileUtils.mkdir_p(File.dirname(struct_path))
+File.write(struct_path, JSON.pretty_generate(doc))
+
+puts "Dumped template structure '#{opts[:template_id]}' -> #{struct_path}"
+puts "  name:     #{page.respond_to?(:name) ? page.name : '(n/a)'}"
+puts "  patchVer: #{page.respond_to?(:patchVer) ? page.patchVer : '(n/a)'}"
+
+# 2) Workflow command log — the applied-command history behind the workflow builder.
+#    Wrapped in a rescue: the PagesWorkflow read model is still partial (stages is a bare
+#    passarray as of SCHEMA_VERSION 20260605), so treat this as best-effort.
+begin
+  query = Ecoportal::API::GraphQL::Query::PagesWorkflowCommands.new(api.client)
+  commands = []
+  query.each(id: opts[:template_id], first: 100) do |cmd|
+    commands << (cmd.respond_to?(:doc) ? cmd.doc : cmd)
+  end
+  File.write(commands_path, JSON.pretty_generate(commands))
+  puts "Dumped #{commands.size} workflow command(s) -> #{commands_path}"
+rescue StandardError => e
+  warn "Workflow command log not captured (#{e.class}: #{e.message})"
+  warn '  -> structural fixture is still valid; the command log read may be WIP for this org.'
+end
+
+puts 'Tip: capture --label before and --label after an executeWorkflowCommands batch, then diff the JSON.'