npm - @vendure/docs - Versions diffs - 0.0.0-202601161959 → 0.0.0-202601201656 - Mend

@vendure/docs 0.0.0-202601161959 → 0.0.0-202601201656

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.

Files changed (662) hide show

package/docs/reference/admin-ui-api/services/modal-service.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "ModalService"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## ModalService

package/docs/reference/admin-ui-api/services/notification-service.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "NotificationService"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## NotificationService

package/docs/reference/admin-ui-api/tabs/index.mdx CHANGED Viewed

@@ -2,4 +2,3 @@
 title: "Tabs"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->

package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "PageTabConfig"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## PageTabConfig

package/docs/reference/admin-ui-api/tabs/register-page-tab.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "RegisterPageTab"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## registerPageTab

package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "AdminUiExtension"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## AdminUiExtension

package/docs/reference/admin-ui-api/ui-devkit/compile-ui-extensions.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "CompileUiExtensions"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## compileUiExtensions

package/docs/reference/admin-ui-api/ui-devkit/helpers.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "Helpers"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## setBranding

package/docs/reference/admin-ui-api/ui-devkit/index.mdx CHANGED Viewed

@@ -2,4 +2,3 @@
 title: "Ui Devkit"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->

package/docs/reference/admin-ui-api/ui-devkit/ui-devkit-client.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "UiDevkitClient"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## setTargetOrigin

package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "UiExtensionBuildCommand"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## UiExtensionBuildCommand

package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "UiExtensionCompilerOptions"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## UiExtensionCompilerOptions

package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "UiExtensionCompilerProcessArgument"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## UiExtensionCompilerProcessArgument

package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "AdminUiPluginOptions"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## AdminUiPluginOptions

package/docs/reference/core-plugins/admin-ui-plugin/index.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "AdminUiPlugin"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## AdminUiPlugin

package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "AssetServerOptions"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## AssetServerOptions

package/docs/reference/core-plugins/asset-server-plugin/cache-config.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "CacheConfig"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## CacheConfig

package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "HashedAssetNamingStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## HashedAssetNamingStrategy

package/docs/reference/core-plugins/asset-server-plugin/image-transform-mode.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "ImageTransformMode"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## ImageTransformMode

package/docs/reference/core-plugins/asset-server-plugin/image-transform-preset.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "ImageTransformPreset"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## ImageTransformPreset

package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "ImageTransformStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## ImageTransformStrategy

package/docs/reference/core-plugins/asset-server-plugin/index.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "AssetServerPlugin"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## AssetServerPlugin

package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "LocalAssetStorageStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## LocalAssetStorageStrategy

package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "PresetOnlyStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## PresetOnlyStrategy

package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "S3AssetStorageStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## S3AssetStorageStrategy
@@ -15,7 +14,7 @@ See their [getting started guide](https://aws.amazon.com/s3/getting-started/) fo
 Before using this strategy, make sure you have the `@aws-sdk/client-s3` and `@aws-sdk/lib-storage` package installed:
-```bash
+```sh
 npm install @aws-sdk/client-s3 @aws-sdk/lib-storage
 ```
@@ -151,7 +150,7 @@ Returns a configured instance of the <a href='/reference/core-plugins/asset-serv
 Before using this strategy, make sure you have the `@aws-sdk/client-s3` and `@aws-sdk/lib-storage` package installed:
-```bash
+```sh
 npm install @aws-sdk/client-s3 @aws-sdk/lib-storage
 ```

package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "SharpAssetPreviewStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## SharpAssetPreviewStrategy

package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "DashboardPluginOptions"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## DashboardPluginOptions

package/docs/reference/core-plugins/dashboard-plugin/index.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "DashboardPlugin"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## DashboardPlugin

package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "ElasticsearchOptions"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## ElasticsearchOptions
@@ -358,7 +357,7 @@ will extend the `SearchResultSortParameter` input type like this:
 *Example*
-```graphql
+```GraphQl
 extend input SearchResultSortParameter {
      distance: SortOrder
 }

package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "ElasticsearchPlugin"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## ElasticsearchPlugin

package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "EmailEventHandlerWithAsyncData"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## EmailEventHandlerWithAsyncData

package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "EmailEventHandler"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## EmailEventHandler

package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "EmailEventListener"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## EmailEventListener

package/docs/reference/core-plugins/email-plugin/email-generator.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "EmailGenerator"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## EmailGenerator

package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "EmailPluginOptions"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## EmailPluginOptions

package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "Email Plugin Types"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## EventWithContext

package/docs/reference/core-plugins/email-plugin/email-send-event.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "EmailSendEvent"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## EmailSendEvent

package/docs/reference/core-plugins/email-plugin/email-sender.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "EmailSender"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## EmailSender

package/docs/reference/core-plugins/email-plugin/email-utils.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "Email Utils"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## transformOrderLineAssetUrls

package/docs/reference/core-plugins/email-plugin/index.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "EmailPlugin"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## EmailPlugin

package/docs/reference/core-plugins/email-plugin/template-loader.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "TemplateLoader"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## TemplateLoader

package/docs/reference/core-plugins/email-plugin/transport-options.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "Transport Options"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## EmailTransportOptions

package/docs/reference/core-plugins/graphiql-plugin/index.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "GraphiqlPlugin"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## GraphiqlPlugin

package/docs/reference/core-plugins/harden-plugin/default-vendure-complexity-estimator.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "DefaultVendureComplexityEstimator"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## defaultVendureComplexityEstimator

package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "HardenPluginOptions"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## HardenPluginOptions

package/docs/reference/core-plugins/harden-plugin/index.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "HardenPlugin"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## HardenPlugin
@@ -53,7 +52,7 @@ be required to resolve that query.
 The goal of this setting is to prevent attacks in which a malicious actor crafts a very complex query in order to overwhelm your
 server resources. Here's an example of a request which would likely overwhelm a Vendure server:
-```graphql
+```GraphQL
 query EvilQuery {
   products {
     items {
@@ -119,7 +118,7 @@ const config: VendureConfig = {
 With logging configured as above, the following query:
-```graphql
+```GraphQL
 query ProductList {
   products(options: { take: 5 }) {
     items {
@@ -134,7 +133,7 @@ query ProductList {
 ```
 will log the following breakdown:
-```bash
+```sh
 debug 16/12/22, 14:12 - [HardenPlugin] Calculating complexity of [ProductList]
 debug 16/12/22, 14:12 - [HardenPlugin] Product.id: ID!     childComplexity: 0, score: 1
 debug 16/12/22, 14:12 - [HardenPlugin] Product.name: String!       childComplexity: 0, score: 1

package/docs/reference/core-plugins/index.mdx CHANGED Viewed

@@ -2,4 +2,3 @@
 title: "Core Plugins"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->

package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "BullMQJobQueuePlugin"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## BullMQJobQueuePlugin
@@ -30,7 +29,7 @@ in processing jobs.
 Note: To use this plugin, you need to manually install the `bullmq` package:
-```bash
+```shell
 npm install bullmq@^5.4.2
 ```
@@ -60,7 +59,7 @@ To develop with this plugin, you'll need an instance of Redis to connect to. Her
 that will set up [Redis](https://redis.io/) as well as [Redis Commander](https://github.com/joeferner/redis-commander),
 which is a web-based UI for interacting with Redis:
-```yaml
+```YAML
 version: "3"
 services:
   redis:

package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "BullMQJobQueueStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## BullMQJobQueueStrategy
@@ -14,7 +13,7 @@ on top of Redis. It should not be used alone, but as part of the <a href='/refer
 Note: To use this strategy, you need to manually install the `bullmq` package:
-```bash
+```shell
 npm install bullmq@^5.4.2
 ```

package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "BullMQPluginOptions"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## BullMQPluginOptions

package/docs/reference/core-plugins/job-queue-plugin/index.mdx CHANGED Viewed

@@ -2,4 +2,3 @@
 title: "Job Queue Plugin"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->

package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "PubSubJobQueueStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## PubSubJobQueueStrategy
@@ -14,7 +13,7 @@ It should not be used alone, but as part of the <a href='/reference/core-plugins
 Note: To use this strategy, you need to manually install the `@google-cloud/pubsub` package:
-```bash
+```shell
 npm install
 ```ts title="Signature"

package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "PubSubPlugin"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## PubSubPlugin
@@ -15,7 +14,7 @@ This plugin uses Google Cloud Pub/Sub to implement a job queue strategy for Vend
 Note: To use this plugin, you need to manually install the `@google-cloud/pubsub` package:
-```bash
+```shell
 npm install
 ```ts title="Signature"

package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "BraintreePlugin"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## BraintreePlugin
@@ -15,12 +14,12 @@ This plugin enables payments to be processed by [Braintree](https://www.braintre
 1. You will need to create a Braintree sandbox account as outlined in https://developers.braintreepayments.com/start/overview.
 2. Then install `braintree` and `@types/braintree` from npm. This plugin was written with `v3.x` of the Braintree lib.
-    ```bash
+    ```shell
     yarn add @vendure/payments-plugin braintree
     yarn add -D @types/braintree
     ```
     or
-    ```bash
+    ```shell
     npm install @vendure/payments-plugin braintree
     npm install -D @types/braintree
     ```
@@ -53,7 +52,7 @@ The plugin is designed to work with the [Braintree drop-in UI](https://developer
 This is a library provided by Braintree which will handle the payment UI for you. You can install it in your storefront project
 with:
-```bash
+```shell
 yarn add braintree-web-drop-in
 # or
 npm install braintree-web-drop-in
@@ -208,7 +207,7 @@ BraintreePlugin.init({
 Since v1.8, it is possible to override vaulting on a per-payment basis by passing `includeCustomerId: false` to the `generateBraintreeClientToken`
 mutation:
-```graphql
+```GraphQL
 const { generateBraintreeClientToken } = await graphQlClient.query(gql`
   query GenerateBraintreeClientToken($includeCustomerId: Boolean) {
     generateBraintreeClientToken(includeCustomerId: $includeCustomerId)

package/docs/reference/core-plugins/payments-plugin/index.mdx CHANGED Viewed

@@ -2,4 +2,3 @@
 title: "Payments Plugin"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->

package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "MolliePlugin"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## MolliePlugin
@@ -46,7 +45,7 @@ In your storefront you add a payment to an order using the `createMolliePaymentI
 PaymentMethod was given the code "mollie-payment-method". The `redirectUrl``is the url that is used to redirect the end-user
 back to your storefront after completing the payment.
-```graphql
+```GraphQL
 mutation CreateMolliePaymentIntent {
   createMolliePaymentIntent(input: {
     redirectUrl: "https://storefront/order/1234XYZ" // Optional, the fallback redirect url set in the admin UI will be used if not provided
@@ -73,7 +72,7 @@ platform.
 'molliePaymentMethodCode' is an optional parameter that can be passed to skip Mollie's hosted payment method selection screen
 You can get available Mollie payment methods with the following query:
-```graphql
+```GraphQL
 {
  molliePaymentMethods(input: { paymentMethodCode: "mollie-payment-method" }) {
    id