feat(core): Move global stock & language settings into Channel

This allows better control for multivendor setups, so each channel can define its own set of supported languages, currencies and stock settings
vendure-ecommerce · May 18, 2023 · 2748a6e · 2748a6e
1 parent 85418af
commit 2748a6e
Show file tree

Hide file tree

Showing 17 changed files with 413 additions and 3 deletions.
diff --git a/packages/asset-server-plugin/e2e/graphql/generated-e2e-asset-server-plugin-types.ts b/packages/asset-server-plugin/e2e/graphql/generated-e2e-asset-server-plugin-types.ts
@@ -352,6 +352,8 @@ export type Cancellation = Node &
     };
 
 export type Channel = Node & {
+    availableCurrencyCodes: Array<CurrencyCode>;
+    availableLanguageCodes?: Maybe<Array<LanguageCode>>;
     code: Scalars['String'];
     createdAt: Scalars['DateTime'];
     /** @deprecated Use defaultCurrencyCode instead */
@@ -362,9 +364,11 @@ export type Channel = Node & {
     defaultShippingZone?: Maybe<Zone>;
     defaultTaxZone?: Maybe<Zone>;
     id: Scalars['ID'];
+    outOfStockThreshold?: Maybe<Scalars['Int']>;
     pricesIncludeTax: Scalars['Boolean'];
     seller?: Maybe<Seller>;
     token: Scalars['String'];
+    trackInventory?: Maybe<Scalars['Boolean']>;
     updatedAt: Scalars['DateTime'];
 };
 
@@ -386,8 +390,10 @@ export type ChannelFilterParameter = {
     defaultCurrencyCode?: InputMaybe<StringOperators>;
     defaultLanguageCode?: InputMaybe<StringOperators>;
     id?: InputMaybe<IdOperators>;
+    outOfStockThreshold?: InputMaybe<NumberOperators>;
     pricesIncludeTax?: InputMaybe<BooleanOperators>;
     token?: InputMaybe<StringOperators>;
+    trackInventory?: InputMaybe<BooleanOperators>;
     updatedAt?: InputMaybe<DateOperators>;
 };
 
@@ -413,6 +419,7 @@ export type ChannelSortParameter = {
     code?: InputMaybe<SortOrder>;
     createdAt?: InputMaybe<SortOrder>;
     id?: InputMaybe<SortOrder>;
+    outOfStockThreshold?: InputMaybe<SortOrder>;
     token?: InputMaybe<SortOrder>;
     updatedAt?: InputMaybe<SortOrder>;
 };
@@ -679,15 +686,19 @@ export type CreateAssetInput = {
 export type CreateAssetResult = Asset | MimeTypeError;
 
 export type CreateChannelInput = {
+    availableCurrencyCodes?: InputMaybe<Array<CurrencyCode>>;
+    availableLanguageCodes?: InputMaybe<Array<LanguageCode>>;
     code: Scalars['String'];
     currencyCode: CurrencyCode;
     customFields?: InputMaybe<Scalars['JSON']>;
     defaultLanguageCode: LanguageCode;
     defaultShippingZoneId: Scalars['ID'];
     defaultTaxZoneId: Scalars['ID'];
+    outOfStockThreshold?: InputMaybe<Scalars['Int']>;
     pricesIncludeTax: Scalars['Boolean'];
     sellerId?: InputMaybe<Scalars['ID']>;
     token: Scalars['String'];
+    trackInventory?: InputMaybe<Scalars['Boolean']>;
 };
 
 export type CreateChannelResult = Channel | LanguageNotAvailableError;
@@ -5646,16 +5657,20 @@ export type UpdateAssetInput = {
 };
 
 export type UpdateChannelInput = {
+    availableCurrencyCodes?: InputMaybe<Array<CurrencyCode>>;
+    availableLanguageCodes?: InputMaybe<Array<LanguageCode>>;
     code?: InputMaybe<Scalars['String']>;
     currencyCode?: InputMaybe<CurrencyCode>;
     customFields?: InputMaybe<Scalars['JSON']>;
     defaultLanguageCode?: InputMaybe<LanguageCode>;
     defaultShippingZoneId?: InputMaybe<Scalars['ID']>;
     defaultTaxZoneId?: InputMaybe<Scalars['ID']>;
     id: Scalars['ID'];
+    outOfStockThreshold?: InputMaybe<Scalars['Int']>;
     pricesIncludeTax?: InputMaybe<Scalars['Boolean']>;
     sellerId?: InputMaybe<Scalars['ID']>;
     token?: InputMaybe<Scalars['String']>;
+    trackInventory?: InputMaybe<Scalars['Boolean']>;
 };
 
 export type UpdateChannelResult = Channel | LanguageNotAvailableError;

diff --git a/packages/common/src/generated-shop-types.ts b/packages/common/src/generated-shop-types.ts
@@ -145,6 +145,8 @@ export type BooleanOperators = {
 
 export type Channel = Node & {
     __typename?: 'Channel';
+    availableCurrencyCodes: Array<CurrencyCode>;
+    availableLanguageCodes?: Maybe<Array<LanguageCode>>;
     code: Scalars['String'];
     createdAt: Scalars['DateTime'];
     /** @deprecated Use defaultCurrencyCode instead */
@@ -155,9 +157,11 @@ export type Channel = Node & {
     defaultShippingZone?: Maybe<Zone>;
     defaultTaxZone?: Maybe<Zone>;
     id: Scalars['ID'];
+    outOfStockThreshold?: Maybe<Scalars['Int']>;
     pricesIncludeTax: Scalars['Boolean'];
     seller?: Maybe<Seller>;
     token: Scalars['String'];
+    trackInventory?: Maybe<Scalars['Boolean']>;
     updatedAt: Scalars['DateTime'];
 };
 

diff --git a/packages/common/src/generated-types.ts b/packages/common/src/generated-types.ts
@@ -347,6 +347,8 @@ export type Cancellation = Node & StockMovement & {
 
 export type Channel = Node & {
   __typename?: 'Channel';
+  availableCurrencyCodes: Array<CurrencyCode>;
+  availableLanguageCodes?: Maybe<Array<LanguageCode>>;
   code: Scalars['String'];
   createdAt: Scalars['DateTime'];
   /** @deprecated Use defaultCurrencyCode instead */
@@ -357,9 +359,11 @@ export type Channel = Node & {
   defaultShippingZone?: Maybe<Zone>;
   defaultTaxZone?: Maybe<Zone>;
   id: Scalars['ID'];
+  outOfStockThreshold?: Maybe<Scalars['Int']>;
   pricesIncludeTax: Scalars['Boolean'];
   seller?: Maybe<Seller>;
   token: Scalars['String'];
+  trackInventory?: Maybe<Scalars['Boolean']>;
   updatedAt: Scalars['DateTime'];
 };
 
@@ -382,8 +386,10 @@ export type ChannelFilterParameter = {
   defaultCurrencyCode?: InputMaybe<StringOperators>;
   defaultLanguageCode?: InputMaybe<StringOperators>;
   id?: InputMaybe<IdOperators>;
+  outOfStockThreshold?: InputMaybe<NumberOperators>;
   pricesIncludeTax?: InputMaybe<BooleanOperators>;
   token?: InputMaybe<StringOperators>;
+  trackInventory?: InputMaybe<BooleanOperators>;
   updatedAt?: InputMaybe<DateOperators>;
 };
 
@@ -410,6 +416,7 @@ export type ChannelSortParameter = {
   code?: InputMaybe<SortOrder>;
   createdAt?: InputMaybe<SortOrder>;
   id?: InputMaybe<SortOrder>;
+  outOfStockThreshold?: InputMaybe<SortOrder>;
   token?: InputMaybe<SortOrder>;
   updatedAt?: InputMaybe<SortOrder>;
 };
@@ -691,15 +698,19 @@ export type CreateAssetInput = {
 export type CreateAssetResult = Asset | MimeTypeError;
 
 export type CreateChannelInput = {
+  availableCurrencyCodes?: InputMaybe<Array<CurrencyCode>>;
+  availableLanguageCodes?: InputMaybe<Array<LanguageCode>>;
   code: Scalars['String'];
   currencyCode: CurrencyCode;
   customFields?: InputMaybe<Scalars['JSON']>;
   defaultLanguageCode: LanguageCode;
   defaultShippingZoneId: Scalars['ID'];
   defaultTaxZoneId: Scalars['ID'];
+  outOfStockThreshold?: InputMaybe<Scalars['Int']>;
   pricesIncludeTax: Scalars['Boolean'];
   sellerId?: InputMaybe<Scalars['ID']>;
   token: Scalars['String'];
+  trackInventory?: InputMaybe<Scalars['Boolean']>;
 };
 
 export type CreateChannelResult = Channel | LanguageNotAvailableError;
@@ -5968,16 +5979,20 @@ export type UpdateAssetInput = {
 };
 
 export type UpdateChannelInput = {
+  availableCurrencyCodes?: InputMaybe<Array<CurrencyCode>>;
+  availableLanguageCodes?: InputMaybe<Array<LanguageCode>>;
   code?: InputMaybe<Scalars['String']>;
   currencyCode?: InputMaybe<CurrencyCode>;
   customFields?: InputMaybe<Scalars['JSON']>;
   defaultLanguageCode?: InputMaybe<LanguageCode>;
   defaultShippingZoneId?: InputMaybe<Scalars['ID']>;
   defaultTaxZoneId?: InputMaybe<Scalars['ID']>;
   id: Scalars['ID'];
+  outOfStockThreshold?: InputMaybe<Scalars['Int']>;
   pricesIncludeTax?: InputMaybe<Scalars['Boolean']>;
   sellerId?: InputMaybe<Scalars['ID']>;
   token?: InputMaybe<Scalars['String']>;
+  trackInventory?: InputMaybe<Scalars['Boolean']>;
 };
 
 export type UpdateChannelResult = Channel | LanguageNotAvailableError;

diff --git a/packages/core/e2e/graphql/generated-e2e-admin-types.ts b/packages/core/e2e/graphql/generated-e2e-admin-types.ts
@@ -352,6 +352,8 @@ export type Cancellation = Node &
     };
 
 export type Channel = Node & {
+    availableCurrencyCodes: Array<CurrencyCode>;
+    availableLanguageCodes?: Maybe<Array<LanguageCode>>;
     code: Scalars['String'];
     createdAt: Scalars['DateTime'];
     /** @deprecated Use defaultCurrencyCode instead */
@@ -362,9 +364,11 @@ export type Channel = Node & {
     defaultShippingZone?: Maybe<Zone>;
     defaultTaxZone?: Maybe<Zone>;
     id: Scalars['ID'];
+    outOfStockThreshold?: Maybe<Scalars['Int']>;
     pricesIncludeTax: Scalars['Boolean'];
     seller?: Maybe<Seller>;
     token: Scalars['String'];
+    trackInventory?: Maybe<Scalars['Boolean']>;
     updatedAt: Scalars['DateTime'];
 };
 
@@ -386,8 +390,10 @@ export type ChannelFilterParameter = {
     defaultCurrencyCode?: InputMaybe<StringOperators>;
     defaultLanguageCode?: InputMaybe<StringOperators>;
     id?: InputMaybe<IdOperators>;
+    outOfStockThreshold?: InputMaybe<NumberOperators>;
     pricesIncludeTax?: InputMaybe<BooleanOperators>;
     token?: InputMaybe<StringOperators>;
+    trackInventory?: InputMaybe<BooleanOperators>;
     updatedAt?: InputMaybe<DateOperators>;
 };
 
@@ -413,6 +419,7 @@ export type ChannelSortParameter = {
     code?: InputMaybe<SortOrder>;
     createdAt?: InputMaybe<SortOrder>;
     id?: InputMaybe<SortOrder>;
+    outOfStockThreshold?: InputMaybe<SortOrder>;
     token?: InputMaybe<SortOrder>;
     updatedAt?: InputMaybe<SortOrder>;
 };
@@ -679,15 +686,19 @@ export type CreateAssetInput = {
 export type CreateAssetResult = Asset | MimeTypeError;
 
 export type CreateChannelInput = {
+    availableCurrencyCodes?: InputMaybe<Array<CurrencyCode>>;
+    availableLanguageCodes?: InputMaybe<Array<LanguageCode>>;
     code: Scalars['String'];
     currencyCode: CurrencyCode;
     customFields?: InputMaybe<Scalars['JSON']>;
     defaultLanguageCode: LanguageCode;
     defaultShippingZoneId: Scalars['ID'];
     defaultTaxZoneId: Scalars['ID'];
+    outOfStockThreshold?: InputMaybe<Scalars['Int']>;
     pricesIncludeTax: Scalars['Boolean'];
     sellerId?: InputMaybe<Scalars['ID']>;
     token: Scalars['String'];
+    trackInventory?: InputMaybe<Scalars['Boolean']>;
 };
 
 export type CreateChannelResult = Channel | LanguageNotAvailableError;
@@ -5646,16 +5657,20 @@ export type UpdateAssetInput = {
 };
 
 export type UpdateChannelInput = {
+    availableCurrencyCodes?: InputMaybe<Array<CurrencyCode>>;
+    availableLanguageCodes?: InputMaybe<Array<LanguageCode>>;
     code?: InputMaybe<Scalars['String']>;
     currencyCode?: InputMaybe<CurrencyCode>;
     customFields?: InputMaybe<Scalars['JSON']>;
     defaultLanguageCode?: InputMaybe<LanguageCode>;
     defaultShippingZoneId?: InputMaybe<Scalars['ID']>;
     defaultTaxZoneId?: InputMaybe<Scalars['ID']>;
     id: Scalars['ID'];
+    outOfStockThreshold?: InputMaybe<Scalars['Int']>;
     pricesIncludeTax?: InputMaybe<Scalars['Boolean']>;
     sellerId?: InputMaybe<Scalars['ID']>;
     token?: InputMaybe<Scalars['String']>;
+    trackInventory?: InputMaybe<Scalars['Boolean']>;
 };
 
 export type UpdateChannelResult = Channel | LanguageNotAvailableError;

diff --git a/packages/core/e2e/graphql/generated-e2e-shop-types.ts b/packages/core/e2e/graphql/generated-e2e-shop-types.ts
@@ -137,6 +137,8 @@ export type BooleanOperators = {
 };
 
 export type Channel = Node & {
+    availableCurrencyCodes: Array<CurrencyCode>;
+    availableLanguageCodes?: Maybe<Array<LanguageCode>>;
     code: Scalars['String'];
     createdAt: Scalars['DateTime'];
     /** @deprecated Use defaultCurrencyCode instead */
@@ -147,9 +149,11 @@ export type Channel = Node & {
     defaultShippingZone?: Maybe<Zone>;
     defaultTaxZone?: Maybe<Zone>;
     id: Scalars['ID'];
+    outOfStockThreshold?: Maybe<Scalars['Int']>;
     pricesIncludeTax: Scalars['Boolean'];
     seller?: Maybe<Seller>;
     token: Scalars['String'];
+    trackInventory?: Maybe<Scalars['Boolean']>;
     updatedAt: Scalars['DateTime'];
 };
 

diff --git a/packages/core/src/api/schema/admin-api/channel.api.graphql b/packages/core/src/api/schema/admin-api/channel.api.graphql
@@ -29,8 +29,12 @@ input CreateChannelInput {
     code: String!
     token: String!
     defaultLanguageCode: LanguageCode!
+    availableLanguageCodes: [LanguageCode!]
     pricesIncludeTax: Boolean!
     currencyCode: CurrencyCode!
+    availableCurrencyCodes: [CurrencyCode!]
+    trackInventory: Boolean
+    outOfStockThreshold: Int
     defaultTaxZoneId: ID!
     defaultShippingZoneId: ID!
     sellerId: ID
@@ -41,8 +45,12 @@ input UpdateChannelInput {
     code: String
     token: String
     defaultLanguageCode: LanguageCode
+    availableLanguageCodes: [LanguageCode!]
     pricesIncludeTax: Boolean
     currencyCode: CurrencyCode
+    availableCurrencyCodes: [CurrencyCode!]
+    trackInventory: Boolean
+    outOfStockThreshold: Int
     defaultTaxZoneId: ID
     defaultShippingZoneId: ID
     sellerId: ID

diff --git a/packages/core/src/api/schema/common/channel.type.graphql b/packages/core/src/api/schema/common/channel.type.graphql
@@ -7,8 +7,12 @@ type Channel implements Node {
     defaultTaxZone: Zone
     defaultShippingZone: Zone
     defaultLanguageCode: LanguageCode!
+    availableLanguageCodes: [LanguageCode!]
     currencyCode: CurrencyCode! @deprecated(reason: "Use defaultCurrencyCode instead")
     defaultCurrencyCode: CurrencyCode!
+    availableCurrencyCodes: [CurrencyCode!]!
+    trackInventory: Boolean
+    outOfStockThreshold: Int
     pricesIncludeTax: Boolean!
     seller: Seller
 }
diff --git a/packages/core/src/entity/channel/channel.entity.ts b/packages/core/src/entity/channel/channel.entity.ts
@@ -41,6 +41,9 @@ export class Channel extends VendureEntity {
 
     @Column('varchar') defaultLanguageCode: LanguageCode;
 
+    @Column('simple-array')
+    availableLanguageCodes: LanguageCode[];
+
     @Index()
     @ManyToOne(type => Zone)
     defaultTaxZone: Zone;
@@ -52,6 +55,26 @@ export class Channel extends VendureEntity {
     @Column('varchar')
     defaultCurrencyCode: CurrencyCode;
 
+    @Column('simple-array')
+    availableCurrencyCodes: CurrencyCode[];
+
+    /**
+     * @description
+     * Specifies the default value for inventory tracking for ProductVariants.
+     * Can be overridden per ProductVariant, but this value determines the default
+     * if not otherwise specified.
+     */
+    @Column({ default: true })
+    trackInventory: boolean;
+
+    /**
+     * @description
+     * Specifies the value of stockOnHand at which a given ProductVariant is considered
+     * out of stock.
+     */
+    @Column({ default: 0 })
+    outOfStockThreshold: number;
+
     @Column(type => CustomChannelFields)
     customFields: CustomChannelFields;
 

diff --git a/packages/core/src/entity/global-settings/global-settings.entity.ts b/packages/core/src/entity/global-settings/global-settings.entity.ts
@@ -12,6 +12,9 @@ export class GlobalSettings extends VendureEntity implements HasCustomFields {
         super(input);
     }
 
+    /**
+     * @deprecated use `Channel.availableLanguageCodes`
+     */
     @Column('simple-array')
     availableLanguages: LanguageCode[];
 
@@ -20,6 +23,8 @@ export class GlobalSettings extends VendureEntity implements HasCustomFields {
      * Specifies the default value for inventory tracking for ProductVariants.
      * Can be overridden per ProductVariant, but this value determines the default
      * if not otherwise specified.
+     *
+     * @deprecated use `Channel.trackInventory`
      */
     @Column({ default: true })
     trackInventory: boolean;
@@ -28,6 +33,8 @@ export class GlobalSettings extends VendureEntity implements HasCustomFields {
      * @description
      * Specifies the value of stockOnHand at which a given ProductVariant is considered
      * out of stock.
+     *
+     * @deprecated use `Channel.outOfStockThreshold`
      */
     @Column({ default: 0 })
     outOfStockThreshold: number;

diff --git a/packages/core/src/service/services/channel.service.ts b/packages/core/src/service/services/channel.service.ts
@@ -228,6 +228,7 @@ export class ChannelService {
         const channel = new Channel({
             ...input,
             defaultCurrencyCode: input.currencyCode,
+            availableCurrencyCodes: input.availableCurrencyCodes ?? [input.currencyCode],
         });
         const defaultLanguageValidationResult = await this.validateDefaultLanguageCode(ctx, input);
         if (isGraphQlErrorResult(defaultLanguageValidationResult)) {