@vendure/core 2.1.0-next.3 → 2.1.0-next.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api/common/request-context.d.ts +1 -1
- package/dist/api/common/request-context.js +1 -1
- package/dist/api/decorators/allow.decorator.d.ts +2 -2
- package/dist/api/decorators/allow.decorator.js +2 -2
- package/dist/api/decorators/api.decorator.d.ts +1 -1
- package/dist/api/decorators/api.decorator.js +1 -1
- package/dist/api/decorators/relations.decorator.d.ts +3 -3
- package/dist/api/decorators/relations.decorator.js +3 -3
- package/dist/api/decorators/request-context.decorator.d.ts +1 -1
- package/dist/api/decorators/request-context.decorator.js +1 -1
- package/dist/api/decorators/transaction.decorator.d.ts +2 -2
- package/dist/api/decorators/transaction.decorator.js +1 -1
- package/dist/api/decorators/transaction.decorator.js.map +1 -1
- package/dist/api/middleware/transaction-interceptor.js.map +1 -1
- package/dist/bootstrap.d.ts +3 -3
- package/dist/bootstrap.js +3 -3
- package/dist/common/configurable-operation.d.ts +5 -5
- package/dist/common/configurable-operation.js +1 -1
- package/dist/common/error/error-result.d.ts +2 -2
- package/dist/common/error/error-result.js.map +1 -1
- package/dist/common/finite-state-machine/types.d.ts +1 -1
- package/dist/common/permission-definition.d.ts +6 -6
- package/dist/common/permission-definition.js +6 -6
- package/dist/common/types/common-types.d.ts +2 -1
- package/dist/common/types/entity-relation-paths.d.ts +1 -1
- package/dist/common/types/injectable-strategy.d.ts +1 -1
- package/dist/common/utils.d.ts +1 -1
- package/dist/common/utils.js +1 -1
- package/dist/config/asset-import-strategy/asset-import-strategy.d.ts +7 -0
- package/dist/config/asset-naming-strategy/asset-naming-strategy.d.ts +7 -0
- package/dist/config/asset-preview-strategy/asset-preview-strategy.d.ts +8 -0
- package/dist/config/asset-storage-strategy/asset-storage-strategy.d.ts +7 -0
- package/dist/config/auth/authentication-strategy.d.ts +9 -2
- package/dist/config/auth/password-hashing-strategy.d.ts +7 -0
- package/dist/config/auth/password-validation-strategy.d.ts +7 -0
- package/dist/config/catalog/collection-filter.d.ts +1 -1
- package/dist/config/catalog/collection-filter.js +1 -1
- package/dist/config/catalog/product-variant-price-calculation-strategy.d.ts +7 -0
- package/dist/config/catalog/product-variant-price-selection-strategy.d.ts +7 -0
- package/dist/config/catalog/stock-display-strategy.d.ts +7 -0
- package/dist/config/catalog/stock-location-strategy.d.ts +7 -0
- package/dist/config/custom-field/custom-field-types.d.ts +1 -66
- package/dist/config/entity/entity-id-strategy.d.ts +9 -2
- package/dist/config/entity/money-strategy.d.ts +10 -3
- package/dist/config/entity/uuid-id-strategy.d.ts +1 -1
- package/dist/config/entity/uuid-id-strategy.js +1 -1
- package/dist/config/entity-metadata/entity-metadata-modifier.d.ts +4 -4
- package/dist/config/fulfillment/fulfillment-handler.d.ts +3 -3
- package/dist/config/fulfillment/fulfillment-handler.js +3 -3
- package/dist/config/job-queue/job-queue-strategy.d.ts +7 -0
- package/dist/config/merge-config.d.ts +1 -1
- package/dist/config/merge-config.js +1 -1
- package/dist/config/order/active-order-strategy.d.ts +2 -2
- package/dist/config/order/changed-price-handling-strategy.d.ts +7 -0
- package/dist/config/order/default-guest-checkout-strategy.d.ts +1 -1
- package/dist/config/order/default-guest-checkout-strategy.js +1 -1
- package/dist/config/order/default-order-process.d.ts +1 -1
- package/dist/config/order/default-order-process.js +1 -1
- package/dist/config/order/guest-checkout-strategy.d.ts +7 -0
- package/dist/config/order/order-by-code-access-strategy.d.ts +8 -1
- package/dist/config/order/order-by-code-access-strategy.js.map +1 -1
- package/dist/config/order/order-code-strategy.d.ts +8 -1
- package/dist/config/order/order-code-strategy.js.map +1 -1
- package/dist/config/order/order-item-price-calculation-strategy.d.ts +8 -1
- package/dist/config/order/order-merge-strategy.d.ts +7 -0
- package/dist/config/order/order-placed-strategy.d.ts +7 -0
- package/dist/config/order/order-process.d.ts +7 -0
- package/dist/config/order/order-seller-strategy.d.ts +7 -0
- package/dist/config/order/stock-allocation-strategy.d.ts +7 -0
- package/dist/config/payment/payment-process.d.ts +7 -0
- package/dist/config/promotion/utils/facet-value-checker.d.ts +1 -1
- package/dist/config/promotion/utils/facet-value-checker.js +1 -1
- package/dist/config/session-cache/session-cache-strategy.d.ts +8 -1
- package/dist/config/shipping-method/shipping-eligibility-checker.d.ts +1 -1
- package/dist/config/shipping-method/shipping-eligibility-checker.js.map +1 -1
- package/dist/config/shipping-method/shipping-line-assignment-strategy.d.ts +34 -0
- package/dist/config/system/health-check-strategy.d.ts +7 -1
- package/dist/config/tax/tax-line-calculation-strategy.d.ts +7 -0
- package/dist/config/tax/tax-zone-strategy.d.ts +7 -0
- package/dist/config/vendure-config.d.ts +4 -4
- package/dist/connection/transactional-connection.d.ts +1 -1
- package/dist/data-import/providers/import-parser/import-parser.d.ts +1 -1
- package/dist/data-import/providers/import-parser/import-parser.js +1 -1
- package/dist/data-import/providers/importer/importer.d.ts +1 -1
- package/dist/data-import/providers/importer/importer.js +1 -1
- package/dist/entity/channel/channel.entity.d.ts +9 -0
- package/dist/entity/channel/channel.entity.js.map +1 -1
- package/dist/entity/entity-id.decorator.d.ts +4 -0
- package/dist/entity/entity-id.decorator.js +4 -0
- package/dist/entity/entity-id.decorator.js.map +1 -1
- package/dist/entity/index.d.ts +2 -0
- package/dist/entity/index.js +2 -0
- package/dist/entity/index.js.map +1 -1
- package/dist/entity/money.decorator.d.ts +1 -0
- package/dist/entity/money.decorator.js +1 -0
- package/dist/entity/money.decorator.js.map +1 -1
- package/dist/event-bus/event-bus.d.ts +1 -1
- package/dist/event-bus/event-bus.js +1 -1
- package/dist/health-check/health-check-registry.service.d.ts +1 -1
- package/dist/health-check/health-check-registry.service.js +1 -1
- package/dist/health-check/http-health-check-strategy.d.ts +1 -1
- package/dist/health-check/http-health-check-strategy.js +1 -1
- package/dist/health-check/typeorm-health-check-strategy.d.ts +1 -1
- package/dist/health-check/typeorm-health-check-strategy.js +1 -1
- package/dist/job-queue/in-memory-job-queue-strategy.d.ts +1 -1
- package/dist/job-queue/in-memory-job-queue-strategy.js +1 -1
- package/dist/job-queue/job-buffer/job-buffer-storage-strategy.d.ts +9 -2
- package/dist/job-queue/job-buffer/job-buffer.d.ts +2 -2
- package/dist/job-queue/job-queue.d.ts +2 -2
- package/dist/job-queue/job-queue.js +2 -2
- package/dist/job-queue/job-queue.service.d.ts +2 -2
- package/dist/job-queue/job-queue.service.js +2 -2
- package/dist/plugin/default-job-queue-plugin/default-job-queue-plugin.d.ts +5 -5
- package/dist/plugin/default-job-queue-plugin/default-job-queue-plugin.js +4 -4
- package/dist/plugin/default-search-plugin/default-search-plugin.d.ts +4 -4
- package/dist/plugin/default-search-plugin/default-search-plugin.js +4 -4
- package/dist/plugin/default-search-plugin/search-strategy/search-strategy.d.ts +7 -0
- package/dist/plugin/default-search-plugin/types.d.ts +2 -2
- package/dist/plugin/vendure-plugin.d.ts +3 -3
- package/dist/plugin/vendure-plugin.js +1 -1
- package/dist/process-context/process-context.d.ts +1 -1
- package/dist/process-context/process-context.js +1 -1
- package/dist/service/helpers/entity-hydrator/entity-hydrator.service.d.ts +3 -3
- package/dist/service/helpers/entity-hydrator/entity-hydrator.service.js +3 -3
- package/dist/service/helpers/list-query-builder/list-query-builder.d.ts +2 -2
- package/dist/service/helpers/list-query-builder/list-query-builder.js +2 -2
- package/dist/service/helpers/product-price-applicator/product-price-applicator.d.ts +1 -1
- package/dist/service/helpers/product-price-applicator/product-price-applicator.js +1 -1
- package/dist/service/helpers/translatable-saver/translatable-saver.d.ts +1 -1
- package/dist/service/helpers/translatable-saver/translatable-saver.js +1 -1
- package/dist/service/helpers/translator/translator.service.d.ts +33 -0
- package/dist/service/helpers/translator/translator.service.js +33 -0
- package/dist/service/helpers/translator/translator.service.js.map +1 -1
- package/dist/service/services/asset.service.d.ts +1 -1
- package/dist/service/services/asset.service.js +1 -1
- package/dist/service/services/history.service.d.ts +6 -6
- package/dist/service/services/history.service.js +6 -6
- package/dist/service/services/order.service.d.ts +1 -2
- package/dist/service/services/order.service.js +1 -2
- package/dist/service/services/order.service.js.map +1 -1
- package/dist/service/services/product.service.js +6 -1
- package/dist/service/services/product.service.js.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +3 -6
|
@@ -12,6 +12,40 @@ import { ShippingLine } from '../../entity/shipping-line/shipping-line.entity';
|
|
|
12
12
|
* The {@link DefaultShippingLineAssignmentStrategy} simply assigns _all_ OrderLines, so is suitable for the
|
|
13
13
|
* most common scenario of a single shipping method per Order.
|
|
14
14
|
*
|
|
15
|
+
* :::info
|
|
16
|
+
*
|
|
17
|
+
* This is configured via the `shippingOptions.shippingLineAssignmentStrategy` property of
|
|
18
|
+
* your VendureConfig.
|
|
19
|
+
*
|
|
20
|
+
* :::
|
|
21
|
+
*
|
|
22
|
+
* Here's an example of a custom ShippingLineAssignmentStrategy which assigns digital products to a
|
|
23
|
+
* different ShippingLine to physical products:
|
|
24
|
+
*
|
|
25
|
+
* ```ts
|
|
26
|
+
* import {
|
|
27
|
+
* Order,
|
|
28
|
+
* OrderLine,
|
|
29
|
+
* RequestContext,
|
|
30
|
+
* ShippingLine,
|
|
31
|
+
* ShippingLineAssignmentStrategy,
|
|
32
|
+
* } from '\@vendure/core';
|
|
33
|
+
*
|
|
34
|
+
* export class DigitalShippingLineAssignmentStrategy implements ShippingLineAssignmentStrategy {
|
|
35
|
+
* assignShippingLineToOrderLines(
|
|
36
|
+
* ctx: RequestContext,
|
|
37
|
+
* shippingLine: ShippingLine,
|
|
38
|
+
* order: Order,
|
|
39
|
+
* ): OrderLine[] | Promise<OrderLine[]> {
|
|
40
|
+
* if (shippingLine.shippingMethod.customFields.isDigital) {
|
|
41
|
+
* return order.lines.filter(l => l.productVariant.customFields.isDigital);
|
|
42
|
+
* } else {
|
|
43
|
+
* return order.lines.filter(l => !l.productVariant.customFields.isDigital);
|
|
44
|
+
* }
|
|
45
|
+
* }
|
|
46
|
+
* }
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
15
49
|
* @since 2.0.0
|
|
16
50
|
* @docsCategory shipping
|
|
17
51
|
*/
|
|
@@ -16,10 +16,16 @@ import { InjectableStrategy } from '../../common/types/injectable-strategy';
|
|
|
16
16
|
* Vendure also ships with the {@link HttpHealthCheckStrategy}, which is convenient
|
|
17
17
|
* for adding a health check dependent on an HTTP ping.
|
|
18
18
|
*
|
|
19
|
+
* :::info
|
|
20
|
+
*
|
|
21
|
+
* This is configured via the `systemOptions.healthChecks` property of
|
|
22
|
+
* your VendureConfig.
|
|
23
|
+
*
|
|
24
|
+
* :::
|
|
19
25
|
*
|
|
20
26
|
*
|
|
21
27
|
* @example
|
|
22
|
-
* ```
|
|
28
|
+
* ```ts
|
|
23
29
|
* import { HttpHealthCheckStrategy, TypeORMHealthCheckStrategy } from '\@vendure/core';
|
|
24
30
|
* import { MyCustomHealthCheckStrategy } from './config/custom-health-check-strategy';
|
|
25
31
|
*
|
|
@@ -13,6 +13,13 @@ import { TaxRate } from '../../entity/tax-rate/tax-rate.entity';
|
|
|
13
13
|
* However, custom strategies may use any suitable method for calculating TaxLines.
|
|
14
14
|
* For example, a third-party tax API or a lookup of a custom tax table may be used.
|
|
15
15
|
*
|
|
16
|
+
* :::info
|
|
17
|
+
*
|
|
18
|
+
* This is configured via the `taxOptions.taxLineCalculationStrategy` property of
|
|
19
|
+
* your VendureConfig.
|
|
20
|
+
*
|
|
21
|
+
* :::
|
|
22
|
+
*
|
|
16
23
|
* @docsCategory tax
|
|
17
24
|
* @docsPage TaxLineCalculationStrategy
|
|
18
25
|
* @docsWeight 0
|
|
@@ -15,6 +15,13 @@ import { Channel, Order, Zone } from '../../entity';
|
|
|
15
15
|
* Note that this method is called very often in a typical user session, so any work it performs should be designed with as little
|
|
16
16
|
* performance impact as possible.
|
|
17
17
|
*
|
|
18
|
+
* :::info
|
|
19
|
+
*
|
|
20
|
+
* This is configured via the `taxOptions.taxZoneStrategy` property of
|
|
21
|
+
* your VendureConfig.
|
|
22
|
+
*
|
|
23
|
+
* :::
|
|
24
|
+
*
|
|
18
25
|
* @docsCategory tax
|
|
19
26
|
*/
|
|
20
27
|
export interface TaxZoneStrategy extends InjectableStrategy {
|
|
@@ -169,7 +169,7 @@ export interface ApiOptions {
|
|
|
169
169
|
cors?: boolean | CorsOptions;
|
|
170
170
|
/**
|
|
171
171
|
* @description
|
|
172
|
-
* Custom Express or NestJS middleware for the server.
|
|
172
|
+
* Custom Express or NestJS middleware for the server. More information can be found in the {@link Middleware} docs.
|
|
173
173
|
*
|
|
174
174
|
* @default []
|
|
175
175
|
*/
|
|
@@ -195,7 +195,7 @@ export interface ApiOptions {
|
|
|
195
195
|
* will not work.
|
|
196
196
|
*
|
|
197
197
|
* @example
|
|
198
|
-
* ```
|
|
198
|
+
* ```ts
|
|
199
199
|
* {
|
|
200
200
|
* introspection: process.env.NODE_ENV !== 'production'
|
|
201
201
|
* }
|
|
@@ -893,12 +893,12 @@ export interface EntityOptions {
|
|
|
893
893
|
* entities via the API. The default uses a simple auto-increment integer
|
|
894
894
|
* strategy.
|
|
895
895
|
*
|
|
896
|
-
*
|
|
896
|
+
* :::caution
|
|
897
897
|
* Note: changing from an integer-based strategy to a uuid-based strategy
|
|
898
898
|
* on an existing Vendure database will lead to problems with broken foreign-key
|
|
899
899
|
* references. To change primary key types like this, you'll need to start with
|
|
900
900
|
* a fresh database.
|
|
901
|
-
*
|
|
901
|
+
* :::
|
|
902
902
|
*
|
|
903
903
|
* @since 1.3.0
|
|
904
904
|
* @default AutoIncrementIdStrategy
|
|
@@ -67,7 +67,7 @@ export declare class TransactionalConnection {
|
|
|
67
67
|
* all inner method calls.
|
|
68
68
|
*
|
|
69
69
|
* @example
|
|
70
|
-
* ```
|
|
70
|
+
* ```ts
|
|
71
71
|
* private async transferCredit(outerCtx: RequestContext, fromId: ID, toId: ID, amount: number) {
|
|
72
72
|
* await this.connection.withTransaction(outerCtx, async ctx => {
|
|
73
73
|
* // Note you must not use `outerCtx` here, instead use `ctx`. Otherwise, this query
|
|
@@ -117,7 +117,7 @@ export declare class ImportParser {
|
|
|
117
117
|
constructor(configService: ConfigService);
|
|
118
118
|
/**
|
|
119
119
|
* @description
|
|
120
|
-
* Parses the contents of the [product import CSV file](/
|
|
120
|
+
* Parses the contents of the [product import CSV file](/guides/developer-guide/importing-data/#product-import-format) and
|
|
121
121
|
* returns a data structure which can then be used to populate Vendure using the {@link FastImporterService}.
|
|
122
122
|
*/
|
|
123
123
|
parseProducts(input: string | Stream, mainLanguage?: LanguageCode): Promise<ParseResult<ParsedProductWithVariants>>;
|
|
@@ -59,7 +59,7 @@ let ImportParser = class ImportParser {
|
|
|
59
59
|
}
|
|
60
60
|
/**
|
|
61
61
|
* @description
|
|
62
|
-
* Parses the contents of the [product import CSV file](/
|
|
62
|
+
* Parses the contents of the [product import CSV file](/guides/developer-guide/importing-data/#product-import-format) and
|
|
63
63
|
* returns a data structure which can then be used to populate Vendure using the {@link FastImporterService}.
|
|
64
64
|
*/
|
|
65
65
|
async parseProducts(input, mainLanguage = this.configService.defaultLanguageCode) {
|
|
@@ -41,7 +41,7 @@ export declare class Importer {
|
|
|
41
41
|
constructor(configService: ConfigService, importParser: ImportParser, channelService: ChannelService, facetService: FacetService, facetValueService: FacetValueService, taxCategoryService: TaxCategoryService, assetImporter: AssetImporter, fastImporter: FastImporterService);
|
|
42
42
|
/**
|
|
43
43
|
* @description
|
|
44
|
-
* Parses the contents of the [product import CSV file](/
|
|
44
|
+
* Parses the contents of the [product import CSV file](/guides/developer-guide/importing-data/#product-import-format) and imports
|
|
45
45
|
* the resulting Product & ProductVariants, as well as any associated Assets, Facets & FacetValues.
|
|
46
46
|
*
|
|
47
47
|
* The `ctxOrLanguageCode` argument is used to specify the languageCode to be used when creating the Products.
|
|
@@ -56,7 +56,7 @@ let Importer = class Importer {
|
|
|
56
56
|
}
|
|
57
57
|
/**
|
|
58
58
|
* @description
|
|
59
|
-
* Parses the contents of the [product import CSV file](/
|
|
59
|
+
* Parses the contents of the [product import CSV file](/guides/developer-guide/importing-data/#product-import-format) and imports
|
|
60
60
|
* the resulting Product & ProductVariants, as well as any associated Assets, Facets & FacetValues.
|
|
61
61
|
*
|
|
62
62
|
* The `ctxOrLanguageCode` argument is used to specify the languageCode to be used when creating the Products.
|
|
@@ -26,7 +26,16 @@ import { Zone } from '../zone/zone.entity';
|
|
|
26
26
|
*/
|
|
27
27
|
export declare class Channel extends VendureEntity {
|
|
28
28
|
constructor(input?: DeepPartial<Channel>);
|
|
29
|
+
/**
|
|
30
|
+
* @description
|
|
31
|
+
* The name of the Channel. For example "US Webstore" or "German Webstore".
|
|
32
|
+
*/
|
|
29
33
|
code: string;
|
|
34
|
+
/**
|
|
35
|
+
* @description
|
|
36
|
+
* A unique token (string) used to identify the Channel in the `vendure-token` header of the
|
|
37
|
+
* GraphQL API requests.
|
|
38
|
+
*/
|
|
30
39
|
token: string;
|
|
31
40
|
description: string;
|
|
32
41
|
seller?: Seller;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"channel.entity.js","sourceRoot":"","sources":["../../../src/entity/channel/channel.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yEAAiF;AAEjF,qCAA2D;AAE3D,qDAAoD;AACpD,kEAA8D;AAC9D,gEAAkD;AAClD,2DAAiD;AACjD,qDAA2C;AAE3C;;;;;;;;;;;;;;;;;;;GAmBG;AAEI,IAAM,OAAO,GAAb,MAAM,OAAQ,SAAQ,2BAAa;IACtC,YAAY,KAA4B;QACpC,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE;YACxB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;SACrC;IACL,CAAC;
|
|
1
|
+
{"version":3,"file":"channel.entity.js","sourceRoot":"","sources":["../../../src/entity/channel/channel.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yEAAiF;AAEjF,qCAA2D;AAE3D,qDAAoD;AACpD,kEAA8D;AAC9D,gEAAkD;AAClD,2DAAiD;AACjD,qDAA2C;AAE3C;;;;;;;;;;;;;;;;;;;GAmBG;AAEI,IAAM,OAAO,GAAb,MAAM,OAAQ,SAAQ,2BAAa;IACtC,YAAY,KAA4B;QACpC,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE;YACxB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;SACrC;IACL,CAAC;IAoEO,aAAa;QACjB,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACpE,OAAO,GAAG,YAAY,EAAE,GAAG,YAAY,EAAE,EAAE,CAAC;IAChD,CAAC;CACJ,CAAA;AAlEG;IAAC,IAAA,gBAAM,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;;qCACZ;AAOb;IAAC,IAAA,gBAAM,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;;sCACX;AAEd;IAAC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;4CACpB;AAEpB;IAAC,IAAA,eAAK,GAAE;IACP,IAAA,mBAAS,EAAC,IAAI,CAAC,EAAE,CAAC,sBAAM,CAAC;8BACjB,sBAAM;uCAAC;AAEhB;IAAC,IAAA,8BAAQ,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yCACf;AAEd;IAAC,IAAA,gBAAM,EAAC,SAAS,CAAC;;oDAAmC;AAErD;IAAC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uDACV;AAEvC;IAAC,IAAA,eAAK,GAAE;IACP,IAAA,mBAAS,EAAC,IAAI,CAAC,EAAE,CAAC,kBAAI,CAAC;8BACR,kBAAI;+CAAC;AAErB;IAAC,IAAA,eAAK,GAAE;IACP,IAAA,mBAAS,EAAC,IAAI,CAAC,EAAE,CAAC,kBAAI,CAAC;8BACH,kBAAI;oDAAC;AAE1B;IAAC,IAAA,gBAAM,EAAC,SAAS,CAAC;;oDACgB;AAElC;IAAC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uDACV;AAQvC;IAAC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;+CACF;AAOxB;IAAC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;;oDACK;AAE5B;IAAC,IAAA,gBAAM,EAAC,IAAI,CAAC,EAAE,CAAC,0CAAmB,CAAC;8BACtB,0CAAmB;6CAAC;AAElC;IAAC,IAAA,gBAAM,GAAE;;iDAA2B;AAxE3B,OAAO;IADnB,IAAA,gBAAM,GAAE;;GACI,OAAO,CA8EnB;AA9EY,0BAAO"}
|
|
@@ -16,9 +16,13 @@ interface IdColumnConfig {
|
|
|
16
16
|
*/
|
|
17
17
|
export declare function PrimaryGeneratedId(): (entity: any, propertyName: string) => void;
|
|
18
18
|
/**
|
|
19
|
+
* @description
|
|
19
20
|
* Decorates a property which points to another entity by ID. This custom decorator is needed
|
|
20
21
|
* because we do not know the data type of the ID column until runtime, when we have access
|
|
21
22
|
* to the configured EntityIdStrategy.
|
|
23
|
+
*
|
|
24
|
+
* @docsCategory configuration
|
|
25
|
+
* @docsPage EntityId Decorator
|
|
22
26
|
*/
|
|
23
27
|
export declare function EntityId(options?: IdColumnOptions): (entity: any, propertyName: string) => void;
|
|
24
28
|
/**
|
|
@@ -17,9 +17,13 @@ function PrimaryGeneratedId() {
|
|
|
17
17
|
}
|
|
18
18
|
exports.PrimaryGeneratedId = PrimaryGeneratedId;
|
|
19
19
|
/**
|
|
20
|
+
* @description
|
|
20
21
|
* Decorates a property which points to another entity by ID. This custom decorator is needed
|
|
21
22
|
* because we do not know the data type of the ID column until runtime, when we have access
|
|
22
23
|
* to the configured EntityIdStrategy.
|
|
24
|
+
*
|
|
25
|
+
* @docsCategory configuration
|
|
26
|
+
* @docsPage EntityId Decorator
|
|
23
27
|
*/
|
|
24
28
|
function EntityId(options) {
|
|
25
29
|
return (entity, propertyName) => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entity-id.decorator.js","sourceRoot":"","sources":["../../src/entity/entity-id.decorator.ts"],"names":[],"mappings":";;;AAeA,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAyB,CAAC;AAC1D,IAAI,sBAAiE,CAAC;AAEtE;;;GAGG;AACH,SAAgB,kBAAkB;IAC9B,OAAO,CAAC,MAAW,EAAE,YAAoB,EAAE,EAAE;QACzC,sBAAsB,GAAG;YACrB,MAAM;YACN,IAAI,EAAE,YAAY;SACrB,CAAC;IACN,CAAC,CAAC;AACN,CAAC;AAPD,gDAOC;AAED
|
|
1
|
+
{"version":3,"file":"entity-id.decorator.js","sourceRoot":"","sources":["../../src/entity/entity-id.decorator.ts"],"names":[],"mappings":";;;AAeA,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAyB,CAAC;AAC1D,IAAI,sBAAiE,CAAC;AAEtE;;;GAGG;AACH,SAAgB,kBAAkB;IAC9B,OAAO,CAAC,MAAW,EAAE,YAAoB,EAAE,EAAE;QACzC,sBAAsB,GAAG;YACrB,MAAM;YACN,IAAI,EAAE,YAAY;SACrB,CAAC;IACN,CAAC,CAAC;AACN,CAAC;AAPD,gDAOC;AAED;;;;;;;;GAQG;AACH,SAAgB,QAAQ,CAAC,OAAyB;IAC9C,OAAO,CAAC,MAAW,EAAE,YAAoB,EAAE,EAAE;QACzC,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;QACtD,IAAI,SAAS,EAAE;YACX,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACzB;aAAM;YACH,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;SACzC;IACL,CAAC,CAAC;AACN,CAAC;AAVD,4BAUC;AAED;;;GAGG;AACH,SAAgB,eAAe,CAAC,UAAqB;IACjD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CACrD,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,KAAK,UAAU,CAC3D,CAAC;IACF,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACjC,CAAC;AALD,0CAKC;AAED;;;GAGG;AACH,SAAgB,2BAA2B;IACvC,IAAI,CAAC,sBAAsB,EAAE;QACzB,MAAM,IAAI,KAAK,CACX,mIAAmI,CACtI,CAAC;KACL;IACD,OAAO,sBAAsB,CAAC;AAClC,CAAC;AAPD,kEAOC"}
|
package/dist/entity/index.d.ts
CHANGED
package/dist/entity/index.js
CHANGED
|
@@ -78,4 +78,6 @@ __exportStar(require("./tax-category/tax-category.entity"), exports);
|
|
|
78
78
|
__exportStar(require("./tax-rate/tax-rate.entity"), exports);
|
|
79
79
|
__exportStar(require("./user/user.entity"), exports);
|
|
80
80
|
__exportStar(require("./zone/zone.entity"), exports);
|
|
81
|
+
__exportStar(require("./entity-id.decorator"), exports);
|
|
82
|
+
__exportStar(require("./money.decorator"), exports);
|
|
81
83
|
//# sourceMappingURL=index.js.map
|
package/dist/entity/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/entity/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAyC;AACzC,uEAAqD;AACrD,uDAAqC;AACrC,uFAAqE;AACrE,gGAA8E;AAC9E,8FAA4E;AAC5E,qDAAmC;AACnC,2DAAyC;AACzC,uEAAqD;AACrD,6EAA2D;AAC3D,iEAA+C;AAC/C,0DAAwC;AACxC,yDAAuC;AACvC,yEAAuD;AACvD,6DAA2C;AAC3C,+EAA6D;AAC7D,mEAAiD;AACjD,mEAAiD;AACjD,uDAAqC;AACrC,mEAAiD;AACjD,2EAAyD;AACzD,uDAAqC;AACrC,iEAA+C;AAC/C,iFAA+D;AAC/D,wFAAsE;AACtE,qFAAmE;AACnE,4EAA0D;AAC1D,2DAAyC;AACzC,yEAAuD;AACvD,2DAAyC;AACzC,iGAA+E;AAC/E,qFAAmE;AACnE,qFAAmE;AACnE,yEAAuD;AACvD,iFAA+D;AAC/D,iFAA+D;AAC/D,uFAAqE;AACrE,2EAAyD;AACzD,iEAA+C;AAC/C,uEAAqD;AACrD,2DAAyC;AACzC,+DAA6C;AAC7C,yDAAuC;AACvC,qDAAmC;AACnC,yDAAuC;AACvC,qEAAmD;AACnD,yEAAuD;AACvD,2DAAyC;AACzC,uEAAqD;AACrD,2EAAyD;AACzD,mEAAiD;AACjD,yEAAuD;AACvD,qEAAmD;AACnD,uEAAqD;AACrD,kEAAgD;AAChD,+DAA6C;AAC7C,2EAAyD;AACzD,yEAAuD;AACvD,+DAA6C;AAC7C,mDAAiC;AACjC,qEAAmD;AACnD,6DAA2C;AAC3C,qDAAmC;AACnC,qDAAmC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/entity/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAyC;AACzC,uEAAqD;AACrD,uDAAqC;AACrC,uFAAqE;AACrE,gGAA8E;AAC9E,8FAA4E;AAC5E,qDAAmC;AACnC,2DAAyC;AACzC,uEAAqD;AACrD,6EAA2D;AAC3D,iEAA+C;AAC/C,0DAAwC;AACxC,yDAAuC;AACvC,yEAAuD;AACvD,6DAA2C;AAC3C,+EAA6D;AAC7D,mEAAiD;AACjD,mEAAiD;AACjD,uDAAqC;AACrC,mEAAiD;AACjD,2EAAyD;AACzD,uDAAqC;AACrC,iEAA+C;AAC/C,iFAA+D;AAC/D,wFAAsE;AACtE,qFAAmE;AACnE,4EAA0D;AAC1D,2DAAyC;AACzC,yEAAuD;AACvD,2DAAyC;AACzC,iGAA+E;AAC/E,qFAAmE;AACnE,qFAAmE;AACnE,yEAAuD;AACvD,iFAA+D;AAC/D,iFAA+D;AAC/D,uFAAqE;AACrE,2EAAyD;AACzD,iEAA+C;AAC/C,uEAAqD;AACrD,2DAAyC;AACzC,+DAA6C;AAC7C,yDAAuC;AACvC,qDAAmC;AACnC,yDAAuC;AACvC,qEAAmD;AACnD,yEAAuD;AACvD,2DAAyC;AACzC,uEAAqD;AACrD,2EAAyD;AACzD,mEAAiD;AACjD,yEAAuD;AACvD,qEAAmD;AACnD,uEAAqD;AACrD,kEAAgD;AAChD,+DAA6C;AAC7C,2EAAyD;AACzD,yEAAuD;AACvD,+DAA6C;AAC7C,mDAAiC;AACjC,qEAAmD;AACnD,6DAA2C;AAC3C,qDAAmC;AACnC,qDAAmC;AACnC,wDAAsC;AACtC,oDAAkC"}
|
|
@@ -15,6 +15,7 @@ interface MoneyColumnConfig {
|
|
|
15
15
|
* This allows the column type to be defined by the configured {@link MoneyStrategy}.
|
|
16
16
|
*
|
|
17
17
|
* @docsCategory money
|
|
18
|
+
* @docsPage Money Decorator
|
|
18
19
|
* @since 2.0.0
|
|
19
20
|
*/
|
|
20
21
|
export declare function Money(options?: MoneyColumnOptions): (entity: any, propertyName: string) => void;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"money.decorator.js","sourceRoot":"","sources":["../../src/entity/money.decorator.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"money.decorator.js","sourceRoot":"","sources":["../../src/entity/money.decorator.ts"],"names":[],"mappings":";;;AAcA,MAAM,mBAAmB,GAAG,IAAI,GAAG,EAA4B,CAAC;AAEhE;;;;;;;;GAQG;AACH,SAAgB,KAAK,CAAC,OAA4B;IAC9C,OAAO,CAAC,MAAW,EAAE,YAAoB,EAAE,EAAE;QACzC,MAAM,SAAS,GAAG,mBAAmB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAClD,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;QACtD,IAAI,SAAS,EAAE;YACX,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACzB;aAAM;YACH,mBAAmB,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;SAC5C;IACL,CAAC,CAAC;AACN,CAAC;AAVD,sBAUC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,UAAqB;IACpD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CACxD,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,KAAK,UAAU,CAC3D,CAAC;IACF,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACjC,CAAC;AALD,gDAKC"}
|
|
@@ -18,7 +18,7 @@ import { VendureEvent } from './vendure-event';
|
|
|
18
18
|
* stream of events:
|
|
19
19
|
*
|
|
20
20
|
* @example
|
|
21
|
-
* ```
|
|
21
|
+
* ```ts
|
|
22
22
|
* import { OnApplicationBootstrap } from '\@nestjs/common';
|
|
23
23
|
* import { EventBus, PluginCommonModule, VendurePlugin } from '\@vendure/core';
|
|
24
24
|
* import { filter } from 'rxjs/operators';
|
|
@@ -32,7 +32,7 @@ const transaction_subscriber_1 = require("../connection/transaction-subscriber")
|
|
|
32
32
|
* stream of events:
|
|
33
33
|
*
|
|
34
34
|
* @example
|
|
35
|
-
* ```
|
|
35
|
+
* ```ts
|
|
36
36
|
* import { OnApplicationBootstrap } from '\@nestjs/common';
|
|
37
37
|
* import { EventBus, PluginCommonModule, VendurePlugin } from '\@vendure/core';
|
|
38
38
|
* import { filter } from 'rxjs/operators';
|
|
@@ -22,7 +22,7 @@ import { HealthIndicatorFunction } from '@nestjs/terminus';
|
|
|
22
22
|
* plugin module. To use it in your plugin, you'll need to import the {@link PluginCommonModule}:
|
|
23
23
|
*
|
|
24
24
|
* @example
|
|
25
|
-
* ```
|
|
25
|
+
* ```ts
|
|
26
26
|
* import { HealthCheckRegistryService, PluginCommonModule, VendurePlugin } from '\@vendure/core';
|
|
27
27
|
* import { TerminusModule } from '\@nestjs/terminus';
|
|
28
28
|
*
|
|
@@ -24,7 +24,7 @@ exports.HealthCheckRegistryService = void 0;
|
|
|
24
24
|
* plugin module. To use it in your plugin, you'll need to import the {@link PluginCommonModule}:
|
|
25
25
|
*
|
|
26
26
|
* @example
|
|
27
|
-
* ```
|
|
27
|
+
* ```ts
|
|
28
28
|
* import { HealthCheckRegistryService, PluginCommonModule, VendurePlugin } from '\@vendure/core';
|
|
29
29
|
* import { TerminusModule } from '\@nestjs/terminus';
|
|
30
30
|
*
|
|
@@ -12,7 +12,7 @@ export interface HttpHealthCheckOptions {
|
|
|
12
12
|
* the [NestJS HttpHealthIndicator](https://docs.nestjs.com/recipes/terminus#http-healthcheck).
|
|
13
13
|
*
|
|
14
14
|
* @example
|
|
15
|
-
* ```
|
|
15
|
+
* ```ts
|
|
16
16
|
* import { HttpHealthCheckStrategy, TypeORMHealthCheckStrategy } from '\@vendure/core';
|
|
17
17
|
*
|
|
18
18
|
* export const config = {
|
|
@@ -9,7 +9,7 @@ let indicator;
|
|
|
9
9
|
* the [NestJS HttpHealthIndicator](https://docs.nestjs.com/recipes/terminus#http-healthcheck).
|
|
10
10
|
*
|
|
11
11
|
* @example
|
|
12
|
-
* ```
|
|
12
|
+
* ```ts
|
|
13
13
|
* import { HttpHealthCheckStrategy, TypeORMHealthCheckStrategy } from '\@vendure/core';
|
|
14
14
|
*
|
|
15
15
|
* export const config = {
|
|
@@ -5,6 +5,13 @@ import { Job } from '../job';
|
|
|
5
5
|
* This strategy defines where to store jobs that have been collected by a
|
|
6
6
|
* {@link JobBuffer}.
|
|
7
7
|
*
|
|
8
|
+
* :::info
|
|
9
|
+
*
|
|
10
|
+
* This is configured via the `jobQueueOptions.jobBufferStorageStrategy` property of
|
|
11
|
+
* your VendureConfig.
|
|
12
|
+
*
|
|
13
|
+
* :::
|
|
14
|
+
*
|
|
8
15
|
* @since 1.3.0
|
|
9
16
|
* @docsCategory job-queue
|
|
10
17
|
*/
|
|
@@ -24,7 +31,7 @@ export interface JobBufferStorageStrategy extends InjectableStrategy {
|
|
|
24
31
|
* If the array is empty, sizes will be returned for _all_ bufferIds.
|
|
25
32
|
*
|
|
26
33
|
* @example
|
|
27
|
-
* ```
|
|
34
|
+
* ```ts
|
|
28
35
|
* const sizes = await myJobBufferStrategy.bufferSize(['buffer-1', 'buffer-2']);
|
|
29
36
|
*
|
|
30
37
|
* // sizes = { 'buffer-1': 12, 'buffer-2': 3 }
|
|
@@ -40,7 +47,7 @@ export interface JobBufferStorageStrategy extends InjectableStrategy {
|
|
|
40
47
|
* arranged by bufferId
|
|
41
48
|
*
|
|
42
49
|
* @example
|
|
43
|
-
* ```
|
|
50
|
+
* ```ts
|
|
44
51
|
* const result = await myJobBufferStrategy.flush(['buffer-1', 'buffer-2']);
|
|
45
52
|
*
|
|
46
53
|
* // result = {
|
|
@@ -16,7 +16,7 @@ import { JobData } from '../types';
|
|
|
16
16
|
* work.
|
|
17
17
|
*
|
|
18
18
|
* @example
|
|
19
|
-
* ```
|
|
19
|
+
* ```ts
|
|
20
20
|
* // This is a buffer which will collect all the
|
|
21
21
|
* // 'apply-collection-filters' jobs and buffer them.
|
|
22
22
|
* export class CollectionJobBuffer implements JobBuffer<ApplyCollectionFiltersJobData> {
|
|
@@ -62,7 +62,7 @@ import { JobData } from '../types';
|
|
|
62
62
|
* `reduce()` method and sent to the job queue.
|
|
63
63
|
*
|
|
64
64
|
* @example
|
|
65
|
-
* ```
|
|
65
|
+
* ```ts
|
|
66
66
|
* const collectionBuffer = new CollectionJobBuffer();
|
|
67
67
|
*
|
|
68
68
|
* await this.jobQueueService.addBuffer(collectionBuffer);
|
|
@@ -32,7 +32,7 @@ export declare class JobQueue<Data extends JobData<Data> = object> {
|
|
|
32
32
|
* calling code to subscribe to updates to the Job:
|
|
33
33
|
*
|
|
34
34
|
* @example
|
|
35
|
-
* ```
|
|
35
|
+
* ```ts
|
|
36
36
|
* const job = await this.myQueue.add({ intervalMs, shouldFail }, { retries: 2 });
|
|
37
37
|
* return job.updates().pipe(
|
|
38
38
|
* map(update => {
|
|
@@ -52,7 +52,7 @@ export declare class JobQueue<Data extends JobData<Data> = object> {
|
|
|
52
52
|
* `progress` changes, you can convert to a Promise like this:
|
|
53
53
|
*
|
|
54
54
|
* @example
|
|
55
|
-
* ```
|
|
55
|
+
* ```ts
|
|
56
56
|
* const job = await this.myQueue.add({ intervalMs, shouldFail }, { retries: 2 });
|
|
57
57
|
* return job.updates().toPromise()
|
|
58
58
|
* .then(update => update.result),
|
|
@@ -51,7 +51,7 @@ class JobQueue {
|
|
|
51
51
|
* calling code to subscribe to updates to the Job:
|
|
52
52
|
*
|
|
53
53
|
* @example
|
|
54
|
-
* ```
|
|
54
|
+
* ```ts
|
|
55
55
|
* const job = await this.myQueue.add({ intervalMs, shouldFail }, { retries: 2 });
|
|
56
56
|
* return job.updates().pipe(
|
|
57
57
|
* map(update => {
|
|
@@ -71,7 +71,7 @@ class JobQueue {
|
|
|
71
71
|
* `progress` changes, you can convert to a Promise like this:
|
|
72
72
|
*
|
|
73
73
|
* @example
|
|
74
|
-
* ```
|
|
74
|
+
* ```ts
|
|
75
75
|
* const job = await this.myQueue.add({ intervalMs, shouldFail }, { retries: 2 });
|
|
76
76
|
* return job.updates().toPromise()
|
|
77
77
|
* .then(update => update.result),
|
|
@@ -12,7 +12,7 @@ import { CreateQueueOptions, JobData } from './types';
|
|
|
12
12
|
* existing jobs.
|
|
13
13
|
*
|
|
14
14
|
* @example
|
|
15
|
-
* ```
|
|
15
|
+
* ```ts
|
|
16
16
|
* // A service which transcodes video files
|
|
17
17
|
* class VideoTranscoderService {
|
|
18
18
|
*
|
|
@@ -81,7 +81,7 @@ export declare class JobQueueService implements OnModuleDestroy {
|
|
|
81
81
|
* If no argument is passed, sizes will be returned for _all_ JobBuffers.
|
|
82
82
|
*
|
|
83
83
|
* @example
|
|
84
|
-
* ```
|
|
84
|
+
* ```ts
|
|
85
85
|
* const sizes = await this.jobQueueService.bufferSize('buffer-1', 'buffer-2');
|
|
86
86
|
*
|
|
87
87
|
* // sizes = { 'buffer-1': 12, 'buffer-2': 3 }
|
|
@@ -21,7 +21,7 @@ const job_queue_1 = require("./job-queue");
|
|
|
21
21
|
* existing jobs.
|
|
22
22
|
*
|
|
23
23
|
* @example
|
|
24
|
-
* ```
|
|
24
|
+
* ```ts
|
|
25
25
|
* // A service which transcodes video files
|
|
26
26
|
* class VideoTranscoderService {
|
|
27
27
|
*
|
|
@@ -118,7 +118,7 @@ let JobQueueService = class JobQueueService {
|
|
|
118
118
|
* If no argument is passed, sizes will be returned for _all_ JobBuffers.
|
|
119
119
|
*
|
|
120
120
|
* @example
|
|
121
|
-
* ```
|
|
121
|
+
* ```ts
|
|
122
122
|
* const sizes = await this.jobQueueService.bufferSize('buffer-1', 'buffer-2');
|
|
123
123
|
*
|
|
124
124
|
* // sizes = { 'buffer-1': 12, 'buffer-2': 3 }
|
|
@@ -41,7 +41,7 @@ export interface DefaultJobQueueOptions {
|
|
|
41
41
|
* the job being added.
|
|
42
42
|
*
|
|
43
43
|
* @example
|
|
44
|
-
* ```
|
|
44
|
+
* ```ts
|
|
45
45
|
* setRetries: (queueName, job) => {
|
|
46
46
|
* if (queueName === 'send-email') {
|
|
47
47
|
* // Override the default number of retries
|
|
@@ -71,11 +71,11 @@ export interface DefaultJobQueueOptions {
|
|
|
71
71
|
/**
|
|
72
72
|
* @description
|
|
73
73
|
* A plugin which configures Vendure to use the SQL database to persist the JobQueue jobs using the {@link SqlJobQueueStrategy}. If you add this
|
|
74
|
-
* plugin to an existing Vendure installation, you'll need to run a [database migration](/
|
|
74
|
+
* plugin to an existing Vendure installation, you'll need to run a [database migration](/guides/developer-guide/migrations), since this
|
|
75
75
|
* plugin will add a new "job_record" table to the database.
|
|
76
76
|
*
|
|
77
77
|
* @example
|
|
78
|
-
* ```
|
|
78
|
+
* ```ts
|
|
79
79
|
* import { DefaultJobQueuePlugin, VendureConfig } from '\@vendure/core';
|
|
80
80
|
*
|
|
81
81
|
* export const config: VendureConfig = {
|
|
@@ -97,7 +97,7 @@ export interface DefaultJobQueueOptions {
|
|
|
97
97
|
* a pollInterval based on the queue name:
|
|
98
98
|
*
|
|
99
99
|
* @example
|
|
100
|
-
* ```
|
|
100
|
+
* ```ts
|
|
101
101
|
* export const config: VendureConfig = {
|
|
102
102
|
* plugins: [
|
|
103
103
|
* DefaultJobQueuePlugin.init({
|
|
@@ -126,7 +126,7 @@ export interface DefaultJobQueueOptions {
|
|
|
126
126
|
* exponential backoff may be used which progressively increases the delay between each subsequent retry.
|
|
127
127
|
*
|
|
128
128
|
* @example
|
|
129
|
-
* ```
|
|
129
|
+
* ```ts
|
|
130
130
|
* export const config: VendureConfig = {
|
|
131
131
|
* plugins: [
|
|
132
132
|
* DefaultJobQueuePlugin.init({
|
|
@@ -17,11 +17,11 @@ const sql_job_queue_strategy_1 = require("./sql-job-queue-strategy");
|
|
|
17
17
|
/**
|
|
18
18
|
* @description
|
|
19
19
|
* A plugin which configures Vendure to use the SQL database to persist the JobQueue jobs using the {@link SqlJobQueueStrategy}. If you add this
|
|
20
|
-
* plugin to an existing Vendure installation, you'll need to run a [database migration](/
|
|
20
|
+
* plugin to an existing Vendure installation, you'll need to run a [database migration](/guides/developer-guide/migrations), since this
|
|
21
21
|
* plugin will add a new "job_record" table to the database.
|
|
22
22
|
*
|
|
23
23
|
* @example
|
|
24
|
-
* ```
|
|
24
|
+
* ```ts
|
|
25
25
|
* import { DefaultJobQueuePlugin, VendureConfig } from '\@vendure/core';
|
|
26
26
|
*
|
|
27
27
|
* export const config: VendureConfig = {
|
|
@@ -43,7 +43,7 @@ const sql_job_queue_strategy_1 = require("./sql-job-queue-strategy");
|
|
|
43
43
|
* a pollInterval based on the queue name:
|
|
44
44
|
*
|
|
45
45
|
* @example
|
|
46
|
-
* ```
|
|
46
|
+
* ```ts
|
|
47
47
|
* export const config: VendureConfig = {
|
|
48
48
|
* plugins: [
|
|
49
49
|
* DefaultJobQueuePlugin.init({
|
|
@@ -72,7 +72,7 @@ const sql_job_queue_strategy_1 = require("./sql-job-queue-strategy");
|
|
|
72
72
|
* exponential backoff may be used which progressively increases the delay between each subsequent retry.
|
|
73
73
|
*
|
|
74
74
|
* @example
|
|
75
|
-
* ```
|
|
75
|
+
* ```ts
|
|
76
76
|
* export const config: VendureConfig = {
|
|
77
77
|
* plugins: [
|
|
78
78
|
* DefaultJobQueuePlugin.init({
|
|
@@ -17,12 +17,12 @@ export interface DefaultSearchReindexResponse extends SearchReindexResponse {
|
|
|
17
17
|
*
|
|
18
18
|
* The DefaultSearchPlugin is bundled with the `\@vendure/core` package. If you are not using an alternative search
|
|
19
19
|
* plugin, then make sure this one is used, otherwise you will not be able to search products via the
|
|
20
|
-
* [`search` query](/
|
|
20
|
+
* [`search` query](/reference/graphql-api/shop/queries#search).
|
|
21
21
|
*
|
|
22
|
-
*
|
|
22
|
+
* :::caution
|
|
23
23
|
* Note that the quality of the fulltext search capabilities varies depending on the underlying database being used. For example,
|
|
24
24
|
* the MySQL & Postgres implementations will typically yield better results than the SQLite implementation.
|
|
25
|
-
*
|
|
25
|
+
* :::
|
|
26
26
|
*
|
|
27
27
|
*
|
|
28
28
|
* @example
|
|
@@ -40,7 +40,7 @@ export interface DefaultSearchReindexResponse extends SearchReindexResponse {
|
|
|
40
40
|
* };
|
|
41
41
|
* ```
|
|
42
42
|
*
|
|
43
|
-
* @docsCategory
|
|
43
|
+
* @docsCategory DefaultSearchPlugin
|
|
44
44
|
*/
|
|
45
45
|
export declare class DefaultSearchPlugin implements OnApplicationBootstrap, OnApplicationShutdown {
|
|
46
46
|
private eventBus;
|