spree_api 6.0.2 → 6.0.4

data/lib/spree/api/typelizer_generation.rb

@@ -5,6 +5,44 @@ module Spree
     # place where the API's and the email serializers are all loaded: running
     # it with any serializer missing would delete that serializer's types.
     module TypelizerGeneration
+      # Serializers that exist only for the Admin API, kept out of the Store
+      # SDK. Event serializers stay in: they describe the `data` of the typed
+      # webhook events the Store SDK ships.
+      STORE_EXCLUDED = %w[Asset CartPromotion OrderPromotion Report TaxCategory].to_set.freeze
+
+      # The store-level types the Seller SDK carries because a seller
+      # serializer nests them (see the seller writer in the initializer).
+      SELLER_STORE_TYPES = %w[Category CustomField OptionType OptionValue Seller].to_set.freeze
+
+      # Typelizer's Alba plugin, taught the custom Alba types (see alba.rb);
+      # unmapped typed attributes crash generation.
+      #
+      # @return [Hash] Typelizer's `plugin_configs`
+      def self.plugin_configs
+        {
+          alba: {
+            ts_mapper: Typelizer::SerializerPlugins::Alba::ALBA_TS_MAPPER.merge(
+              'iso8601' => { type: :string },
+              'string' => { type: :string }
+            )
+          }
+        }
+      end
+
+      # `interface` rather than `type`, so SDK consumers can extend generated
+      # types through declaration merging.
+      #
+      # @param dir [String, Pathname] a folder Typelizer wrote
+      def self.use_interfaces!(dir)
+        Dir[File.join(dir, '*.ts')].each do |file|
+          next if File.basename(file) == 'index.ts'
+
+          content = File.read(file)
+          updated = content.gsub(/^type (\w+) = \{/, 'interface \1 {')
+          File.write(file, updated) if updated != content
+        end
+      end
+
       # @param serializer_dirs [Array<String, Pathname>] directories to load before generating
       def self.call(serializer_dirs)
         serializer_dirs.each { |dir| Rails.autoloaders.main.eager_load_dir(dir.to_s) }
@@ -17,19 +55,9 @@ module Spree
         require 'typelizer/generator'
         Typelizer::Generator.call(force: true)
 
-        # `interface` rather than `type`, so SDK consumers can extend generated
-        # types through declaration merging.
         api_root = Spree::Api::Engine.root
         [api_root.join('../../packages/sdk/src/types/generated'), api_root.join('../../packages/admin-sdk/src/types/generated'),
-         api_root.join('../../packages/admin-sdk/src/types/generated/emails')].each do |dir|
-          Dir[File.join(dir, '*.ts')].each do |file|
-            next if File.basename(file) == 'index.ts'
-
-            content = File.read(file)
-            updated = content.gsub(/^type (\w+) = \{/, 'interface \1 {')
-            File.write(file, updated) if updated != content
-          end
-        end
+         api_root.join('../../packages/admin-sdk/src/types/generated/emails')].each { |dir| use_interfaces!(dir) }
 
         # The typed webhook events in @spree/sdk, from the event catalog.
         require Spree::Api::Engine.root.join('lib/spree/api/webhook_event_types').to_s

data/lib/tasks/openapi.rake

@@ -0,0 +1,5 @@
+# `spree task openapi:generate` (`bin/rails spree:openapi:generate`) in a Spree
+# application: writes openapi/admin.yaml from the app's own rswag specs, so the
+# admin endpoints it adds are documented, and each documented action is an
+# agent tool. Extensions get the same task from extension_rake.
+load File.expand_path('../spree/api/testing_support/openapi_tasks.rb', __dir__)

data/lib/tasks/sdk_types.rake

@@ -0,0 +1,6 @@
+# `spree task sdk:serializer_types OUT=…` (`bin/rails spree:sdk:serializer_types`)
+# in a Spree application: writes the response types of a package that extends
+# the SDKs for the app's own endpoints, from the app's serializers. Extensions
+# get the same task from extension_rake.
+require 'spree/api/sdk_types_task'
+Spree::Api::SdkTypesTask.new

data/lib/typelizer/open_enums.rb

@@ -19,6 +19,14 @@ module Typelizer
   # the standard can add a country, a currency or a unit, and markets only
   # accept the locales `Spree::Locales::ALL` lists.
   module OpenEnums
+    class << self
+      # Where a named list's type is imported from. Spree's own SDKs re-export
+      # it from `@spree/sdk-core`; an extension's package (Spree::Api::SdkTypes)
+      # sets this to nil and defines its lists itself, open unless closed.
+      attr_accessor :source
+    end
+    self.source = '@spree/sdk-core'
+
     CLOSED_TYPE_NAMES = %w[CountryCode CurrencyCode LocaleCode WeightUnit DimensionUnit].freeze
 
     CLOSED_LIST_NAMES = %w[
@@ -61,7 +69,11 @@ module Typelizer
 
     module Property
       def enum_definition(...)
-        super && "type { #{enum_type_name} } from '@spree/sdk-core'"
+        definition = super
+        return definition unless definition
+        return "type { #{enum_type_name} } from '#{OpenEnums.source}'" if OpenEnums.source
+
+        OpenEnums.closed?(enum_type_name) ? definition : "#{definition} | (string & {})"
       end
 
       # Typelizer skips rewriting a file whose digest is unchanged, and the