@vendure/core 2.1.0-next.3 → 2.1.0-next.5

package/dist/plugin/default-search-plugin/default-search-plugin.js

@@ -42,12 +42,12 @@ const search_job_buffer_service_1 = require("./search-job-buffer/search-job-buff
  *
  * The DefaultSearchPlugin is bundled with the `\@vendure/core` package. If you are not using an alternative search
  * plugin, then make sure this one is used, otherwise you will not be able to search products via the
- * [`search` query](/docs/graphql-api/shop/queries#search).
+ * [`search` query](/reference/graphql-api/shop/queries#search).
  *
- * {{% alert "warning" %}}
+ * :::caution
  * Note that the quality of the fulltext search capabilities varies depending on the underlying database being used. For example,
  * the MySQL & Postgres implementations will typically yield better results than the SQLite implementation.
- * {{% /alert %}}
+ * :::
  *
  *
  * @example
@@ -65,7 +65,7 @@ const search_job_buffer_service_1 = require("./search-job-buffer/search-job-buff
  * };
  * ```
  *
- * @docsCategory core plugins/DefaultSearchPlugin
+ * @docsCategory DefaultSearchPlugin
  */
 let DefaultSearchPlugin = DefaultSearchPlugin_1 = class DefaultSearchPlugin {
     /** @internal */

package/dist/plugin/default-search-plugin/search-strategy/search-strategy.d.ts

@@ -5,6 +5,13 @@ import { InjectableStrategy } from '../../../common';
 /**
  * This interface defines the contract that any database-specific search implementations
  * should follow.
+ *
+ * :::info
+ *
+ * This is configured via the `searchStrategy` property of
+ * the {@link DefaultSearchPluginInitOptions}.
+ *
+ * :::
  */
 export interface SearchStrategy extends InjectableStrategy {
     getSearchResults(ctx: RequestContext, input: SearchInput, enabledOnly: boolean): Promise<SearchResult[]>;

package/dist/plugin/default-search-plugin/types.d.ts

@@ -7,7 +7,7 @@ import { SearchStrategy } from './search-strategy/search-strategy';
  * @description
  * Options which configure the behaviour of the DefaultSearchPlugin
  *
- * @docsCategory core plugins/DefaultSearchPlugin
+ * @docsCategory DefaultSearchPlugin
  */
 export interface DefaultSearchPluginInitOptions {
     /**
@@ -40,7 +40,7 @@ export interface DefaultSearchPluginInitOptions {
      * such as {@link MysqlSearchStrategy}, {@link PostgresSearchStrategy} or {@link SqliteSearchStrategy}.
      *
      * @example
-     * ```Typescript
+     * ```ts
      * export class MySearchStrategy implements SearchStrategy {
      *     private readonly minTermLength = 2;
      *     private connection: TransactionalConnection;

package/dist/plugin/vendure-plugin.d.ts

@@ -47,7 +47,7 @@ export interface VendurePluginMetadata extends ModuleMetadata {
      * To effectively disable this check for a plugin, you can use an overly-permissive string such as `>0.0.0`.
      *
      * @example
-     * ```typescript
+     * ```ts
      * compatibility: '^2.0.0'
      * ```
      *
@@ -68,7 +68,7 @@ export interface APIExtensionDefinition {
      * Extensions to the schema.
      *
      * @example
-     * ```TypeScript
+     * ```ts
      * const schema = gql`extend type SearchReindexResponse {
      *     timeTaken: Int!
      *     indexedItemCount: Int!
@@ -110,7 +110,7 @@ export type PluginConfigurationFn = (config: RuntimeVendureConfig) => RuntimeVen
  * entirely new types. Database entities and resolvers can also be defined to handle the extended GraphQL types.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * import { Controller, Get } from '\@nestjs/common';
  * import { Ctx, PluginCommonModule, ProductService, RequestContext, VendurePlugin } from '\@vendure/core';
  *

package/dist/plugin/vendure-plugin.js

@@ -16,7 +16,7 @@ const plugin_metadata_1 = require("./plugin-metadata");
  * entirely new types. Database entities and resolvers can also be defined to handle the extended GraphQL types.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * import { Controller, Get } from '\@nestjs/common';
  * import { Ctx, PluginCommonModule, ProductService, RequestContext, VendurePlugin } from '\@vendure/core';
  *

package/dist/process-context/process-context.d.ts

@@ -5,7 +5,7 @@ type ProcessContextType = 'server' | 'worker';
  * is being executed in the context of the main Vendure server or the worker.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * import { Injectable, OnApplicationBootstrap } from '\@nestjs/common';
  * import { ProcessContext } from '\@vendure/core';
  *

package/dist/process-context/process-context.js

@@ -8,7 +8,7 @@ let currentContext = 'server';
  * is being executed in the context of the main Vendure server or the worker.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * import { Injectable, OnApplicationBootstrap } from '\@nestjs/common';
  * import { ProcessContext } from '\@vendure/core';
  *

package/dist/service/helpers/entity-hydrator/entity-hydrator.service.d.ts

@@ -11,7 +11,7 @@ import { HydrateOptions } from './entity-hydrator-types';
  * and you need to ensure that one or more relations are present.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * const product = await this.productVariantService
  *   .getProductForVariant(ctx, variantId);
  *
@@ -30,7 +30,7 @@ import { HydrateOptions } from './entity-hydrator-types';
  * Custom field relations may also be hydrated:
  *
  * @example
- * ```TypeScript
+ * ```ts
  * const customer = await this.customerService
  *   .findOne(ctx, id);
  *
@@ -52,7 +52,7 @@ export declare class EntityHydrator {
      * mutates the `target` entity.
      *
      * @example
-     * ```TypeScript
+     * ```ts
      * await this.entityHydrator.hydrate(ctx, product, {
      *   relations: [
      *     'variants.stockMovements'

package/dist/service/helpers/entity-hydrator/entity-hydrator.service.js

@@ -25,7 +25,7 @@ const translator_service_1 = require("../translator/translator.service");
  * and you need to ensure that one or more relations are present.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * const product = await this.productVariantService
  *   .getProductForVariant(ctx, variantId);
  *
@@ -44,7 +44,7 @@ const translator_service_1 = require("../translator/translator.service");
  * Custom field relations may also be hydrated:
  *
  * @example
- * ```TypeScript
+ * ```ts
  * const customer = await this.customerService
  *   .findOne(ctx, id);
  *
@@ -67,7 +67,7 @@ let EntityHydrator = class EntityHydrator {
      * mutates the `target` entity.
      *
      * @example
-     * ```TypeScript
+     * ```ts
      * await this.entityHydrator.hydrate(ctx, product, {
      *   relations: [
      *     'variants.stockMovements'

package/dist/service/helpers/list-query-builder/list-query-builder.d.ts

@@ -136,7 +136,7 @@ export type ExtendedListQueryOptions<T extends VendureEntity> = {
  *
  * Your resolver function will then look like this:
  *
- * ```TypeScript
+ * ```ts
  * \@Resolver()
  * export class BlogPostResolver
  *   constructor(private blogPostService: BlogPostService) {}
@@ -153,7 +153,7 @@ export type ExtendedListQueryOptions<T extends VendureEntity> = {
  *
  * and the corresponding service will use the ListQueryBuilder:
  *
- * ```TypeScript
+ * ```ts
  * \@Injectable()
  * export class BlogPostService {
  *   constructor(private listQueryBuilder: ListQueryBuilder) {}

package/dist/service/helpers/list-query-builder/list-query-builder.js

@@ -58,7 +58,7 @@ const parse_sort_params_1 = require("./parse-sort-params");
  *
  * Your resolver function will then look like this:
  *
- * ```TypeScript
+ * ```ts
  * \@Resolver()
  * export class BlogPostResolver
  *   constructor(private blogPostService: BlogPostService) {}
@@ -75,7 +75,7 @@ const parse_sort_params_1 = require("./parse-sort-params");
  *
  * and the corresponding service will use the ListQueryBuilder:
  *
- * ```TypeScript
+ * ```ts
  * \@Injectable()
  * export class BlogPostService {
  *   constructor(private listQueryBuilder: ListQueryBuilder) {}

package/dist/service/helpers/product-price-applicator/product-price-applicator.d.ts

@@ -13,7 +13,7 @@ import { ZoneService } from '../../services/zone.service';
  * always be `0` until you use the `applyChannelPriceAndTax()` method:
  *
  * @example
- * ```TypeScript
+ * ```ts
  * export class MyCustomService {
  *   constructor(private connection: TransactionalConnection,
  *               private productPriceApplicator: ProductPriceApplicator) {}

package/dist/service/helpers/product-price-applicator/product-price-applicator.js

@@ -24,7 +24,7 @@ const zone_service_1 = require("../../services/zone.service");
  * always be `0` until you use the `applyChannelPriceAndTax()` method:
  *
  * @example
- * ```TypeScript
+ * ```ts
  * export class MyCustomService {
  *   constructor(private connection: TransactionalConnection,
  *               private productPriceApplicator: ProductPriceApplicator) {}

package/dist/service/helpers/translatable-saver/translatable-saver.d.ts

@@ -21,7 +21,7 @@ export interface UpdateTranslatableOptions<T extends Translatable> extends Creat
  * A helper which contains methods for creating and updating entities which implement the {@link Translatable} interface.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * export class MyService {
  *   constructor(private translatableSaver: TranslatableSaver) {}
  *

package/dist/service/helpers/translatable-saver/translatable-saver.js

@@ -20,7 +20,7 @@ const translation_differ_1 = require("./translation-differ");
  * A helper which contains methods for creating and updating entities which implement the {@link Translatable} interface.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * export class MyService {
  *   constructor(private translatableSaver: TranslatableSaver) {}
  *

package/dist/service/helpers/translator/translator.service.d.ts

@@ -3,6 +3,39 @@ import { Translatable } from '../../../common/types/locale-types';
 import { ConfigService } from '../../../config';
 import { VendureEntity } from '../../../entity';
 import { DeepTranslatableRelations } from '../utils/translate-entity';
+/**
+ * @description
+ * The TranslatorService is used to translate entities into the current language.
+ *
+ * @example
+ * ```ts
+ * import { Injectable } from '\@nestjs/common';
+ * import { ID, Product, RequestContext, TransactionalConnection, TranslatorService } from '\@vendure/core';
+ *
+ * \@Injectable()
+ * export class ProductService {
+ *
+ *     constructor(private connection: TransactionalConnection,
+ *                 private translator: TranslatorService){}
+ *
+ *     async findOne(ctx: RequestContext, productId: ID): Promise<Product | undefined> {
+ *         const product = await this.connection.findOneInChannel(ctx, Product, productId, ctx.channelId, {
+ *             relations: {
+ *                  facetValues: {
+ *                      facet: true,
+ *                  }
+ *             }
+ *         });
+ *         if (!product) {
+ *             return;
+ *         }
+ *         return this.translator.translate(product, ctx, ['facetValues', ['facetValues', 'facet']]);
+ *     }
+ * }
+ * ```
+ *
+ * @docsCategory service-helpers
+ */
 export declare class TranslatorService {
     private configService;
     constructor(configService: ConfigService);

package/dist/service/helpers/translator/translator.service.js

@@ -13,6 +13,39 @@ exports.TranslatorService = void 0;
 const common_1 = require("@nestjs/common");
 const config_1 = require("../../../config");
 const translate_entity_1 = require("../utils/translate-entity");
+/**
+ * @description
+ * The TranslatorService is used to translate entities into the current language.
+ *
+ * @example
+ * ```ts
+ * import { Injectable } from '\@nestjs/common';
+ * import { ID, Product, RequestContext, TransactionalConnection, TranslatorService } from '\@vendure/core';
+ *
+ * \@Injectable()
+ * export class ProductService {
+ *
+ *     constructor(private connection: TransactionalConnection,
+ *                 private translator: TranslatorService){}
+ *
+ *     async findOne(ctx: RequestContext, productId: ID): Promise<Product | undefined> {
+ *         const product = await this.connection.findOneInChannel(ctx, Product, productId, ctx.channelId, {
+ *             relations: {
+ *                  facetValues: {
+ *                      facet: true,
+ *                  }
+ *             }
+ *         });
+ *         if (!product) {
+ *             return;
+ *         }
+ *         return this.translator.translate(product, ctx, ['facetValues', ['facetValues', 'facet']]);
+ *     }
+ * }
+ * ```
+ *
+ * @docsCategory service-helpers
+ */
 let TranslatorService = class TranslatorService {
     constructor(configService) {
         this.configService = configService;

package/dist/service/helpers/translator/translator.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"translator.service.js","sourceRoot":"","sources":["../../../../src/service/helpers/translator/translator.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4C;AAI5C,4CAAgD;AAEhD,gEAAqF;AAG9E,IAAM,iBAAiB,GAAvB,MAAM,iBAAiB;IAC1B,YAAoB,aAA4B;QAA5B,kBAAa,GAAb,aAAa,CAAe;IAAG,CAAC;IAEpD,SAAS,CACL,YAAe,EACf,GAAmB,EACnB,wBAAsD,EAAE;QAExD,OAAO,IAAA,gCAAa,EAChB,YAAY,EACZ,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,OAAO,CAAC,mBAAmB,EAAE,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC,EAC3F,qBAAqB,CACxB,CAAC;IACN,CAAC;CACJ,CAAA;AAdY,iBAAiB;IAD7B,IAAA,mBAAU,GAAE;qCAE0B,sBAAa;GADvC,iBAAiB,CAc7B;AAdY,8CAAiB"}
+{"version":3,"file":"translator.service.js","sourceRoot":"","sources":["../../../../src/service/helpers/translator/translator.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4C;AAI5C,4CAAgD;AAEhD,gEAAqF;AAErF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEI,IAAM,iBAAiB,GAAvB,MAAM,iBAAiB;IAC1B,YAAoB,aAA4B;QAA5B,kBAAa,GAAb,aAAa,CAAe;IAAG,CAAC;IAEpD,SAAS,CACL,YAAe,EACf,GAAmB,EACnB,wBAAsD,EAAE;QAExD,OAAO,IAAA,gCAAa,EAChB,YAAY,EACZ,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,OAAO,CAAC,mBAAmB,EAAE,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC,EAC3F,qBAAqB,CACxB,CAAC;IACN,CAAC;CACJ,CAAA;AAdY,iBAAiB;IAD7B,IAAA,mBAAU,GAAE;qCAE0B,sBAAa;GADvC,iBAAiB,CAc7B;AAdY,8CAAiB"}

package/dist/service/services/asset.service.d.ts

@@ -79,7 +79,7 @@ export declare class AssetService {
      * using the [GraphQL multipart request specification](https://github.com/jaydenseric/graphql-multipart-request-spec),
      * e.g. using the [apollo-upload-client](https://github.com/jaydenseric/apollo-upload-client) npm package.
      *
-     * See the [Uploading Files docs](/docs/developer-guide/uploading-files) for an example of usage.
+     * See the [Uploading Files docs](/guides/developer-guide/uploading-files) for an example of usage.
      */
     create(ctx: RequestContext, input: CreateAssetInput): Promise<CreateAssetResult>;
     /**

package/dist/service/services/asset.service.js

@@ -217,7 +217,7 @@ let AssetService = class AssetService {
      * using the [GraphQL multipart request specification](https://github.com/jaydenseric/graphql-multipart-request-spec),
      * e.g. using the [apollo-upload-client](https://github.com/jaydenseric/apollo-upload-client) npm package.
      *
-     * See the [Uploading Files docs](/docs/developer-guide/uploading-files) for an example of usage.
+     * See the [Uploading Files docs](/guides/developer-guide/uploading-files) for an example of usage.
      */
     async create(ctx, input) {
         return new Promise(async (resolve, reject) => {

package/dist/service/services/history.service.d.ts

@@ -138,7 +138,7 @@ export interface UpdateCustomerHistoryEntryArgs<T extends keyof CustomerHistoryE
  * First of all we'd extend the GraphQL `HistoryEntryType` enum for our new type as part of a plugin
  *
  * @example
- * ```TypeScript
+ * ```ts
  * import { PluginCommonModule, VendurePlugin } from '\@vendure/core';
  * import { VerificationService } from './verification.service';
  *
@@ -161,7 +161,7 @@ export interface UpdateCustomerHistoryEntryArgs<T extends keyof CustomerHistoryE
  * and [ambient modules](https://www.typescriptlang.org/docs/handbook/modules.html#ambient-modules) features.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * // types.ts
  * import { CustomerHistoryEntryData } from '\@vendure/core';
  *
@@ -185,7 +185,7 @@ export interface UpdateCustomerHistoryEntryArgs<T extends keyof CustomerHistoryE
  * Now that we have our types set up, we can use the HistoryService to add a new HistoryEntry in a type-safe manner:
  *
  * @example
- * ```TypeScript
+ * ```ts
  * // verification.service.ts
  * import { Injectable } from '\@nestjs/common';
  * import { RequestContext } from '\@vendure/core';
@@ -212,10 +212,10 @@ export interface UpdateCustomerHistoryEntryArgs<T extends keyof CustomerHistoryE
  *   }
  * }
  * ```
- * {{% alert %}}
+ * :::info
  * It is also possible to define a UI component to display custom history entry types. See the
- * [Custom History Timeline Components guide]({{< relref "custom-timeline-components" >}}).
- * {{% /alert %}}
+ * [Custom History Timeline Components guide](/guides/extending-the-admin-ui/custom-timeline-components/).
+ * :::
  *
  * @docsCategory services
  */

package/dist/service/services/history.service.js

@@ -37,7 +37,7 @@ const administrator_service_1 = require("./administrator.service");
  * First of all we'd extend the GraphQL `HistoryEntryType` enum for our new type as part of a plugin
  *
  * @example
- * ```TypeScript
+ * ```ts
  * import { PluginCommonModule, VendurePlugin } from '\@vendure/core';
  * import { VerificationService } from './verification.service';
  *
@@ -60,7 +60,7 @@ const administrator_service_1 = require("./administrator.service");
  * and [ambient modules](https://www.typescriptlang.org/docs/handbook/modules.html#ambient-modules) features.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * // types.ts
  * import { CustomerHistoryEntryData } from '\@vendure/core';
  *
@@ -84,7 +84,7 @@ const administrator_service_1 = require("./administrator.service");
  * Now that we have our types set up, we can use the HistoryService to add a new HistoryEntry in a type-safe manner:
  *
  * @example
- * ```TypeScript
+ * ```ts
  * // verification.service.ts
  * import { Injectable } from '\@nestjs/common';
  * import { RequestContext } from '\@vendure/core';
@@ -111,10 +111,10 @@ const administrator_service_1 = require("./administrator.service");
  *   }
  * }
  * ```
- * {{% alert %}}
+ * :::info
  * It is also possible to define a UI component to display custom history entry types. See the
- * [Custom History Timeline Components guide]({{< relref "custom-timeline-components" >}}).
- * {{% /alert %}}
+ * [Custom History Timeline Components guide](/guides/extending-the-admin-ui/custom-timeline-components/).
+ * :::
  *
  * @docsCategory services
  */

package/dist/service/services/order.service.d.ts

@@ -177,8 +177,7 @@ export declare class OrderService {
     removeCouponCode(ctx: RequestContext, orderId: ID, couponCode: string): Promise<Order>;
     /**
      * @description
-     * Returns all {@link Promotion}s associated with an Order. A Promotion only gets associated with
-     * and Order once the order has been placed (see {@link OrderPlacedStrategy}).
+     * Returns all {@link Promotion}s associated with an Order.
      */
     getOrderPromotions(ctx: RequestContext, orderId: ID): Promise<Promotion[]>;
     /**

package/dist/service/services/order.service.js

@@ -556,8 +556,7 @@ let OrderService = class OrderService {
     }
     /**
      * @description
-     * Returns all {@link Promotion}s associated with an Order. A Promotion only gets associated with
-     * and Order once the order has been placed (see {@link OrderPlacedStrategy}).
+     * Returns all {@link Promotion}s associated with an Order.
      */
     async getOrderPromotions(ctx, orderId) {
         const order = await this.connection.getEntityOrThrow(ctx, order_entity_1.Order, orderId, {