ecoportal-api-graphql 2.0.0 → 3.0.0

data/lib/ecoportal/api/graphql/mutation/file_container/upload.rb

@@ -31,16 +31,23 @@ module Ecoportal
             # @param other_tags [Array<String>, nil] tags — the only supported way to tag a
             #   container (there is no separate tag mutation; confirmed 2026-07-30).
             # @param container_id [String, nil] add a new VERSION to an existing container.
-            def query(filename:, filetype:, filesize:, url:, location_ids: nil, other_tags: nil, container_id: nil, **kargs, &block)
+            # @param client_mutation_id [String, nil] optional correlation/tracing id --
+            #   `UploadInput`'s own `clientMutationId` (confirmed in this file's own header,
+            #   `UploadInput { clientMutationId filename filetype filesize locationIds
+            #   otherTags url containerId }`). Omitted entirely when not given, so every
+            #   existing caller's input shape is byte-identical to before.
+            def query(filename:, filetype:, filesize:, url:, location_ids: nil, other_tags: nil,
+                      container_id: nil, client_mutation_id: nil, **kargs, &block)
               input = {
                 filename: filename,
                 filetype: filetype,
                 filesize: filesize.to_s,
                 url:      url
               }
-              input[:locationIds] = Array(location_ids) if location_ids
-              input[:otherTags]   = Array(other_tags)   if other_tags
-              input[:containerId] = container_id        if container_id
+              input[:locationIds]      = Array(location_ids) if location_ids
+              input[:otherTags]        = Array(other_tags)   if other_tags
+              input[:containerId]      = container_id        if container_id
+              input[:clientMutationId] = client_mutation_id  unless client_mutation_id.nil?
 
               super(input: input, **kargs, &block)
             end

data/lib/ecoportal/api/graphql/mutation/image/upload.rb

@@ -0,0 +1,88 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Mutation
+        module Image
+          # Registers an object already uploaded to S3 as a `TempImage` -- the upload-staging
+          # model behind Image Gallery (and other, non-gallery) image uploads.
+          #
+          # ★ Sibling to `Mutation::FileContainer::Upload`, NOT a variant of it: an Image
+          # Gallery image is explicitly NOT a `FileContainer`. Verified against the live
+          # ecoPortal server source (read-only, /tmp/work/ecoPortal):
+          #   * `app/graphql/mutations/images/upload.rb:1-23` -- the mutation builds an
+          #     `Enzyme::ImageReference::TempImage`, not `uploadFile`/`FileContainer`.
+          #   * `app/graphql/types/mutation_type.rb:224` -- schema field `uploadImage`
+          #     (`field :upload_image, mutation: Mutations::Images::Upload`).
+          #   * `app/graphql/types/enums/files/image_upload_type_enum.rb` -- `type:` is a
+          #     live enum (`image_gallery`, `policy_group`, `theme`, `user`, `organization`,
+          #     `brand`); `"image_gallery"` is the one `Base::Page::DataField::ImageGallery`
+          #     consumes.
+          #
+          # The SIGNATURE and S3-POST steps upstream of this call are IDENTICAL to the
+          # `uploadFile` flow (same `fileUploadSignature`, same multipart POST) -- see
+          # `FileUpload::Client#upload_image`, which shares its presign+store step with
+          # `#upload` and only diverges here, at registration.
+          #
+          # Verified against the live schema:
+          #   uploadImage(input: ImagesUploadInput!) -> ImagesUploadPayload
+          #     { clientMutationId errors item: TempImage }
+          #   ImagesUploadInput { clientMutationId key type id import }
+          class Upload < Logic::Mutation
+            field_name :uploadImage
+
+            class_resolver :payload_class, 'Ecoportal::API::GraphQL::Payload::ImagesUpload'
+
+            # @param key [String] the S3 object key produced by the S3 POST step.
+            # @param type [String, Symbol] live enum value -- `FileUpload::Client` always
+            #   passes `'image_gallery'` today; any other value is sent verbatim for a future
+            #   caller.
+            # @param id [String, nil] a target id the image is being uploaded FOR, in
+            #   contexts that need one (e.g. an existing brand/policy_group/user). Unused by
+            #   the Image Gallery context -- that attach happens later, via `updatePage`, not
+            #   here.
+            # @param import [Boolean] matches the live schema's own default (`true`).
+            # @param client_mutation_id [String, nil] optional correlation/tracing id --
+            #   `ImagesUploadInput`'s own `clientMutationId` (confirmed in this file's own
+            #   header, `ImagesUploadInput { clientMutationId key type id import }`). Omitted
+            #   entirely when not given, so every existing caller's input shape is
+            #   byte-identical to before.
+            def query(key:, type:, id: nil, import: true, client_mutation_id: nil, **kargs, &block)
+              super(input: build_input(key: key, type: type, id: id, import: import,
+                                       client_mutation_id: client_mutation_id), **kargs, &block)
+            end
+
+            private
+
+            def build_input(key:, type:, id:, import:, client_mutation_id: nil)
+              input = {key: key, type: type.to_s, import: import}
+              input[:id] = id if id
+              input[:clientMutationId] = client_mutation_id unless client_mutation_id.nil?
+              input
+            end
+
+            def basic_block(&block)
+              payload_block = block || default_payload_block
+              proc {
+                mutation(input: :ImagesUploadInput!) {
+                  uploadImage(input: :input, &payload_block)
+                }
+              }
+            end
+
+            def default_payload_block
+              proc {
+                errors { details fullMessages }
+                item {
+                  id
+                  s3Key
+                  complete
+                  error
+                }
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Mutation
+        # Namespaced `Image` (matches the schema's own `TempImageType`/`ImagesUploadInput`
+        # naming) -- sibling to `Mutation::FileContainer`, NOT a variant of it.
+        module Image
+        end
+      end
+    end
+  end
+end
+
+require_relative 'image/upload'

data/lib/ecoportal/api/graphql/mutation/location_structure/apply_commands.rb

@@ -1,54 +1,54 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Mutation
-        module LocationStructure
-          class ApplyCommands < Logic::Mutation
-            field_name :applyCommandsToLocationStructure
-            class_resolver :payload_class, Payload::LocationStructure::ApplyCommands
-            class_resolver :input_class, Input::LocationStructure::ApplyCommands
-
-            private
-
-            def basic_block(&block)
-              payload_block = block || default_payload_block
-              proc {
-                mutation(input: :ApplyCommandsToLocationStructureInput!) {
-                  applyCommandsToLocationStructure(
-                    input: :input,
-                    &payload_block
-                  )
-                }
-              }
-            end
-
-            def default_payload_block
-              proc {
-                clientMutationId
-                error {
-                  spread :LocationsError
-                }
-                results {
-                  ok
-                  command {
-                    id
-                    state
-                    __typename
-                  }
-                  error {
-                    spread :LocationsError
-                  }
-                }
-                structure {
-                  nodes(includeArchived: true) {
-                    spread :LocationNode
-                  }
-                }
-              }
-            end
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Mutation
+        module LocationStructure
+          class ApplyCommands < Logic::Mutation
+            field_name :applyCommandsToLocationStructure
+            class_resolver :payload_class, Payload::LocationStructure::ApplyCommands
+            class_resolver :input_class, Input::LocationStructure::ApplyCommands
+
+            private
+
+            def basic_block(&block)
+              payload_block = block || default_payload_block
+              proc {
+                mutation(input: :ApplyCommandsToLocationStructureInput!) {
+                  applyCommandsToLocationStructure(
+                    input: :input,
+                    &payload_block
+                  )
+                }
+              }
+            end
+
+            def default_payload_block
+              proc {
+                clientMutationId
+                error {
+                  spread :LocationsError
+                }
+                results {
+                  ok
+                  command {
+                    id
+                    state
+                    __typename
+                  }
+                  error {
+                    spread :LocationsError
+                  }
+                }
+                structure {
+                  nodes(includeArchived: true) {
+                    spread :LocationNode
+                  }
+                }
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/mutation/location_structure/draft/add_commands.rb

@@ -1,55 +1,55 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Mutation
-        module LocationStructure
-          module Draft
-            class AddCommands < Logic::Mutation
-              field_name :addCommandsToLocationDraft
-
-              class_resolver :payload_class, Payload::LocationStructure::Draft::AddCommands
-              class_resolver :input_class, Input::LocationStructure::Draft::AddCommands
-
-              private
-
-              def basic_block(&block)
-                payload_block = block || default_payload_block
-                proc {
-                  mutation(
-                    input: :AddCommandsToLocationDraftInput!
-                  ) {
-                    addCommandsToLocationDraft(
-                      input: :input,
-                      &payload_block
-                    )
-                  }
-                }
-              end
-
-              def default_payload_block
-                proc {
-                  clientMutationId
-                  draft {
-                    spread :LocationDraft
-                    structure {
-                      nodes(
-                        includeArchived: true
-                      ) {
-                        spread :LocationNode
-                      }
-                    }
-                  }
-                  ok
-                  errors {
-                    details
-                    fullMessages
-                  }
-                }
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Mutation
+        module LocationStructure
+          module Draft
+            class AddCommands < Logic::Mutation
+              field_name :addCommandsToLocationDraft
+
+              class_resolver :payload_class, Payload::LocationStructure::Draft::AddCommands
+              class_resolver :input_class, Input::LocationStructure::Draft::AddCommands
+
+              private
+
+              def basic_block(&block)
+                payload_block = block || default_payload_block
+                proc {
+                  mutation(
+                    input: :AddCommandsToLocationDraftInput!
+                  ) {
+                    addCommandsToLocationDraft(
+                      input: :input,
+                      &payload_block
+                    )
+                  }
+                }
+              end
+
+              def default_payload_block
+                proc {
+                  clientMutationId
+                  draft {
+                    spread :LocationDraft
+                    structure {
+                      nodes(
+                        includeArchived: true
+                      ) {
+                        spread :LocationNode
+                      }
+                    }
+                  }
+                  ok
+                  errors {
+                    details
+                    fullMessages
+                  }
+                }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/mutation/location_structure/draft/create.rb

@@ -1,54 +1,54 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Mutation
-        module LocationStructure
-          module Draft
-            class Create < Logic::Mutation
-              field_name :createLocationDraft
-
-              class_resolver :payload_class, Payload::LocationStructure::Draft::Create
-              class_resolver :input_class, Input::LocationStructure::Draft::Create
-
-              private
-
-              def basic_block(&block)
-                payload_block = block || default_payload_block
-                proc {
-                  mutation(
-                    input: :CreateLocationDraftInput!
-                  ) {
-                    createLocationDraft(
-                      input: :input,
-                      &payload_block
-                    )
-                  }
-                }
-              end
-
-              def default_payload_block
-                proc {
-                  clientMutationId
-                  draft {
-                    spread :LocationDraft
-                    structure {
-                      nodes(
-                        includeArchived: true
-                      ) {
-                        spread :LocationNode
-                      }
-                    }
-                  }
-                  errors {
-                    details
-                    fullMessages
-                  }
-                }
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Mutation
+        module LocationStructure
+          module Draft
+            class Create < Logic::Mutation
+              field_name :createLocationDraft
+
+              class_resolver :payload_class, Payload::LocationStructure::Draft::Create
+              class_resolver :input_class, Input::LocationStructure::Draft::Create
+
+              private
+
+              def basic_block(&block)
+                payload_block = block || default_payload_block
+                proc {
+                  mutation(
+                    input: :CreateLocationDraftInput!
+                  ) {
+                    createLocationDraft(
+                      input: :input,
+                      &payload_block
+                    )
+                  }
+                }
+              end
+
+              def default_payload_block
+                proc {
+                  clientMutationId
+                  draft {
+                    spread :LocationDraft
+                    structure {
+                      nodes(
+                        includeArchived: true
+                      ) {
+                        spread :LocationNode
+                      }
+                    }
+                  }
+                  errors {
+                    details
+                    fullMessages
+                  }
+                }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/mutation/location_structure/draft/delete.rb

@@ -1,43 +1,43 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Mutation
-        module LocationStructure
-          module Draft
-            class Delete < Logic::Mutation
-              field_name :deleteLocationDraft
-
-              class_resolver :payload_class, Payload::LocationStructure::Draft::Delete
-              class_resolver :input_class, Input::LocationStructure::Draft::Delete
-
-              private
-
-              def basic_block(&block)
-                payload_block = block || default_payload_block
-                proc {
-                  mutation(input: :DeleteLocationDraftInput!) {
-                    deleteLocationDraft(
-                      input: :input,
-                      &payload_block
-                    )
-                  }
-                }
-              end
-
-              def default_payload_block
-                proc {
-                  clientMutationId
-                  ok
-                  errors {
-                    details
-                    fullMessages
-                  }
-                }
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Mutation
+        module LocationStructure
+          module Draft
+            class Delete < Logic::Mutation
+              field_name :deleteLocationDraft
+
+              class_resolver :payload_class, Payload::LocationStructure::Draft::Delete
+              class_resolver :input_class, Input::LocationStructure::Draft::Delete
+
+              private
+
+              def basic_block(&block)
+                payload_block = block || default_payload_block
+                proc {
+                  mutation(input: :DeleteLocationDraftInput!) {
+                    deleteLocationDraft(
+                      input: :input,
+                      &payload_block
+                    )
+                  }
+                }
+              end
+
+              def default_payload_block
+                proc {
+                  clientMutationId
+                  ok
+                  errors {
+                    details
+                    fullMessages
+                  }
+                }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/mutation/location_structure/draft/drop_bad_commands.rb

@@ -1,56 +1,56 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Mutation
-        module LocationStructure
-          class DropBadCommands < Logic::Mutation
-            field_name :dropBadCommandsFromLocationDraft
-
-            class_resolver :payload_class, Payload::LocationStructure::Draft::DropBadCommands
-            class_resolver :input_class, Input::LocationStructure::Draft::DropBadCommands
-
-            private
-
-            def basic_block(&block)
-              payload_block = block || default_payload_block
-              proc {
-                mutation(
-                  input: :DropBadCommandsFromLocationDraftInput!
-                ) {
-                  dropBadCommandsFromLocationDraft(
-                    input: :input,
-                    &payload_block
-                  )
-                }
-              }
-            end
-
-            def default_payload_block
-              proc {
-                clientMutationId
-                draft {
-                  spread :LocationDraft
-                  structure {
-                    nodes(
-                      includeArchived: true
-                    ) {
-                      spread :LocationNode
-                    }
-                  }
-                }
-                ok
-                error {
-                  spread :LocationsError
-                }
-                errors {
-                  details
-                  fullMessages
-                }
-              }
-            end
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Mutation
+        module LocationStructure
+          class DropBadCommands < Logic::Mutation
+            field_name :dropBadCommandsFromLocationDraft
+
+            class_resolver :payload_class, Payload::LocationStructure::Draft::DropBadCommands
+            class_resolver :input_class, Input::LocationStructure::Draft::DropBadCommands
+
+            private
+
+            def basic_block(&block)
+              payload_block = block || default_payload_block
+              proc {
+                mutation(
+                  input: :DropBadCommandsFromLocationDraftInput!
+                ) {
+                  dropBadCommandsFromLocationDraft(
+                    input: :input,
+                    &payload_block
+                  )
+                }
+              }
+            end
+
+            def default_payload_block
+              proc {
+                clientMutationId
+                draft {
+                  spread :LocationDraft
+                  structure {
+                    nodes(
+                      includeArchived: true
+                    ) {
+                      spread :LocationNode
+                    }
+                  }
+                }
+                ok
+                error {
+                  spread :LocationsError
+                }
+                errors {
+                  details
+                  fullMessages
+                }
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end