@vendure/docs 0.0.0-202601201808 → 0.0.0-202601211028

package/docs/reference/typescript-api/data-access/list-query-builder.mdx

@@ -2,13 +2,9 @@
 title: "ListQueryBuilder"
 generated: true
 ---
-
-
-## ListQueryBuilder
-
 <GenerationInfo sourceFile="packages/core/src/service/helpers/list-query-builder/list-query-builder.ts" sourceLine="207" packageName="@vendure/core" />
 
-This helper class is used when fetching entities the database from queries which return a <a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a> type.
+This helper class is used when fetching entities the database from queries which return a <DocsLink href="/reference/typescript-api/common/paginated-list#paginatedlist">PaginatedList</DocsLink> type.
 These queries all follow the same format:
 
 In the GraphQL definition, they return a type which implements the `Node` interface, and the query returns a
@@ -94,7 +90,7 @@ class ListQueryBuilder implements OnApplicationBootstrap {
 
 ### filterObjectHasProperty
 
-<MemberInfo kind="method" type={`(filterObject: FP | NullOptionals&#60;FP&#62; | null | undefined, property: keyof FP) => boolean`}   />
+<MemberInfo kind="method" type={`(filterObject: FP | NullOptionals<FP> | null | undefined, property: keyof FP) => boolean`}   />
 
 Used to determine whether a list query `filter` object contains the
 given property, either at the top level or nested inside a boolean
@@ -106,16 +102,12 @@ filter object contains that property, which then means we would need
 to join that relation.
 ### build
 
-<MemberInfo kind="method" type={`(entity: Type&#60;T&#62;, options: ListQueryOptions&#60;T&#62; = {}, extendedOptions: <a href='/reference/typescript-api/data-access/list-query-builder#extendedlistqueryoptions'>ExtendedListQueryOptions</a>&#60;T&#62; = {}) => SelectQueryBuilder&#60;T&#62;`}   />
+<MemberInfo kind="method" type={`(entity: Type<T>, options: ListQueryOptions<T> = {}, extendedOptions: <a href='/reference/typescript-api/data-access/list-query-builder#extendedlistqueryoptions'>ExtendedListQueryOptions</a><T> = {}) => SelectQueryBuilder<T>`}   />
 
 
 
 
 </div>
-
-
-## ExtendedListQueryOptions
-
 <GenerationInfo sourceFile="packages/core/src/service/helpers/list-query-builder/list-query-builder.ts" sourceLine="48" packageName="@vendure/core" />
 
 Options which can be passed to the ListQueryBuilder's `build()` method.
@@ -147,12 +139,12 @@ type ExtendedListQueryOptions<T extends VendureEntity> = {
 
 ### where
 
-<MemberInfo kind="property" type={`FindOptionsWhere&#60;T&#62;`}   />
+<MemberInfo kind="property" type={`FindOptionsWhere<T>`}   />
 
 
 ### orderBy
 
-<MemberInfo kind="property" type={`FindOneOptions&#60;T&#62;['order']`}   />
+<MemberInfo kind="property" type={`FindOneOptions<T>['order']`}   />
 
 
 ### entityAlias

package/docs/reference/typescript-api/data-access/transactional-connection.mdx

@@ -2,14 +2,10 @@
 title: "TransactionalConnection"
 generated: true
 ---
-
-
-## TransactionalConnection
-
 <GenerationInfo sourceFile="packages/core/src/connection/transactional-connection.ts" sourceLine="41" packageName="@vendure/core" />
 
 The TransactionalConnection is a wrapper around the TypeORM `Connection` object which works in conjunction
-with the <a href='/reference/typescript-api/request/transaction-decorator#transaction'>Transaction</a> decorator to implement per-request transactions. All services which access the
+with the <DocsLink href="/reference/typescript-api/request/transaction-decorator#transaction">Transaction</DocsLink> decorator to implement per-request transactions. All services which access the
 database should use this class rather than the raw TypeORM connection, to ensure that db changes can be
 easily wrapped in transactions when required.
 
@@ -55,36 +51,36 @@ performed with this connection will not be performed within any outer
 transactions.
 ### getRepository
 
-<MemberInfo kind="method" type={`(target: ObjectType&#60;Entity&#62; | EntitySchema&#60;Entity&#62; | string) => Repository&#60;Entity&#62;`}   />
+<MemberInfo kind="method" type={`(target: ObjectType<Entity> | EntitySchema<Entity> | string) => Repository<Entity>`}   />
 
 Returns a TypeORM repository. Note that when no RequestContext is supplied, the repository will not
 be aware of any existing transaction. Therefore, calling this method without supplying a RequestContext
 is discouraged without a deliberate reason.
 ### getRepository
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | undefined, target: ObjectType&#60;Entity&#62; | EntitySchema&#60;Entity&#62; | string, options?: {             replicationMode?: ReplicationMode;         }) => Repository&#60;Entity&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | undefined, target: ObjectType<Entity> | EntitySchema<Entity> | string, options?: {             replicationMode?: ReplicationMode;         }) => Repository<Entity>`}   />
 
 Returns a TypeORM repository which is bound to any existing transactions. It is recommended to _always_ pass
 the RequestContext argument when possible, otherwise the queries will be executed outside of any
-ongoing transactions which have been started by the <a href='/reference/typescript-api/request/transaction-decorator#transaction'>Transaction</a> decorator.
+ongoing transactions which have been started by the <DocsLink href="/reference/typescript-api/request/transaction-decorator#transaction">Transaction</DocsLink> decorator.
 
 The `options` parameter allows specifying additional configurations, such as the `replicationMode`,
 which determines whether the repository should interact with the master or replica database.
 ### getRepository
 
-<MemberInfo kind="method" type={`(ctxOrTarget: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | ObjectType&#60;Entity&#62; | EntitySchema&#60;Entity&#62; | string | undefined, maybeTarget?: ObjectType&#60;Entity&#62; | EntitySchema&#60;Entity&#62; | string, options?: {             replicationMode?: ReplicationMode;         }) => Repository&#60;Entity&#62;`}   />
+<MemberInfo kind="method" type={`(ctxOrTarget: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | ObjectType<Entity> | EntitySchema<Entity> | string | undefined, maybeTarget?: ObjectType<Entity> | EntitySchema<Entity> | string, options?: {             replicationMode?: ReplicationMode;         }) => Repository<Entity>`}   />
 
 Returns a TypeORM repository. Depending on the parameters passed, it will either be transaction-aware
 or not. If `RequestContext` is provided, the repository is bound to any ongoing transactions. The
 `options` parameter allows further customization, such as selecting the replication mode (e.g., 'master').
 ### withTransaction
 
-<MemberInfo kind="method" type={`(work: (ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) =&#62; Promise&#60;T&#62;) => Promise&#60;T&#62;`}  since="1.3.0"  />
+<MemberInfo kind="method" type={`(work: (ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<T>) => Promise<T>`}  since="1.3.0"  />
 
 Allows database operations to be wrapped in a transaction, ensuring that in the event of an error being
 thrown at any point, the entire transaction will be rolled back and no changes will be saved.
 
-In the context of API requests, you should instead use the <a href='/reference/typescript-api/request/transaction-decorator#transaction'>Transaction</a> decorator on your resolver or
+In the context of API requests, you should instead use the <DocsLink href="/reference/typescript-api/request/transaction-decorator#transaction">Transaction</DocsLink> decorator on your resolver or
 controller method.
 
 On the other hand, for code that does not run in the context of a GraphQL/REST request, this method
@@ -94,7 +90,7 @@ inconsistent state.
 Such situations include function processed by the JobQueue or stand-alone scripts which make use
 of Vendure internal services.
 
-If there is already a <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> object available, you should pass it in as the first
+If there is already a <DocsLink href="/reference/typescript-api/request/request-context#requestcontext">RequestContext</DocsLink> object available, you should pass it in as the first
 argument in order to create transactional context as the copy. If not, omit the first argument and an empty
 RequestContext object will be created, which is then used to propagate the transaction to
 all inner method calls.
@@ -120,12 +116,12 @@ private async transferCredit(outerCtx: RequestContext, fromId: ID, toId: ID, amo
 ```
 ### withTransaction
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, work: (ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) =&#62; Promise&#60;T&#62;) => Promise&#60;T&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, work: (ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<T>) => Promise<T>`}   />
 
 
 ### withTransaction
 
-<MemberInfo kind="method" type={`(ctxOrWork: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | ((ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) =&#62; Promise&#60;T&#62;), maybeWork?: (ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) =&#62; Promise&#60;T&#62;) => Promise&#60;T&#62;`}   />
+<MemberInfo kind="method" type={`(ctxOrWork: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | ((ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<T>), maybeWork?: (ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<T>) => Promise<T>`}   />
 
 
 ### startTransaction
@@ -133,12 +129,12 @@ private async transferCredit(outerCtx: RequestContext, fromId: ID, toId: ID, amo
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, isolationLevel?: <a href='/reference/typescript-api/request/transaction-decorator#transactionisolationlevel'>TransactionIsolationLevel</a>) => `}   />
 
 Manually start a transaction if one is not already in progress. This method should be used in
-conjunction with the `'manual'` mode of the <a href='/reference/typescript-api/request/transaction-decorator#transaction'>Transaction</a> decorator.
+conjunction with the `'manual'` mode of the <DocsLink href="/reference/typescript-api/request/transaction-decorator#transaction">Transaction</DocsLink> decorator.
 ### commitOpenTransaction
 
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `}   />
 
-Manually commits any open transaction. Should be very rarely needed, since the <a href='/reference/typescript-api/request/transaction-decorator#transaction'>Transaction</a> decorator
+Manually commits any open transaction. Should be very rarely needed, since the <DocsLink href="/reference/typescript-api/request/transaction-decorator#transaction">Transaction</DocsLink> decorator
 and the internal TransactionInterceptor take care of this automatically. Use-cases include situations
 in which the worker thread needs to access changes made in the current transaction, or when using the
 Transaction decorator in manual mode.
@@ -146,24 +142,24 @@ Transaction decorator in manual mode.
 
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `}   />
 
-Manually rolls back any open transaction. Should be very rarely needed, since the <a href='/reference/typescript-api/request/transaction-decorator#transaction'>Transaction</a> decorator
+Manually rolls back any open transaction. Should be very rarely needed, since the <DocsLink href="/reference/typescript-api/request/transaction-decorator#transaction">Transaction</DocsLink> decorator
 and the internal TransactionInterceptor take care of this automatically. Use-cases include when using the
 Transaction decorator in manual mode.
 ### getEntityOrThrow
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entityType: Type&#60;T&#62;, id: <a href='/reference/typescript-api/common/id#id'>ID</a>, options: <a href='/reference/typescript-api/data-access/get-entity-or-throw-options#getentityorthrowoptions'>GetEntityOrThrowOptions</a>&#60;T&#62; = {}) => Promise&#60;T&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entityType: Type<T>, id: <a href='/reference/typescript-api/common/id#id'>ID</a>, options: <a href='/reference/typescript-api/data-access/get-entity-or-throw-options#getentityorthrowoptions'>GetEntityOrThrowOptions</a><T> = {}) => Promise<T>`}   />
 
 Finds an entity of the given type by ID, or throws an `EntityNotFoundError` if none
 is found.
 ### findOneInChannel
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: Type&#60;T&#62;, id: <a href='/reference/typescript-api/common/id#id'>ID</a>, channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options: FindOneOptions&#60;T&#62; = {}) => `}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: Type<T>, id: <a href='/reference/typescript-api/common/id#id'>ID</a>, channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options: FindOneOptions<T> = {}) => `}   />
 
 Like the TypeOrm `Repository.findOne()` method, but limits the results to
 the given Channel.
 ### findByIdsInChannel
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: Type&#60;T&#62;, ids: <a href='/reference/typescript-api/common/id#id'>ID</a>[], channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options: FindManyOptions&#60;T&#62;) => `}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: Type<T>, ids: <a href='/reference/typescript-api/common/id#id'>ID</a>[], channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options: FindManyOptions<T>) => `}   />
 
 Like the TypeOrm `Repository.findByIds()` method, but limits the results to
 the given Channel.

package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.mdx

@@ -2,10 +2,6 @@
 title: "DefaultSearchPluginInitOptions"
 generated: true
 ---
-
-
-## DefaultSearchPluginInitOptions
-
 <GenerationInfo sourceFile="packages/core/src/plugin/default-search-plugin/types.ts" sourceLine="15" packageName="@vendure/core" />
 
 Options which configure the behaviour of the DefaultSearchPlugin
@@ -43,8 +39,8 @@ the worker.
 
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/default-search-plugin/search-strategy#searchstrategy'>SearchStrategy</a>`} default={`undefined`}  since="1.6.0"  />
 
-Set a custom search strategy that implements <a href='/reference/typescript-api/default-search-plugin/search-strategy#searchstrategy'>SearchStrategy</a> or extends an existing search strategy
-such as <a href='/reference/typescript-api/default-search-plugin/mysql-search-strategy#mysqlsearchstrategy'>MysqlSearchStrategy</a>, <a href='/reference/typescript-api/default-search-plugin/postgres-search-strategy#postgressearchstrategy'>PostgresSearchStrategy</a> or <a href='/reference/typescript-api/default-search-plugin/sqlite-search-strategy#sqlitesearchstrategy'>SqliteSearchStrategy</a>.
+Set a custom search strategy that implements <DocsLink href="/reference/typescript-api/default-search-plugin/search-strategy#searchstrategy">SearchStrategy</DocsLink> or extends an existing search strategy
+such as <DocsLink href="/reference/typescript-api/default-search-plugin/mysql-search-strategy#mysqlsearchstrategy">MysqlSearchStrategy</DocsLink>, <DocsLink href="/reference/typescript-api/default-search-plugin/postgres-search-strategy#postgressearchstrategy">PostgresSearchStrategy</DocsLink> or <DocsLink href="/reference/typescript-api/default-search-plugin/sqlite-search-strategy#sqlitesearchstrategy">SqliteSearchStrategy</DocsLink>.
 
 *Example*
 

package/docs/reference/typescript-api/default-search-plugin/index.mdx

@@ -2,10 +2,6 @@
 title: "DefaultSearchPlugin"
 generated: true
 ---
-
-
-## DefaultSearchPlugin
-
 <GenerationInfo sourceFile="packages/core/src/plugin/default-search-plugin/default-search-plugin.ts" sourceLine="70" packageName="@vendure/core" />
 
 The DefaultSearchPlugin provides a full-text Product search based on the full-text searching capabilities of the
@@ -55,7 +51,7 @@ class DefaultSearchPlugin implements OnApplicationBootstrap, OnApplicationShutdo
 
 ### init
 
-<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/default-search-plugin/default-search-plugin-init-options#defaultsearchplugininitoptions'>DefaultSearchPluginInitOptions</a>) => Type&#60;<a href='/reference/typescript-api/default-search-plugin/#defaultsearchplugin'>DefaultSearchPlugin</a>&#62;`}   />
+<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/default-search-plugin/default-search-plugin-init-options#defaultsearchplugininitoptions'>DefaultSearchPluginInitOptions</a>) => Type<<a href='/reference/typescript-api/default-search-plugin/#defaultsearchplugin'>DefaultSearchPlugin</a>>`}   />
 
 
 

package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx

@@ -2,10 +2,6 @@
 title: "MysqlSearchStrategy"
 generated: true
 ---
-
-
-## MysqlSearchStrategy
-
 <GenerationInfo sourceFile="packages/core/src/plugin/default-search-plugin/search-strategy/mysql-search-strategy.ts" sourceLine="28" packageName="@vendure/core" />
 
 A weighted fulltext search for MySQL / MariaDB.
@@ -32,22 +28,22 @@ class MysqlSearchStrategy implements SearchStrategy {
 
 ### getFacetValueIds
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise&#60;Map&#60;<a href='/reference/typescript-api/common/id#id'>ID</a>, number&#62;&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<Map<<a href='/reference/typescript-api/common/id#id'>ID</a>, number>>`}   />
 
 
 ### getCollectionIds
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise&#60;Map&#60;<a href='/reference/typescript-api/common/id#id'>ID</a>, number&#62;&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<Map<<a href='/reference/typescript-api/common/id#id'>ID</a>, number>>`}   />
 
 
 ### getSearchResults
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise&#60;SearchResult[]&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<SearchResult[]>`}   />
 
 
 ### getTotalCount
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise&#60;number&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<number>`}   />
 
 
 

package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx

@@ -2,10 +2,6 @@
 title: "PostgresSearchStrategy"
 generated: true
 ---
-
-
-## PostgresSearchStrategy
-
 <GenerationInfo sourceFile="packages/core/src/plugin/default-search-plugin/search-strategy/postgres-search-strategy.ts" sourceLine="28" packageName="@vendure/core" />
 
 A weighted fulltext search for PostgeSQL.
@@ -32,22 +28,22 @@ class PostgresSearchStrategy implements SearchStrategy {
 
 ### getFacetValueIds
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise&#60;Map&#60;<a href='/reference/typescript-api/common/id#id'>ID</a>, number&#62;&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<Map<<a href='/reference/typescript-api/common/id#id'>ID</a>, number>>`}   />
 
 
 ### getCollectionIds
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise&#60;Map&#60;<a href='/reference/typescript-api/common/id#id'>ID</a>, number&#62;&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<Map<<a href='/reference/typescript-api/common/id#id'>ID</a>, number>>`}   />
 
 
 ### getSearchResults
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise&#60;SearchResult[]&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<SearchResult[]>`}   />
 
 
 ### getTotalCount
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise&#60;number&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<number>`}   />
 
 
 

package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx

@@ -2,10 +2,6 @@
 title: "SearchStrategy"
 generated: true
 ---
-
-
-## SearchStrategy
-
 <GenerationInfo sourceFile="packages/core/src/plugin/default-search-plugin/search-strategy/search-strategy.ts" sourceLine="21" packageName="@vendure/core" />
 
 This interface defines the contract that any database-specific search implementations
@@ -14,7 +10,7 @@ should follow.
 :::info
 
 This is configured via the `searchStrategy` property of
-the <a href='/reference/typescript-api/default-search-plugin/default-search-plugin-init-options#defaultsearchplugininitoptions'>DefaultSearchPluginInitOptions</a>.
+the <DocsLink href="/reference/typescript-api/default-search-plugin/default-search-plugin-init-options#defaultsearchplugininitoptions">DefaultSearchPluginInitOptions</DocsLink>.
 
 :::
 
@@ -34,22 +30,22 @@ interface SearchStrategy extends InjectableStrategy {
 
 ### getSearchResults
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise&#60;SearchResult[]&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<SearchResult[]>`}   />
 
 
 ### getTotalCount
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise&#60;number&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<number>`}   />
 
 
 ### getFacetValueIds
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise&#60;Map&#60;<a href='/reference/typescript-api/common/id#id'>ID</a>, number&#62;&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<Map<<a href='/reference/typescript-api/common/id#id'>ID</a>, number>>`}   />
 
 
 ### getCollectionIds
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise&#60;Map&#60;<a href='/reference/typescript-api/common/id#id'>ID</a>, number&#62;&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<Map<<a href='/reference/typescript-api/common/id#id'>ID</a>, number>>`}   />
 
 
 

package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx

@@ -2,10 +2,6 @@
 title: "SqliteSearchStrategy"
 generated: true
 ---
-
-
-## SqliteSearchStrategy
-
 <GenerationInfo sourceFile="packages/core/src/plugin/default-search-plugin/search-strategy/sqlite-search-strategy.ts" sourceLine="30" packageName="@vendure/core" />
 
 A rather naive search for SQLite / SQL.js. Rather than proper
@@ -33,22 +29,22 @@ class SqliteSearchStrategy implements SearchStrategy {
 
 ### getFacetValueIds
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise&#60;Map&#60;<a href='/reference/typescript-api/common/id#id'>ID</a>, number&#62;&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<Map<<a href='/reference/typescript-api/common/id#id'>ID</a>, number>>`}   />
 
 
 ### getCollectionIds
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise&#60;Map&#60;<a href='/reference/typescript-api/common/id#id'>ID</a>, number&#62;&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<Map<<a href='/reference/typescript-api/common/id#id'>ID</a>, number>>`}   />
 
 
 ### getSearchResults
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise&#60;SearchResult[]&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<SearchResult[]>`}   />
 
 
 ### getTotalCount
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise&#60;number&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<number>`}   />
 
 
 

package/docs/reference/typescript-api/entities/address.mdx

@@ -2,13 +2,9 @@
 title: "Address"
 generated: true
 ---
-
-
-## Address
-
 <GenerationInfo sourceFile="packages/core/src/entity/address/address.entity.ts" sourceLine="16" packageName="@vendure/core" />
 
-Represents a <a href='/reference/typescript-api/entities/customer#customer'>Customer</a>'s address.
+Represents a <DocsLink href="/reference/typescript-api/entities/customer#customer">Customer</DocsLink>'s address.
 
 ```ts title="Signature"
 class Address extends VendureEntity implements HasCustomFields {
@@ -50,7 +46,7 @@ class Address extends VendureEntity implements HasCustomFields {
 
 ### constructor
 
-<MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/address#address'>Address</a>&#62;) => Address`}   />
+<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/address#address'>Address</a>>) => Address`}   />
 
 
 ### customer

package/docs/reference/typescript-api/entities/administrator.mdx

@@ -2,15 +2,11 @@
 title: "Administrator"
 generated: true
 ---
-
-
-## Administrator
-
 <GenerationInfo sourceFile="packages/core/src/entity/administrator/administrator.entity.ts" sourceLine="18" packageName="@vendure/core" />
 
 An administrative user who has access to the Admin UI and Admin API. The
 specific permissions of the Administrator are determined by the assigned
-<a href='/reference/typescript-api/entities/role#role'>Role</a>s.
+<DocsLink href="/reference/typescript-api/entities/role#role">Role</DocsLink>s.
 
 ```ts title="Signature"
 class Administrator extends VendureEntity implements SoftDeletable, HasCustomFields {
@@ -39,7 +35,7 @@ class Administrator extends VendureEntity implements SoftDeletable, HasCustomFie
 
 ### constructor
 
-<MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>&#62;) => Administrator`}   />
+<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>>) => Administrator`}   />
 
 
 ### deletedAt

package/docs/reference/typescript-api/entities/anonymous-session.mdx

@@ -2,10 +2,6 @@
 title: "AnonymousSession"
 generated: true
 ---
-
-
-## AnonymousSession
-
 <GenerationInfo sourceFile="packages/core/src/entity/session/anonymous-session.entity.ts" sourceLine="16" packageName="@vendure/core" />
 
 An anonymous session is created when a unauthenticated user interacts with restricted operations,
@@ -25,7 +21,7 @@ class AnonymousSession extends Session {
 
 ### constructor
 
-<MemberInfo kind="method" type={`(input: DeepPartial&#60;<a href='/reference/typescript-api/entities/anonymous-session#anonymoussession'>AnonymousSession</a>&#62;) => AnonymousSession`}   />
+<MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/anonymous-session#anonymoussession'>AnonymousSession</a>>) => AnonymousSession`}   />
 
 
 

package/docs/reference/typescript-api/entities/asset.mdx

@@ -2,10 +2,6 @@
 title: "Asset"
 generated: true
 ---
-
-
-## Asset
-
 <GenerationInfo sourceFile="packages/core/src/entity/asset/asset.entity.ts" sourceLine="22" packageName="@vendure/core" />
 
 An Asset represents a file such as an image which can be associated with certain other entities
@@ -51,7 +47,7 @@ class Asset extends VendureEntity implements Taggable, ChannelAware, HasCustomFi
 
 ### constructor
 
-<MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>&#62;) => Asset`}   />
+<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>>) => Asset`}   />
 
 
 ### name

package/docs/reference/typescript-api/entities/authenticated-session.mdx

@@ -2,10 +2,6 @@
 title: "AuthenticatedSession"
 generated: true
 ---
-
-
-## AuthenticatedSession
-
 <GenerationInfo sourceFile="packages/core/src/entity/session/authenticated-session.entity.ts" sourceLine="14" packageName="@vendure/core" />
 
 An AuthenticatedSession is created upon successful authentication.
@@ -28,19 +24,19 @@ class AuthenticatedSession extends Session {
 
 ### constructor
 
-<MemberInfo kind="method" type={`(input: DeepPartial&#60;<a href='/reference/typescript-api/entities/authenticated-session#authenticatedsession'>AuthenticatedSession</a>&#62;) => AuthenticatedSession`}   />
+<MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/authenticated-session#authenticatedsession'>AuthenticatedSession</a>>) => AuthenticatedSession`}   />
 
 
 ### user
 
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/user#user'>User</a>`}   />
 
-The <a href='/reference/typescript-api/entities/user#user'>User</a> who has authenticated to create this session.
+The <DocsLink href="/reference/typescript-api/entities/user#user">User</DocsLink> who has authenticated to create this session.
 ### authenticationStrategy
 
 <MemberInfo kind="property" type={`string`}   />
 
-The name of the <a href='/reference/typescript-api/auth/authentication-strategy#authenticationstrategy'>AuthenticationStrategy</a> used when authenticating
+The name of the <DocsLink href="/reference/typescript-api/auth/authentication-strategy#authenticationstrategy">AuthenticationStrategy</DocsLink> used when authenticating
 to create this session.
 
 

package/docs/reference/typescript-api/entities/authentication-method.mdx

@@ -2,14 +2,10 @@
 title: "AuthenticationMethod"
 generated: true
 ---
-
-
-## AuthenticationMethod
-
 <GenerationInfo sourceFile="packages/core/src/entity/authentication-method/authentication-method.entity.ts" sourceLine="14" packageName="@vendure/core" />
 
-An AuthenticationMethod represents the means by which a <a href='/reference/typescript-api/entities/user#user'>User</a> is authenticated. There are two kinds:
-<a href='/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod'>NativeAuthenticationMethod</a> and <a href='/reference/typescript-api/entities/authentication-method#externalauthenticationmethod'>ExternalAuthenticationMethod</a>.
+An AuthenticationMethod represents the means by which a <DocsLink href="/reference/typescript-api/entities/user#user">User</DocsLink> is authenticated. There are two kinds:
+<DocsLink href="/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod">NativeAuthenticationMethod</DocsLink> and <DocsLink href="/reference/typescript-api/entities/authentication-method#externalauthenticationmethod">ExternalAuthenticationMethod</DocsLink>.
 
 ```ts title="Signature"
 class AuthenticationMethod extends VendureEntity {
@@ -32,10 +28,6 @@ class AuthenticationMethod extends VendureEntity {
 
 
 </div>
-
-
-## ExternalAuthenticationMethod
-
 <GenerationInfo sourceFile="packages/core/src/entity/authentication-method/external-authentication-method.entity.ts" sourceLine="14" packageName="@vendure/core" />
 
 This method is used when an external authentication service is used to authenticate Vendure Users.
@@ -60,7 +52,7 @@ class ExternalAuthenticationMethod extends AuthenticationMethod {
 
 ### constructor
 
-<MemberInfo kind="method" type={`(input: DeepPartial&#60;<a href='/reference/typescript-api/entities/authentication-method#externalauthenticationmethod'>ExternalAuthenticationMethod</a>&#62;) => ExternalAuthenticationMethod`}   />
+<MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/authentication-method#externalauthenticationmethod'>ExternalAuthenticationMethod</a>>) => ExternalAuthenticationMethod`}   />
 
 
 ### strategy
@@ -81,10 +73,6 @@ class ExternalAuthenticationMethod extends AuthenticationMethod {
 
 
 </div>
-
-
-## NativeAuthenticationMethod
-
 <GenerationInfo sourceFile="packages/core/src/entity/authentication-method/native-authentication-method.entity.ts" sourceLine="14" packageName="@vendure/core" />
 
 This is the default, built-in authentication method which uses a identifier (typically username or email address)
@@ -114,7 +102,7 @@ class NativeAuthenticationMethod extends AuthenticationMethod {
 
 ### constructor
 
-<MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod'>NativeAuthenticationMethod</a>&#62;) => NativeAuthenticationMethod`}   />
+<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod'>NativeAuthenticationMethod</a>>) => NativeAuthenticationMethod`}   />
 
 
 ### identifier

package/docs/reference/typescript-api/entities/channel.mdx

@@ -2,10 +2,6 @@
 title: "Channel"
 generated: true
 ---
-
-
-## Channel
-
 <GenerationInfo sourceFile="packages/core/src/entity/channel/channel.entity.ts" sourceLine="37" packageName="@vendure/core" />
 
 A Channel represents a distinct sales channel and configures defaults for that
@@ -90,7 +86,7 @@ class Channel extends VendureEntity {
 
 ### constructor
 
-<MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>&#62;) => Channel`}   />
+<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>>) => Channel`}   />
 
 
 ### code