shopify-cli 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3355ade46f06f8fad98098842f7b68bb0a154a53921a498ca4aba18379512ff6
-  data.tar.gz: 57617469febb8905d737a9991f4da4a578e0f87bc8cad17bfc3d674e28cd40c2
+  metadata.gz: 2311f814efc977b70f6a1e4541e4e7a2daf627a900397a08d1868eaedbd17ba8
+  data.tar.gz: be52f7301fcdd6f8ab377209dc50d587bbf9bfcbd7f7cc461fba702c59a1620f
 SHA512:
-  metadata.gz: a71cd8e3f4f9409f0c527ab6da9152e592d7cd1be173d9fe4e1499713998cf245541504151a1e63fa5901cf0c83b1d41302bc6628defff86042908b5e63d37af
-  data.tar.gz: 2d16c25b44bd21abbcd154abd0ff5d3b3e9e464b7c89377b523299855800cd65bf3357d89b3d92d8a66137e8316d64de755263a1bc21f30df1c5ad3b8e492492
+  metadata.gz: 8c1a078a7e1a78d8616fd6f0ff3dfdf52a635a756f62eb897d8a14da59ba14162a9c83e4f0384ea5ad240efaf649b3f55812b345a9a334ca9de713730d6e1c0f
+  data.tar.gz: f8d4cd3489a73d5ea9fe29f57b4687cecaf60ed3440334c2b85e726ac18621036968f8141e5dc0fe91ef2995000cf77ccf7025d3667a27c6b77c83b704690b61

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+Version 1.0.3
+------
+* Fix a bug which causes an error in the `populate` and `generate` commands when prompting for the shop name
+
 Version 1.0.2
 ------
 * Fix missing shop parameter to AdminAPI.query() call (impacting populate and generate commands)

data/lib/project_types/extension/cli.rb

@@ -2,7 +2,7 @@
 
 module Extension
   class Project < ShopifyCli::ProjectType
-    hidden_project_type
+    hidden_feature
     creator 'App Extension', 'Extension::Commands::Create'
 
     register_command('Extension::Commands::Build', "build")

data/lib/project_types/extension/commands/build.rb

@@ -4,7 +4,7 @@ require 'shopify_cli'
 module Extension
   module Commands
     class Build < ExtensionCommand
-      hidden_command
+      hidden_feature
 
       YARN_BUILD_COMMAND = %w(build)
       NPM_BUILD_COMMAND = %w(run-script build)

data/lib/project_types/rails/cli.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 module Rails
   class Project < ShopifyCli::ProjectType
-    # hidden_project_type
     creator 'Ruby on Rails App', 'Rails::Commands::Create'
 
     register_command('Rails::Commands::Deploy', "deploy")

data/lib/project_types/script/cli.rb

@@ -2,7 +2,7 @@
 
 module Script
   class Project < ShopifyCli::ProjectType
-    hidden_project_type
+    hidden_feature(feature_set: :script_project)
     creator 'Script', 'Script::Commands::Create'
 
     register_command('Script::Commands::Push', 'push')
@@ -24,8 +24,6 @@ module Script
   # define/autoload project specific Forms
   module Forms
     autoload :Create, Project.project_filepath('forms/create')
-    autoload :Push, Project.project_filepath('forms/push')
-    autoload :Enable, Project.project_filepath('forms/enable')
     autoload :ScriptForm, Project.project_filepath('forms/script_form')
   end
 
@@ -66,6 +64,7 @@ module Script
 
   module UI
     autoload :ErrorHandler, Project.project_filepath('ui/error_handler')
+    autoload :PrintingSpinner, Project.project_filepath('ui/printing_spinner')
     autoload :StrictSpinner, Project.project_filepath('ui/strict_spinner')
   end
 

data/lib/project_types/script/commands/create.rb

@@ -19,15 +19,15 @@ module Script
           return @ctx.puts(self.class.help)
         end
 
-        Layers::Application::CreateScript.call(
+        project = Layers::Application::CreateScript.call(
           ctx: @ctx,
           language: language,
           script_name: form.name,
           extension_point_type: form.extension_point
         )
-        project = ScriptProject.current
-        @ctx.puts(@ctx.message('script.create.script_path', folder: project.script_name))
-        @ctx.puts(@ctx.message('script.create.script_created', script_id: project.source_file))
+        @ctx.puts(@ctx.message('script.create.change_directory_notice', project.script_name))
+      rescue Script::Errors::ScriptProjectAlreadyExistsError => e
+        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message('script.create.error.operation_failed'))
       rescue StandardError => e
         ScriptProject.cleanup(ctx: @ctx, script_name: form.name, root_dir: cur_dir) if form
         UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message('script.create.error.operation_failed'))

data/lib/project_types/script/commands/disable.rb

@@ -3,20 +3,14 @@
 module Script
   module Commands
     class Disable < ShopifyCli::Command
-      options do |parser, flags|
-        parser.on('--api_key=APIKEY') { |t| flags[:api_key] = t }
-        parser.on('--shop_domain=MYSHOPIFYDOMAIN') { |t| flags[:shop_domain] = t }
-      end
-
-      def call(args, _name)
-        form = Forms::Enable.ask(@ctx, args, options.flags)
-        return @ctx.puts(self.class.help) unless form
+      prerequisite_task :ensure_env
 
+      def call(_args, _name)
         project = ScriptProject.current
         Layers::Application::DisableScript.call(
           ctx: @ctx,
-          api_key: form.api_key,
-          shop_domain: form.shop_domain,
+          api_key: project.env[:api_key],
+          shop_domain: project.env[:shop],
           extension_point_type: project.extension_point_type
         )
         @ctx.puts(@ctx.message('script.disable.script_disabled'))
@@ -27,10 +21,6 @@ module Script
       def self.help
         ShopifyCli::Context.message('script.disable.help', ShopifyCli::TOOL_NAME)
       end
-
-      def self.extended_help
-        ShopifyCli::Context.message('script.disable.extended_help', ShopifyCli::TOOL_NAME)
-      end
     end
   end
 end

data/lib/project_types/script/commands/enable.rb

@@ -3,29 +3,31 @@
 module Script
   module Commands
     class Enable < ShopifyCli::Command
+      prerequisite_task :ensure_env
       options do |parser, flags|
-        parser.on('--api_key=APIKEY') { |t| flags[:api_key] = t }
-        parser.on('--shop_domain=MYSHOPIFYDOMAIN') { |t| flags[:shop_domain] = t }
+        parser.on('--config_props=KEYVALUEPAIRS', Array) do |t|
+          flags[:config_props] = Hash[t.map { |s| s.split(':') }]
+        end
+        parser.on('--config_file=CONFIGFILEPATH') { |t| flags[:config_file] = t }
       end
 
-      def call(args, _name)
-        form = Forms::Enable.ask(@ctx, args, options.flags)
-        return @ctx.puts(self.class.help) unless form
-
+      def call(_args, _name)
         project = ScriptProject.current
+        api_key = project.env[:api_key]
+        shop_domain = project.env[:shop]
 
         Layers::Application::EnableScript.call(
           ctx: @ctx,
-          api_key: form.api_key,
-          shop_domain: form.shop_domain,
-          configuration: { entries: [] },
+          api_key: api_key,
+          shop_domain: shop_domain,
+          configuration: acquire_configuration(**slice(options.flags, :config_file, :config_props)),
           extension_point_type: project.extension_point_type,
           title: project.script_name
         )
         @ctx.puts(@ctx.message(
           'script.enable.script_enabled',
-          api_key: form.api_key,
-          shop_domain: form.shop_domain,
+          api_key: api_key,
+          shop_domain: shop_domain,
           type: project.extension_point_type.capitalize,
           title: project.script_name
         ))
@@ -41,6 +43,28 @@ module Script
       def self.extended_help
         ShopifyCli::Context.message('script.enable.extended_help', ShopifyCli::TOOL_NAME)
       end
+
+      private
+
+      def acquire_configuration(config_file: nil, config_props: nil)
+        properties = {}
+        properties = YAML.load(File.read(config_file)) unless config_file.nil?
+        properties = properties.merge(config_props) unless config_props.nil?
+
+        configuration = { entries: [] }
+        properties.each do |key, value|
+          configuration[:entries].push({
+            key: key,
+            value: value,
+          })
+        end
+        configuration
+      end
+
+      # No slice pre Ruby 2.5 so roll our own
+      def slice(hash, *keys)
+        Hash[hash.to_a - hash.select { |key, _value| !keys.include?(key) }.to_a]
+      end
     end
   end
 end

data/lib/project_types/script/commands/push.rb

@@ -3,27 +3,27 @@
 module Script
   module Commands
     class Push < ShopifyCli::Command
+      prerequisite_task :ensure_env
+
       options do |parser, flags|
-        parser.on('--api_key=APIKEY') { |t| flags[:api_key] = t }
         parser.on('--force') { |t| flags[:force] = t }
       end
 
-      def call(args, _name)
-        form = Forms::Push.ask(@ctx, args, options.flags)
+      def call(_args, _name)
         project = ScriptProject.current
-
-        return @ctx.puts(self.class.help) unless form && ScriptProject::SUPPORTED_LANGUAGES.include?(project.language)
-
+        api_key = project.env[:api_key]
+        return @ctx.puts(self.class.help) unless api_key &&
+          ScriptProject::SUPPORTED_LANGUAGES.include?(project.language)
         Layers::Application::PushScript.call(
           ctx: @ctx,
           language: project.language,
           extension_point_type: project.extension_point_type,
           script_name: project.script_name,
           source_file: project.source_file,
-          api_key: form.api_key,
-          force: form.force
+          api_key: api_key,
+          force: options.flags.key?(:force)
         )
-        @ctx.puts(@ctx.message('script.push.script_pushed', api_key: form.api_key))
+        @ctx.puts(@ctx.message('script.push.script_pushed', api_key: api_key))
       rescue StandardError => e
         UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message('script.push.error.operation_failed'))
       end

data/lib/project_types/script/config/extension_points.yml

@@ -1,18 +1,24 @@
 discount:
   assemblyscript:
     package: "@shopify/extension-point-as-discount"
-    version: "^0.2.3"
+    version: "^0.2.4"
     sdk-version: "^6.0.0"
     toolchain-version: "^1.1.0"
 unit_limit_per_order:
   assemblyscript:
     package: "@shopify/extension-point-as-unit-limit-per-order"
-    version: "^0.1.4"
+    version: "^0.1.6"
     sdk-version: "^6.0.0"
     toolchain-version: "^1.1.0"
 payment_filter:
   assemblyscript:
     package: "@shopify/extension-point-as-payment-filter"
-    version: "^0.2.1"
+    version: "^0.2.2"
+    sdk-version: "^6.0.0"
+    toolchain-version: "^1.1.0"
+shipping_filter:
+  assemblyscript:
+    package: "@shopify/extension-point-as-shipping-filter"
+    version: "^0.2.4"
     sdk-version: "^6.0.0"
     toolchain-version: "^1.1.0"

data/lib/project_types/script/forms/script_form.rb

@@ -11,8 +11,11 @@ module Script
 
       def organizations
         return @organizations if defined?(@organizations)
-        ctx.puts(ctx.message('script.forms.script_form.fetching_organizations'))
-        @organizations = ShopifyCli::PartnersAPI::Organizations.fetch_with_app(ctx)
+        UI::PrintingSpinner.spin(ctx, ctx.message('script.forms.script_form.fetching_organizations')) do |ctx, spinner|
+          @organizations = ShopifyCli::PartnersAPI::Organizations.fetch_with_app(ctx)
+          spinner.update_title(ctx.message('script.forms.script_form.fetched_organizations'))
+        end
+        @organizations
       end
 
       def ask_app_api_key(apps, message: ctx.message('script.forms.script_form.ask_app_api_key_default'))

data/lib/project_types/script/layers/application/create_script.rb

@@ -12,8 +12,9 @@ module Script
             project = setup_project(ctx, script_name, extension_point)
             project_creator = Infrastructure::ProjectCreator
               .for(ctx, language, extension_point, script_name, project.directory)
-            install_dependencies(ctx, language, script_name, project, project_creator)
-            bootstrap(ctx, project_creator)
+            install_dependencies(ctx, language, script_name, project.source_file, project_creator)
+            bootstrap(ctx, project.source_path, project_creator)
+            project
           end
 
           private
@@ -30,16 +31,16 @@ module Script
             ScriptProject.current
           end
 
-          def install_dependencies(ctx, language, script_name, project, project_creator)
-            task_runner = Infrastructure::TaskRunner.for(ctx, language, script_name, project.source_file)
+          def install_dependencies(ctx, language, script_name, source_file, project_creator)
+            task_runner = Infrastructure::TaskRunner.for(ctx, language, script_name, source_file)
             project_creator.setup_dependencies
             ProjectDependencies.install(ctx: ctx, task_runner: task_runner)
           end
 
-          def bootstrap(ctx, project_creator)
+          def bootstrap(ctx, source_path, project_creator)
             UI::StrictSpinner.spin(ctx.message('script.create.creating')) do |spinner|
               project_creator.bootstrap
-              spinner.update_title(ctx.message('script.create.created'))
+              spinner.update_title(ctx.message('script.create.created', source_path))
             end
           end
         end

data/lib/project_types/script/layers/application/disable_script.rb

@@ -5,13 +5,15 @@ module Script
     module Application
       class DisableScript
         def self.call(ctx:, api_key:, shop_domain:, extension_point_type:)
-          script_service = Infrastructure::ScriptService.new(ctx: ctx)
-          script_service.disable(
-            api_key: api_key,
-            shop_domain: shop_domain,
-            extension_point_type: extension_point_type,
-          )
-          ctx.puts(ctx.message('script.application.disabled'))
+          UI::PrintingSpinner.spin(ctx, ctx.message('script.application.disabling')) do |p_ctx, spinner|
+            script_service = Infrastructure::ScriptService.new(ctx: p_ctx)
+            script_service.disable(
+              api_key: api_key,
+              shop_domain: shop_domain,
+              extension_point_type: extension_point_type,
+            )
+            spinner.update_title(p_ctx.message('script.application.disabled'))
+          end
         end
       end
     end

data/lib/project_types/script/layers/application/enable_script.rb

@@ -5,15 +5,17 @@ module Script
     module Application
       class EnableScript
         def self.call(ctx:, api_key:, shop_domain:, configuration:, extension_point_type:, title:)
-          script_service = Infrastructure::ScriptService.new(ctx: ctx)
-          script_service.enable(
-            api_key: api_key,
-            shop_domain: shop_domain,
-            configuration: configuration,
-            extension_point_type: extension_point_type,
-            title: title
-          )
-          ctx.puts(ctx.message('script.application.enabled'))
+          UI::PrintingSpinner.spin(ctx, ctx.message('script.application.enabling')) do |p_ctx, spinner|
+            script_service = Infrastructure::ScriptService.new(ctx: p_ctx)
+            script_service.enable(
+              api_key: api_key,
+              shop_domain: shop_domain,
+              configuration: configuration,
+              extension_point_type: extension_point_type,
+              title: title
+            )
+            spinner.update_title(p_ctx.message('script.application.enabled'))
+          end
         end
       end
     end

data/lib/project_types/script/layers/application/push_script.rb

@@ -20,10 +20,12 @@ module Script
           private
 
           def push_script(ctx, task_runner, script, api_key, force)
-            Infrastructure::PushPackageRepository.new(ctx: ctx)
-              .get_push_package(script, task_runner.compiled_type)
-              .push(Infrastructure::ScriptService.new(ctx: ctx), api_key, force)
-            ctx.puts(ctx.message('script.application.pushed'))
+            UI::PrintingSpinner.spin(ctx, ctx.message('script.application.pushing')) do |p_ctx, spinner|
+              Infrastructure::PushPackageRepository.new(ctx: p_ctx)
+                .get_push_package(script, task_runner.compiled_type)
+                .push(Infrastructure::ScriptService.new(ctx: p_ctx), api_key, force)
+              spinner.update_title(p_ctx.message('script.application.pushed'))
+            end
           end
         end
       end

data/lib/project_types/script/layers/infrastructure/assemblyscript_project_creator.rb

@@ -86,14 +86,14 @@ module Script
                 "@shopify/scripts-toolchain-as": "#{extension_point.sdks[:ts].toolchain_version}",
                 "#{extension_point.sdks[:ts].package}": "#{extension_point.sdks[:ts].version}",
                 "@as-pect/cli": "4.0.0",
-                "as-wasi": "^0.0.1",
+                "as-wasi": "^0.2.0",
                 "assemblyscript": "^0.12.0"
               },
               "scripts": {
                 "test": "asp --config test/as-pect.config.js --summary --verbose"
               },
               "engines": {
-                "node": ">=12.16"
+                "node": ">=14.5"
               }
             }
           HERE

data/lib/project_types/script/layers/infrastructure/assemblyscript_task_runner.rb

@@ -6,7 +6,7 @@ module Script
       class AssemblyScriptTaskRunner
         BYTECODE_FILE = "%{name}.wasm"
         SCRIPT_SDK_BUILD = "npx --no-install shopify-scripts-build --src=../%{source} --binary=#{BYTECODE_FILE} "\
-                           "-- --lib=../node_modules --validate --optimize"
+                           "-- --lib=../node_modules --optimize --use Date="
 
         attr_reader :ctx, :script_name, :script_source_file
 

data/lib/project_types/script/layers/infrastructure/errors.rb

@@ -5,6 +5,7 @@ module Script
     module Infrastructure
       module Errors
         class AppNotInstalledError < ScriptProjectError; end
+        class AppScriptNotPushedError < ScriptProjectError; end
         class AppScriptUndefinedError < ScriptProjectError; end
         class BuildError < ScriptProjectError; end
         class DependencyInstallError < ScriptProjectError; end

data/lib/project_types/script/layers/infrastructure/script_service.rb

@@ -60,6 +60,8 @@ module Script
             raise Errors::AppScriptUndefinedError, api_key
           elsif user_errors.any? { |e| e['tag'] == 'shop_script_conflict' }
             raise Errors::ShopScriptConflictError
+          elsif user_errors.any? { |e| e['tag'] == 'app_script_not_pushed' }
+            raise Errors::AppScriptNotPushedError
           else
             raise Errors::ScriptServiceUserError.new(query_name, user_errors.to_s)
           end

data/lib/project_types/script/messages/messages.rb

@@ -42,6 +42,8 @@ module Script
 
           app_not_installed_cause: "App not installed on development store.",
 
+          app_script_not_pushed_help: "Push the script and then try this command again.",
+
           app_script_undefined_help: "Push script to app.",
 
           build_error_cause: "Something went wrong while building the script.",
@@ -83,10 +85,9 @@ module Script
             operation_failed: "Script not created.",
           },
 
-          script_path: "{{v}} Project directory: {{green:%{folder}}}",
-          script_created: "{{v}} Script created: {{green:%{script_id}}}",
+          change_directory_notice: "{{*}} Change directories to {{green:%s}} to run script commands",
           creating: "Creating script",
-          created: "Created script",
+          created: "Created script: {{green:%s}}",
         },
 
         push: {
@@ -96,7 +97,6 @@ module Script
           HELP
           extended_help: <<~HELP,
             \s\sOptions:
-              \s\s{{command:--API_key=<API_key>}} API key. Must be a valid API key, otherwise store access fails.
               \s\s{{command:[--force]}} Forces the script to be overwritten if an instance of it already exists.
           HELP
 
@@ -112,14 +112,10 @@ module Script
           Turn off script in development store.
             Usage: {{command:%s disable}}
           HELP
-          extended_help: <<~HELP,
-            \s\sOptions:
-              \s\s{{command:--API_key=<API_key>}} API key. Must be a valid API key, otherwise store access fails.
-              \s\s{{command:--shop_domain=<my_store.myshopify.com>}} Test store URL. Must be an existing test store.
-          HELP
 
           error: {
             operation_failed: "Can't disable script.",
+            not_pushed_to_app: "Can't disable the script because it hasn't been pushed to the app.",
           },
 
           script_disabled: "{{v}} Script disabled. Script is turned off in development store.",
@@ -132,8 +128,8 @@ module Script
           HELP
           extended_help: <<~HELP,
             \s\sOptions:
-              \s\s{{command:--API_key=<API_key>}} API key. Must be a valid API key, otherwise store access fails.
-              \s\s{{command:--shop_domain=<my_store.myshopify.com>}} Test store URL. Must be an existing test store.
+              \s\s{{command:--config_props='name1:value1, name2:value2'}} Optional. Define the configuration of your script by passing individual name and value pairs. If used with --config_file, then matching values in --config_props will override those set in the file.
+              \s\s{{command:--config_file=<path/to/YAMLFilename>}} Optional. Define the configuration of your script using a YAML formatted file. --config_props values override properties in this file.
           HELP
 
           info: "{{*}} A script always remains enabled until you disable it - even after pushing "\
@@ -142,6 +138,7 @@ module Script
 
           error: {
             operation_failed: "Can't enable script.",
+            not_pushed_to_app: "Can't enable the script because it hasn't been pushed to the app.",
           },
 
           script_enabled: "{{v}} Script enabled. %{type} script %{title} in app (API key: %{api_key}) "\
@@ -177,25 +174,25 @@ module Script
           script_form: {
             ask_app_api_key_default: "Which app do you want this script to belong to?",
             ask_shop_domain_default: "Select a development store",
-            fetching_organizations: "{{i}} Fetching partner organizations",
+            fetching_organizations: "Fetching partner organizations",
+            fetched_organizations: "Fetched partner organizations",
             select_organization: "Select partner organization.",
             using_app: "Using app {{green:%{title} (%{api_key})}}.",
             using_development_store: "Using development store {{green:%{domain}}}",
             using_organization: "Partner organization {{green:%s}}.",
           },
-          enable: {
-            ask_app_api_key: "Which app is the script pushed to?",
-            ask_shop_domain: "Which development store is the app installed on?",
-          },
         },
 
         application: {
           building: "Building",
           building_script: "Building script",
           built: "Built",
-          pushed: "{{v}} Pushed",
-          disabled: "{{v}} Disabled",
-          enabled: "{{v}} Enabled",
+          pushing: "Pushing",
+          pushed: "Pushed",
+          disabling: "Disabling",
+          disabled: "Disabled",
+          enabling: "Enabling",
+          enabled: "Enabled",
         },
       },
     }.freeze