@shopify/cli-kit 3.69.4 → 3.70.0

package/assets/cli-ruby/lib/project_types/extension/extension_project.rb

@@ -1,151 +0,0 @@
-# frozen_string_literal: true
-require "shopify_cli"
-require "shopify_cli/environment"
-require "securerandom"
-
-module Extension
-  class ExtensionProject < ShopifyCLI::Project
-    class << self
-      def write_cli_file(context:, type:)
-        ShopifyCLI::Project.write(
-          context,
-          project_type: :extension,
-          organization_id: nil,
-          "#{ExtensionProjectKeys::SPECIFICATION_IDENTIFIER_KEY}": type
-        )
-      end
-
-      def update_env_file(context:, **updates)
-        current_config = {
-          title: current.title,
-          shop: current.env.shop,
-          api_key: current.app.api_key,
-          api_secret: current.app.secret,
-          registration_id: current.registration_id,
-          registration_uuid: current.registration_uuid,
-          resource_url: current.resource_url,
-        }
-
-        write_env_file(
-          context: context,
-          **current_config,
-          **updates
-        )
-      end
-
-      def write_env_file(
-        context:,
-        title:,
-        api_key: "",
-        api_secret: "",
-        registration_id: nil,
-        registration_uuid: nil,
-        resource_url: nil,
-        shop: nil
-      )
-        ShopifyCLI::Resources::EnvFile.new(
-          api_key: api_key,
-          secret: api_secret,
-          shop: shop,
-          extra: {
-            ExtensionProjectKeys::TITLE_KEY => title,
-            ExtensionProjectKeys::REGISTRATION_ID_KEY => registration_id,
-            ExtensionProjectKeys::REGISTRATION_UUID_KEY => registration_uuid || generate_temporary_uuid,
-            ExtensionProjectKeys::RESOURCE_URL_KEY => resource_url,
-          }.compact
-        ).write(context)
-
-        reload
-      end
-
-      def reload
-        current.reload unless project_empty?
-      end
-
-      private
-
-      def project_empty?
-        directory(Dir.pwd).nil?
-      end
-    end
-
-    def app
-      validate_env_present
-      Models::App.new(api_key: env["api_key"], secret: env["secret"])
-    end
-
-    def registered?
-      registration_id?
-    end
-
-    def title
-      get_extra_field(ExtensionProjectKeys::TITLE_KEY)
-    end
-
-    def specification_identifier
-      key = ExtensionProjectKeys::SPECIFICATION_IDENTIFIER_KEY
-
-      if ShopifyCLI::Environment.run_as_subprocess?
-        get_extra_field(key)
-      else
-        config[key]
-      end
-    end
-
-    def registration_id?
-      extra_property_present?(ExtensionProjectKeys::REGISTRATION_ID_KEY) &&
-        integer?(get_extra_field(ExtensionProjectKeys::REGISTRATION_ID_KEY)) &&
-        registration_id > 0
-    end
-
-    def registration_id
-      get_extra_field(ExtensionProjectKeys::REGISTRATION_ID_KEY).to_i
-    end
-
-    def registration_uuid
-      get_extra_field(ExtensionProjectKeys::REGISTRATION_UUID_KEY)
-    end
-
-    def resource_url
-      get_extra_field(ExtensionProjectKeys::RESOURCE_URL_KEY)
-    end
-
-    def reload
-      @env = nil
-    end
-
-    def self.generate_temporary_uuid
-      "dev-#{SecureRandom.uuid}"
-    end
-
-    private
-
-    def get_extra_field(key)
-      unless env
-        Kernel.puts("Run the command inside the correct extension directory.")
-        exit
-      end
-
-      extra = env[:extra] || {}
-      extra[key]
-    end
-
-    def extra_property_present?(key)
-      env[:extra].key?(key) && !get_extra_field(key).nil?
-    end
-
-    def property_present?(key)
-      validate_env_present
-      !env[key].nil? && !env[key].strip.empty?
-    end
-
-    def validate_env_present
-      return if env
-      raise ShopifyCLI::Abort, "Missing .env file. Run `shopify extension connect` to generate an .env file."
-    end
-
-    def integer?(value)
-      value.to_i.to_s == value.to_s
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/extension_project_keys.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-require "shopify_cli"
-
-module Extension
-  module ExtensionProjectKeys
-    REGISTRATION_ID_KEY = "EXTENSION_ID"
-    REGISTRATION_UUID_KEY = "EXTENSION_UUID"
-    SPECIFICATION_IDENTIFIER_KEY = "EXTENSION_TYPE"
-    TITLE_KEY = "EXTENSION_TITLE"
-    RESOURCE_URL_KEY = "EXTENSION_RESOURCE_URL"
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/features/argo.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-require "base64"
-require "shopify_cli"
-require "semantic/semantic"
-
-module Extension
-  module Features
-    class Argo
-      include SmartProperties
-
-      property! :git_template, converts: :to_str
-      property! :renderer_package_name, converts: :to_str
-
-      SCRIPT_PATH = %w(build main.js).freeze
-
-      YARN_INSTALL_COMMAND = %w(install).freeze
-      YARN_INSTALL_PARAMETERS = %w(--silent).freeze
-      YARN_RUN_COMMAND = %w(run).freeze
-      YARN_RUN_SCRIPT_NAME = %w(build).freeze
-      private_constant :YARN_INSTALL_COMMAND, :YARN_INSTALL_PARAMETERS, :YARN_RUN_COMMAND, :YARN_RUN_SCRIPT_NAME
-
-      def create(directory_name, identifier, context)
-        Features::ArgoSetup.new(git_template: git_template).call(directory_name, identifier, context)
-      end
-
-      def config(context, include_renderer_version: true)
-        filepath = File.join(context.root, SCRIPT_PATH)
-        context.abort(context.message("features.argo.missing_file_error")) unless File.exist?(filepath)
-
-        renderer_version = nil
-        if include_renderer_version
-          renderer_version = renderer_package(context).version
-        end
-
-        begin
-          {
-            renderer_version: renderer_version,
-            serialized_script: Base64.strict_encode64(File.read(filepath).chomp),
-          }
-        rescue StandardError
-          context.abort(context.message("features.argo.script_prepare_error"))
-        end
-      end
-
-      def renderer_package(context)
-        Tasks::FindPackageFromJson.call(renderer_package_name, context: context)
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/features/argo_config.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Features
-    class ArgoConfig
-      CONFIG_FILE_NAME = "extension.config.yml"
-
-      class << self
-        def parse_yaml(context, permitted_keys = [])
-          file_name = File.join(context.root, CONFIG_FILE_NAME)
-
-          return {} unless File.size?(file_name)
-
-          begin
-            config = YAML.load_file(file_name)
-
-            # `YAML.load_file` returns nil if the file is not empty
-            # but does not contain any parsable yml data, e.g. only comments
-            # We consider this valid
-            return {} if config.nil?
-
-            unless config.is_a?(Hash)
-              raise ShopifyCLI::Abort, ShopifyCLI::Context.message("core.yaml.error.not_hash", CONFIG_FILE_NAME)
-            end
-
-            config.transform_keys!(&:to_sym)
-            assert_valid_config(config, permitted_keys) unless permitted_keys.empty?
-
-            config
-          rescue Psych::SyntaxError => e
-            raise(
-              ShopifyCLI::Abort,
-              ShopifyCLI::Context.message("core.yaml.error.invalid", CONFIG_FILE_NAME, e.message)
-            )
-          end
-        end
-
-        private
-
-        def assert_valid_config(config, permitted_keys)
-          unpermitted_keys = config.keys.select do |k|
-            !permitted_keys.include?(k)
-          end
-
-          unless unpermitted_keys.empty?
-            raise(
-              ShopifyCLI::Abort,
-              ShopifyCLI::Context.message(
-                "features.argo.config.unpermitted_keys",
-                CONFIG_FILE_NAME,
-                unpermitted_keys.map { |k| "\n- #{k}" }.join
-              )
-            )
-          end
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/features/argo_dependencies.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Features
-    class ArgoDependencies
-      def self.node_installed(min_major:, min_minor: nil)
-        -> (context) do
-          out, status = CLI::Kit::System.capture2("node", "-v")
-          context.abort(context.message("features.argo.dependencies.node.node_not_installed")) unless status.success?
-
-          min_version = "v" + min_major .to_s + "." + (min_minor.nil? ? "x" : min_minor.to_s) + ".x"
-          version = out.strip
-          parsed_version = version.match(/v(?<major>\d+).(?<minor>\d+).(?<patch>\d+)/)
-
-          unless min_major.nil? || parsed_version[:major].to_i >= min_major
-            context.abort(context.message("features.argo.dependencies.node.version_too_low", version, min_version))
-          end
-
-          return if parsed_version[:major].to_i > min_major
-
-          unless min_minor.nil? || parsed_version[:minor].to_i >= min_minor
-            context.abort(context.message("features.argo.dependencies.node.version_too_low", version, min_version))
-          end
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/features/argo_runtime.rb

@@ -1,15 +0,0 @@
-module Extension
-  module Features
-    class ArgoRuntime
-      RUNTIMES = [
-        Runtimes::Admin.new,
-        Runtimes::CheckoutPostPurchase.new,
-        Runtimes::CheckoutUiExtension.new,
-      ]
-
-      def self.find(cli_package:, identifier:)
-        RUNTIMES.find { |runtime| runtime.active_runtime?(cli_package, identifier) }
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/features/argo_serve.rb

@@ -1,115 +0,0 @@
-module Extension
-  module Features
-    class ArgoServe
-      include SmartProperties
-
-      YARN_SERVE_COMMAND = %w(server)
-      NPM_SERVE_COMMAND = %w(run-script server)
-
-      property! :specification_handler, accepts: Extension::Models::SpecificationHandlers::Default
-      property :argo_runtime, accepts: -> (runtime) { runtime.class < Features::Runtimes::Base }
-      property! :context, accepts: ShopifyCLI::Context
-      property! :port, accepts: Integer
-      property  :tunnel_url, accepts: String, default: nil
-      property! :js_system, accepts: ->(jss) { jss.respond_to?(:call) }, default: ShopifyCLI::JsSystem
-      property :resource_url, accepts: String, default: nil
-
-      def call
-        validate_env!
-
-        CLI::UI::Frame.open(context.message("serve.frame_title")) do
-          next if start_server
-          context.abort(context.message("serve.serve_failure_message"))
-        end
-      end
-
-      def resource_url
-        super || ExtensionProject.current(force_reload: true).resource_url
-      end
-
-      private
-
-      def start_server
-        return new_serve_flow if supports_development_server?
-        js_system.call(context, yarn: yarn_serve_command, npm: npm_serve_command)
-      end
-
-      def specification
-        specification_handler.specification
-      end
-
-      def renderer_package
-        specification_handler.renderer_package(context)
-      end
-
-      def required_fields
-        specification.features.argo.required_fields
-      end
-
-      def yarn_serve_command
-        YARN_SERVE_COMMAND + options
-      end
-
-      def npm_serve_command
-        NPM_SERVE_COMMAND  + ["--"] + options
-      end
-
-      def validate_env!
-        ExtensionProject.reload
-
-        return if required_fields.none?
-
-        ShopifyCLI::Tasks::EnsureEnv.call(context, required: required_fields)
-        ShopifyCLI::Tasks::EnsureDevStore.call(context) if required_fields.include?(:shop)
-
-        project = ExtensionProject.current
-        if resource_url_required?
-          Tasks::EnsureResourceUrl.call(context: context, specification_handler: specification_handler)
-        end
-
-        return if required_fields.all? do |field|
-          value = project.env.public_send(field)
-          value && !value.strip.empty?
-        end
-
-        context.abort(context.message("serve.serve_missing_information"))
-      end
-
-      def resource_url_required?
-        specification_handler.supplies_resource_url? && resource_url.nil?
-      end
-
-      def options
-        project = ExtensionProject.current
-
-        @serve_options ||= [].tap do |options|
-          options << "--port=#{port}" if argo_runtime.supports?(:port)
-          options << "--store=#{project.env.shop}" if argo_runtime.supports?(:shop)
-          options << "--apiKey=#{project.env.api_key}" if argo_runtime.supports?(:api_key)
-          options << "--rendererVersion=#{renderer_package.version}" if argo_runtime.supports?(:renderer_version)
-          options << "--uuid=#{project.registration_uuid}" if argo_runtime.supports?(:uuid)
-          options << "--publicUrl=#{tunnel_url}" if !tunnel_url.nil? && argo_runtime.supports?(:public_url)
-          options << "--name=#{project.title}" if argo_runtime.supports?(:name)
-          options << "--resourceUrl=#{resource_url}" if !resource_url.nil? && argo_runtime.supports?(:resource_url)
-        end
-      end
-
-      def new_serve_flow
-        Tasks::ExecuteCommands.serve(
-          type: specification_handler.specification.identifier,
-          context: context,
-          config_file_path: specification_handler.server_config_path,
-          port: port,
-          resource_url: resource_url,
-          tunnel_url: tunnel_url
-        ).unwrap do |error|
-          raise error unless error.nil?
-        end
-      end
-
-      def supports_development_server?
-        Models::DevelopmentServerRequirements.supported?(specification_handler.specification.identifier)
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/features/argo_setup.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Features
-    class ArgoSetup
-      include SmartProperties
-
-      GIT_DIRECTORY = ".git"
-      SCRIPTS_DIRECTORY = "scripts"
-
-      property! :git_template, accepts: String
-      property! :dependency_checks, default: -> { [] }
-
-      def call(directory_name, identifier, context)
-        steps = [
-          ArgoSetupSteps.check_dependencies(dependency_checks),
-          ArgoSetupSteps.clone_template(git_template),
-          ArgoSetupSteps.install_dependencies,
-          ArgoSetupSteps.initialize_project,
-        ]
-
-        install_result = run_install_steps(context, steps, identifier, directory_name)
-
-        cleanup(context, install_result, directory_name)
-        install_result
-      end
-
-      def run_install_steps(context, steps, identifier, directory_name)
-        system = ShopifyCLI::JsSystem.new(ctx: context)
-
-        steps.inject(true) do |success, setup_step|
-          success && setup_step.call(context, identifier, directory_name, system)
-        end
-      end
-
-      def cleanup(context, install_result, directory_name)
-        install_result ? cleanup_template(context) : cleanup_on_failure(context, directory_name)
-      end
-
-      def cleanup_template(context)
-        context.rm_r(GIT_DIRECTORY)
-        context.rm_r(SCRIPTS_DIRECTORY)
-      rescue Errno::ENOENT => e
-        context.debug(e)
-      end
-
-      def cleanup_on_failure(context, directory_name)
-        FileUtils.rm_r(directory_name) if Dir.exist?(directory_name)
-      rescue Errno::ENOENT => e
-        context.debug(e)
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/features/argo_setup_step.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Features
-    class ArgoSetupStep
-      include SmartProperties
-
-      property! :step
-      property! :can_fail, accepts: [true, false], reader: :can_fail?
-
-      def call(context, identifier, directory_name, js_system)
-        step_result = step.call(context, identifier, directory_name, js_system)
-        can_fail? ? step_result : true
-      rescue ShopifyCLI::Abort => e
-        context.puts(e.message)
-        false
-      rescue StandardError => e
-        context.puts("{{x}} #{e.message}")
-        false
-      end
-
-      def self.default(&block)
-        ArgoSetupStep.new(step: block, can_fail: true)
-      end
-
-      def self.always_successful(&block)
-        ArgoSetupStep.new(step: block, can_fail: false)
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/features/argo_setup_steps.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Features
-    module ArgoSetupSteps
-      YARN_INITIALIZE_COMMAND = %w(generate).freeze
-      NPM_INITIALIZE_COMMAND = %w(run generate --).freeze
-      INITIALIZE_TYPE_PARAMETER = "--type=%s"
-
-      def self.check_dependencies(dependency_checks)
-        ArgoSetupStep.always_successful do |context, _identifier, _directory_name, _js_system|
-          dependency_checks.each do |dependency_check|
-            dependency_check.call(context)
-          end
-        end
-      end
-
-      def self.clone_template(git_template)
-        ArgoSetupStep.default do |context, _identifier, directory_name, _js_system|
-          ShopifyCLI::Git.clone(git_template, directory_name, ctx: context)
-          context.root = File.join(context.root, directory_name)
-        rescue StandardError
-          context.puts("{{x}} Unable to clone the repository.")
-        end
-      end
-
-      def self.install_dependencies
-        ArgoSetupStep.default do |context, _identifier, _directory_name, js_system|
-          ShopifyCLI::JsDeps.new(ctx: context, system: js_system).install
-        end
-      end
-
-      def self.initialize_project
-        ArgoSetupStep.default do |context, identifier, _directory_name, js_system|
-          frame_title = context.message("create.setup_project_frame_title")
-          failure_message = context.message("features.argo.initialization_error")
-
-          result = true
-          CLI::UI::Frame.open(frame_title, failure_text: failure_message) do
-            result = js_system.call(
-              yarn: YARN_INITIALIZE_COMMAND + [INITIALIZE_TYPE_PARAMETER % identifier],
-              npm: NPM_INITIALIZE_COMMAND + [INITIALIZE_TYPE_PARAMETER % identifier]
-            )
-          end
-
-          result
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/features/runtimes/admin.rb

@@ -1,29 +0,0 @@
-module Extension
-  module Features
-    module Runtimes
-      class Admin < Base
-        ADMIN_UI_EXTENSIONS_RUN = "@shopify/admin-ui-extensions-run"
-        PRODUCT_SUBSCRIPTION = "PRODUCT_SUBSCRIPTION"
-
-        AVAILABLE_FLAGS = [
-          :api_key,
-          :name,
-          :port,
-          :public_url,
-          :renderer_version,
-          :resource_url,
-          :shop,
-          :uuid,
-        ]
-
-        def available_flags
-          AVAILABLE_FLAGS
-        end
-
-        def active_runtime?(cli_package, identifier)
-          cli_package.name == ADMIN_UI_EXTENSIONS_RUN && identifier == PRODUCT_SUBSCRIPTION
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/features/runtimes/base.rb

@@ -1,19 +0,0 @@
-module Extension
-  module Features
-    module Runtimes
-      class Base
-        def available_flags
-          []
-        end
-
-        def supports?(flag)
-          available_flags.include?(flag)
-        end
-
-        def active_runtime?(cli_package, identifier)
-          raise NotImplementedError
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/features/runtimes/checkout_post_purchase.rb

@@ -1,23 +0,0 @@
-module Extension
-  module Features
-    module Runtimes
-      class CheckoutPostPurchase < Base
-        CHECKOUT_UI_EXTENSIONS_RUN = "@shopify/checkout-ui-extensions-run"
-        CHECKOUT_POST_PURCHASE = "CHECKOUT_POST_PURCHASE"
-
-        AVAILABLE_FLAGS = [
-          :port,
-          :public_url,
-        ]
-
-        def available_flags
-          AVAILABLE_FLAGS
-        end
-
-        def active_runtime?(cli_package, identifier)
-          cli_package.name == CHECKOUT_UI_EXTENSIONS_RUN && identifier == CHECKOUT_POST_PURCHASE
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/features/runtimes/checkout_ui_extension.rb

@@ -1,29 +0,0 @@
-module Extension
-  module Features
-    module Runtimes
-      class CheckoutUiExtension < Base
-        CHECKOUT_UI_EXTENSIONS_RUN = "@shopify/checkout-ui-extensions-run"
-
-        IDENTIFIERS = [
-          "CHECKOUT_ARGO_EXTENSION",
-          "CHECKOUT_UI_EXTENSION",
-        ]
-
-        AVAILABLE_FLAGS = [
-          :port,
-          :public_url,
-          :resource_url,
-          :shop,
-        ]
-
-        def available_flags
-          AVAILABLE_FLAGS
-        end
-
-        def active_runtime?(cli_package, identifier)
-          cli_package.name == CHECKOUT_UI_EXTENSIONS_RUN && IDENTIFIERS.include?(identifier)
-        end
-      end
-    end
-  end
-end