@shopify/cli-kit 3.45.0 → 3.46.0-pre.0

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

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Models
-    module ServerConfig
-      class Root < Base
-        include SmartProperties
-
-        property  :app, accepts: ServerConfig::App
-        property! :extensions, accepts: Array, default: -> { [] }
-        property! :port, accepts: Integer, default: 39351
-        property  :public_url, accepts: String
-        property  :store, accepts: String
-
-        def to_yaml
-          to_h.to_yaml.gsub("---\n", "")
-        end
-      end
-    end
-  end
-end

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

@@ -1,10 +0,0 @@
-module Extension
-  module Models
-    module ServerConfig
-      class User < Base
-        include SmartProperties
-        property! :metafields, accepts: Array, default: -> { [] }
-      end
-    end
-  end
-end

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

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-require "base64"
-
-module Extension
-  module Models
-    module SpecificationHandlers
-      class CheckoutPostPurchase < Default
-        PERMITTED_CONFIG_KEYS = [:metafields]
-        RENDERER_PACKAGE_NAME = "@shopify/post-purchase-ui-extensions"
-
-        def config(context)
-          {
-            **Features::ArgoConfig.parse_yaml(context, PERMITTED_CONFIG_KEYS),
-            **argo.config(context, include_renderer_version: false),
-          }
-        end
-
-        protected
-
-        def argo
-          Features::Argo.new(
-            git_template: specification.features.argo.git_template,
-            renderer_package_name: RENDERER_PACKAGE_NAME
-          )
-        end
-      end
-    end
-  end
-end

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

@@ -1,170 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Models
-    module SpecificationHandlers
-      class CheckoutUiExtension < Default
-        L10N_ERROR_PREFIX = "core.extension.push.checkout_ui_extension.localization.error"
-        L10N_FILE_SIZE_LIMIT = 16 * 1024 # 16kb
-        L10N_BUNDLE_SIZE_LIMIT = 256 * 1024 # 256kb
-        LOCALE_CODE_FORMAT = %r{
-          \A
-          (?<language>[a-zA-Z]{2,3}) # Language tag
-          (?:
-           -
-           (?<region>[a-zA-Z]{2}) # Optional region subtag
-          )?
-          \z}x
-        PERMITTED_CONFIG_KEYS = [:extension_points, :metafields, :name, :capabilities]
-
-        def config(context)
-          {
-            **Features::ArgoConfig.parse_yaml(context, PERMITTED_CONFIG_KEYS),
-            **argo.config(context, include_renderer_version: false),
-            **localization(context),
-          }
-        end
-
-        def supplies_resource_url?
-          true
-        end
-
-        def build_resource_url(context:, shop:)
-          product = Tasks::GetProduct.call(context, shop)
-          return unless product
-          format("/cart/%<variant_id>d:%<quantity>d", variant_id: product.variant_id, quantity: 1)
-        end
-
-        private
-
-        def localization(context)
-          Dir.chdir(context.root) do
-            locale_filenames = Dir["locales/*"].select { |filename| valid_l10n_file?(filename) }
-            # Localization is optional
-            return {} if locale_filenames.empty?
-
-            validate_no_duplicate_locale(locale_filenames)
-            validate_total_size(locale_filenames)
-            default_locale = single_default_locale(locale_filenames)
-
-            locale_filenames.map do |filename|
-              locale = basename_for_locale_filename(filename)
-              [locale.to_sym, read_locale_file(filename)]
-            end
-              .yield_self do |encoded_files_by_locale|
-              {
-                localization: {
-                  default_locale: default_locale,
-                  translations: encoded_files_by_locale.to_h,
-                },
-              }
-            end
-          end
-        end
-
-        def read_locale_file(filename)
-          content = File.read(filename, mode: "rt", encoding: "bom|utf-8").strip
-          raise_invalid_encoding_error(filename) unless content.valid_encoding?
-          Base64.strict_encode64(content)
-        rescue ArgumentError
-          raise_invalid_encoding_error(filename)
-        end
-
-        def validate_no_duplicate_locale(locale_filenames)
-          duplicate_locale = locale_filenames
-            .map { |filename| basename_for_locale_filename(filename.downcase) }
-            .group_by { |locale| locale }
-            .detect { |_k, v| v.size > 1 }
-            &.first
-          raise(
-            ShopifyCLI::Abort,
-            ShopifyCLI::Context.message("#{L10N_ERROR_PREFIX}.duplicate_locale_code", duplicate_locale)
-          ) unless duplicate_locale.nil?
-        end
-
-        def validate_total_size(locale_filenames)
-          total_size = locale_filenames.sum { |filename| File.size(filename) }
-          if total_size > L10N_BUNDLE_SIZE_LIMIT
-            raise(
-              ShopifyCLI::Abort,
-              ShopifyCLI::Context.message(
-                "#{L10N_ERROR_PREFIX}.bundle_too_large",
-                CLI::Kit::Util.to_filesize(L10N_BUNDLE_SIZE_LIMIT)
-              )
-            )
-          end
-        end
-
-        def single_default_locale(locale_filenames)
-          default_locale_matches = locale_filenames.grep(/default/)
-          if default_locale_matches.size != 1
-            raise(ShopifyCLI::Abort, ShopifyCLI::Context.message("#{L10N_ERROR_PREFIX}.single_default_locale"))
-          end
-          basename_for_locale_filename(default_locale_matches.first)
-        end
-
-        def valid_l10n_file?(filename)
-          return false unless File.file?(filename)
-          return false unless File.dirname(filename) == "locales"
-
-          validate_file_extension(filename)
-          validate_file_locale_code(filename)
-          validate_file_size(filename)
-          validate_file_not_empty(filename)
-
-          true
-        end
-
-        def validate_file_extension(filename)
-          if File.extname(filename) != ".json"
-            raise(
-              ShopifyCLI::Abort, ShopifyCLI::Context.message("#{L10N_ERROR_PREFIX}.invalid_file_extension", filename)
-            )
-          end
-        end
-
-        def validate_file_locale_code(filename)
-          unless valid_locale_code?(basename_for_locale_filename(filename))
-            raise(
-              ShopifyCLI::Abort, ShopifyCLI::Context.message("#{L10N_ERROR_PREFIX}.invalid_locale_code", filename)
-            )
-          end
-        end
-
-        def validate_file_size(filename)
-          if File.size(filename) > L10N_FILE_SIZE_LIMIT
-            raise(
-              ShopifyCLI::Abort,
-              ShopifyCLI::Context.message(
-                "#{L10N_ERROR_PREFIX}.file_too_large",
-                filename,
-                CLI::Kit::Util.to_filesize(L10N_FILE_SIZE_LIMIT)
-              )
-            )
-          end
-        end
-
-        def validate_file_not_empty(filename)
-          if File.zero?(filename)
-            raise(ShopifyCLI::Abort, ShopifyCLI::Context.message("#{L10N_ERROR_PREFIX}.file_empty", filename))
-          end
-        end
-
-        def valid_locale_code?(locale_code)
-          LOCALE_CODE_FORMAT.match?(locale_code)
-        end
-
-        def basename_for_locale_filename(filename)
-          File.basename(File.basename(filename, ".json"), ".default")
-        end
-
-        def raise_invalid_encoding_error(filename)
-          raise(
-            ShopifyCLI::Abort,
-            ShopifyCLI::Context.message("#{L10N_ERROR_PREFIX}.invalid_file_encoding", filename)
-          )
-        end
-      end
-    end
-  end
-end

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

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-require "base64"
-require "fileutils"
-require "json"
-require_relative "web_pixel_extension_utils/script_config"
-require_relative "web_pixel_extension_utils/script_config_repository"
-
-module Extension
-  module Models
-    module SpecificationHandlers
-      class WebPixelExtension < Default
-        SCRIPT_FILE = "build/main.js"
-
-        def name
-          "Web Pixel Extension"
-        end
-
-        def read_configuration
-        end
-
-        def access_config_property(context, ext_config, key, &process_value)
-          context.abort(context.message("core.extension.push.web_pixel_extension.error.missing_config_key_error",
-            key)) unless ext_config.key?(key)
-
-          begin
-            process_value.nil? ? ext_config[key] : process_value.call(ext_config[key])
-          rescue StandardError
-            context.abort(context.message("core.extension.push.web_pixel_extension.error.invalid_config_value_error",
-              key))
-          end
-        end
-
-        def config(context)
-          begin
-            ext_config = WebPixelExtensionUtils::ScriptConfigYmlRepository.new(ctx: context).get!.content
-          rescue StandardError
-            context.abort(context.message("core.extension.push.web_pixel_extension.error.file_read_error",
-              WebPixelExtensionUtils::ScriptConfigYmlRepository.filename))
-          end
-
-          begin
-            script_contents = File.read(File.join(context.root, SCRIPT_FILE)).chomp
-          rescue
-            context.abort(context.message("core.extension.push.web_pixel_extension.error.file_read_error", SCRIPT_FILE))
-          end
-          {
-            runtime_context: access_config_property(context, ext_config, "runtime_context"),
-            serialized_script: Base64.strict_encode64(script_contents),
-            runtime_configuration_definition: access_config_property(context, ext_config,
-              "configuration", &:to_json),
-            config_version: access_config_property(context, ext_config,
-              "version", &:to_s),
-          }
-        end
-      end
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Models
-    module SpecificationHandlers
-      module WebPixelExtensionUtils
-        class ScriptConfig
-          attr_reader :content, :version, :configuration, :filename
-
-          REQUIRED_FIELDS = %w(version)
-
-          def initialize(content:, filename:)
-            @filename = filename
-            validate_content!(content)
-            @content = content
-            @version = @content["version"].to_s
-            @configuration = @content["configuration"]
-          end
-
-          private
-
-          def validate_content!(content)
-            REQUIRED_FIELDS.each do |field|
-              if content[field].nil?
-                raise "invalid field:#{field}, filename:#{filename}"
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,75 +0,0 @@
-require_relative "script_config"
-module Extension
-  module Models
-    module SpecificationHandlers
-      module WebPixelExtensionUtils
-        class ScriptConfigRepository
-          include SmartProperties
-          property! :ctx, accepts: ShopifyCLI::Context
-
-          def active?
-            ctx.file_exist?(filename)
-          end
-
-          def get!
-            raise RuntimeError.new("NoScriptConfigFile"), filename unless active?
-
-            content = ctx.read(filename)
-            hash = file_content_to_hash(content)
-
-            from_h(hash)
-          end
-
-          def filename
-            raise NotImplementedError
-          end
-
-          private
-
-          def from_h(hash)
-            Extension::Models::SpecificationHandlers::WebPixelExtensionUtils::ScriptConfig.new(content: hash,
-              filename: filename)
-          end
-
-          def file_content_to_hash(file_content)
-            raise NotImplementedError
-          end
-
-          def hash_to_file_content(hash)
-            raise NotImplementedError
-          end
-        end
-
-        class ScriptConfigYmlRepository < ScriptConfigRepository
-          def self.filename
-            "extension.config.yml"
-          end
-
-          def filename
-            ScriptConfigYmlRepository.filename
-          end
-
-          private
-
-          def file_content_to_hash(file_content)
-            begin
-              hash = YAML.load(file_content)
-            rescue Psych::SyntaxError
-              raise parse_error
-            end
-            raise parse_error unless hash.is_a?(Hash)
-            hash
-          end
-
-          def hash_to_file_content(hash)
-            YAML.dump(hash)
-          end
-
-          def parse_error
-            RuntimeError.new("ScriptConfigParseError #{filename}, serialization_format: \"YAML\" ")
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-require "shopify_cli"
-require "socket"
-
-module Extension
-  module Tasks
-    class ChooseNextAvailablePort
-      include ShopifyCLI::MethodObject
-
-      property! :from
-      property! :to, default: -> { from + 10 }
-      property! :host, default: "127.0.0.1"
-
-      def call
-        available_port = port_range(from: from, to: to).find { |p| available?(host, p) }
-        raise ArgumentError, "Ports between #{from} and #{to} are unavailable" if available_port.nil?
-        available_port
-      end
-
-      private
-
-      def port_range(from:, to:)
-        (from..to)
-      end
-
-      def available?(host, port)
-        Socket.tcp(host, port, connect_timeout: 1) do |socket|
-          socket.close
-          false
-        end
-      rescue Errno::ECONNREFUSED
-        true
-      end
-    end
-  end
-end

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

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-require "shopify_cli"
-
-module Extension
-  module Tasks
-    class ConvertServerConfig
-      include SmartProperties
-
-      property! :api_key, accepts: String
-      property! :context, accepts: ShopifyCLI::Context
-      property! :hash, accepts: Hash
-      property! :port, accepts: Integer
-      property! :registration_uuid, accepts: String
-      property  :resource_url, accepts: String
-      property! :store, accepts: String
-      property! :title, accepts: String
-      property  :tunnel_url, accepts: String
-      property! :type, accepts: String
-      property  :metafields, accepts: Array
-
-      DEFAULT_BUILD_DIR = "build"
-
-      def self.call(*args)
-        new(*args).call
-      end
-
-      def call
-        context.abort(context.message("tasks.errors.parse_error")) if hash.nil?
-
-        renderer = Models::ServerConfig::DevelopmentRenderer.find(type)
-        extension = Models::ServerConfig::Extension.new(
-          uuid: registration_uuid,
-          type: type,
-          user: Models::ServerConfig::User.new,
-          development: Models::ServerConfig::Development.new(
-            build_dir: hash.dig("development", "build_dir") || DEFAULT_BUILD_DIR,
-            renderer: renderer,
-            entries: Models::ServerConfig::DevelopmentEntries.new(
-              main: hash.dig("development", "entries", "main") || determine_default_entry_main(project_directory),
-            )
-          ),
-          extension_points: hash.dig("extension_points"),
-          capabilities: Models::ServerConfig::Capabilities.new(
-            network_access: hash.dig("capabilities", "network_access") || false
-          ),
-          version: renderer ? version(renderer.name, context) : nil,
-          title: title,
-          metafields: metafields
-        )
-
-        unless resource_url.nil?
-          extension.development.resource = Models::ServerConfig::DevelopmentResource.new(url: resource_url)
-        end
-        server_config = Models::ServerConfig::Root.new(
-          extensions: [extension],
-          port: port,
-          public_url: tunnel_url,
-          store: store
-        )
-
-        unless api_key.nil?
-          server_config.app = Models::ServerConfig::App.new(api_key: api_key)
-        end
-
-        server_config
-      end
-
-      def version(renderer, context)
-        Tasks::FindPackageFromJson.call(renderer, context: context).version
-      end
-
-      private
-
-      def determine_default_entry_main(project_directory)
-        Dir.chdir(project_directory) do
-          Dir["src/*"].lazy.grep(/index.[jt]sx?/).first
-        end
-      end
-
-      def project_directory
-        ExtensionProject.current.directory
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-require "shopify_cli"
-
-module Extension
-  module Tasks
-    module Converters
-      module AppConverter
-        API_KEY_FIELD = "apiKey"
-        API_SECRET_KEYS_FIELD = "apiSecretKeys"
-        API_SECRET_FIELD = "secret"
-        TITLE_FIELD = "title"
-        ORGANIZATION_NAME_FIELD = "businessName"
-
-        def self.from_hash(hash, organization = {})
-          return nil if hash.nil?
-
-          Models::App.new(
-            api_key: hash[API_KEY_FIELD],
-            secret: hash[API_SECRET_KEYS_FIELD].first[API_SECRET_FIELD],
-            title: hash[TITLE_FIELD],
-            business_name: organization[ORGANIZATION_NAME_FIELD]
-          )
-        end
-      end
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-require "shopify_cli"
-
-module Extension
-  module Tasks
-    module Converters
-      module ProductConverter
-        VARIANT_PATH = ["data", "products", "edges", 0, "node", "variants", "edges", 0, "node", "id"]
-
-        def self.from_hash(hash)
-          return nil if hash.nil?
-          variant = hash.dig(*VARIANT_PATH)
-          return unless variant
-          Models::Product.new(
-            variant_id: ShopifyCLI::API.gid_to_id(variant)
-          )
-        end
-      end
-    end
-  end
-end

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

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-require "shopify_cli"
-
-module Extension
-  module Tasks
-    module Converters
-      module RegistrationConverter
-        ID_FIELD = "id"
-        UUID_FIELD = "uuid"
-        TYPE_FIELD = "type"
-        TITLE_FIELD = "title"
-        DRAFT_VERSION_FIELD = "draftVersion"
-
-        def self.from_hash(context, hash)
-          context.abort(context.message("tasks.errors.parse_error")) if hash.nil?
-
-          Models::Registration.new(
-            id: hash[ID_FIELD].to_i,
-            uuid: hash[UUID_FIELD],
-            type: hash[TYPE_FIELD],
-            title: hash[TITLE_FIELD],
-            draft_version: VersionConverter.from_hash(context, hash[DRAFT_VERSION_FIELD])
-          )
-        end
-      end
-    end
-  end
-end

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

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-require "shopify_cli"
-
-module Extension
-  module Tasks
-    class CreateExtension < ShopifyCLI::Task
-      include UserErrors
-
-      GRAPHQL_FILE = "extension_create"
-
-      RESPONSE_FIELD = %w(data extensionCreate)
-      REGISTRATION_FIELD = "extensionRegistration"
-
-      def call(context:, api_key:, type:, title:, config:, extension_context: nil)
-        input = {
-          api_key: api_key,
-          type: type,
-          title: title,
-          config: JSON.generate(config),
-          extension_context: extension_context,
-        }
-
-        response = ShopifyCLI::PartnersAPI.query(context, GRAPHQL_FILE, **input).dig(*RESPONSE_FIELD)
-        context.abort(context.message("tasks.errors.parse_error")) if response.nil?
-
-        abort_if_user_errors(context, response)
-        Converters::RegistrationConverter.from_hash(context, response.dig(REGISTRATION_FIELD))
-      end
-    end
-  end
-end

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

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-require "shopify_cli"
-
-module Extension
-  module Tasks
-    class EnsureResourceUrl < ShopifyCLI::Task
-      include SmartProperties
-
-      property! :context, accepts: ShopifyCLI::Context
-      property! :specification_handler, accepts: Extension::Models::SpecificationHandlers::Default
-
-      def self.call(*args)
-        new(*args).call
-      end
-
-      def call
-        project = ExtensionProject.current(force_reload: true)
-
-        ShopifyCLI::Result
-          .wrap(project.resource_url)
-          .rescue { specification_handler.build_resource_url(shop: project.env.shop, context: context) }
-          .then(&method(:persist_resource_url))
-          .unwrap do |nil_or_exception|
-            case nil_or_exception
-            when nil
-              context.warn(context.message("warnings.resource_url_auto_generation_failed", project.env.shop))
-            else
-              context.abort(nil_or_exception)
-            end
-          end
-      end
-
-      def persist_resource_url(resource_url)
-        ExtensionProject.update_env_file(context: context, resource_url: resource_url)
-        resource_url
-      end
-    end
-  end
-end

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

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-require "shopify_cli"
-
-module Extension
-  module Tasks
-    module ExecuteCommands
-      class Base
-        include SmartProperties
-
-        property! :type, accepts: Models::DevelopmentServerRequirements::SUPPORTED_EXTENSION_TYPES
-        property! :context, accepts: ShopifyCLI::Context
-      end
-    end
-  end
-end