featureparity 0.0.23 → 0.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fd282368d3fb2417adaf990518352726bc46fe816d70e73ec04f57e2a5ea067
-  data.tar.gz: 7edf6bda3e44e4b8cce99efbe59d1adff0cbfe9ab2b8c24613a4b0eaf456cb7f
+  metadata.gz: 4e68b70dce16d28e928ead4413623002ccda97f4508f62bbe6d980c8bb29a21c
+  data.tar.gz: e630a9bd6f49db70c343f6374cd3c049a9c9fb4b786251dd313b76a177e0a1f9
 SHA512:
-  metadata.gz: 83b7560fa29083b77581005c176b3c01f9a2d60201616cbb97dc8b60ede719f8029b4a02b7d5012310a3a57ef6cd642bd21af32344c5e42c8c300ecb76617356
-  data.tar.gz: 1d2b3bf3e6500b1bed84696588225ad718f3aaa9016ffbeffc410226c631c8e55fb48cdafa30446f41814ac2869eb166b98e10fbb21d00b7fb8c2a4d73731802
+  metadata.gz: 55bde2507b4cfccbe49b8d799d0b3e7efba22c0298450e823a3ac86299ec4d392b0e51f13c3c643a2abc1d60f1d68d091074420c0928fbbcf9da6947fea296d1
+  data.tar.gz: c5d9754313a59721bfc78f5d4e65d4924ef1f5120659037cace19e6ee816a96dea0e467f47ad285cf03003ba37ed836501754c5592f9b22385f5a52315be5cae

data/lib/fp/client.rb

@@ -108,16 +108,17 @@ module Fp
     end
 
     # POST /projects/:id/showroom/media/presign
-    def presign_showroom_media(project_id, filename:, content_type:, size_bytes:, surface_id: nil)
+    def presign_showroom_media(project_id, filename:, content_type:, size_bytes:, surface_id: nil, purpose: nil)
       body = { filename: filename, content_type: content_type, size_bytes: size_bytes }
       body[:surface_id] = surface_id if surface_id
+      body[:purpose] = purpose if purpose
       post("/api/projects/#{project_id}/showroom/media/presign", body)
     end
 
     # POST /projects/:id/showroom/media
     # Confirm an upload and create the media record.
     def create_showroom_media(project_id, media_id:, s3_key:, filename:, content_type:, size_bytes:,
-                              surface_id: nil, caption: nil, position: nil)
+                              surface_id: nil, caption: nil, position: nil, purpose: nil)
       body = {
         media_id: media_id,
         s3_key: s3_key,
@@ -128,6 +129,7 @@ module Fp
       body[:surface_id] = surface_id if surface_id
       body[:caption] = caption if caption
       body[:position] = position if position
+      body[:purpose] = purpose if purpose
       post("/api/projects/#{project_id}/showroom/media", body)
     end
 

data/lib/fp/commands/showroom.rb

@@ -23,6 +23,7 @@ module Fp
       help_usage 'fp showroom --project <slug>',
                  'fp showroom media --project <slug>',
                  'fp showroom media add <file> --project <slug> [--surface <key>] [--caption "..."] [--position N]',
+                 'fp showroom media add <image> --project <slug> --surface <key> --icon',
                  'fp showroom media edit <id> --project <slug> [--caption "..."] [--position N]',
                  'fp showroom media remove <id> --project <slug> [--yes]'
       help_flag :project, 'Project slug (falls back to .featureparity.yml)'
@@ -33,6 +34,7 @@ module Fp
       help_example 'fp showroom --project stowzilla'
       help_example 'fp showroom media add e2e/checkout.webm --project stowzilla --surface web --caption "Checking out"'
       help_example 'fp showroom media add overview.png --project stowzilla --position 1'
+      help_example 'fp showroom media add app-icon.png --project stowzilla --surface ios --icon'
       help_example 'fp showroom media edit <id> --project stowzilla --caption ""'
       help_example 'fp showroom media remove <id> --project stowzilla --yes'
       help_note "Prints the welcome note, the gallery, and each surface's card, then the surfaces that are NOT shown and why.\n" \

data/lib/fp/commands/showroom_media.rb

@@ -7,6 +7,7 @@ module Fp
   module Commands
     # fp showroom media [--project <slug>]                        - list the showroom's media
     # fp showroom media add <file> [--surface <key>] [--caption] [--position N]
+    # fp showroom media add <image> --surface <key> --icon         - set the surface's icon
     # fp showroom media edit <id> [--caption "..."] [--position N]
     # fp showroom media remove <id> [--yes]
     #
@@ -19,13 +20,19 @@ module Fp
     # Uploads reuse attach's flow (presign, PUT the bytes, confirm) and its visual file
     # types — images and videos only. SVG can carry script and PDFs don't render inline,
     # so both are refused before anything is sent.
+    #
+    # `--icon` (Fizzy #1499) makes the image the surface's own icon in place of the
+    # built-in platform logo: one per surface, a new one replaces the old, and removing
+    # it brings the built-in logo back.
     class ShowroomMedia < Base
       CONTENT_TYPES = Attach::CONTENT_TYPES.slice(*Attach::VISUAL_EXTENSIONS).freeze
       MAX_FILE_SIZE = Attach::MAX_FILE_SIZE
       MAX_CAPTION_LENGTH = 500
+      ICON_EXTENSIONS = %w[png jpg jpeg gif webp].freeze
+      MAX_ICON_SIZE = 5 * 1024 * 1024
 
       LIST_FLAGS = { project: :string }.freeze
-      ADD_FLAGS = { project: :string, surface: :string, caption: :string, position: :string }.freeze
+      ADD_FLAGS = { project: :string, surface: :string, caption: :string, position: :string, icon: :boolean }.freeze
       EDIT_FLAGS = { project: :string, caption: :string, position: :string }.freeze
       REMOVE_FLAGS = { project: :string, yes: :boolean }.freeze
 
@@ -83,6 +90,7 @@ module Fp
 
         # Everything that can be checked locally is checked before a byte is sent.
         file = prepare_file!(path)
+        check_icon!(file, opts) if opts[:icon]
         caption = flag_text(opts[:caption]).strip if opts.key?(:caption)
         caption = nil if caption&.empty?
         check_caption!(caption) if caption
@@ -95,11 +103,12 @@ module Fp
         require_project!(opts)
         project_id = resolve_project_id(opts[:project])
         surface = opts[:surface] ? find_surface!(project_id, opts[:surface]) : nil
+        purpose = opts[:icon] ? 'icon' : nil
 
         presign = fetch!(client.presign_showroom_media(
                            project_id,
                            filename: file[:filename], content_type: file[:content_type],
-                           size_bytes: file[:size], surface_id: surface&.dig('id')
+                           size_bytes: file[:size], surface_id: surface&.dig('id'), purpose: purpose
                          ), prefix: 'Failed to get upload URL')['presign'] || {}
 
         uploaded = client.upload_to_presigned_url(presign['upload_url'], file[:path], file[:content_type])
@@ -109,13 +118,19 @@ module Fp
                         project_id,
                         media_id: presign['media_id'], s3_key: presign['s3_key'],
                         filename: file[:filename], content_type: file[:content_type], size_bytes: file[:size],
-                        surface_id: surface&.dig('id'), caption: caption, position: position
+                        surface_id: surface&.dig('id'), caption: caption, position: position, purpose: purpose
                       ), prefix: 'Failed to confirm upload')['media'] || {}
 
         where = surface ? "surface '#{surface['key']}'" : 'the project gallery'
         output.success({ media: item, surface: surface&.dig('key'), project: opts[:project] }) do
-          puts "Added #{file[:filename]} to #{where} in project '#{opts[:project]}'."
-          print_item_detail(item)
+          if purpose
+            puts "Set #{file[:filename]} as the icon for #{where} in project '#{opts[:project]}'."
+            puts "Remove it to go back to the built-in logo: fp showroom media remove #{item['id']} " \
+                 "--project #{opts[:project]}"
+          else
+            puts "Added #{file[:filename]} to #{where} in project '#{opts[:project]}'."
+            print_item_detail(item)
+          end
         end
       end
 
@@ -239,6 +254,22 @@ module Fp
         { path: path, filename: filename, content_type: content_type, size: size }
       end
 
+      # An icon is a still picture on one surface, with nothing to caption or order.
+      def check_icon!(file, opts)
+        problem =
+          if flag_text(opts[:surface]).strip.empty? then '--icon needs --surface <key>: an icon belongs to a surface.'
+          elsif opts.key?(:caption) || opts.key?(:position) then '--icon takes no --caption or --position.'
+          elsif !ICON_EXTENSIONS.include?(File.extname(file[:filename]).delete('.').downcase)
+            'An icon must be an image (png, jpg, jpeg, gif, webp).'
+          elsif file[:size] > MAX_ICON_SIZE
+            "Icon too large: #{format_size(file[:size])} (max #{format_size(MAX_ICON_SIZE)})"
+          end
+        return unless problem
+
+        output.error(problem)
+        exit 1
+      end
+
       def check_caption!(caption)
         return if caption.length <= MAX_CAPTION_LENGTH
 
@@ -305,6 +336,7 @@ module Fp
 
       def print_item_line(item)
         position = item['position'].to_i.positive? ? "##{item['position'].to_i}" : '-'
+        position = 'icon' if item['purpose'] == 'icon'
         caption = item['caption'].to_s.strip
         line = "  #{item['id']}  #{position.ljust(3)}  #{item['media_kind'].to_s.ljust(5)}  #{item['filename']}"
         line += "  \"#{caption}\"" unless caption.empty?

data/lib/fp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fp
-  VERSION = '0.0.23'
+  VERSION = '0.0.24'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: featureparity
 version: !ruby/object:Gem::Version
-  version: 0.0.23
+  version: 0.0.24
 platform: ruby
 authors:
 - Stowzilla