spree_api 6.0.1 → 6.0.3

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,10 +19,18 @@ 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[
-      ApiKeyType CaptureMethod CatalogAssignableType CatalogPriceSource ClaimResolution
+      AdminUserStatus ApiKeyType CaptureMethod CatalogAssignableType CatalogPriceSource ClaimResolution
       CollectionRuleMatchPolicy CollectionSortOrder CommissionKind CompanyInvitationStatus CompanyKind
       ConsentSource DataRequestKind DeliveryStatus DeliveryZoneMemberType DiscountKind DocumentNumberFormat
       EmailFont EmailTemplateKind FileUploadVisibility FulfillmentType MatchPolicy MediaType OptionTypeKind
@@ -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