zendesk_apps_support 4.50.0 → 4.51.0.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c15ea4bafff914946cdb8690a7357447f9b02c91806fa7b4fec6766c1a327b7
-  data.tar.gz: 167ba11debabf6de1dc4d76a772e36dbf6b9c9753dce174a36866783c124b5ce
+  metadata.gz: bbe9d3c1dd86e4e85156e9362d93e98bdd4930c24ae9a1936381ad1f22c7eb28
+  data.tar.gz: fe03b96eabca49cbd865c7af1790efe1622908ee26f8e585e0ba85d47f266e60
 SHA512:
-  metadata.gz: 79359a73f2af9256af3337be7696561bd213b9dd842cd7d46c867a694216adfe715a8c4523c477cfadc34d7a1b5cea00088cb850b9eca781e119cc0fd74803ba
-  data.tar.gz: 86d32a1526b471ccbd78c83a71f6fda82b2546c5317be74d92f409ed984b8089a9ee16e24c2a97ad607a171ba0cad767c4a967f49ac5a12d9aac8ba55a479ca7
+  metadata.gz: 9590ab75e91345a87710d49372cf6951e950bcc6dc699ea4d8c5f2214eced46882a4485c3d18ec96b7f4c611630f1229bce0e756a94c65689887a74f3941fb1b
+  data.tar.gz: 169e4b7ed9c2d94db1be6c21a2214b88b62b542dcfd22eecf0a01037173967b4590540dc98bc90c7052b98e53db85c3d3b0e7d1522bfe08ecdb4f5bf5ba397cb

data/config/locales/en.yml

@@ -268,6 +268,9 @@ en:
                 do not match products in translations (%{translation_products})
               insecure_token_parameter_in_manifest: 'Make sure to set secure to true
                 when using keys in Settings. Learn more: %{link}'
+              password_parameter_deprecated: 'Password parameter type is deprecated
+                and will not be accepted in the future. Use Basic Access Authentication
+                instead. Learn more: %{link}.'
               default_secure_or_hidden_parameter_in_manifest: Default values for secure
                 or hidden parameters are not stored securely. Be sure to review them
                 and confirm they do not contain sensitive data
@@ -295,11 +298,22 @@ en:
             oauth_parameter_cannot_be_secure: oauth parameter cannot be set to be
               secure.
             invalid_url: '%{field} must be a valid URL, got "%{value}".'
+            password_parameter_type_deprecated: 'Password parameter type can no longer
+              be used. Use Secure settings instead. Learn more: %{link}.'
             field_requires_secure_parameter: "%{field} cannot be defined in a non-secure
               parameter."
             field_cannot_be_empty: "%{field} cannot be empty."
             field_contains_invalid_values: "%{field} contains invalid values: %{values}."
             field_contains_invalid_keys: "%{field} contains invalid keys: %{keys}."
+            object_types_must_be_array: objectTypes must be an array of strings for
+              the %{location} location, but it was %{value}.
+            object_types_empty: objectTypes cannot be empty for the %{location} location.
+              Specify at least one object type.
+            object_types_invalid_entries: objectTypes must contain only non-empty
+              strings for the %{location} location.
+            object_types_not_supported: objectTypes is not supported for the %{location}
+              location.
+            object_types_required: objectTypes is required for the %{location} location.
         warning:
           app_build:
             deprecated_version: You are targeting a deprecated version of the framework.

data/config/locales/translations/zendesk_apps_support.yml

@@ -657,7 +657,7 @@ parts:
       key: "txt.apps.admin.error.app_build.password_parameter_type_deprecated"
       title: "App builder job: Password parameter type is deprecated"
       value: "Password parameter type can no longer be used. Use Secure settings instead. Learn more: %{link}."
-      obesolete: "2026-08-31"
+      obsolete: "2026-08-31"
   - translation:
       key: "txt.apps.admin.error.app_build.field_requires_secure_parameter"
       title: "App builder job: Error when parameter field requires secure setting set to true. Placeholder %{field} shows parameter field along with parameter name like \"parameter[name='param'].scopes\" found in the supplied manifest file."
@@ -674,6 +674,26 @@ parts:
       key: "txt.apps.admin.error.app_build.field_contains_invalid_keys"
       title: "App builder job: Error for invalid field keys. Placeholder %{field} shows parameter fields like \"parameter[name='param'].scopes\" provided in the supplied manifest file, %{keys} shows the invalid keys found within the field."
       value: "%{field} contains invalid keys: %{keys}."
+  - translation:
+      key: "txt.apps.admin.error.app_build.object_types_must_be_array"
+      title: "App builder job: objectTypes must be an array of strings for the given location. Do not translate 'objectTypes' as it is a manifest property."
+      value: "objectTypes must be an array of strings for the %{location} location, but it was %{value}."
+  - translation:
+      key: "txt.apps.admin.error.app_build.object_types_empty"
+      title: "App builder job: objectTypes cannot be empty for the given location. Do not translate 'objectTypes' as it is a manifest property."
+      value: "objectTypes cannot be empty for the %{location} location. Specify at least one object type."
+  - translation:
+      key: "txt.apps.admin.error.app_build.object_types_invalid_entries"
+      title: "App builder job: objectTypes must contain only non-empty strings for the given location. Do not translate 'objectTypes' as it is a manifest property."
+      value: "objectTypes must contain only non-empty strings for the %{location} location."
+  - translation:
+      key: "txt.apps.admin.error.app_build.object_types_not_supported"
+      title: "App builder job: objectTypes is not supported for the given location. Do not translate 'objectTypes' as it is a manifest property."
+      value: "objectTypes is not supported for the %{location} location."
+  - translation:
+      key: "txt.apps.admin.error.app_build.object_types_required"
+      title: "App builder job: objectTypes is required for the given location. Do not translate 'objectTypes' as it is a manifest property."
+      value: "objectTypes is required for the %{location} location."
   - translation:
       key: "txt.apps.admin.error.app_build.translation.secure_parameters_with_no_scopes_in_manifest"
       title: "Validation message to indicate missing scopes field in manifest's secure parameter.

data/lib/zendesk_apps_support/location.rb

@@ -5,6 +5,8 @@ module ZendeskAppsSupport
     extend ZendeskAppsSupport::Finders
     attr_reader :id, :name, :orderable, :collapsible, :visible, :product_code, :v2_only
 
+    CUSTOM_OBJECT_RECORD_SIDEBAR_LOCATION = 'custom_object_record_sidebar'
+
     def self.unique_ids
       @ids ||= Set.new
     end
@@ -65,7 +67,9 @@ module ZendeskAppsSupport
       Location.new(id: 23, name: 'call_log_editor', product_code: Product::SELL.code, visible: true),
       Location.new(id: 24, name: 'email_editor', product_code: Product::SELL.code, visible: true),
       Location.new(id: 25, name: 'top_bar', product_code: Product::SELL.code, visible: true),
-      Location.new(id: 26, name: 'visit_editor', product_code: Product::SELL.code, visible: true)
+      Location.new(id: 26, name: 'visit_editor', product_code: Product::SELL.code, visible: true),
+      Location.new(id: 27, orderable: true, collapsible: true, name: CUSTOM_OBJECT_RECORD_SIDEBAR_LOCATION,
+                   product_code: Product::SUPPORT.code, visible: true)
     ].freeze
   end
 end

data/lib/zendesk_apps_support/manifest/location_options.rb

@@ -10,7 +10,8 @@ module ZendeskAppsSupport
         flexible: 'flexible',
         signed: 'signed',
         url: 'url',
-        size: 'size'
+        size: 'size',
+        object_types: 'objectTypes'
       }.freeze
 
       attr_reader :location

data/lib/zendesk_apps_support/package.rb

@@ -34,9 +34,10 @@ module ZendeskAppsSupport
     def validate(options = {})
       marketplace = options.fetch(:marketplace, true)
       skip_marketplace_translations = options.fetch(:skip_marketplace_translations, false)
+      validate_custom_object_record_sidebar_location = options.fetch(:validate_custom_object_record_sidebar_location, false)
 
       errors = []
-      errors << Validations::Manifest.call(self)
+      errors << Validations::Manifest.call(self, validate_custom_object_record_sidebar_location: validate_custom_object_record_sidebar_location)
 
       if has_valid_manifest?(errors)
         errors << Validations::Marketplace.call(self) if marketplace

data/lib/zendesk_apps_support/validations/manifest.rb

@@ -14,7 +14,7 @@ module ZendeskAppsSupport
       SECURE_PARAM_SCOPES = %w[header body url jwt_secret_key jwt_claim basic_auth_username basic_auth_password].freeze
 
       class << self
-        def call(package)
+        def call(package, validate_custom_object_record_sidebar_location: false)
           unless package.has_file?('manifest.json')
             nested_manifest = package.files.find { |file| file =~ %r{\A[^/]+?/manifest\.json\Z} }
             if nested_manifest
@@ -22,7 +22,8 @@ module ZendeskAppsSupport
             end
             return [ValidationError.new(:missing_manifest)]
           end
-          collate_manifest_errors(package)
+          collate_manifest_errors(package,
+                                  validate_custom_object_record_sidebar_location: validate_custom_object_record_sidebar_location)
         rescue JSON::ParserError => e
           return [ValidationError.new(:manifest_not_json, errors: e)]
         rescue ZendeskAppsSupport::Manifest::OverrideError => e
@@ -31,7 +32,7 @@ module ZendeskAppsSupport
 
         private
 
-        def collate_manifest_errors(package)
+        def collate_manifest_errors(package, validate_custom_object_record_sidebar_location: false)
           manifest = package.manifest
 
           errors = [
@@ -45,7 +46,8 @@ module ZendeskAppsSupport
               [ ban_location(manifest),
                 ban_framework_version(manifest) ]
             else
-              [ validate_location(package),
+              [ validate_location(package,
+                                  validate_custom_object_record_sidebar_location: validate_custom_object_record_sidebar_location),
                 missing_framework_version(manifest),
                 invalid_version_error(manifest) ]
             end,
@@ -54,13 +56,15 @@ module ZendeskAppsSupport
           errors.flatten.compact
         end
 
-        def validate_location(package)
+        def validate_location(package, validate_custom_object_record_sidebar_location: false)
           manifest = package.manifest
           [
             missing_location_error(package),
-            invalid_location_error(package),
+            invalid_location_error(package,
+                                   validate_custom_object_record_sidebar_location: validate_custom_object_record_sidebar_location),
             invalid_v1_location(package),
-            location_framework_mismatch(manifest)
+            location_framework_mismatch(manifest),
+            (validate_object_types(manifest) if validate_custom_object_record_sidebar_location)
           ]
         end
 
@@ -313,8 +317,10 @@ module ZendeskAppsSupport
           missing_keys_validation_error(['location']) if package.manifest.location_options.empty?
         end
 
-        def invalid_location_error(package)
+        def invalid_location_error(package, validate_custom_object_record_sidebar_location: false)
           errors = []
+          custom_object_record_sidebar = ZendeskAppsSupport::Location::CUSTOM_OBJECT_RECORD_SIDEBAR_LOCATION
+
           package.manifest.location_options.each do |location_options|
             if location_options.url.is_a?(String) && !location_options.url.empty?
               errors << invalid_location_uri_error(package, location_options)
@@ -329,6 +335,16 @@ module ZendeskAppsSupport
 
           Product::PRODUCTS_AVAILABLE.each do |product|
             invalid_locations = package.manifest.unknown_locations(product.name)
+
+            unless validate_custom_object_record_sidebar_location
+              requested_locations = package.manifest.location_options
+                                           .select { |lo| lo.location&.product_code == product.code }
+                                           .map { |lo| lo.location&.name }
+              if requested_locations.include?(custom_object_record_sidebar)
+                invalid_locations << custom_object_record_sidebar
+              end
+            end
+
             next if invalid_locations.empty?
             errors << ValidationError.new(:invalid_location,
                                           invalid_locations: invalid_locations.join(', '),
@@ -379,6 +395,47 @@ module ZendeskAppsSupport
           validation_error
         end
 
+        def validate_object_types(manifest)
+          custom_object_record_sidebar = ZendeskAppsSupport::Location::CUSTOM_OBJECT_RECORD_SIDEBAR_LOCATION
+          manifest.location_options.each do |location_options|
+            object_types = location_options.object_types
+            next if location_options.location.nil?
+
+            location_name = location_options.location.name
+
+            if object_types.nil?
+              if location_name == custom_object_record_sidebar
+                return ValidationError.new(:object_types_required,
+                                           location: location_name)
+              end
+              next
+            end
+
+            if location_name != custom_object_record_sidebar
+              return ValidationError.new(:object_types_not_supported,
+                                         location: location_name)
+            end
+
+            unless object_types.is_a?(Array)
+              return ValidationError.new(:object_types_must_be_array,
+                                         location: location_name,
+                                         value: object_types.class.to_s)
+            end
+
+            if object_types.empty?
+              return ValidationError.new(:object_types_empty,
+                                         location: location_name)
+            end
+
+            non_strings = object_types.reject { |t| t.is_a?(String) && !t.strip.empty? }
+            unless non_strings.empty?
+              return ValidationError.new(:object_types_invalid_entries,
+                                         location: location_name)
+            end
+          end
+          nil
+        end
+
         def valid_absolute_uri?(uri)
           uri.scheme == 'https' || uri.host == 'localhost'
         end

data/lib/zendesk_apps_support/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAppsSupport
-  VERSION = '4.50.0'
+  VERSION = '4.51.0.alpha.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 4.50.0
+  version: 4.51.0.alpha.1
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-30 00:00:00.000000000 Z
+date: 2026-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n