@shopify/cli-kit 3.45.1 → 3.46.0-pre.1

package/assets/cli-ruby/lib/project_types/extension/forms/create.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Forms
-    class Create < ShopifyCLI::Form
-      flag_arguments :name, :type, :api_key, :template
-
-      attr_reader :app
-
-      class ExtensionProjectDetails
-        include SmartProperties
-
-        property :app, accepts: Models::App
-        property :name, accepts: String
-        property :type, accepts: Models::SpecificationHandlers::Default
-        property :template, accepts: String
-
-        def complete?
-          !!(app && name && type)
-        end
-      end
-
-      def ask
-        ShopifyCLI::Result.wrap(ExtensionProjectDetails.new)
-          .then(&Questions::AskApp.new(ctx: ctx, api_key: api_key))
-          .then(&Questions::AskType.new(ctx: ctx, type: type))
-          .then(&Questions::AskTemplate.new(ctx: ctx, template: template))
-          .then(&Questions::AskName.new(ctx: ctx, name: name))
-          .unwrap { |e| raise e }
-          .tap do |project_details|
-            ctx.abort(ctx.message("create.incomplete_configuration")) unless project_details.complete?
-
-            self.app = project_details.app
-            self.type = project_details.type
-            self.template = project_details.template
-            self.name = project_details.name
-          end
-      end
-
-      def directory_name
-        name.strip.gsub(/( )/, "_").downcase
-      end
-
-      private
-
-      attr_writer :app
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/forms/questions/ask_app.rb

@@ -1,53 +0,0 @@
-module Extension
-  module Forms
-    module Questions
-      class AskApp
-        include ShopifyCLI::MethodObject
-
-        property! :ctx
-        property :api_key
-        property! :prompt,
-          converts: :to_proc,
-          default: -> { CLI::UI::Prompt.method(:ask) }
-
-        def call(project_details)
-          project_details.tap(&method(:prompt_for_app))
-        end
-
-        private
-
-        def prompt_for_app(project_details)
-          project_details.app =
-            api_key.nil? ? choose_interactively(load_apps) : validate_app_ownership(api_key)
-        end
-
-        def validate_app_ownership(api_key)
-          found_app = Tasks::GetApp.call(context: ctx, api_key: api_key)
-          ctx.abort(ctx.message("create.invalid_api_key", api_key)) if found_app.nil?
-          found_app
-        end
-
-        def choose_interactively(apps)
-          prompt.call(ctx.message("create.ask_app")) do |handler|
-            apps.each do |app|
-              handler.option("#{app.title} by #{app.business_name}") { app }
-            end
-          end
-        end
-
-        def load_apps
-          ctx.puts(@ctx.message("create.loading_apps"))
-          apps = Tasks::GetApps.call(context: ctx)
-
-          apps.empty? ? abort_no_apps : apps
-        end
-
-        def abort_no_apps
-          ctx.puts(@ctx.message("create.no_apps"))
-          ctx.puts(@ctx.message("create.learn_about_apps"))
-          raise ShopifyCLI::AbortSilent
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/forms/questions/ask_name.rb

@@ -1,48 +0,0 @@
-module Extension
-  module Forms
-    module Questions
-      class AskName
-        include ShopifyCLI::MethodObject
-
-        property! :ctx
-        property :name
-        property :prompt,
-          accepts: ->(prompt) { prompt.respond_to?(:call) },
-          default: -> { CLI::UI::Prompt.method(:ask) }
-
-        def call(project_details)
-          if theme_app_extension?(project_details)
-            project_details.name = name || "theme-app-extension"
-          else
-            project_details.name = ask_with_reprompt(
-              initial_value: name,
-              break_condition: -> (current_name) { Models::Registration.valid_title?(current_name) },
-              prompt_message: ctx.message("create.ask_name"),
-              reprompt_message: ctx.message("create.invalid_name", Models::Registration::MAX_TITLE_LENGTH)
-            )
-          end
-          project_details
-        end
-
-        private
-
-        def theme_app_extension?(project_details)
-          project_details&.type&.identifier == "THEME_APP_EXTENSION"
-        end
-
-        def ask_with_reprompt(initial_value:, break_condition:, prompt_message:, reprompt_message:)
-          value = initial_value
-          reprompt = false
-
-          until break_condition.call(value)
-            ctx.puts(reprompt_message) if reprompt
-            value = prompt.call(prompt_message)&.strip
-            reprompt = true
-          end
-
-          value
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/forms/questions/ask_registration.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Forms
-    module Questions
-      class AskRegistration
-        include ShopifyCLI::MethodObject
-
-        property! :ctx
-        property! :type
-        property! :prompt,
-          converts: :to_proc,
-          default: -> { CLI::UI::Prompt.method(:ask) }
-
-        def call(project_details)
-          project_details.tap(&method(:prompt_for_registration))
-        end
-
-        private
-
-        def prompt_for_registration(project_details)
-          apps_and_registrations = load_registrations(type)
-          app, registration = choose_interactively(apps_and_registrations)
-          project_details.app = app
-          project_details.registration = registration
-        end
-
-        def choose_interactively(apps_and_registrations)
-          prompt.call(ctx.message("connect.ask_registration")) do |handler|
-            apps_and_registrations.each do |(app, extension)|
-              handler.option("#{app.title} by #{app.business_name}: #{extension.title}") { [app, extension] }
-            end
-          end
-        end
-
-        def load_registrations(type)
-          registrations = []
-          loading_extensions = @ctx.message("connect.loading_extensions")
-
-          CLI::UI::Spinner.spin(loading_extensions) do |_spinner|
-            registrations += Tasks::GetExtensions.call(context: ctx, type: type)
-          end
-
-          registrations.empty? ? abort_no_registrations : registrations
-        end
-
-        def abort_no_registrations
-          ctx.puts(@ctx.message("connect.no_extensions", type))
-          ctx.puts(@ctx.message("connect.learn_about_extensions"))
-          raise ShopifyCLI::AbortSilent
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/forms/questions/ask_template.rb

@@ -1,37 +0,0 @@
-module Extension
-  module Forms
-    module Questions
-      class AskTemplate
-        include ShopifyCLI::MethodObject
-
-        property! :ctx
-        property :template, accepts: Models::ServerConfig::Development::VALID_TEMPLATES
-        property :prompt,
-          accepts: ->(prompt) { prompt.respond_to?(:call) },
-          default: -> { CLI::UI::Prompt.method(:ask) }
-
-        def call(project_details)
-          if template_required?(project_details)
-            project_details.template = template || choose_interactively(project_details)
-          end
-          project_details
-        end
-
-        private
-
-        def template_required?(project_details)
-          type = project_details&.type&.identifier
-          Models::DevelopmentServerRequirements.supported?(type)
-        end
-
-        def choose_interactively(project_details)
-          prompt.call(ctx.message("create.ask_template")) do |handler|
-            Models::ServerConfig::Development.find(project_details&.type&.identifier).each do |template|
-              handler.option(template) { template }
-            end
-          end
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/forms/questions/ask_type.rb

@@ -1,47 +0,0 @@
-module Extension
-  module Forms
-    module Questions
-      class AskType
-        include ShopifyCLI::MethodObject
-
-        property! :ctx
-        property :type
-        property :prompt,
-          converts: :to_proc,
-          default: -> { CLI::UI::Prompt.method(:ask) }
-
-        def call(project_details)
-          specifications = Models::Specifications.new(
-            fetch_specifications: Tasks::FetchSpecifications.new(context: ctx, api_key: project_details.app.api_key)
-          )
-
-          project_details.tap do |p|
-            p.type = type.nil? ? choose_type(specifications) : validate_given_type(specifications, type)
-          end
-        end
-
-        private
-
-        def validate_given_type(specifications, type)
-          return specifications[type] if specifications.valid?(type)
-          ctx.abort(ctx.message("create.invalid_type")) unless type.nil?
-        end
-
-        def choose_type(specifications)
-          abort_due_to_missing_specifications if specifications.none?
-
-          prompt.call(ctx.message("create.ask_type")) do |handler|
-            specifications.each do |type|
-              handler.option("#{type.name} #{type.tagline}") { type }
-            end
-          end
-        end
-
-        def abort_due_to_missing_specifications
-          ctx.puts(@ctx.message("create.no_available_extensions"))
-          raise ShopifyCLI::AbortSilent
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/models/development_server.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Models
-    class DevelopmentServer
-      class DevelopmentServerError < StandardError; end
-
-      include SmartProperties
-
-      EXECUTABLE_DIRECTORY = File.join(ShopifyCLI::ROOT, "ext", "shopify-extensions")
-
-      property :executable, converts: :to_s
-
-      def executable
-        super || begin
-          case RbConfig::CONFIG.fetch("host_os")
-          when /(linux)|(darwin)/
-            File.join(EXECUTABLE_DIRECTORY, "shopify-extensions")
-          else
-            File.join(EXECUTABLE_DIRECTORY, "shopify-extensions.exe")
-          end
-        end
-      end
-
-      def executable_installed?
-        File.exist?(executable)
-      end
-
-      def create(server_config)
-        output, _ = CLI::Kit::System.capture2e(executable, "create", "-", stdin_data: server_config.to_yaml)
-        output
-      rescue StandardError => error
-        raise error
-      end
-
-      def build(server_config)
-        output, error, status = CLI::Kit::System.capture3(executable, "build", "-", stdin_data: server_config.to_yaml)
-        return output if status.success?
-        raise DevelopmentServerError, error
-      end
-
-      def serve(context, server_config)
-        CLI::Kit::System.popen3(executable, "serve", "-") do |input, out, err, status|
-          context.debug("Sending configuration data to extension development server …")
-          input << server_config.to_yaml
-          input.close
-
-          forward_output_to_user(out, err, context)
-
-          status.value
-        end
-      end
-
-      def version
-        raise NotImplementedError
-      end
-
-      private
-
-      def forward_output_to_user(out, err, ctx)
-        ctx.debug("Starting message processing threads to relay output produced by the extension development server …")
-
-        Thread.new do
-          while (line = out.gets)
-            ctx.puts(line)
-          end
-        end
-
-        Thread.new do
-          while (error = err.gets)
-            ctx.puts(error)
-          end
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/models/development_server_requirements.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require "shopify_cli"
-
-module Extension
-  module Models
-    class DevelopmentServerRequirements
-      SUPPORTED_EXTENSION_TYPES = [
-        "checkout_ui_extension",
-        "checkout_post_purchase",
-        "product_subscription",
-        "web_pixel_extension",
-        "pos_ui_extension",
-      ]
-
-      class << self
-        def supported?(type)
-          if type_supported?(type) && beta_enabled?
-            return true if binary_installed?
-            warn_about_missing_binary
-          end
-
-          false
-        end
-
-        def beta_enabled?
-          ShopifyCLI::Feature.enabled?(:extension_server_beta)
-        end
-
-        def type_supported?(type)
-          SUPPORTED_EXTENSION_TYPES.include?(type.downcase)
-        end
-
-        private
-
-        def binary_installed?
-          Models::DevelopmentServer.new.executable_installed?
-        end
-
-        def warn_about_missing_binary
-          CLI::UI::Frame.open(message("errors.development_server_binary_not_found.title"), color: :yellow) do
-            context.puts(message("errors.development_server_binary_not_found.message"))
-          end
-        end
-
-        def message(key)
-          context.message(key)
-        end
-
-        def context
-          @context ||= ShopifyCLI::Context.new
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/models/npm_package.rb

@@ -1,44 +0,0 @@
-require "semantic/semantic"
-
-module Extension
-  module Models
-    class NpmPackage
-      include SmartProperties
-      include Comparable
-
-      property :name
-      property :version
-      property :scripts, accepts: Hash, default: -> { {} }
-      property :dependencies, accepts: Hash, default: -> { {} }
-      property :dev_dependencies, accepts: Hash, default: -> { {} }
-
-      def initialize(**config)
-        super(**config.select { |property_name, _| self.class.properties.key?(property_name) })
-      end
-
-      def self.parse(io)
-        ShopifyCLI::Result.call { JSON.parse(io.read) }
-          .then(&ShopifyCLI::TransformDataStructure.new(underscore_keys: true, symbolize_keys: true, shallow: true))
-          .then { |specification| new(**specification) }
-          .unwrap { |error| raise "Failed to parse NPM package specification: #{error}" }
-      end
-
-      def <=>(other)
-        return nil unless name == other.name
-        Semantic::Version.new(version) <=> Semantic::Version.new(other.version)
-      end
-
-      def script?(name)
-        scripts.key?(name)
-      end
-
-      def dependency?(name)
-        dependencies.key?(name)
-      end
-
-      def dev_dependency?(name)
-        dev_dependencies.key?(name)
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/models/product.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Models
-    class Product
-      include SmartProperties
-
-      property :variant_id, accepts: Integer, converts: :to_i
-      property :quantity, accepts: Integer, default: 1
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/models/registration.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Models
-    class Registration
-      MAX_TITLE_LENGTH = 50
-      include SmartProperties
-
-      property! :id, accepts: Integer
-      property! :uuid, accepts: String
-      property! :type, accepts: String
-      property! :title, accepts: String
-      property! :draft_version, accepts: Extension::Models::Version
-
-      def self.valid_title?(title)
-        !title.nil? && !title.strip.empty? && title.length <= MAX_TITLE_LENGTH
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/models/server_config/app.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Models
-    module ServerConfig
-      class App < Base
-        include SmartProperties
-
-        property! :api_key, accepts: String
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/models/server_config/base.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Models
-    module ServerConfig
-      class Base
-        def to_h
-          to_hash
-        end
-
-        def to_hash
-          is_hashable = ->(obj) { obj.respond_to?(:to_hash) }
-          is_collection_of_hashables = ->(obj) { obj.is_a?(Enumerable) && obj.all?(&is_hashable) }
-
-          self.class.properties.each.reduce({}) do |data, (_, property)|
-            data.merge(property.name.to_s => send(property.reader).yield_self do |value|
-              case value
-              when is_collection_of_hashables
-                value.map { |element| element.to_hash.transform_keys(&:to_s) }
-              when is_hashable
-                value.to_hash.transform_keys(&:to_s)
-              else
-                value
-              end
-            end)
-          end
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/models/server_config/capabilities.rb

@@ -1,11 +0,0 @@
-module Extension
-  module Models
-    module ServerConfig
-      class Capabilities < Base
-        include SmartProperties
-
-        property :network_access, accepts: [true, false], default: false
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/models/server_config/development.rb

@@ -1,33 +0,0 @@
-module Extension
-  module Models
-    module ServerConfig
-      class Development < Base
-        include SmartProperties
-        VALID_TEMPLATES = [
-          "javascript",
-          "javascript-react",
-          "typescript",
-          "typescript-react",
-        ]
-
-        CURRENT_DIRECTORY = "."
-
-        property  :root_dir, accepts: String, default: CURRENT_DIRECTORY
-        property! :build_dir, accepts: String, default: "build"
-        property  :template, accepts: VALID_TEMPLATES
-        property  :renderer, accepts: ServerConfig::DevelopmentRenderer
-        property  :entries, accepts: ServerConfig::DevelopmentEntries
-        property  :resource, accepts: ServerConfig::DevelopmentResource
-
-        def self.find(type)
-          case type.downcase
-          when "web_pixel_extension"
-            ["javascript"]
-          else
-            VALID_TEMPLATES
-          end
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/models/server_config/development_entries.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Models
-    module ServerConfig
-      class DevelopmentEntries < Base
-        include SmartProperties
-
-        JAVASCRIPT = "javascript"
-        JAVASCRIPT_REACT = "javascript-react"
-        TYPESCRIPT = "typescript"
-        TYPESCRIPT_REACT = "typescript-react"
-
-        VALID_ENTRY_POINTS = [
-          "src/index.js",
-          "src/index.jsx",
-          "src/index.ts",
-          "src/index.tsx",
-        ]
-
-        property! :main, accepts: VALID_ENTRY_POINTS
-
-        def self.find(template)
-          case template
-          when JAVASCRIPT
-            new(main: "src/index.js")
-          when JAVASCRIPT_REACT
-            new(main: "src/index.jsx")
-          when TYPESCRIPT
-            new(main: "src/index.ts")
-          when TYPESCRIPT_REACT
-            new(main: "src/index.tsx")
-          end
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/models/server_config/development_renderer.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Models
-    module ServerConfig
-      class DevelopmentRenderer < Base
-        include SmartProperties
-
-        VALID_RENDERERS = [
-          "@shopify/admin-ui-extensions",
-          "@shopify/post-purchase-ui-extensions",
-          "@shopify/checkout-ui-extensions",
-          "@shopify/retail-ui-extensions",
-        ]
-
-        property! :name, accepts: VALID_RENDERERS
-        property! :version, accepts: String, default: "latest"
-
-        def self.find(type)
-          case type.downcase
-          when "product_subscription"
-            new(name: "@shopify/admin-ui-extensions", version: "^1.0.1")
-          when "checkout_ui_extension"
-            new(name: "@shopify/checkout-ui-extensions", version: "^0.15.0")
-          when "checkout_post_purchase"
-            new(name: "@shopify/post-purchase-ui-extensions", version: "^0.13.2")
-          when "pos_ui_extension"
-            new(name: "@shopify/retail-ui-extensions", version: "^0.12.0")
-          when "web_pixel_extension"
-            nil
-          else
-            raise ArgumentError, "Unknown extension type: #{type}"
-          end
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/models/server_config/development_resource.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Models
-    module ServerConfig
-      class DevelopmentResource < Base
-        include SmartProperties
-
-        property! :url, accepts: String
-      end
-    end
-  end
-end