@shopify/cli-kit 3.69.4 → 3.70.0

package/assets/cli-ruby/lib/project_types/extension/loaders/project.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Loaders
-    module Project
-      def self.load(context:, directory:, api_key:, registration_id:, api_secret:, env: {})
-        env_overrides = {
-          "SHOPIFY_API_KEY" => api_key,
-          "SHOPIFY_API_SECRET" => api_secret,
-          "EXTENSION_ID" => registration_id,
-        }.compact.merge(env)
-
-        env_file_present = env_file_exists?(directory)
-        env = if env_file_present
-          ShopifyCLI::Resources::EnvFile.read(directory, overrides: env_overrides)
-        else
-          ShopifyCLI::Resources::EnvFile.from_hash(env_overrides)
-        end
-        # This is a somewhat uncomfortable hack we use because `Project::at` is
-        # a global cache and we can't rely on this class loading the project
-        # first. Long-term we should move away from that global cache.
-        project = ExtensionProject.at(directory)
-        project.env = env
-        project
-      rescue SmartProperties::InitializationError, SmartProperties::MissingValueError => error
-        handle_error(error, context: context)
-      end
-
-      def self.handle_error(error, context:)
-        if ShopifyCLI::Environment.interactive?
-          properties_hash = { api_key: "SHOPIFY_API_KEY", secret: "SHOPIFY_API_SECRET" }
-          missing_env_variables = error.properties.map { |p| properties_hash[p.name] }.compact.join(", ")
-          message = context.message("errors.missing_env_file_variables", missing_env_variables)
-          message += context.message("errors.missing_env_file_variables_solution", ShopifyCLI::TOOL_NAME)
-        else
-          properties_hash = { api_key: "--api-key", secret: "--api-secret" }
-          missing_options = error.properties.map { |p| properties_hash[p.name] }.compact.join(", ")
-          message = context.message("errors.missing_push_options_ci", missing_options)
-          message += context.message("errors.missing_push_options_ci_solution", ShopifyCLI::TOOL_NAME)
-        end
-        raise ShopifyCLI::Abort,
-          message
-      end
-
-      def self.env_file_exists?(directory)
-        File.exist?(ShopifyCLI::Resources::EnvFile.path(directory))
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/loaders/specification_handler.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Loaders
-    module SpecificationHandler
-      def self.load(project:, context:)
-        identifier = project.specification_identifier
-        Models::LazySpecificationHandler.new(identifier) do
-          specifications = Models::Specifications.new(
-            fetch_specifications: Tasks::FetchSpecifications.new(api_key: project.app.api_key, context: context)
-          )
-
-          unless specifications.valid?(identifier)
-            raise ShopifyCLI::Abort, context.message("errors.unknown_type", project.specification_identifier)
-          end
-
-          specifications[identifier]
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/extension/messages/message_loading.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Messages
-    module MessageLoading
-      def self.load
-        type_specific_messages = load_current_type_messages
-        return Messages::MESSAGES if type_specific_messages.nil?
-
-        if type_specific_messages.key?(:overrides)
-          ShopifyCLI::Utilities.deep_merge(Messages::MESSAGES, type_specific_messages[:overrides])
-        else
-          Messages::MESSAGES
-        end
-      end
-
-      def self.load_current_type_messages
-        return unless ShopifyCLI::Project.has_current?
-        messages_for_type(
-          ShopifyCLI::Project.current.config[Extension::ExtensionProjectKeys::SPECIFICATION_IDENTIFIER_KEY]
-        )
-      end
-
-      def self.messages_for_type(type_identifier)
-        return if type_identifier.nil?
-
-        type_identifier_symbol = type_identifier.downcase.to_sym
-        return unless Messages::TYPES.key?(type_identifier_symbol)
-
-        TYPES[type_identifier_symbol]
-      end
-    end
-  end
-end

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

@@ -1,320 +0,0 @@
-# frozen_string_literal: true
-require "shopify_cli"
-
-module Extension
-  module Messages
-    MESSAGES = {
-      extension: {
-        help: <<~HELP,
-          Suite of commands for developing app extensions. See {{command:%1$s extension <command> --help}} for usage of each command.
-            Usage: {{command:%1$s extension [ %2$s ]}}
-        HELP
-      },
-      create: {
-        help: <<~HELP,
-          Create a new app extension.
-            Usage: {{command:%s extension create <name>}}
-            Options:
-              {{command:--type=TYPE}} The type of extension you would like to create.
-              {{command:--name=NAME}} The name of your extension (50 characters).
-              {{command:--api-key=KEY}} The API key of your app.
-        HELP
-        ask_name: "Extension name",
-        invalid_name: "Extension name must be under %s characters",
-        ask_type: "What type of extension are you creating?",
-        invalid_type: "Extension type is invalid.",
-        setup_project_frame_title: "Initializing project",
-        ready_to_start: <<~MESSAGE,
-          {{v}} A new folder was generated at {{green:./%s}}.
-          {{*}} You’re ready to start building {{green:%s}}!
-          Navigate to the new folder, then run {{command:shopify extension serve}} to start a local server.
-        MESSAGE
-        learn_more: <<~MESSAGE,
-          {{*}} Once you're ready to version and publish your extension,
-          run {{command:shopify extension register}} to register this extension with one of your apps.
-        MESSAGE
-        try_again: "{{*}} Fix the errors and run {{command:shopify extension create}} again.",
-        errors: {
-          directory_exists: "Directory ‘%s’ already exists. Please remove it or choose a new name for your project.",
-        },
-        incomplete_configuration: "Cannot create extension due to missing configuration information",
-        invalid_api_key: "The API key %s does not match any of your apps.",
-        ask_app: "Which app would you like to register this extension with?",
-        no_apps: "{{x}} You don’t have any apps.",
-        learn_about_apps: "{{*}} Learn more about building apps at <https://shopify.dev/apps>, " \
-          "or try creating a new app using {{command:shopify [node|rails] create}}.",
-        loading_apps: "Loading your apps…",
-        no_available_extensions: "{{x}} There are no available extensions for this app.",
-        ask_template: "Select a template to use for your extension",
-      },
-      connect: {
-        connected: "Project now connected to {{green:%s: %s}}",
-        incomplete_configuration: "Cannot connect extension due to missing configuration information",
-        invalid_api_key: "The API key %s does not match any of your apps.",
-        ask_registration: "Which extension would you like to connect to?",
-        loading_extensions: "Loading your extensions…",
-        no_extensions: "{{x}} You don't have any extensions of type %s",
-        learn_about_extensions: "{{*}} Learn more about building extensions at <https://shopify.dev/concepts/apps>, " \
-          "or try creating a new extension using {{command:shopify extension create}}.",
-        help: <<~HELP,
-          {{command:%s extension connect}}: Connects an existing extension to Shopify CLI. Creates a config file.
-            Usage: {{command:%s extension connect}}
-        HELP
-      },
-      build: {
-        help: <<~HELP,
-          Build your extension to prepare for deployment.
-            Usage: {{command:%s extension build}}
-        HELP
-        frame_title: "Building extension with: %s…",
-        build_failure_message: "Failed to build extension code.",
-      },
-      register: {
-        help: <<~HELP,
-          Register your local extension to a Shopify app
-              Usage: {{command:%s extension register}}
-        HELP
-        frame_title: "Registering Extension",
-        waiting_text: "Registering with Shopify…",
-        already_registered: "Extension is already registered.",
-        confirm_info: "This will create a new extension registration for %s, which can’t be undone.",
-        confirm_question: "Would you like to register this extension? (y/n)",
-        confirm_abort: "Extension was not registered.",
-        success: "{{v}} Registered {{green:%s}}.",
-        success_info: "{{*}} Run {{command:shopify extension push}} to push your extension to Shopify.",
-      },
-      push: {
-        help: <<~HELP,
-          Push the current extension to Shopify.
-            Usage: {{command:%s extension push}}
-            Options:
-              {{command:--api-key=API_KEY}} Connect your extension and app by inserting your app's API key (which you can get from your app setup page on shopify.dev).
-              {{command:--extension-id=EXTENSION_ID}} The id of the extension's registration.
-        HELP
-        frame_title: "Pushing your extension to Shopify",
-        waiting_text: "Pushing code to Shopify…",
-        pushed_with_errors: "{{x}} Code pushed to Shopify with errors on %s.",
-        push_with_errors_info: "{{*}} Fix these errors and run {{command:shopify extension push}} to " \
-          "revalidate your extension.",
-        success_confirmation: "{{v}} Pushed {{green:%s}} to a draft on %s.",
-        success_info: "{{*}} Visit %s to version and publish your extension.",
-      },
-      serve: {
-        help: <<~HELP,
-          Serve your extension in a local simulator for development.
-            Usage: {{command:%s extension serve [ ROOT ]}}
-            Options:
-              {{command:-p, --port=PORT}}             Local port of the development serve.
-              {{command:-T, --theme=NAME_OR_ID}}      Theme ID or name of the host theme.
-              {{command:--tunnel=TUNNEL}}             Establish an ngrok tunnel (default: false).
-              {{command:--api-key=API_KEY}}           Connect your extension and app by inserting your app's API key (which you can get from your app setup page on shopify.dev).
-              {{command:--api-secret=API_SECRET}}     The API secret of the app the script is registered with.
-              {{command:--extension-id=EXTENSION_ID}} The id of the extension's registration.
-        HELP
-        frame_title: "Viewing extension…",
-        no_available_ports_found: "No available ports found to run extension.",
-        serve_failure_message: "Failed to run extension code.",
-        serve_missing_information: "Missing shop or api_key.",
-        tunnel_already_running: "A tunnel running on another port has been detected. Close the tunnel and try again.",
-        preview_message: <<~PREVIEW_MESSAGE,
-          Enable your theme app extension:
-          {{green:%s}}
-
-          Setup your theme app extension in the host theme:
-          {{green:%s}}
-
-          Preview your theme app extension:
-          {{green:%s}}
-        PREVIEW_MESSAGE
-        preview_message_1p: <<~PREVIEW_MESSAGE,
-          Access Shopify Organization:
-          {{green:%s}}
-
-          Enable your theme app extension:
-          {{green:%s}}
-
-          Setup your theme app extension in the host theme:
-          {{green:%s}}
-
-          Preview your theme app extension:
-          {{green:%s}}
-        PREVIEW_MESSAGE
-        preview_message_unified: <<~PREVIEW_MESSAGE,
-          Setup your theme app extension in the host theme:
-          {{green:%s}}
-
-          Preview your theme app extension:
-          {{green:%s}}
-        PREVIEW_MESSAGE
-        preview_message_1p_unified: <<~PREVIEW_MESSAGE,
-          Access Shopify Organization:
-            {{green:%s}}
-
-          Setup your theme app extension in the host theme:
-          {{green:%s}}
-
-          Preview your theme app extension:
-          {{green:%s}}
-        PREVIEW_MESSAGE
-      },
-      tunnel: {
-        duplicate_session: <<~MESSAGE,
-          Another ngrok tunnel is currently running with your auth token, possibly on another machine.
-
-          Terminate that tunnel before opening a new one.
-        MESSAGE
-        invalid_token: <<~MESSAGE,
-          The ngrok token currently configured is invalid.
-
-          After generating a new token, update your local ngrok configuration using {{command:shopify app tunnel auth <token>}}
-        MESSAGE
-        missing_token: "{{x}} {{red:auth requires a token argument}}. "\
-          "Find it on your ngrok dashboard: {{underline:https://dashboard.ngrok.com/auth/your-authtoken}}.",
-        invalid_port: "%s is not a valid port.",
-        no_tunnel_running: "No tunnel running.",
-        tunnel_running_at: "Tunnel running at: {{underline:%s}}",
-        help: <<~HELP,
-          Start or stop an http tunnel to your local development extension using ngrok.
-            Usage: {{command:%s extension tunnel [ auth | start | stop | status ]}}
-        HELP
-        extended_help: <<~HELP,
-          {{bold:Subcommands:}}
-
-            {{cyan:auth}}: Writes an ngrok auth token to ~/.ngrok2/ngrok.yml to connect with an ngrok account.
-            Visit https://dashboard.ngrok.com/signup to sign up.
-              Usage: {{command:%1$s extension tunnel auth <token>}}
-
-            {{cyan:start}}: Starts an ngrok tunnel, will print the URL for an existing tunnel if already running.
-              Usage: {{command:%1$s extension tunnel start}}
-              Options:
-              {{command:--port=PORT}} Forward the ngrok subdomain to local port PORT. Defaults to %2$s.
-
-            {{cyan:stop}}: Stops the ngrok tunnel.
-              Usage: {{command:%1$s extension tunnel stop}}
-
-            {{cyan:status}}: Output the current status of the ngrok tunnel.
-              Usage: {{command:%1$s extension tunnel status}}
-        HELP
-      },
-      check: {
-        help: "Check your extension for errors, suggestions, and best practices.",
-        unsupported: "{{red:%s projects are not supported for `extension check`}}",
-      },
-      features: {
-        argo: {
-          missing_file_error: "Could not find built extension file.",
-          script_prepare_error: "An error occurred while attempting to prepare your script.",
-          initialization_error: "{{x}} There was an error while initializing the project.",
-          dependencies: {
-            node: {
-              node_not_installed: "Node must be installed to create this extension.",
-              version_too_low: "Your node version %s does not meet the minimum required version %s",
-            },
-            argo_missing_renderer_package_error: "Extension template references invalid renderer package "\
-              "please contact Shopify for help.",
-            yarn_install_error: "Something went wrong while running 'yarn install'. %s.",
-            yarn_run_script_error: "Something went wrong while running script. %s.",
-          },
-          config: {
-            unpermitted_keys: "`%s` contains the following unpermitted keys: %s",
-          },
-        },
-      },
-      tasks: {
-        errors: {
-          parse_error: "Unable to parse response from Partners Dashboard.",
-          store_error: "There was an error getting store data. Try again later.",
-        },
-      },
-      errors: {
-        unknown_type: "Unknown extension type %s. Valid extension types include: CHECKOUT_POST_PURCHASE, " \
-        "THEME_APP_EXTENSION, and PRODUCT_SUBSCRIPTION.",
-        package_not_found: "`%s` package not found.",
-        missing_push_options_ci: "The following are missing: %s. ",
-        missing_push_options_ci_solution: "To add them to a CI environment:\n\t1. Run a connect command " \
-        "({{command:%1$s extension connect}})\n\t2. Navigate to the .env file at the root of your project\n\t" \
-            "3. Copy the missing values and pass them through as arguments in {{command:%1$s extension push}}",
-        missing_env_file_variables: "The following are missing in the .env file: %s. ",
-        missing_env_file_variables_solution: "To add it, connect your extension with " \
-        "{{command:%1$s extension connect}} " \
-        "or run {{command:%1$s extension register}} to register a new extension.",
-        module_not_found: "Unable to find module %s. Ensure your dependencies are up-to-date and try again.",
-        development_server_binary_not_found: {
-          title: "Development Server Binary Missing",
-          message: <<~ERROR,
-            The extension development server binary could not be found!
-
-            If you're running a development version of the CLI, please run `rake extensions:install` to install it.
-            Otherwise, please file a bug report via https://github.com/Shopify/cli/issues/new.
-          ERROR
-        },
-        outdated_extensions: {
-          unknown: <<~TEXT.strip,
-            Please refer to the documentation for more information on how to upgrade your extension:
-            https://shopify.dev/apps/app-extensions
-          TEXT
-          checkout_ui_extension: <<~TEXT.strip,
-            Please update your package.json as follows:
-            * Replace the development dependency @shopify/checkout-ui-extensions-run
-              with @shopify/shopify-cli-extensions
-            * Remove the start and server script
-            * Add a develop script: shopify-cli-extensions develop
-            * Change the build script to: shopify-cli-extensions build
-          TEXT
-          product_subscription: <<~TEXT.strip,
-            Please update your package.json as follows:
-            * Replace the development dependency @shopify/admin-ui-extensions-run
-              with @shopify/shopify-cli-extensions
-            * Remove the start and server script
-            * Add a develop script: shopify-cli-extensions develop
-            * Change the build script to: shopify-cli-extensions build
-          TEXT
-          checkout_post_purchase: <<~TEXT.strip,
-            Please update your package.json as follows:
-            * Replace the development dependency @shopify/checkout-ui-extensions-run
-              with @shopify/shopify-cli-extensions
-            * Remove the start and server script
-            * Add a develop script: shopify-cli-extensions develop
-            * Change the build script to: shopify-cli-extensions build
-          TEXT
-        },
-      },
-      warnings: {
-        resource_url_auto_generation_failed: "{{*}} {{yellow:Warning:}} Unable to auto generate " \
-        "the extension resource URL because %s does not have any products. " \
-        "Please run {{bold:shopify populate products}} to generate sample products.",
-      },
-    }
-
-    TYPES = {
-      product_subscription: {
-        name: "Product Subscription",
-        tagline: "(limit 1 per app)",
-        overrides: {
-          register: {
-            confirm_info: "You can only create one %s extension per app, which can’t be undone.",
-          },
-        },
-      },
-      checkout_post_purchase: {
-        name: "Checkout Post Purchase",
-      },
-      theme_app_extension: {
-        name: "Theme App Extension",
-        tagline: "(limit 1 per app)",
-        overrides: {
-          register: {
-            confirm_info: "You can only create one %s extension per app, which can’t be undone.",
-          },
-          create: {
-            ready_to_start: <<~MESSAGE,
-              {{v}} A new folder was generated at {{green:./%s}}.
-              {{*}} You’re ready to start building {{green:%s}}!
-            MESSAGE
-          },
-
-        },
-      },
-    }
-  end
-end

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

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Models
-    class App
-      include SmartProperties
-
-      property! :api_key, accepts: String
-      property :secret, accepts: String
-      property :title, accepts: String
-      property :business_name, accepts: String
-    end
-  end
-end

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

@@ -1,12 +0,0 @@
-module Extension
-  module Models
-    class LazySpecificationHandler < ShopifyCLI::LazyDelegator
-      attr_reader :identifier
-
-      def initialize(identifier, &specification_handler_initializer)
-        super(&specification_handler_initializer)
-        @identifier = identifier
-      end
-    end
-  end
-end

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

@@ -1,41 +0,0 @@
-module Extension
-  module Models
-    class Specification
-      include SmartProperties
-
-      module Features
-        class Argo
-          include SmartProperties
-
-          property! :surface, converts: :to_str
-          property! :renderer_package_name, converts: :to_str
-          property! :git_template, converts: :to_str
-          property! :required_fields, accepts: Array, default: -> { [] }
-          property! :required_shop_beta_flags, accepts: Array, default: -> { [] }
-          property! :cli_package_name, accepts: String, converts: :to_str, default: ""
-        end
-
-        def self.build(feature_set_attributes)
-          feature_set_attributes.each_with_object(OpenStruct.new) do |(identifier, feature_attributes), feature_set|
-            next if feature_attributes.nil?
-            feature_set[identifier] = ShopifyCLI::ResolveConstant
-              .call(identifier, namespace: Features)
-              .rescue { OpenStruct }
-              .then { |c| c.new(**feature_attributes) }
-              .unwrap { |error| raise(error) }
-          end
-        end
-      end
-
-      property! :identifier
-      property :name, converts: :to_str
-      property :graphql_identifier, converts: :to_str
-      property! :features, converts: Features.method(:build), default: -> { [] }
-      property! :options, converts: ->(options) { OpenStruct.new(options) }, default: -> { OpenStruct.new }
-
-      def graphql_identifier
-        super || identifier
-      end
-    end
-  end
-end

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

@@ -1,145 +0,0 @@
-# frozen_string_literal: true
-
-module Extension
-  module Models
-    module SpecificationHandlers
-      class Default
-        attr_reader :specification
-
-        def initialize(specification)
-          @specification = specification
-        end
-
-        def identifier
-          specification.identifier.to_s.upcase
-        end
-
-        def graphql_identifier
-          specification.graphql_identifier.to_s.upcase
-        end
-
-        def name
-          message("name") || specification.name
-        end
-
-        def tagline
-          message("tagline") || ""
-        end
-
-        def config(context)
-          argo.config(context)
-        end
-
-        def create(directory_name, context, **_args)
-          argo.create(directory_name, identifier, context)
-        end
-
-        def extension_context(_context)
-          nil
-        end
-
-        def valid_extension_contexts
-          []
-        end
-
-        def choose_port?(context)
-          return true if supports_development_server?
-          argo_runtime(context).supports?(:port)
-        end
-
-        def establish_tunnel?(context)
-          return true if supports_development_server?
-          argo_runtime(context).supports?(:public_url)
-        end
-
-        def serve(**options)
-          context = options[:context]
-          port = options[:port]
-          tunnel_url = options[:tunnel_url]
-          resource_url = options[:resource_url]
-
-          Features::ArgoServe.new(
-            specification_handler: self,
-            argo_runtime: argo_runtime(context),
-            context: context,
-            port: port,
-            tunnel_url: tunnel_url,
-            resource_url: resource_url
-          ).call
-        end
-
-        def renderer_package(context)
-          argo.renderer_package(context)
-        end
-
-        def argo_runtime(context)
-          return if supports_development_server?
-
-          @argo_runtime ||= Features::ArgoRuntime.find(
-            cli_package: cli_package(context),
-            identifier: identifier
-          )
-        end
-
-        def cli_package(context)
-          cli_package_name = specification.features.argo&.cli_package_name
-          return unless cli_package_name
-
-          js_system = ShopifyCLI::JsSystem.new(ctx: context)
-          Tasks::FindNpmPackages.exactly_one_of(cli_package_name, js_system: js_system)
-            .unwrap { |_e| context.abort(context.message("errors.package_not_found", cli_package_name)) }
-        end
-
-        def message_for_extension(key, *params)
-          override_key = "overrides.#{key}"
-          key_parts = override_key.split(".").map(&:to_sym)
-          if (str = messages.dig(*key_parts))
-            str % params
-          else
-            ShopifyCLI::Context.message(key, *params)
-          end
-        end
-
-        def supplies_resource_url?
-          false
-        end
-
-        def build_resource_url(shop)
-          raise NotImplementedError
-        end
-
-        def server_config_path(base_dir = Dir.pwd)
-          File.join(base_dir, server_config_file)
-        end
-
-        def server_config_file
-          "extension.config.yml"
-        end
-
-        protected
-
-        def argo
-          Features::Argo.new(
-            git_template: specification.features.argo.git_template,
-            renderer_package_name: specification.features.argo.renderer_package_name
-          )
-        end
-
-        private
-
-        def message(key, *params)
-          return unless messages.key?(key.to_sym)
-          messages[key.to_sym] % params
-        end
-
-        def messages
-          @messages ||= Messages::TYPES[identifier.downcase.to_sym] || {}
-        end
-
-        def supports_development_server?
-          Models::DevelopmentServerRequirements.supported?(identifier)
-        end
-      end
-    end
-  end
-end