shopify-cli 1.11.0 → 2.0.0

data/lib/project_types/extension/forms/connect.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Extension
+  module Forms
+    class Connect < ShopifyCli::Form
+      attr_reader :registration, :app
+
+      flag_arguments :type
+
+      class ExtensionProjectDetails
+        include SmartProperties
+
+        property :registration, accepts: Models::Registration
+        property :app, accepts: Models::App
+
+        def complete?
+          !!(registration && app)
+        end
+      end
+
+      def ask
+        ShopifyCli::Result.wrap(ExtensionProjectDetails.new)
+          .then(&Questions::AskRegistration.new(ctx: ctx, type: type))
+          .unwrap { |e| raise e }
+          .tap do |project_details|
+            ctx.abort(ctx.message("connect.incomplete_configuration")) unless project_details.complete?
+
+            self.registration = project_details.registration
+            self.app = project_details.app
+          end
+      end
+
+      def directory_name
+        name.strip.gsub(/( )/, "_").downcase
+      end
+
+      private
+
+      attr_writer :registration, :app
+    end
+  end
+end

data/lib/project_types/extension/forms/questions/ask_name.rb

@@ -11,17 +11,25 @@ module Extension
           default: -> { CLI::UI::Prompt.method(:ask) }
 
         def call(project_details)
-          project_details.name = ask_with_reprompt(
-            initial_value: name,
-            break_condition: -> (current_name) { Models::Registration.valid_title?(current_name) },
-            prompt_message: ctx.message("create.ask_name"),
-            reprompt_message: ctx.message("create.invalid_name", Models::Registration::MAX_TITLE_LENGTH)
-          )
+          if theme_app_extension?(project_details)
+            project_details.name = name || "theme-app-extension"
+          else
+            project_details.name = ask_with_reprompt(
+              initial_value: name,
+              break_condition: -> (current_name) { Models::Registration.valid_title?(current_name) },
+              prompt_message: ctx.message("create.ask_name"),
+              reprompt_message: ctx.message("create.invalid_name", Models::Registration::MAX_TITLE_LENGTH)
+            )
+          end
           project_details
         end
 
         private
 
+        def theme_app_extension?(project_details)
+          project_details&.type&.identifier == "THEME_APP_EXTENSION"
+        end
+
         def ask_with_reprompt(initial_value:, break_condition:, prompt_message:, reprompt_message:)
           value = initial_value
           reprompt = false

data/lib/project_types/extension/forms/questions/ask_registration.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Extension
+  module Forms
+    module Questions
+      class AskRegistration
+        include ShopifyCli::MethodObject
+
+        property! :ctx
+        property! :type
+        property! :prompt,
+          converts: :to_proc,
+          default: -> { CLI::UI::Prompt.method(:ask) }
+
+        def call(project_details)
+          project_details.tap(&method(:prompt_for_registration))
+        end
+
+        private
+
+        def prompt_for_registration(project_details)
+          apps_and_registrations = load_registrations(type)
+          app, registration = choose_interactively(apps_and_registrations)
+          project_details.app = app
+          project_details.registration = registration
+        end
+
+        def choose_interactively(apps_and_registrations)
+          prompt.call(ctx.message("connect.ask_registration")) do |handler|
+            apps_and_registrations.each do |(app, extension)|
+              handler.option("#{app.title} by #{app.business_name}: #{extension.title}") { [app, extension] }
+            end
+          end
+        end
+
+        def load_registrations(type)
+          ctx.puts(@ctx.message("connect.loading_extensions"))
+          registrations = Tasks::GetExtensions.call(context: ctx, type: type)
+
+          registrations.empty? ? abort_no_registrations : registrations
+        end
+
+        def abort_no_registrations
+          ctx.puts(@ctx.message("connect.no_extensions", type))
+          ctx.puts(@ctx.message("connect.learn_about_extensions"))
+          raise ShopifyCli::AbortSilent
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/messages/messages.rb

@@ -4,7 +4,21 @@ 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?",
@@ -13,13 +27,13 @@ module Extension
         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 serve}} to start a local server.
+          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 register}} to register this extension with one of your apps.
+          run {{command:shopify extension register}} to register this extension with one of your apps.
         MESSAGE
-        try_again: "{{*}} Fix the errors and run {{command:shopify create extension}} again.",
+        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.",
         },
@@ -28,15 +42,39 @@ module Extension
         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/concepts/apps>, " \
-          "or try creating a new app using {{command:shopify create}}.",
+          "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.",
       },
+      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}}
+              Options:
+                {{command:--api-key=API_KEY}} The API key used to register an app with the extension. This can be found on the app page on Partners Dashboard.
+        HELP
         frame_title: "Registering Extension",
         waiting_text: "Registering with Shopify...",
         already_registered: "Extension is already registered.",
@@ -44,17 +82,28 @@ module Extension
         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 push}} to push your extension to Shopify.",
+        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}}
+        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 push}} to revalidate your extension.",
+        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}}
+            Options:
+            {{command:--tunnel=TUNNEL}} Establish an ngrok tunnel (default: false)
+        HELP
         frame_title: "Serving extension...",
         no_available_ports_found: "No available ports found to run extension.",
         serve_failure_message: "Failed to run extension code.",
@@ -69,25 +118,25 @@ module Extension
         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 tunnel [ auth | start | stop | status ]}}
+            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 tunnel auth <token>}}
+              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 tunnel start}}
+              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 tunnel stop}}
+              Usage: {{command:%1$s extension tunnel stop}}
 
             {{cyan:status}}: Output the current status of the ngrok tunnel.
-              Usage: {{command:%1$s tunnel status}}
+              Usage: {{command:%1$s extension tunnel status}}
         HELP
       },
       features: {
@@ -134,6 +183,21 @@ module Extension
       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

data/lib/project_types/extension/models/specification.rb

@@ -17,6 +17,7 @@ module Extension
 
         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 }

data/lib/project_types/extension/models/specification_handlers/{checkout_argo_extension.rb → checkout_ui_extension.rb}

@@ -3,7 +3,7 @@
 module Extension
   module Models
     module SpecificationHandlers
-      class CheckoutArgoExtension < Default
+      class CheckoutUiExtension < Default
         PERMITTED_CONFIG_KEYS = [:metafields, :extension_points]
 
         def config(context)
@@ -13,6 +13,8 @@ module Extension
           }
         end
       end
+
+      CheckoutArgoExtension = CheckoutUiExtension
     end
   end
 end

data/lib/project_types/extension/models/specification_handlers/default.rb

@@ -30,7 +30,7 @@ module Extension
           argo.config(context)
         end
 
-        def create(directory_name, context)
+        def create(directory_name, context, **_args)
           argo.create(directory_name, identifier, context)
         end
 
@@ -43,16 +43,21 @@ module Extension
         end
 
         def choose_port?(context)
-          argo_runtime(context).accepts_port?
+          argo_runtime(context).supports?(:port)
         end
 
         def establish_tunnel?(context)
-          argo_runtime(context).accepts_tunnel_url?
+          argo_runtime(context).supports?(:public_url)
         end
 
         def serve(context:, port:, tunnel_url:)
-          Features::ArgoServe.new(specification_handler: self, argo_runtime: argo_runtime(context),
-          context: context, port: port, tunnel_url: tunnel_url).call
+          Features::ArgoServe.new(
+            specification_handler: self,
+            argo_runtime: argo_runtime(context),
+            context: context,
+            port: port,
+            tunnel_url: tunnel_url,
+          ).call
         end
 
         def renderer_package(context)
@@ -62,7 +67,7 @@ module Extension
         def argo_runtime(context)
           @argo_runtime ||= Features::ArgoRuntime.new(
             renderer: renderer_package(context),
-            cli: cli_package(context)
+            cli: cli_package(context),
           )
         end
 
@@ -75,6 +80,16 @@ module Extension
             .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
+
         protected
 
         def argo

data/lib/project_types/extension/models/specification_handlers/theme_app_extension.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+require "base64"
+require "json"
+
+module Extension
+  module Models
+    module SpecificationHandlers
+      class ThemeAppExtension < Default
+        SUPPORTED_BUCKETS = %w(assets blocks snippets)
+        BUNDLE_SIZE_LIMIT = 10 * 1024 * 1024 # 10MB
+        LIQUID_SIZE_LIMIT = 100 * 1024 # 100kb
+        SUPPORTED_ASSET_EXTS = %w(.jpg .js .css .png .svg)
+
+        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)
+          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"
+                  current_liquid_size += File.size(filename)
+                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
+
+        private
+
+        def validate(filename)
+          dirname = File.dirname(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 ext != ".liquid"
+            raise Extension::Errors::InvalidFilenameError,
+              "Invalid filename: #{filename}; Only .liquid allowed in #{dirname}"
+          end
+          true
+        end
+      end
+    end
+  end
+end