@shopify/cli-kit 3.69.4 → 3.70.0

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

@@ -1,134 +0,0 @@
-# frozen_string_literal: true
-require "base64"
-require "json"
-require "shopify_cli/theme/extension/dev_server"
-require "shopify_cli/theme/ignore_filter"
-require "shopify_cli/theme/extension/ignore_helper"
-
-module Extension
-  module Models
-    module SpecificationHandlers
-      class ThemeAppExtension < Default
-        include ShopifyCLI::Theme::Extension::IgnoreHelper
-
-        attr_reader :ignore_filter
-
-        SUPPORTED_BUCKETS = %w(assets blocks snippets locales)
-        BUNDLE_SIZE_LIMIT = 10 * 1024 * 1024 # 10MB
-        LIQUID_SIZE_LIMIT = 100 * 1024 # 100kb
-        SUPPORTED_ASSET_EXTS = %w(.jpg .jpeg .js .json .css .png .svg .wasm)
-        SUPPORTED_LOCALE_EXTS = %w(.json)
-
-        def create(directory_name, context, getting_started: false)
-          context.root = File.join(context.root, directory_name)
-
-          if getting_started
-            ShopifyCLI::Git.clone("https://github.com/Shopify/theme-extension-getting-started", context.root)
-            context.rm_r(".git")
-          else
-            FileUtils.makedirs(SUPPORTED_BUCKETS.map { |b| File.join(context.root, b) })
-          end
-        end
-
-        def config(context)
-          @ignore_filter ||= ShopifyCLI::Theme::IgnoreFilter.from_path(context.root)
-          current_size = 0
-          current_liquid_size = 0
-          Dir.chdir(context.root) do
-            Dir["**/*"].select { |filename| File.file?(filename) && validate(filename) }
-              .map do |filename|
-                dirname = File.dirname(filename)
-                if dirname == "assets"
-                  # Assets should be read as binary data, since they could be images
-                  mode = "rb"
-                  encoding = "BINARY"
-                else
-                  # Other assets should be treated as UTF-8 encoded text
-                  mode = "rt"
-                  encoding = "UTF-8"
-
-                  if dirname == "snippets" || dirname == "blocks"
-                    current_liquid_size += File.size(filename)
-                  end
-                end
-                current_size += File.size(filename)
-                if current_size > BUNDLE_SIZE_LIMIT
-                  raise Extension::Errors::BundleTooLargeError,
-                    "Total size of all files must be less than #{CLI::Kit::Util.to_filesize(BUNDLE_SIZE_LIMIT)}"
-                end
-                if current_liquid_size > LIQUID_SIZE_LIMIT
-                  raise Extension::Errors::BundleTooLargeError,
-                    "Total size of all liquid must be less than #{CLI::Kit::Util.to_filesize(LIQUID_SIZE_LIMIT)}"
-                end
-                [filename, Base64.encode64(File.read(filename, mode: mode, encoding: encoding))]
-              end
-              .yield_self do |encoded_files_by_name|
-                { "theme_extension" => { "files" => encoded_files_by_name.to_h } }
-              end
-          end
-        end
-
-        def name
-          "Theme App Extension"
-        end
-
-        def choose_port?(_ctx)
-          false
-        end
-
-        def establish_tunnel?(_ctx)
-          false
-        end
-
-        def serve(**options)
-          @ctx = options[:context]
-          root = options[:context]&.root
-          project = options[:project]
-          notify = options[:notify]
-          properties = options
-            .slice(:port, :theme, :generate_tmp_theme)
-            .compact
-            .merge({
-              project: project,
-              specification_handler: self,
-              notify: notify,
-            })
-
-          ShopifyCLI::Theme::Extension::DevServer.start(@ctx, root, **properties)
-        end
-
-        private
-
-        def validate(filename)
-          dirname = File.dirname(filename)
-          # Skip files in the root of the directory tree
-          return false if dirname == "."
-
-          # Skip files that are ignored by the ignore filter
-          return false if ignore_path?(filename)
-
-          unless SUPPORTED_BUCKETS.include?(dirname)
-            raise Extension::Errors::InvalidFilenameError, "Invalid directory: #{dirname}"
-          end
-
-          ext = File.extname(filename)
-          if dirname == "assets"
-            unless SUPPORTED_ASSET_EXTS.include?(ext)
-              raise Extension::Errors::InvalidFilenameError,
-                "Invalid filename: #{filename}; #{ext} is not supported"
-            end
-          elsif dirname == "locales"
-            unless SUPPORTED_LOCALE_EXTS.include?(ext)
-              raise Extension::Errors::InvalidFilenameError,
-                "Invalid filename: #{filename}; Only #{SUPPORTED_LOCALE_EXTS.join(", ")} allowed in #{dirname}"
-            end
-          elsif ext != ".liquid"
-            raise Extension::Errors::InvalidFilenameError,
-              "Invalid filename: #{filename}; Only .liquid allowed in #{dirname}"
-          end
-          true
-        end
-      end
-    end
-  end
-end

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

@@ -1,91 +0,0 @@
-module Extension
-  module Models
-    class Specifications
-      include SmartProperties
-
-      property! :custom_handler_root,
-        accepts: ->(d) { File.directory?(d) },
-        default: -> { File.expand_path("lib/project_types/extension/models/specification_handlers", ShopifyCLI::ROOT) }
-
-      property! :custom_handler_namespace,
-        accepts: ->(m) { m.respond_to?(:const_get) },
-        default: -> { ::Extension::Models::SpecificationHandlers }
-
-      property! :fetch_specifications,
-        accepts: ->(p) { p.respond_to?(:to_proc) }
-
-      def [](identifier)
-        handlers[identifier]
-      end
-
-      def valid?(identifier)
-        handlers.key?(identifier)
-      end
-
-      def each(&block)
-        handlers.values.each(&block)
-      end
-
-      def none?
-        each.none?
-      end
-
-      protected
-
-      def handlers
-        @handlers ||= fetch_specifications_and_build_handlers
-      end
-
-      private
-
-      def fetch_specifications_and_build_handlers
-        ShopifyCLI::Result
-          .call(&fetch_specifications)
-          .map(&ShopifyCLI::TransformDataStructure.new(symbolize_keys: true, underscore_keys: true))
-          .then(&method(:select_cli_extensions))
-          .then(&Tasks::ConfigureFeatures)
-          .then(&Tasks::ConfigureOptions)
-          .then(&method(:ensure_legacy_compatibility))
-          .then(&method(:build_specifications))
-          .then(&method(:require_handler_implementations))
-          .then(&method(:instantiate_specification_handlers))
-          .unwrap { |err| raise err }
-      end
-
-      def require_handler_implementations(specifications)
-        specifications.each do |s|
-          implementation_file = File.join(custom_handler_root, "#{s.identifier}.rb")
-          require(implementation_file) if File.file?(implementation_file)
-        end
-      end
-
-      def instantiate_specification_handlers(specifications)
-        specifications.each_with_object({}) do |specification, handlers|
-          ShopifyCLI::ResolveConstant.call(specification.identifier, namespace: custom_handler_namespace)
-            .rescue { |error| error.is_a?(NameError) ? SpecificationHandlers::Default : raise(error) }
-            .then { |handler_class| handler_class.new(specification) }
-            .unwrap { |error| raise error }
-            .yield_self { |handler| handlers[handler.identifier] = handler }
-        end
-      end
-
-      def ensure_legacy_compatibility(specification_attribute_sets)
-        specification_attribute_sets.each do |attributes|
-          next unless attributes.fetch(:identifier) == "subscription_management"
-          attributes[:identifier] = "product_subscription"
-          attributes[:graphql_identifier] = "SUBSCRIPTION_MANAGEMENT"
-        end
-      end
-
-      def build_specifications(specification_attribute_sets)
-        specification_attribute_sets.map { |attributes| Models::Specification.new(**attributes) }
-      end
-
-      def select_cli_extensions(specification_attribute_sets)
-        specification_attribute_sets.select do |attributes|
-          attributes.dig(:options, :management_experience) == "cli" && attributes[:identifier] != "data"
-        end
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Models
-    class ValidationError
-      include SmartProperties
-
-      IS_VALIDATION_ERROR_LIST = -> (errors) do
-        errors.is_a?(Array) && errors.all? { |error| IS_VALIDATION_ERROR.call(error) }
-      end
-      IS_VALIDATION_ERROR = -> (error) { error.is_a?(ValidationError) }
-
-      property! :field, accepts: -> (fields) { fields.all? { |field| field.is_a?(String) } }
-      property! :message, accepts: String
-    end
-  end
-end

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

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Models
-    class Version
-      include SmartProperties
-
-      property! :registration_id, accepts: Integer
-      property! :last_user_interaction_at, accepts: Time
-      property  :context, accepts: String
-      property  :location, accepts: String
-      property :validation_errors, accepts: Models::ValidationError::IS_VALIDATION_ERROR_LIST, default: -> { [] }
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/tasks/configure_features.rb

@@ -1,73 +0,0 @@
-module Extension
-  module Tasks
-    class ConfigureFeatures
-      include ShopifyCLI::MethodObject
-
-      class Error < RuntimeError; end
-      class UnknownSurfaceArea < Error; end
-      class UnspecifiedSurfaceArea < Error; end
-
-      def call(specification_attribute_sets)
-        specification_attribute_sets.each do |attributes|
-          argo_configuration = extract_argo_configuration(attributes)
-          next if argo_configuration.nil?
-          surface_area = extract_surface_area(argo_configuration)
-          if known_surface_area?(surface_area)
-            surface_area_configuration = fetch_surface_area_configuration(surface_area)
-            argo_configuration.merge!(surface_area_configuration)
-          else
-            clear_argo_configuration(attributes)
-          end
-        end
-      end
-
-      private
-
-      def known_surface_area?(surface_area)
-        surface_area_configurations.keys.include?(surface_area.to_sym)
-      end
-
-      def extract_argo_configuration(attributes)
-        attributes.dig(:features, :argo)
-      end
-
-      def extract_surface_area(argo_configuration)
-        argo_configuration.fetch(:surface) do
-          raise UnspecifiedSurfaceArea, "Argo configuration does not specify surface area"
-        end
-      end
-
-      def fetch_surface_area_configuration(surface_area)
-        surface_area_configurations.fetch(surface_area.to_sym) do
-          raise UnknownSurfaceArea, "Unknown surface area: #{surface_area}"
-        end
-      end
-
-      def clear_argo_configuration(attributes)
-        attributes[:name] = "#{attributes[:name]} (Warning: surface area not configured properly)"
-        attributes[:features][:argo] = nil
-      end
-
-      def surface_area_configurations
-        {
-          admin: {
-            git_template: "https://github.com/Shopify/admin-ui-extensions-template",
-            renderer_package_name: "@shopify/admin-ui-extensions",
-            required_fields: [:shop, :api_key],
-            cli_package_name: "@shopify/admin-ui-extensions-run",
-          },
-          checkout: {
-            git_template: "https://github.com/Shopify/checkout-ui-extensions-template",
-            renderer_package_name: "@shopify/checkout-ui-extensions",
-            required_fields: [:shop],
-            cli_package_name: "@shopify/checkout-ui-extensions-run",
-          },
-          point_of_sale: {
-            git_template: "",
-            renderer_package_name: "@shopify/retail-ui-extensions",
-          },
-        }
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/tasks/configure_options.rb

@@ -1,21 +0,0 @@
-module Extension
-  module Tasks
-    class ConfigureOptions
-      include ShopifyCLI::MethodObject
-
-      def call(specification_attribute_sets)
-        specification_attribute_sets.each do |attributes|
-          attributes[:options] ||= {}
-          configure_skip_build(attributes)
-        end
-      end
-
-      private
-
-      def configure_skip_build(attributes)
-        attributes[:options].merge!(skip_build: attributes[:identifier] == "theme_app_extension" ||
-         attributes[:identifier] == "web_pixel_extension")
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/tasks/converters/validation_error_converter.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-require "shopify_cli"
-
-module Extension
-  module Tasks
-    module Converters
-      module ValidationErrorConverter
-        FIELD_FIELD = "field"
-        MESSAGE_FIELD = "message"
-
-        def self.from_array(context, errors)
-          return [] if errors.nil?
-          context.abort(context.message("tasks.errors.parse_error")) unless errors.is_a?(Array)
-
-          errors.map do |error|
-            Models::ValidationError.new(
-              field: error[FIELD_FIELD],
-              message: error[MESSAGE_FIELD]
-            )
-          end
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/tasks/converters/version_converter.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-require "shopify_cli"
-
-module Extension
-  module Tasks
-    module Converters
-      module VersionConverter
-        REGISTRATION_ID_FIELD = "registrationId"
-        CONTEXT_FIELD = "context"
-        LAST_USER_INTERACTION_AT_FIELD = "lastUserInteractionAt"
-        LOCATION_FIELD = "location"
-        VALIDATION_ERRORS_FIELD = "validationErrors"
-
-        def self.from_hash(context, hash)
-          context.abort(context.message("tasks.errors.parse_error")) if hash.nil?
-
-          Models::Version.new(
-            registration_id: hash[REGISTRATION_ID_FIELD].to_i,
-            context: hash[CONTEXT_FIELD],
-            last_user_interaction_at: Time.parse(hash[LAST_USER_INTERACTION_AT_FIELD]),
-            location: hash[LOCATION_FIELD],
-            validation_errors: Converters::ValidationErrorConverter.from_array(context, hash[VALIDATION_ERRORS_FIELD])
-          )
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/tasks/fetch_specifications.rb

@@ -1,21 +0,0 @@
-module Extension
-  module Tasks
-    class FetchSpecifications
-      include ShopifyCLI::MethodObject
-
-      property :context
-      property :api_key
-
-      def call
-        response = ShopifyCLI::PartnersAPI
-          .query(context, "fetch_specifications", api_key: api_key)
-          .dig("data", "extensionSpecifications")
-        context.abort(context.message("tasks.errors.parse_error")) if response.nil?
-
-        response.reject do |line|
-          ::Extension::Features::Runtimes::CheckoutUiExtension::IDENTIFIERS.include?(line["identifier"].upcase)
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/node/cli.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-module Node
-  class Project < ShopifyCLI::ProjectType
-    require Project.project_filepath("messages/messages")
-    register_messages(Node::Messages::MESSAGES)
-  end
-
-  # define/autoload project specific Forms
-  module Forms
-    autoload :Create, Project.project_filepath("forms/create")
-  end
-end

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

@@ -1,45 +0,0 @@
-require "uri"
-
-module Node
-  module Forms
-    class Create < ShopifyCLI::Form
-      attr_accessor :name
-      flag_arguments :name, :organization_id, :shop_domain, :type
-
-      def ask
-        self.name ||= CLI::UI::Prompt.ask(ctx.message("node.forms.create.app_name"))
-        self.name = format_name
-        self.type = ask_type
-        res = ShopifyCLI::Tasks::SelectOrgAndShop.call(ctx, organization_id: organization_id, shop_domain: shop_domain)
-        self.organization_id = res[:organization_id]
-        self.shop_domain = res[:shop_domain]
-      end
-
-      private
-
-      def format_name
-        formatted_name = name.downcase.split(" ").join("_")
-
-        if formatted_name.include?("shopify")
-          ctx.abort(ctx.message("node.forms.create.error.invalid_app_name"))
-        end
-        formatted_name
-      end
-
-      def ask_type
-        if type.nil?
-          return CLI::UI::Prompt.ask(ctx.message("node.forms.create.app_type.select")) do |handler|
-            handler.option(ctx.message("node.forms.create.app_type.select_public")) { "public" }
-            handler.option(ctx.message("node.forms.create.app_type.select_custom")) { "custom" }
-          end
-        end
-
-        unless ShopifyCLI::Tasks::CreateApiClient::VALID_APP_TYPES.include?(type)
-          ctx.abort(ctx.message("node.forms.create.error.invalid_app_type", type))
-        end
-        ctx.puts(ctx.message("node.forms.create.app_type.selected", type))
-        type
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/node/messages/messages.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Node
-  module Messages
-    MESSAGES = {
-      node: {
-        help: <<~HELP,
-          Suite of commands for developing Node.js apps. See {{command:%1$s app node <command> --help}} for usage of each command.
-            Usage: {{command:%1$s app node [ %2$s ]}}
-        HELP
-
-        error: {
-          generic: "Error",
-        },
-        forms: {
-          create: {
-            error: {
-              invalid_app_name: "App name cannot contain 'Shopify'",
-              invalid_app_type: "Invalid app type %s",
-            },
-            app_name: "App name",
-            app_type: {
-              select: "What type of app are you building?",
-              select_public: "Public: An app built for a wide merchant audience.",
-              select_custom: "Custom: An app custom built for a single client.",
-              selected: "App type {{green:%s}}",
-            },
-          },
-        },
-      },
-    }.freeze
-  end
-end

package/assets/cli-ruby/lib/project_types/php/cli.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-module PHP
-  class Project < ShopifyCLI::ProjectType
-    require Project.project_filepath("messages/messages")
-    register_messages(PHP::Messages::MESSAGES)
-  end
-
-  # define/autoload project specific Tasks
-  module Tasks
-  end
-
-  # define/autoload project specific Forms
-  module Forms
-    autoload :Create, Project.project_filepath("forms/create")
-  end
-end

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

@@ -1,44 +0,0 @@
-require "uri"
-
-module PHP
-  module Forms
-    class Create < ShopifyCLI::Form
-      flag_arguments :name, :organization_id, :shop_domain, :type
-
-      def ask
-        self.name ||= CLI::UI::Prompt.ask(ctx.message("php.forms.create.app_name"))
-        self.name = format_name
-        self.type = ask_type
-        res = ShopifyCLI::Tasks::SelectOrgAndShop.call(ctx, organization_id: organization_id, shop_domain: shop_domain)
-        self.organization_id = res[:organization_id]
-        self.shop_domain = res[:shop_domain]
-      end
-
-      private
-
-      def format_name
-        formatted_name = name.downcase.split(" ").join("_")
-
-        if formatted_name.include?("shopify")
-          ctx.abort(ctx.message("php.forms.create.error.invalid_app_name"))
-        end
-        formatted_name
-      end
-
-      def ask_type
-        if type.nil?
-          return CLI::UI::Prompt.ask(ctx.message("php.forms.create.app_type.select")) do |handler|
-            handler.option(ctx.message("php.forms.create.app_type.select_public")) { "public" }
-            handler.option(ctx.message("php.forms.create.app_type.select_custom")) { "custom" }
-          end
-        end
-
-        unless ShopifyCLI::Tasks::CreateApiClient::VALID_APP_TYPES.include?(type)
-          ctx.abort(ctx.message("php.forms.create.error.invalid_app_type", type))
-        end
-        ctx.puts(ctx.message("php.forms.create.app_type.selected", type))
-        type
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/php/messages/messages.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module PHP
-  module Messages
-    MESSAGES = {
-      php: {
-        help: <<~HELP,
-          Suite of commands for developing PHP apps with Laravel. See {{command:%1$s app php <command> --help}} for usage of each command.
-            Usage: {{command:%1$s app php [ %2$s ]}}
-        HELP
-        forms: {
-          create: {
-            error: {
-              invalid_app_name: "App name cannot contain 'Shopify'",
-              invalid_app_type: "Invalid app type %s",
-            },
-            app_name: "App name",
-            app_type: {
-              select: "What type of app are you building?",
-              select_public: "Public: An app built for a wide merchant audience.",
-              select_custom: "Custom: An app custom built for a single client.",
-              selected: "App type {{green:%s}}",
-            },
-          },
-        },
-      },
-    }.freeze
-  end
-end

package/assets/cli-ruby/lib/project_types/rails/cli.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-module Rails
-  class Project < ShopifyCLI::ProjectType
-    require Project.project_filepath("messages/messages")
-    register_messages(Rails::Messages::MESSAGES)
-  end
-
-  # define/autoload project specific Forms
-  module Forms
-    autoload :Create, Project.project_filepath("forms/create")
-  end
-
-  autoload :Ruby, Project.project_filepath("ruby")
-  autoload :Gem, Project.project_filepath("gem")
-end