shopify-cli 1.13.1 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f924d0de5639f7af794a6b35305b0bdcd78e2fad0f8a4c589006d249f48bbac
-  data.tar.gz: 701e91a9b522933b26f3a26baeab8f900a9cb3aa181e3b847b8a231c9edd5f04
+  metadata.gz: d8f8161eea7a180b04614de6e548d11126711cdeabb05f7eb85c1d35cc6c1769
+  data.tar.gz: e07cb22654f647771d78d1aad39514534fcc2817a01a16f24e03b896828ca583
 SHA512:
-  metadata.gz: 96191b61830023526627944dcf5c4ac6a6b883aa060f81be3095cf5275763ef1552268cdcf46bc9d9b65cf9960ce879aa12b07cd799f2068f65329143a3149cc
-  data.tar.gz: 7e4d1e6c0c6b60609b661261cb0846acf5e42d58da4d525a8706df538c0ef3b7d55e9b26d45f8db8a6977aa5802d041bb639b0d4618718366333f2768f2dc1b8
+  metadata.gz: 24bb19308430c1fab1336af24b68182e63223bb24e62eb98c551a7bf34a23f8dc615c0ebe4b74381458085101316f47ec467d37192b28d86d528ef3020d6b220
+  data.tar.gz: f7afb287929f611361137c909846f5f64e8fc58dbfaffa460c37b3b64deae46f33d79d7201bb23f2819de3da2b4b9666ce1fc9d08f6993a91872a0dffaf1ce83

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 Unreleased
 ------
 
+Version 1.14.0
+--------------
+* [1275](https://github.com/Shopify/shopify-app-cli/pull/1275): Use script.json to specify script metadata
+* [1279](https://github.com/Shopify/shopify-app-cli/pull/1279): Fix bug where a script push still fails after the user answers the force push prompt
+* [1288](https://github.com/Shopify/shopify-app-cli/pull/1288): Fix bug where Scripts SDK was included for projects that don't require it
+
 Version 1.13.1
 --------------
 * [1274](https://github.com/Shopify/shopify-app-cli/pull/1274): Only print api_key during error if it exists

data/lib/project_types/script/cli.rb

@@ -39,10 +39,10 @@ module Script
 
     module Domain
       autoload :Errors, Project.project_filepath("layers/domain/errors")
-      autoload :ConfigUi, Project.project_filepath("layers/domain/config_ui")
       autoload :PushPackage, Project.project_filepath("layers/domain/push_package")
       autoload :Metadata, Project.project_filepath("layers/domain/metadata")
       autoload :ExtensionPoint, Project.project_filepath("layers/domain/extension_point")
+      autoload :ScriptJson, Project.project_filepath("layers/domain/script_json")
       autoload :ScriptProject, Project.project_filepath("layers/domain/script_project")
     end
 

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

@@ -8,12 +8,13 @@ module Script
       end
 
       def call(_args, _name)
-        Tasks::EnsureEnv.call(@ctx)
+        fresh_env = Tasks::EnsureEnv.call(@ctx)
+        force = options.flags.key?(:force) || !!fresh_env
 
         api_key = Layers::Infrastructure::ScriptProjectRepository.new(ctx: @ctx).get.api_key
         return @ctx.puts(self.class.help) unless api_key
 
-        Layers::Application::PushScript.call(ctx: @ctx, force: options.flags.key?(:force))
+        Layers::Application::PushScript.call(ctx: @ctx, force: force)
         @ctx.puts(@ctx.message("script.push.script_pushed", api_key: api_key))
       rescue StandardError => e
         msg = if api_key

data/lib/project_types/script/graphql/app_script_update_or_create.graphql

@@ -1,19 +1,22 @@
 mutation AppScriptUpdateOrCreate(
   $extensionPointName: ExtensionPointName!,
   $title: String,
-  $configUi: String,
+  $description: String,
   $sourceCode: String,
   $language: String,
   $force: Boolean,
   $schemaMajorVersion: String,
   $schemaMinorVersion: String,
   $useMsgpack: Boolean,
-  $uuid: String
+  $uuid: String,
+  $configurationUi: Boolean,
+  $scriptJsonVersion: String,
+  $configurationDefinition: String,
 ) {
   appScriptUpdateOrCreate(
     extensionPointName: $extensionPointName
     title: $title
-    configUi: $configUi
+    description: $description
     sourceCode: $sourceCode
     language: $language
     force: $force
@@ -21,6 +24,9 @@ mutation AppScriptUpdateOrCreate(
     schemaMinorVersion: $schemaMinorVersion
     useMsgpack: $useMsgpack,
     uuid: $uuid
+    configurationUi: $configurationUi
+    scriptJsonVersion: $scriptJsonVersion
+    configurationDefinition: $configurationDefinition
 ) {
     userErrors {
       field

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

@@ -12,16 +12,17 @@ module Script
 
             in_new_directory_context(ctx, script_name) do
               extension_point = ExtensionPoints.get(type: extension_point_type)
-              project = Infrastructure::ScriptProjectRepository.new(ctx: ctx).create(
+              script_project_repo = Infrastructure::ScriptProjectRepository.new(ctx: ctx)
+              project = script_project_repo.create(
                 script_name: script_name,
                 extension_point_type: extension_point_type,
-                language: language,
-                no_config_ui: no_config_ui
+                language: language
               )
               project_creator = Infrastructure::Languages::ProjectCreator
                 .for(ctx, language, extension_point, script_name, project.id)
               install_dependencies(ctx, language, script_name, project_creator)
               bootstrap(ctx, project_creator)
+              script_project_repo.update_or_create_script_json(title: script_name, configuration_ui: !no_config_ui)
               project
             end
           end

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

@@ -14,21 +14,16 @@ module Script
           end
         end
 
-        class InvalidConfigUiDefinitionError < ScriptProjectError
-          attr_reader :filename
-          def initialize(filename)
+        class MissingScriptJsonFieldError < ScriptProjectError
+          attr_reader :field
+          def initialize(field)
             super()
-            @filename = filename
+            @field = field
           end
         end
 
-        class MissingSpecifiedConfigUiDefinitionError < ScriptProjectError
-          attr_reader :filename
-          def initialize(filename)
-            super()
-            @filename = filename
-          end
-        end
+        class InvalidScriptJsonDefinitionError < ScriptProjectError; end
+        class NoScriptJsonFile < ScriptProjectError; end
 
         class ScriptNotFoundError < ScriptProjectError
           attr_reader :script_name, :extension_point_type

data/lib/project_types/script/layers/domain/push_package.rb

@@ -7,8 +7,7 @@ module Script
         attr_reader :id,
           :uuid,
           :extension_point_type,
-          :script_name,
-          :config_ui,
+          :script_json,
           :script_content,
           :compiled_type,
           :metadata
@@ -17,33 +16,30 @@ module Script
           id:,
           uuid:,
           extension_point_type:,
-          script_name:,
           script_content:,
           compiled_type:,
           metadata:,
-          config_ui:
+          script_json:
         )
           @id = id
           @uuid = uuid
           @extension_point_type = extension_point_type
-          @script_name = script_name
           @script_content = script_content
           @compiled_type = compiled_type
           @metadata = metadata
-          @config_ui = config_ui
+          @script_json = script_json
         end
 
         def push(script_service, api_key, force)
           script_service.push(
             uuid: @uuid,
             extension_point_type: @extension_point_type,
-            script_name: @script_name,
             script_content: @script_content,
             compiled_type: @compiled_type,
             api_key: api_key,
             force: force,
             metadata: @metadata,
-            config_ui: @config_ui,
+            script_json: @script_json,
           )
         end
       end

data/lib/project_types/script/layers/domain/script_json.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    module Domain
+      class ScriptJson
+        attr_reader :content, :version, :title, :description, :configuration_ui, :configuration
+
+        REQUIRED_FIELDS = %w(version title)
+
+        def initialize(content:)
+          validate_content!(content)
+
+          @content = content
+          @version = @content["version"].to_s
+          @title = @content["title"]
+          @description = @content["description"]
+          @configuration_ui = @content["configurationUi"]
+          @configuration = @content["configuration"]
+        end
+
+        private
+
+        def validate_content!(content)
+          REQUIRED_FIELDS.each do |field|
+            raise Errors::MissingScriptJsonFieldError, field if content[field].nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/project_types/script/layers/domain/script_project.rb

@@ -15,7 +15,7 @@ module Script
         property! :script_name, accepts: String
         property! :language, accepts: String
 
-        property :config_ui, accepts: ConfigUi
+        property :script_json, accepts: ScriptJson
 
         def initialize(*)
           super

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

@@ -6,40 +6,36 @@ module Script
       module Errors
         class AppNotInstalledError < ScriptProjectError; end
         class BuildError < ScriptProjectError; end
-        class ConfigUiSyntaxError < ScriptProjectError; end
+        class ScriptJsonSyntaxError < ScriptProjectError; end
 
-        class ConfigUiMissingKeysError < ScriptProjectError
-          attr_reader :filename, :missing_keys
-          def initialize(filename, missing_keys)
+        class ScriptJsonMissingKeysError < ScriptProjectError
+          attr_reader :missing_keys
+          def initialize(missing_keys)
             super()
-            @filename = filename
             @missing_keys = missing_keys
           end
         end
 
-        class ConfigUiInvalidInputModeError < ScriptProjectError
-          attr_reader :filename, :valid_input_modes
-          def initialize(filename, valid_input_modes)
+        class ScriptJsonInvalidValueError < ScriptProjectError
+          attr_reader :valid_input_modes
+          def initialize(valid_input_modes)
             super()
-            @filename = filename
             @valid_input_modes = valid_input_modes
           end
         end
 
-        class ConfigUiFieldsMissingKeysError < ScriptProjectError
-          attr_reader :filename, :missing_keys
-          def initialize(filename, missing_keys)
+        class ScriptJsonFieldsMissingKeysError < ScriptProjectError
+          attr_reader :missing_keys
+          def initialize(missing_keys)
             super()
-            @filename = filename
             @missing_keys = missing_keys
           end
         end
 
-        class ConfigUiFieldsInvalidTypeError < ScriptProjectError
-          attr_reader :filename, :valid_types
-          def initialize(filename, valid_types)
+        class ScriptJsonFieldsInvalidValueError < ScriptProjectError
+          attr_reader :valid_types
+          def initialize(valid_types)
             super()
-            @filename = filename
             @valid_types = valid_types
           end
         end

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

@@ -45,27 +45,20 @@ module Script
           end
 
           def write_package_json
-            package_json = <<~HERE
-              {
-                "name": "#{script_name}",
-                "version": "1.0.0",
-                "devDependencies": {
-                  "@shopify/scripts-sdk-as": "#{extension_point.sdks.assemblyscript.sdk_version}",
-                  "@shopify/scripts-toolchain-as": "#{extension_point.sdks.assemblyscript.toolchain_version}",
-                  "#{extension_point.sdks.assemblyscript.package}": "#{extension_point_version}",
-                  "@as-pect/cli": "^6.0.0",
-                  "assemblyscript": "^0.18.13"
-                },
-                "scripts": {
-                  "test": "asp --summary --verbose",
-                  "build": "#{build_command}"
-                },
-                "engines": {
-                  "node": ">=#{MIN_NODE_VERSION}"
-                }
-              }
-            HERE
-            ctx.write("package.json", package_json)
+            package_json = {
+              name: script_name,
+              version: "1.0.0",
+              devDependencies: dev_dependencies,
+              scripts: {
+                test: "asp --summary --verbose",
+                build: build_command,
+              },
+              engines: {
+                node: ">=#{MIN_NODE_VERSION}",
+              },
+            }
+
+            ctx.write("package.json", JSON.pretty_generate(package_json))
           end
 
           def bootstap_command
@@ -90,6 +83,21 @@ module Script
               "#{BUILD} --domain #{domain} --ep #{type} #{ASC_ARGS}"
             end
           end
+
+          def dev_dependencies
+            dependencies = {
+              "@as-pect/cli": "^6.0.0",
+              "assemblyscript": "^0.18.13",
+              "@shopify/scripts-toolchain-as": extension_point.sdks.assemblyscript.toolchain_version,
+              "#{extension_point.sdks.assemblyscript.package}": extension_point_version,
+            }
+
+            if extension_point.sdks.assemblyscript.sdk_version
+              dependencies["@shopify/scripts-sdk-as"] = extension_point.sdks.assemblyscript.sdk_version
+            end
+
+            dependencies
+          end
         end
       end
     end

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

@@ -15,11 +15,10 @@ module Script
             id: build_file_path,
             uuid: script_project.uuid,
             extension_point_type: script_project.extension_point_type,
-            script_name: script_project.script_name,
             script_content: script_content,
             compiled_type: compiled_type,
             metadata: metadata,
-            config_ui: script_project.config_ui,
+            script_json: script_project.script_json,
           )
         end
 
@@ -32,11 +31,10 @@ module Script
             id: build_file_path,
             uuid: script_project.uuid,
             extension_point_type: script_project.extension_point_type,
-            script_name: script_project.script_name,
             script_content: script_content,
             compiled_type: compiled_type,
             metadata: metadata,
-            config_ui: script_project.config_ui,
+            script_json: script_project.script_json,
           )
         end
 

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

@@ -7,24 +7,19 @@ module Script
         include SmartProperties
         property! :ctx, accepts: ShopifyCli::Context
 
-        DEFAULT_CONFIG_UI_FILENAME = "config-ui.yml"
+        SCRIPT_JSON_FILENAME = "script.json"
         MUTABLE_ENV_VALUES = %i(uuid)
 
-        def create(script_name:, extension_point_type:, language:, no_config_ui:)
+        def create(script_name:, extension_point_type:, language:)
           validate_metadata!(extension_point_type, language)
 
-          config_ui_file = nil
-          optional_identifiers = {}
-          optional_identifiers.merge!(config_ui_file: DEFAULT_CONFIG_UI_FILENAME) unless no_config_ui
-
           ShopifyCli::Project.write(
             ctx,
             project_type: :script,
             organization_id: nil,
             extension_point_type: extension_point_type,
             script_name: script_name,
-            language: language,
-            **optional_identifiers
+            language: language
           )
 
           Domain::ScriptProject.new(
@@ -32,23 +27,20 @@ module Script
             env: project.env,
             script_name: script_name,
             extension_point_type: extension_point_type,
-            language: language,
-            config_ui: config_ui_file
+            language: language
           )
         end
 
         def get
           validate_metadata!(extension_point_type, language)
 
-          config_ui = ConfigUiRepository.new(ctx: ctx).get(config_ui_file)
-
           Domain::ScriptProject.new(
             id: project.directory,
             env: project.env,
             script_name: script_name,
             extension_point_type: extension_point_type,
             language: language,
-            config_ui: config_ui
+            script_json: ScriptJsonRepository.new(ctx: ctx).get
           )
         end
 
@@ -66,7 +58,7 @@ module Script
             script_name: script_name,
             extension_point_type: extension_point_type,
             language: language,
-            config_ui: ConfigUiRepository.new(ctx: ctx).get(config_ui_file),
+            script_json: ScriptJsonRepository.new(ctx: ctx).get,
           )
         end
 
@@ -85,7 +77,22 @@ module Script
             script_name: script_name,
             extension_point_type: extension_point_type,
             language: language,
-            config_ui: ConfigUiRepository.new(ctx: ctx).get(config_ui_file),
+            script_json: ScriptJsonRepository.new(ctx: ctx).get,
+          )
+        end
+
+        def update_or_create_script_json(title:, configuration_ui: false)
+          script_json = ScriptJsonRepository
+            .new(ctx: ctx)
+            .update_or_create(title: title, configuration_ui: configuration_ui)
+
+          Domain::ScriptProject.new(
+            id: ctx.root,
+            env: project.env,
+            script_name: script_name,
+            extension_point_type: extension_point_type,
+            language: language,
+            script_json: script_json,
           )
         end
 
@@ -103,10 +110,6 @@ module Script
           project_config_value!("script_name")
         end
 
-        def config_ui_file
-          project_config_value("config_ui_file")
-        end
-
         def language
           project_config_value("language")&.downcase || default_language
         end
@@ -137,32 +140,40 @@ module Script
           end
         end
 
-        class ConfigUiRepository
+        class ScriptJsonRepository
           include SmartProperties
           property! :ctx, accepts: ShopifyCli::Context
 
-          def get(filename)
-            return nil unless filename
+          def get
+            current_script_json || raise(Domain::Errors::NoScriptJsonFile)
+          end
 
-            path = File.join(ctx.root, filename)
-            raise Domain::Errors::MissingSpecifiedConfigUiDefinitionError, filename unless File.exist?(path)
+          def update_or_create(title:, configuration_ui:)
+            json = current_script_json&.content || {}
+            json["version"] ||= "1"
+            json["title"] = title
+            json["configurationUi"] = !!configuration_ui
 
-            content = File.read(path)
-            raise Domain::Errors::InvalidConfigUiDefinitionError, filename unless valid_config_ui?(content)
+            ctx.write(SCRIPT_JSON_FILENAME, JSON.pretty_generate(json))
 
-            Domain::ConfigUi.new(
-              filename: filename,
-              content: content,
-            )
+            Domain::ScriptJson.new(content: json)
           end
 
           private
 
-          def valid_config_ui?(raw_yaml)
-            require "yaml" # takes 20ms, so deferred as late as possible.
-            YAML.safe_load(raw_yaml)
+          def current_script_json
+            return nil unless ctx.file_exist?(SCRIPT_JSON_FILENAME)
+
+            content = ctx.read(SCRIPT_JSON_FILENAME)
+            raise Domain::Errors::InvalidScriptJsonDefinitionError unless valid_script_json?(content)
+
+            Domain::ScriptJson.new(content: JSON.parse(content))
+          end
+
+          def valid_script_json?(content)
+            JSON.parse(content)
             true
-          rescue Psych::SyntaxError
+          rescue JSON::ParserError
             false
           end
         end

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

@@ -13,26 +13,28 @@ module Script
         def push(
           uuid:,
           extension_point_type:,
-          script_name:,
           script_content:,
           compiled_type:,
           api_key: nil,
           force: false,
           metadata:,
-          config_ui:
+          script_json:
         )
           query_name = "app_script_update_or_create"
           variables = {
             uuid: uuid,
             extensionPointName: extension_point_type.upcase,
-            title: script_name,
-            configUi: config_ui&.content,
+            title: script_json.title,
+            description: script_json.description,
             sourceCode: Base64.encode64(script_content),
             language: compiled_type,
             force: force,
             schemaMajorVersion: metadata.schema_major_version.to_s, # API expects string value
             schemaMinorVersion: metadata.schema_minor_version.to_s, # API expects string value
             useMsgpack: metadata.use_msgpack,
+            scriptJsonVersion: script_json.version,
+            configurationUi: script_json.configuration_ui,
+            configurationDefinition: script_json.configuration&.to_json,
           }
           resp_hash = script_service_request(query_name: query_name, api_key: api_key, variables: variables)
           user_errors = resp_hash["data"]["appScriptUpdateOrCreate"]["userErrors"]
@@ -41,16 +43,20 @@ module Script
 
           if user_errors.any? { |e| e["tag"] == "already_exists_error" }
             raise Errors::ScriptRepushError, uuid
-          elsif (e = user_errors.any? { |err| err["tag"] == "config_ui_syntax_error" })
-            raise Errors::ConfigUiSyntaxError, config_ui&.filename
-          elsif (e = user_errors.find { |err| err["tag"] == "config_ui_missing_keys_error" })
-            raise Errors::ConfigUiMissingKeysError.new(config_ui&.filename, e["message"])
-          elsif (e = user_errors.find { |err| err["tag"] == "config_ui_invalid_input_mode_error" })
-            raise Errors::ConfigUiInvalidInputModeError.new(config_ui&.filename, e["message"])
-          elsif (e = user_errors.find { |err| err["tag"] == "config_ui_fields_missing_keys_error" })
-            raise Errors::ConfigUiFieldsMissingKeysError.new(config_ui&.filename, e["message"])
-          elsif (e = user_errors.find { |err| err["tag"] == "config_ui_fields_invalid_type_error" })
-            raise Errors::ConfigUiFieldsInvalidTypeError.new(config_ui&.filename, e["message"])
+          elsif (e = user_errors.any? { |err| err["tag"] == "configuration_syntax_error" })
+            raise Errors::ScriptJsonSyntaxError
+          elsif (e = user_errors.find { |err| err["tag"] == "configuration_definition_missing_keys_error" })
+            raise Errors::ScriptJsonMissingKeysError, e["message"]
+          elsif (e = user_errors.find { |err| err["tag"] == "configuration_definition_invalid_value_error" })
+            raise Errors::ScriptJsonInvalidValueError, e["message"]
+          elsif (e = user_errors.find do |err|
+                   err["tag"] == "configuration_definition_schema_field_missing_keys_error"
+                 end)
+            raise Errors::ScriptJsonFieldsMissingKeysError, e["message"]
+          elsif (e = user_errors.find do |err|
+                   err["tag"] == "configuration_definition_schema_field_invalid_value_error"
+                 end)
+            raise Errors::ScriptJsonFieldsInvalidValueError, e["message"]
           elsif user_errors.find { |err| %w(not_use_msgpack_error schema_version_argument_error).include?(err["tag"]) }
             raise Domain::Errors::MetadataValidationError
           else

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

@@ -51,30 +51,33 @@ module Script
           invalid_config: "Can't change the configuration values because %1$s is missing or "\
                           "it is not formatted properly.",
 
-          invalid_config_ui_definition_cause: "The UI configuration file %s contains invalid YAML.",
-          invalid_config_ui_definition_help: "Fix the errors and try again.",
+          missing_script_json_field_cause: "The script.json file is missing the required %s field.",
+          missing_script_json_field_help: "Add the field and try again.",
 
-          missing_config_ui_definition_cause: "You are missing the UI configuration file %s.",
-          missing_config_ui_definition_help: "Create this file and try again.",
+          invalid_script_json_definition_cause: "The script.json file contains invalid JSON.",
+          invalid_script_json_definition_help: "Fix the errors and try again.",
 
-          config_ui_syntax_error_cause: "The UI configuration file %{filename} is not formatted properly.",
-          config_ui_syntax_error_help: "Fix the errors and try again.",
+          no_script_json_file_cause: "You are missing the required script.json file.",
+          no_script_json_file_help: "Create this file and try again.",
 
-          config_ui_missing_keys_error_cause: "The UI configuration file %{filename} is missing required keys: "\
+          configuration_syntax_error_cause: "The script.json configuration schema is not formatted properly.",
+          configuration_syntax_error_help: "Fix the errors and try again.",
+
+          configuration_missing_keys_error_cause: "The script.json configuration schema is missing required keys: "\
                                               "%{missing_keys}.",
-          config_ui_missing_keys_error_help: "Add the keys and try again.",
+          configuration_missing_keys_error_help: "Add the keys and try again.",
 
-          config_ui_invalid_input_mode_error_cause: "The UI configuration file %{filename} only accept "\
-                                              "one of the following input mode(s): %{valid_input_modes}.",
-          config_ui_invalid_input_mode_error_help: "Change the input modes and try again.",
+          configuration_invalid_value_error_cause: "The script.json configuration only accepts "\
+                                              "one of the following types(s): %{valid_input_modes}.",
+          configuration_invalid_value_error_help: "Change the type and try again.",
 
-          config_ui_fields_missing_keys_error_cause: "A field entry in the UI configuration file %{filename} is "\
-                                                     "missing required keys: %{missing_keys}.",
-          config_ui_fields_missing_keys_error_help: "Add the keys and try again.",
+          configuration_schema_field_missing_keys_error_cause: "A field entry in the script.json configuration "\
+                                                     "schema is missing required keys: %{missing_keys}.",
+          configuration_definition_schema_field_missing_keys_error_help: "Add the keys and try again.",
 
-          config_ui_fields_invalid_type_error_cause: "The UI configuration file %{filename} fields only accept "\
-                                                     "one of the following type(s): %{valid_types}.",
-          config_ui_fields_invalid_type_error_help: "Change the types and try again.",
+          configuration_schema_field_invalid_value_error_cause: "The script.json configuration schema fields only "\
+                                                     "accept one of the following type(s): %{valid_types}.",
+          configuration_schema_field_invalid_value_error_help: "Change the types and try again.",
 
           script_not_found_cause: "Couldn't find script %s for extension point %s",
 

data/lib/project_types/script/tasks/ensure_env.rb

@@ -11,7 +11,7 @@ module Script
         script_project_repo = Layers::Infrastructure::ScriptProjectRepository.new(ctx: ctx)
         script_project = script_project_repo.get
 
-        return if script_project.api_key && script_project.api_secret && script_project.uuid_defined?
+        return false if script_project.api_key && script_project.api_secret && script_project.uuid_defined?
 
         org = ask_org
         app = ask_app(org["apps"])
@@ -22,6 +22,8 @@ module Script
           secret: app["apiSecretKeys"].first["secret"],
           uuid: uuid
         )
+
+        true
       end
 
       private

data/lib/project_types/script/ui/error_handler.rb

@@ -120,17 +120,20 @@ module Script
             cause_of_error: ShopifyCli::Context.message("script.error.metadata_not_found_cause"),
             help_suggestion: ShopifyCli::Context.message("script.error.metadata_not_found_help"),
           }
-        when Layers::Domain::Errors::InvalidConfigUiDefinitionError
+        when Layers::Domain::Errors::MissingScriptJsonFieldError
           {
-            cause_of_error: ShopifyCli::Context
-              .message("script.error.invalid_config_ui_definition_cause", e.filename),
-            help_suggestion: ShopifyCli::Context.message("script.error.invalid_config_ui_definition_help"),
+            cause_of_error: ShopifyCli::Context.message("script.error.missing_script_json_field_cause", e.field),
+            help_suggestion: ShopifyCli::Context.message("script.error.missing_script_json_field_help"),
           }
-        when Layers::Domain::Errors::MissingSpecifiedConfigUiDefinitionError
+        when Layers::Domain::Errors::InvalidScriptJsonDefinitionError
           {
-            cause_of_error: ShopifyCli::Context
-              .message("script.error.missing_config_ui_definition_cause", e.filename),
-            help_suggestion: ShopifyCli::Context.message("script.error.missing_config_ui_definition_help"),
+            cause_of_error: ShopifyCli::Context.message("script.error.invalid_script_json_definition_cause"),
+            help_suggestion: ShopifyCli::Context.message("script.error.invalid_script_json_definition_help"),
+          }
+        when Layers::Domain::Errors::NoScriptJsonFile
+          {
+            cause_of_error: ShopifyCli::Context.message("script.error.no_script_json_file_cause"),
+            help_suggestion: ShopifyCli::Context.message("script.error.no_script_json_file_help"),
           }
         when Layers::Infrastructure::Errors::AppNotInstalledError
           {
@@ -141,49 +144,46 @@ module Script
             cause_of_error: ShopifyCli::Context.message("script.error.build_error_cause"),
             help_suggestion: ShopifyCli::Context.message("script.error.build_error_help"),
           }
-        when Layers::Infrastructure::Errors::ConfigUiSyntaxError
+        when Layers::Infrastructure::Errors::ScriptJsonSyntaxError
           {
-            cause_of_error: ShopifyCli::Context.message(
-              "script.error.config_ui_syntax_error_cause",
-              filename: e.message
-            ),
-            help_suggestion: ShopifyCli::Context.message("script.error.config_ui_syntax_error_help"),
+            cause_of_error: ShopifyCli::Context.message("script.error.configuration_syntax_error_cause"),
+            help_suggestion: ShopifyCli::Context.message("script.error.configuration_syntax_error_help"),
           }
-        when Layers::Infrastructure::Errors::ConfigUiMissingKeysError
+        when Layers::Infrastructure::Errors::ScriptJsonMissingKeysError
           {
             cause_of_error: ShopifyCli::Context.message(
-              "script.error.config_ui_missing_keys_error_cause",
-              filename: e.filename,
+              "script.error.configuration_missing_keys_error_cause",
               missing_keys: e.missing_keys
             ),
-            help_suggestion: ShopifyCli::Context.message("script.error.config_ui_missing_keys_error_help"),
+            help_suggestion: ShopifyCli::Context.message("script.error.configuration_missing_keys_error_help"),
           }
-        when Layers::Infrastructure::Errors::ConfigUiInvalidInputModeError
+        when Layers::Infrastructure::Errors::ScriptJsonInvalidValueError
           {
             cause_of_error: ShopifyCli::Context.message(
-              "script.error.config_ui_invalid_input_mode_error_cause",
-              filename: e.filename,
+              "script.error.configuration_invalid_value_error_cause",
               valid_input_modes: e.valid_input_modes
             ),
-            help_suggestion: ShopifyCli::Context.message("script.error.config_ui_invalid_input_mode_error_help"),
+            help_suggestion: ShopifyCli::Context.message("script.error.configuration_invalid_value_error_help"),
           }
-        when Layers::Infrastructure::Errors::ConfigUiFieldsMissingKeysError
+        when Layers::Infrastructure::Errors::ScriptJsonFieldsMissingKeysError
           {
             cause_of_error: ShopifyCli::Context.message(
-              "script.error.config_ui_fields_missing_keys_error_cause",
-              filename: e.filename,
+              "script.error.configuration_schema_field_missing_keys_error_cause",
               missing_keys: e.missing_keys
             ),
-            help_suggestion: ShopifyCli::Context.message("script.error.config_ui_fields_missing_keys_error_help"),
+            help_suggestion: ShopifyCli::Context.message(
+              "script.error.configuration_definition_schema_field_missing_keys_error_help"
+            ),
           }
-        when Layers::Infrastructure::Errors::ConfigUiFieldsInvalidTypeError
+        when Layers::Infrastructure::Errors::ScriptJsonFieldsInvalidValueError
           {
             cause_of_error: ShopifyCli::Context.message(
-              "script.error.config_ui_fields_invalid_type_error_cause",
-              filename: e.filename,
+              "script.error.configuration_schema_field_invalid_value_error_cause",
               valid_types: e.valid_types
             ),
-            help_suggestion: ShopifyCli::Context.message("script.error.config_ui_fields_invalid_type_error_help"),
+            help_suggestion: ShopifyCli::Context.message(
+              "script.error.configuration_schema_field_invalid_value_error_help"
+            ),
           }
         when Layers::Infrastructure::Errors::DependencyInstallError
           {

data/lib/shopify-cli/context.rb

@@ -144,6 +144,19 @@ module ShopifyCli
       File.write(ctx_path(fname), content)
     end
 
+    # will read a file relative to the context root unless the file path is absolute.
+    #
+    # #### Parameters
+    # * `fname` - filename of the file that you are reading, relative to root unless it is absolute.
+    #
+    # #### Example
+    #
+    #   @ctx.read('file.txt')
+    #
+    def read(fname)
+      File.read(ctx_path(fname))
+    end
+
     # will read a binary file relative to the context root unless the file path is absolute.
     #
     # #### Parameters

data/lib/shopify-cli/version.rb

@@ -1,3 +1,3 @@
 module ShopifyCli
-  VERSION = "1.13.1"
+  VERSION = "1.14.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-cli
 version: !ruby/object:Gem::Version
-  version: 1.13.1
+  version: 1.14.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-14 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -227,11 +227,11 @@ files:
 - lib/project_types/script/layers/application/extension_points.rb
 - lib/project_types/script/layers/application/project_dependencies.rb
 - lib/project_types/script/layers/application/push_script.rb
-- lib/project_types/script/layers/domain/config_ui.rb
 - lib/project_types/script/layers/domain/errors.rb
 - lib/project_types/script/layers/domain/extension_point.rb
 - lib/project_types/script/layers/domain/metadata.rb
 - lib/project_types/script/layers/domain/push_package.rb
+- lib/project_types/script/layers/domain/script_json.rb
 - lib/project_types/script/layers/domain/script_project.rb
 - lib/project_types/script/layers/infrastructure/command_runner.rb
 - lib/project_types/script/layers/infrastructure/errors.rb

data/lib/project_types/script/layers/domain/config_ui.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Script
-  module Layers
-    module Domain
-      class ConfigUi
-        attr_reader :filename, :content
-
-        def initialize(filename:, content:)
-          @filename = filename
-          @content = content
-        end
-      end
-    end
-  end
-end