@vendure/docs 0.0.0-202601201808 → 0.0.0-202601211028

package/docs/reference/typescript-api/testing/create-test-environment.mdx

@@ -2,14 +2,10 @@
 title: "CreateTestEnvironment"
 generated: true
 ---
-
-
-## createTestEnvironment
-
 <GenerationInfo sourceFile="packages/testing/src/create-test-environment.ts" sourceLine="60" packageName="@vendure/testing" />
 
-Configures a <a href='/reference/typescript-api/testing/test-server#testserver'>TestServer</a> and a <a href='/reference/typescript-api/testing/simple-graph-qlclient#simplegraphqlclient'>SimpleGraphQLClient</a> for each of the GraphQL APIs
-for use in end-to-end tests. Returns a <a href='/reference/typescript-api/testing/test-environment#testenvironment'>TestEnvironment</a> object.
+Configures a <DocsLink href="/reference/typescript-api/testing/test-server#testserver">TestServer</DocsLink> and a <DocsLink href="/reference/typescript-api/testing/simple-graph-qlclient#simplegraphqlclient">SimpleGraphQLClient</DocsLink> for each of the GraphQL APIs
+for use in end-to-end tests. Returns a <DocsLink href="/reference/typescript-api/testing/test-environment#testenvironment">TestEnvironment</DocsLink> object.
 
 *Example*
 
@@ -42,5 +38,5 @@ Parameters
 
 ### config
 
-<MemberInfo kind="parameter" type={`Required&#60;<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>&#62;`} />
+<MemberInfo kind="parameter" type={`Required<<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>>`} />
 

package/docs/reference/typescript-api/testing/error-result-guard.mdx

@@ -2,10 +2,6 @@
 title: "ErrorResultGuard"
 generated: true
 ---
-
-
-## ErrorResultGuard
-
 <GenerationInfo sourceFile="packages/testing/src/error-result-guard.ts" sourceLine="50" packageName="@vendure/testing" />
 
 A utility class which is used to assert the success of an operation
@@ -47,7 +43,7 @@ class ErrorResultGuard<T> {
 
 ### constructor
 
-<MemberInfo kind="method" type={`(testFn: (input: T) =&#62; boolean) => ErrorResultGuard`}   />
+<MemberInfo kind="method" type={`(testFn: (input: T) => boolean) => ErrorResultGuard`}   />
 
 
 ### isSuccess

package/docs/reference/typescript-api/testing/get-superadmin-context.mdx

@@ -2,13 +2,9 @@
 title: "GetSuperadminContext"
 generated: true
 ---
-
-
-## getSuperadminContext
-
 <GenerationInfo sourceFile="packages/testing/src/utils/get-superadmin-context.ts" sourceLine="11" packageName="@vendure/testing" />
 
-Creates a <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> configured for the default Channel with the activeUser set
+Creates a <DocsLink href="/reference/typescript-api/request/request-context#requestcontext">RequestContext</DocsLink> configured for the default Channel with the activeUser set
 as the superadmin user. Useful for populating data.
 
 ```ts title="Signature"

package/docs/reference/typescript-api/testing/register-initializer.mdx

@@ -2,14 +2,10 @@
 title: "RegisterInitializer"
 generated: true
 ---
-
-
-## registerInitializer
-
 <GenerationInfo sourceFile="packages/testing/src/initializers/initializers.ts" sourceLine="16" packageName="@vendure/testing" />
 
-Registers a <a href='/reference/typescript-api/testing/test-db-initializer#testdbinitializer'>TestDbInitializer</a> for the given database type. Should be called before invoking
-<a href='/reference/typescript-api/testing/create-test-environment#createtestenvironment'>createTestEnvironment</a>.
+Registers a <DocsLink href="/reference/typescript-api/testing/test-db-initializer#testdbinitializer">TestDbInitializer</DocsLink> for the given database type. Should be called before invoking
+<DocsLink href="/reference/typescript-api/testing/create-test-environment#createtestenvironment">createTestEnvironment</DocsLink>.
 
 ```ts title="Signature"
 function registerInitializer(type: DataSourceOptions['type'], initializer: TestDbInitializer<any>): void
@@ -22,5 +18,5 @@ Parameters
 
 ### initializer
 
-<MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/testing/test-db-initializer#testdbinitializer'>TestDbInitializer</a>&#60;any&#62;`} />
+<MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/testing/test-db-initializer#testdbinitializer'>TestDbInitializer</a><any>`} />
 

package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx

@@ -2,10 +2,6 @@
 title: "SimpleGraphQLClient"
 generated: true
 ---
-
-
-## SimpleGraphQLClient
-
 <GenerationInfo sourceFile="packages/testing/src/simple-graphql-client.ts" sourceLine="40" packageName="@vendure/testing" />
 
 A minimalistic GraphQL client for populating and querying test data.
@@ -34,7 +30,7 @@ class SimpleGraphQLClient {
 
 ### constructor
 
-<MemberInfo kind="method" type={`(vendureConfig: Required&#60;<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>&#62;, apiUrl: string = '') => SimpleGraphQLClient`}   />
+<MemberInfo kind="method" type={`(vendureConfig: Required<<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>>, apiUrl: string = '') => SimpleGraphQLClient`}   />
 
 
 ### setAuthToken
@@ -54,19 +50,19 @@ Sets the authToken to be used in each GraphQL request.
 Returns the authToken currently being used.
 ### query
 
-<MemberInfo kind="method" type={`(query: DocumentNode | TypedDocumentNode&#60;T, V&#62;, variables?: V, queryParams?: QueryParams) => Promise&#60;T&#62;`}   />
+<MemberInfo kind="method" type={`(query: DocumentNode | TypedDocumentNode<T, V>, variables?: V, queryParams?: QueryParams) => Promise<T>`}   />
 
 Performs both query and mutation operations.
 ### fetch
 
-<MemberInfo kind="method" type={`(url: string, options: RequestInit = {}) => Promise&#60;Response&#62;`}   />
+<MemberInfo kind="method" type={`(url: string, options: RequestInit = {}) => Promise<Response>`}   />
 
 Performs a raw HTTP request to the given URL, but also includes the authToken & channelToken
 headers if they have been set. Useful for testing non-GraphQL endpoints, e.g. for plugins
 which make use of REST controllers.
 ### queryStatus
 
-<MemberInfo kind="method" type={`(query: DocumentNode, variables?: V) => Promise&#60;number&#62;`}   />
+<MemberInfo kind="method" type={`(query: DocumentNode, variables?: V) => Promise<number>`}   />
 
 Performs a query or mutation and returns the resulting status code.
 ### asUserWithCredentials
@@ -86,7 +82,7 @@ Logs in as the SuperAdmin user.
 Logs out so that the client is then treated as an anonymous user.
 ### fileUploadMutation
 
-<MemberInfo kind="method" type={`(options: {         mutation: DocumentNode;         filePaths: string[];         mapVariables: (filePaths: string[]) =&#62; any;     }) => Promise&#60;any&#62;`}   />
+<MemberInfo kind="method" type={`(options: {         mutation: DocumentNode;         filePaths: string[];         mapVariables: (filePaths: string[]) => any;     }) => Promise<any>`}   />
 
 Perform a file upload mutation.
 

package/docs/reference/typescript-api/testing/test-config.mdx

@@ -2,13 +2,9 @@
 title: "TestConfig"
 generated: true
 ---
-
-
-## testConfig
-
 <GenerationInfo sourceFile="packages/testing/src/config/test-config.ts" sourceLine="42" packageName="@vendure/testing" />
 
-A <a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a> object used for e2e tests. This configuration uses sqljs as the database
+A <DocsLink href="/reference/typescript-api/configuration/vendure-config#vendureconfig">VendureConfig</DocsLink> object used for e2e tests. This configuration uses sqljs as the database
 and configures some special settings which are optimized for e2e tests:
 
 * `entityIdStrategy: new TestingEntityIdStrategy()` This ID strategy uses auto-increment IDs but encodes all IDs

package/docs/reference/typescript-api/testing/test-db-initializer.mdx

@@ -2,17 +2,13 @@
 title: "TestDbInitializer"
 generated: true
 ---
-
-
-## TestDbInitializer
-
 <GenerationInfo sourceFile="packages/testing/src/initializers/test-db-initializer.ts" sourceLine="23" packageName="@vendure/testing" />
 
 Defines how the e2e TestService sets up a particular DB to run a single test suite.
 The `@vendure/testing` package ships with initializers for sql.js, MySQL & Postgres.
 
 Custom initializers can be created by implementing this interface and registering
-it with the <a href='/reference/typescript-api/testing/register-initializer#registerinitializer'>registerInitializer</a> function:
+it with the <DocsLink href="/reference/typescript-api/testing/register-initializer#registerinitializer">registerInitializer</DocsLink> function:
 
 *Example*
 
@@ -36,7 +32,7 @@ interface TestDbInitializer<T extends BaseConnectionOptions> {
 
 ### init
 
-<MemberInfo kind="method" type={`(testFileName: string, connectionOptions: T) => Promise&#60;T&#62;`}   />
+<MemberInfo kind="method" type={`(testFileName: string, connectionOptions: T) => Promise<T>`}   />
 
 Responsible for creating a database for the current test suite.
 Typically, this method will:
@@ -46,12 +42,12 @@ Typically, this method will:
 * mutate the `connetionOptions` object to point to that new database
 ### populate
 
-<MemberInfo kind="method" type={`(populateFn: () =&#62; Promise&#60;void&#62;) => Promise&#60;void&#62;`}   />
+<MemberInfo kind="method" type={`(populateFn: () => Promise<void>) => Promise<void>`}   />
 
 Execute the populateFn to populate your database.
 ### destroy
 
-<MemberInfo kind="method" type={`() => void | Promise&#60;void&#62;`}   />
+<MemberInfo kind="method" type={`() => void | Promise<void>`}   />
 
 Clean up any resources used during the init() phase (i.e. close open DB connections)
 

package/docs/reference/typescript-api/testing/test-environment.mdx

@@ -2,13 +2,9 @@
 title: "TestEnvironment"
 generated: true
 ---
-
-
-## TestEnvironment
-
 <GenerationInfo sourceFile="packages/testing/src/create-test-environment.ts" sourceLine="13" packageName="@vendure/testing" />
 
-The return value of <a href='/reference/typescript-api/testing/create-test-environment#createtestenvironment'>createTestEnvironment</a>, containing the test server
+The return value of <DocsLink href="/reference/typescript-api/testing/create-test-environment#createtestenvironment">createTestEnvironment</DocsLink>, containing the test server
 and clients for the Shop API and Admin API.
 
 ```ts title="Signature"

package/docs/reference/typescript-api/testing/test-server-options.mdx

@@ -2,13 +2,9 @@
 title: "TestServerOptions"
 generated: true
 ---
-
-
-## TestServerOptions
-
 <GenerationInfo sourceFile="packages/testing/src/types.ts" sourceLine="14" packageName="@vendure/testing" />
 
-Configuration options used to initialize an instance of the <a href='/reference/typescript-api/testing/test-server#testserver'>TestServer</a>.
+Configuration options used to initialize an instance of the <DocsLink href="/reference/typescript-api/testing/test-server#testserver">TestServer</DocsLink>.
 
 ```ts title="Signature"
 interface TestServerOptions {

package/docs/reference/typescript-api/testing/test-server.mdx

@@ -2,10 +2,6 @@
 title: "TestServer"
 generated: true
 ---
-
-
-## TestServer
-
 <GenerationInfo sourceFile="packages/testing/src/test-server.ts" sourceLine="17" packageName="@vendure/testing" />
 
 A real Vendure server against which the e2e tests should be run.
@@ -29,12 +25,12 @@ class TestServer {
 
 ### constructor
 
-<MemberInfo kind="method" type={`(vendureConfig: Required&#60;<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>&#62;) => TestServer`}   />
+<MemberInfo kind="method" type={`(vendureConfig: Required<<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>>) => TestServer`}   />
 
 
 ### init
 
-<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/testing/test-server-options#testserveroptions'>TestServerOptions</a>) => Promise&#60;void&#62;`}   />
+<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/testing/test-server-options#testserveroptions'>TestServerOptions</a>) => Promise<void>`}   />
 
 Bootstraps an instance of Vendure server and populates the database according to the options
 passed in. Should be called in the `beforeAll` function.

package/docs/reference/typescript-api/testing/testing-logger.mdx

@@ -2,10 +2,6 @@
 title: "TestingLogger"
 generated: true
 ---
-
-
-## TestingLogger
-
 <GenerationInfo sourceFile="packages/testing/src/testing-logger.ts" sourceLine="55" packageName="@vendure/testing" />
 
 The TestingLogger can be used in unit tests or e2e tests to make assertions on whether the various
@@ -81,7 +77,7 @@ class TestingLogger<Spy extends (...args: any[]) => any> implements VendureLogge
 
 ### constructor
 
-<MemberInfo kind="method" type={`(createSpyFn: () =&#62; Spy) => TestingLogger`}   />
+<MemberInfo kind="method" type={`(createSpyFn: () => Spy) => TestingLogger`}   />
 
 
 ### debugSpy

package/docs/reference/typescript-api/worker/bootstrap-worker.mdx

@@ -2,13 +2,9 @@
 title: "BootstrapWorker"
 generated: true
 ---
-
-
-## bootstrapWorker
-
 <GenerationInfo sourceFile="packages/core/src/bootstrap.ts" sourceLine="225" packageName="@vendure/core" />
 
-Bootstraps a Vendure worker. Resolves to a <a href='/reference/typescript-api/worker/vendure-worker#vendureworker'>VendureWorker</a> object containing a reference to the underlying
+Bootstraps a Vendure worker. Resolves to a <DocsLink href="/reference/typescript-api/worker/vendure-worker#vendureworker">VendureWorker</DocsLink> object containing a reference to the underlying
 NestJs [standalone application](https://docs.nestjs.com/standalone-applications) as well as convenience
 methods for starting the job queue and health check server.
 
@@ -36,16 +32,12 @@ Parameters
 
 ### userConfig
 
-<MemberInfo kind="parameter" type={`Partial&#60;<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>&#62;`} />
+<MemberInfo kind="parameter" type={`Partial<<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>>`} />
 
 ### options
 
 <MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/worker/bootstrap-worker#bootstrapworkeroptions'>BootstrapWorkerOptions</a>`} />
 
-
-
-## BootstrapWorkerOptions
-
 <GenerationInfo sourceFile="packages/core/src/bootstrap.ts" sourceLine="83" packageName="@vendure/core" since="2.2.0" />
 
 Additional options that can be used to configure the bootstrap process of the
@@ -67,9 +59,9 @@ interface BootstrapWorkerOptions {
 These options get passed directly to the `NestFactory.createApplicationContext` method.
 ### ignoreCompatibilityErrorsForPlugins
 
-<MemberInfo kind="property" type={`Array&#60;DynamicModule | Type&#60;any&#62;&#62;`} default={`[]`}  since="3.1.0"  />
+<MemberInfo kind="property" type={`Array<DynamicModule | Type<any>>`} default={`[]`}  since="3.1.0"  />
 
-See the `ignoreCompatibilityErrorsForPlugins` option in <a href='/reference/typescript-api/common/bootstrap#bootstrapoptions'>BootstrapOptions</a>.
+See the `ignoreCompatibilityErrorsForPlugins` option in <DocsLink href="/reference/typescript-api/common/bootstrap#bootstrapoptions">BootstrapOptions</DocsLink>.
 
 
 </div>

package/docs/reference/typescript-api/worker/vendure-worker.mdx

@@ -2,13 +2,9 @@
 title: "VendureWorker"
 generated: true
 ---
-
-
-## VendureWorker
-
 <GenerationInfo sourceFile="packages/core/src/worker/vendure-worker.ts" sourceLine="13" packageName="@vendure/core" />
 
-This object is created by calling the <a href='/reference/typescript-api/worker/bootstrap-worker#bootstrapworker'>bootstrapWorker</a> function.
+This object is created by calling the <DocsLink href="/reference/typescript-api/worker/bootstrap-worker#bootstrapworker">bootstrapWorker</DocsLink> function.
 
 ```ts title="Signature"
 class VendureWorker {
@@ -34,12 +30,12 @@ the NestJS [standalone application](https://docs.nestjs.com/standalone-applicati
 
 ### startJobQueue
 
-<MemberInfo kind="method" type={`() => Promise&#60;<a href='/reference/typescript-api/worker/vendure-worker#vendureworker'>VendureWorker</a>&#62;`}   />
+<MemberInfo kind="method" type={`() => Promise<<a href='/reference/typescript-api/worker/vendure-worker#vendureworker'>VendureWorker</a>>`}   />
 
 Starts the job queues running so that the worker can handle background jobs.
 ### startHealthCheckServer
 
-<MemberInfo kind="method" type={`(healthCheckConfig: <a href='/reference/typescript-api/worker/worker-health-check-config#workerhealthcheckconfig'>WorkerHealthCheckConfig</a>) => Promise&#60;<a href='/reference/typescript-api/worker/vendure-worker#vendureworker'>VendureWorker</a>&#62;`}  since="1.2.0"  />
+<MemberInfo kind="method" type={`(healthCheckConfig: <a href='/reference/typescript-api/worker/worker-health-check-config#workerhealthcheckconfig'>WorkerHealthCheckConfig</a>) => Promise<<a href='/reference/typescript-api/worker/vendure-worker#vendureworker'>VendureWorker</a>>`}  since="1.2.0"  />
 
 Starts a simple http server which can be used as a health check on the worker instance.
 This endpoint can be used by container orchestration services such as Kubernetes to

package/docs/reference/typescript-api/worker/worker-health-check-config.mdx

@@ -2,10 +2,6 @@
 title: "WorkerHealthCheckConfig"
 generated: true
 ---
-
-
-## WorkerHealthCheckConfig
-
 <GenerationInfo sourceFile="packages/core/src/worker/worker-health.service.ts" sourceLine="14" packageName="@vendure/core" since="1.2.0" />
 
 Specifies the configuration for the Worker's HTTP health check endpoint.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vendure/docs",
-    "version": "0.0.0-202601201808",
+    "version": "0.0.0-202601211028",
     "type": "module",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -24,7 +24,7 @@
         "typecheck": "tsc"
     },
     "dependencies": {
-        "@vendure-io/docs-provider": "^0.4.0"
+        "@vendure-io/docs-provider": "^0.5.0"
     },
     "devDependencies": {
         "rimraf": "^5.0.5",

package/docs/reference/admin-ui-api/index.mdx

@@ -1,4 +0,0 @@
----
-title: "Admin UI API"
-generated: true
----

package/docs/reference/dashboard/index.mdx

@@ -1,4 +0,0 @@
----
-title: "Dashboard API"
-generated: true
----

package/docs/reference/graphql-api/admin/_index.mdx

@@ -1,4 +0,0 @@
----
-title: "Admin API"
-generated: true
----

package/docs/reference/graphql-api/shop/_index.mdx

@@ -1,4 +0,0 @@
----
-title: "Shop API"
-generated: true
----

package/docs/reference/typescript-api/_index.mdx

@@ -1,4 +0,0 @@
----
-title: "TypeScript API"
-generated: true
----