@shopify/cli-kit 3.39.0 → 3.40.1

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

@@ -0,0 +1,28 @@
+# 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/converters/validation_error_converter.rb

@@ -0,0 +1,25 @@
+# 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

@@ -0,0 +1,28 @@
+# 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/create_extension.rb

@@ -0,0 +1,31 @@
+# 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

@@ -0,0 +1,39 @@
+# 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

@@ -0,0 +1,15 @@
+# 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

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Tasks
+    module ExecuteCommands
+      class Build < Base
+        prepend OutdatedExtensionDetection
+
+        property! :config_file_path, accepts: String
+
+        def call
+          ShopifyCLI::Result
+            .call(&method(:merge_server_config))
+            .then { |server_config| Models::DevelopmentServer.new.build(server_config) }
+        end
+
+        private
+
+        def merge_server_config
+          Tasks::MergeServerConfig.call(
+            context: context,
+            file_path: config_file_path,
+            type: type
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Tasks
+    module ExecuteCommands
+      class Create < Base
+        property!  :template, accepts: Models::ServerConfig::Development::VALID_TEMPLATES
+        property!  :root_dir, accepts: String
+
+        def call
+          ShopifyCLI::Result.success(generate_config)
+            .then { |server_config| Models::DevelopmentServer.new.create(server_config) }
+        end
+
+        private
+
+        def generate_config
+          extension = Models::ServerConfig::Extension.build(
+            template: template,
+            type: type,
+            root_dir: root_dir,
+          )
+
+          Models::ServerConfig::Root.new(extensions: [extension])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+module Extension
+  module Tasks
+    module ExecuteCommands
+      module OutdatedExtensionDetection
+        class OutdatedCheck
+          include ShopifyCLI::MethodObject
+
+          property! :type, accepts: Models::DevelopmentServerRequirements.method(:type_supported?)
+          property! :context, accepts: ShopifyCLI::Context
+          property! :project, accepts: ShopifyCLI::Project, default: -> { ShopifyCLI::Project.current }
+
+          def call
+            return false if valid?(parse_package)
+            context.abort(upgrade_instructions)
+          end
+
+          private
+
+          def upgrade_instructions
+            case type
+            when "checkout_ui_extension"
+              context.message("errors.outdated_extensions.checkout_ui_extension")
+            when "product_subscription"
+              context.message("errors.outdated_extensions.product_subscription")
+            when "checkout_post_purchase"
+              context.message("errors.outdated_extensions.checkout_post_purchase")
+            else
+              context.message("errors.outdated_extensions.unknown")
+            end
+          end
+
+          def parse_package
+            File.open(Pathname(project.directory).join("package.json")) do |file|
+              Models::NpmPackage.parse(file)
+            end
+          end
+
+          def valid?(package)
+            case type
+            when "checkout_ui_extension", "product_subscription", "checkout_post_purchase"
+              package.dev_dependency?("@shopify/shopify-cli-extensions") &&
+                package.script?("build") &&
+                package.script?("develop")
+            else
+              true
+            end
+          end
+        end
+
+        def call(*)
+          return super unless Models::DevelopmentServerRequirements.supported?(type)
+          OutdatedCheck.call(type: type, context: context).then { super }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Tasks
+    module ExecuteCommands
+      class Serve < Base
+        prepend OutdatedExtensionDetection
+
+        property! :config_file_path, accepts: String
+        property  :port, accepts: Integer, default: ShopifyCLI::Constants::Extension::DEFAULT_PORT
+        property  :resource_url, accepts: String
+        property! :tunnel_url, accepts: String
+
+        def call
+          ShopifyCLI::Result
+            .call(&method(:merge_server_config))
+            .then { |server_config| Models::DevelopmentServer.new.serve(context, server_config) }
+        end
+
+        private
+
+        def merge_server_config
+          Tasks::MergeServerConfig.call(
+            context: context,
+            file_path: config_file_path,
+            port: port,
+            resource_url: resource_url,
+            tunnel_url: tunnel_url,
+            type: type
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+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/extension/tasks/find_npm_packages.rb

@@ -0,0 +1,106 @@
+module Extension
+  module Tasks
+    class FindNpmPackages
+      include ShopifyCLI::MethodObject
+
+      property! :js_system, accepts: ShopifyCLI::JsSystem
+      property! :production_only, accepts: [true, false], default: false, reader: :production_only?
+
+      def self.at_least_one_of(*package_names, **config)
+        new(**config).at_least_one_of(*package_names)
+      end
+
+      def self.all(*package_names, **config)
+        new(**config).all(*package_names)
+      end
+
+      def self.exactly_one_of(*package_names, **config)
+        new(**config).exactly_one_of(*package_names)
+      end
+
+      def all(*package_names)
+        call(*package_names) do |found_packages|
+          found_package_names = found_packages.map(&:name)
+          next found_packages if Set.new(found_package_names) == Set.new(package_names)
+          raise PackageResolutionFailed, format(
+            "Missing packages: %s",
+            (package_names - found_package_names).join(", ")
+          )
+        end
+      end
+
+      def at_least_one_of(*package_names)
+        call(*package_names) do |found_packages|
+          found_package_names = found_packages.map(&:name)
+          next found_packages unless (found_package_names & package_names).empty?
+          raise PackageResolutionFailed, format(
+            "Expected at least one of the following packages: %s",
+            package_names.join(", ")
+          )
+        end
+      end
+
+      def exactly_one_of(*package_names)
+        call(*package_names) do |found_packages|
+          case found_packages.count
+          when 0
+            raise PackageResolutionFailed, format(
+              "Expected one of the following packages: %s",
+              package_names.join(", ")
+            )
+          when 1
+            found_packages.first.tap do |found_package|
+              next found_package if package_names.include?(found_package.name)
+              raise PackageResolutionFailed, format(
+                "Expected the following package: %s",
+                found_package.name
+              )
+            end
+          else
+            raise PackageResolutionFailed, "Found more than one package"
+          end
+        end
+      end
+
+      def call(*package_names, &validate)
+        validate ||= ->(found_packages) { found_packages }
+
+        unless package_names.all? { |name| name.is_a?(String) }
+          raise ArgumentError, "Expected a list of package names"
+        end
+
+        ShopifyCLI::Result
+          .call(&method(:list_packages))
+          .then(&method(:search_packages).curry[package_names])
+          .then(&method(:filter_duplicates))
+          .then(&validate)
+      end
+
+      def list_packages
+        result, error, status =
+          js_system.call(yarn: yarn_list, npm: npm_list, capture_response: true)
+        raise error unless status.success?
+        result
+      end
+
+      def yarn_list
+        production_only? ? %w[list --production --depth=0] : %w[list]
+      end
+
+      def npm_list
+        production_only? ? %w[list --prod --depth=0] : %w[list]
+      end
+
+      def search_packages(packages, package_list)
+        pattern = /(#{packages.join("|")})@(\d.*)$/
+        package_list.scan(pattern).map do |(name, version)|
+          Models::NpmPackage.new(name: name, version: version.strip)
+        end
+      end
+
+      def filter_duplicates(packages)
+        packages.reject { |p| p.version.match(/deduped/) }.uniq
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+require "json"
+
+module Extension
+  module Tasks
+    class FindPackageFromJson < ShopifyCLI::Task
+      include SmartProperties
+
+      property! :context, accepts: ShopifyCLI::Context
+
+      def self.call(package_name, **config)
+        new(**config).call(package_name)
+      end
+
+      def call(package_name)
+        ShopifyCLI::Result.success(resolve_package_json(package_name))
+          .then { |file| File.read(file) }
+          .then { |file| JSON.parse(file) }
+          .then { |file| file.dig("version") }
+          .then { |version| return Models::NpmPackage.new(name: package_name, version: version) }
+          .unwrap do |error|
+            context.debug(error)
+            context.abort(context.message("errors.module_not_found", package_name))
+          end
+      end
+
+      private
+
+      def resolve_package_json(package_name)
+        path = "path.join(require.resolve('#{package_name}'), '../package.json')"
+        package_json, error, _ = CLI::Kit::System.capture3("node", "-p", path)
+        return error unless !error.nil?
+        package_json.chomp
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Tasks
+    class GetApp < ShopifyCLI::Task
+      GRAPHQL_FILE = "get_app_by_api_key"
+
+      RESPONSE_FIELD = %w(data)
+      APP_FIELD = "app"
+
+      def call(context:, api_key:)
+        input = { api_key: api_key }
+
+        response = ShopifyCLI::PartnersAPI.query(context, GRAPHQL_FILE, **input).dig(*RESPONSE_FIELD)
+        context.abort(context.message("tasks.errors.parse_error")) if response.nil?
+
+        Converters::AppConverter.from_hash(response.dig(APP_FIELD))
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Tasks
+    class GetApps < ShopifyCLI::Task
+      def call(context:)
+        org_id = ShopifyCLI::DB.get(:organization_id)
+        return [] unless org_id
+
+        organization = ShopifyCLI::PartnersAPI::Organizations.fetch_with_apps(context, id: org_id)
+        apps_owned_by_organization(organization)
+      end
+
+      private
+
+      def apps_owned_by_organization(organization)
+        return [] unless organization&.dig("apps")
+
+        organization["apps"].map do |app|
+          Converters::AppConverter.from_hash(app, organization)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Tasks
+    class GetExtensions < ShopifyCLI::Task
+      def call(context:, type:)
+        org_id = ShopifyCLI::DB.get(:organization_id)
+        return [] unless org_id
+
+        organization = ShopifyCLI::PartnersAPI::Organizations.fetch_with_extensions(context, type, id: org_id)
+        return [] unless organization_with_apps?(organization)
+        extensions_owned_by_organization(organization, context: context)
+      end
+
+      private
+
+      def extensions_owned_by_organization(organization, context:)
+        organization["apps"].flat_map do |app|
+          registrations = app["extensionRegistrations"] || []
+          registrations.map do |registration|
+            [Converters::AppConverter.from_hash(app, organization),
+             Converters::RegistrationConverter.from_hash(context, registration)]
+          end
+        end
+      end
+
+      def organization_with_apps?(organization)
+        organization&.key?("apps") && organization["apps"].any?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Tasks
+    class GetProduct < ShopifyCLI::Task
+      API_VERSION = "2021-07"
+      GRAPHQL_FILE = "get_variant_id"
+
+      def call(context, shop)
+        response = ShopifyCLI::AdminAPI.query(
+          context,
+          GRAPHQL_FILE,
+          shop: shop,
+          api_version: API_VERSION
+        )
+        context.abort(context.message("tasks.errors.store_error")) if response.nil?
+        Converters::ProductConverter.from_hash(response)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+require "shopify_cli"
+require "pathname"
+
+module Extension
+  module Tasks
+    class MergeServerConfig
+      include SmartProperties
+
+      property! :context, accepts: ShopifyCLI::Context
+      property! :file_path, accepts: ->(path) { Pathname(path).yield_self(&:absolute?) }
+      property! :port, accepts: Integer, default: ShopifyCLI::Constants::Extension::DEFAULT_PORT
+      property  :resource_url, accepts: String
+      property  :tunnel_url, accepts: String
+      property! :type, accepts: Models::DevelopmentServerRequirements::SUPPORTED_EXTENSION_TYPES
+
+      def self.call(*args)
+        new(*args).call
+      end
+
+      def call
+        config = YAML.load_file(file_path) if File.file?(file_path)
+        config ||= {}
+
+        project = ExtensionProject.current
+        Tasks::ConvertServerConfig.call(
+          api_key: project.env.api_key,
+          context: context,
+          hash: config,
+          registration_uuid: project.registration_uuid,
+          resource_url: resource_url || project.resource_url,
+          store: project.env.shop || "",
+          title: project.title,
+          tunnel_url: tunnel_url,
+          type: type,
+          port: port,
+          metafields: config["metafields"]
+        )
+      rescue Psych::SyntaxError => e
+        raise(
+          ShopifyCLI::Abort,
+          ShopifyCLI::Context.message("core.yaml.error.invalid", file_name, e.message)
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Tasks
+    class UpdateDraft < ShopifyCLI::Task
+      include UserErrors
+
+      GRAPHQL_FILE = "extension_update_draft"
+
+      RESPONSE_FIELD = %w(data extensionUpdateDraft)
+      VERSION_FIELD = "extensionVersion"
+
+      def call(context:, api_key:, registration_id:, config:, extension_context:)
+        input = {
+          api_key: api_key,
+          registration_id: registration_id,
+          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::VersionConverter.from_hash(context, response.dig(VERSION_FIELD))
+      end
+    end
+  end
+end