npm - @vendure/docs - Versions diffs - 0.0.0-202601161603 → 0.0.0-202601161707 - Mend

@vendure/docs 0.0.0-202601161603 → 0.0.0-202601161707

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 (131) hide show

package/docs/guides/extending-the-admin-ui/ui-library/index.mdx CHANGED Viewed

@@ -2,9 +2,6 @@
 title: "UI Component Library"
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 The Admin UI is built on a customized version of the [Clarity Design System](https://clarity.design/documentation/get-started). This means that if you are writing Angular-based UI extensions, you can use the same components that are used in the rest of the Admin UI. If you are using React, we are gradually exporting the most-used components for use with React.
 ## Buttons

package/docs/guides/extending-the-admin-ui/using-other-frameworks/index.mdx CHANGED Viewed

@@ -128,7 +128,7 @@ import '@vendure/admin-ui/static/theme.min.css';
 If your extension does not have a build step, you can still include the theme stylesheet as a local resource:
-```HTML
+```html
 <!-- src/ui-extension/plain-js-app/index.html -->
 <head>
   <link rel="stylesheet" href="../../theme.min.css" />

package/docs/guides/extending-the-dashboard/creating-pages/detail-pages.mdx CHANGED Viewed

@@ -2,9 +2,6 @@
 title: 'Creating Detail Pages'
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 ## Setup
 :::info

package/docs/guides/extending-the-dashboard/creating-pages/index.mdx CHANGED Viewed

@@ -2,9 +2,6 @@
 title: 'Creating Pages'
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 ## Page Structure
 All pages in the Dashboard follow this structure:

package/docs/guides/extending-the-dashboard/creating-pages/list-pages.mdx CHANGED Viewed

@@ -2,9 +2,6 @@
 title: 'Creating List Pages'
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 ## Setup
 :::info

package/docs/guides/extending-the-dashboard/creating-pages/tabbed-pages.mdx CHANGED Viewed

@@ -2,9 +2,6 @@
 title: 'Creating Tabbed Pages'
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 ## Setup
 :::info

package/docs/guides/extending-the-dashboard/custom-form-components/form-component-examples.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: 'Form Component Examples'
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 ## Email Input with Validation
 This example uses the `react-hook-form` validation state in order to display an icon indicating

package/docs/guides/extending-the-dashboard/extending-overview/index.mdx CHANGED Viewed

@@ -2,9 +2,6 @@
 title: 'Extending the Dashboard'
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 The custom functionality you create in your Vendure plugins often needs to be exposed via the Dashboard so that
 administrators can interact with it.

package/docs/guides/extending-the-dashboard/getting-started/index.mdx CHANGED Viewed

@@ -2,9 +2,6 @@
 title: 'Getting Started'
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 :::info
 From Vendure v3.5.0, the `@vendure/dashboard` package and configuration comes as standard with new projects that are started with
 the `npx @vendure/create` command.

package/docs/guides/extending-the-dashboard/localization/index.mdx CHANGED Viewed

@@ -86,7 +86,7 @@ src/
 Since we set the "sourceLocale" to be "en", the `en.po` file will already be complete. You'll then need to
 open up the `de.po` file and add German translations for each of the strings, by filling out the empty `msgstr` values:
-```po title="de.po"
+```text title="de.po"
 #: test-plugins/reviews/dashboard/review-list.tsx:51
 msgid "Welcome to Dashboard"
 // highlight-next-line

package/docs/guides/extending-the-dashboard/migration/index.mdx CHANGED Viewed

@@ -3,8 +3,6 @@ title: Migrating from Admin UI
 sidebar_position: 1
 ---
-# Migrating from Admin UI
 If you have existing extensions to the legacy Angular-based Admin UI, you will want to migrate to the new Dashboard to enjoy
 an improved developer experience, many more customization options, and ongoing support from the Vendure team.

package/docs/guides/getting-started/graphql-intro/index.mdx CHANGED Viewed

@@ -1,9 +1,6 @@
 ---
 title: Introducing GraphQL
 ---
-import Playground from '@site/src/components/Playground';
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 :::info

package/docs/guides/getting-started/installation/index.mdx CHANGED Viewed

@@ -3,9 +3,6 @@ title: 'Installation'
 sidebar_position: 1
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 ## Requirements
 - [Node.js](https://nodejs.org/en/) **v20**, **v22** and **v24** - these versions are tested and supported. (Odd-numbered versions above v20 should still work but are not officially supported.)
@@ -226,7 +223,7 @@ Use `npx vendure add` to start adding plugins & custom functionality to your Ven
 - If you encounter any issues during installation, you can get a more detailed output by setting the log level to `verbose`:
-    ```sh
+    ```bash
     npx @vendure/create my-shop --log-level verbose
     ```

package/docs/guides/getting-started/try-the-api/index.mdx CHANGED Viewed

@@ -2,9 +2,6 @@
 title: 'Try the API'
 ---
-import Playground from '@site/src/components/Playground';
 Once you have successfully installed Vendure locally following the [installation guide](/guides/getting-started/installation),
 it's time to try out the API!

package/docs/guides/how-to/cms-integration-plugin/index.mdx CHANGED Viewed

@@ -2,9 +2,6 @@
 title: 'Building a CMS Integration Plugin'
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 A CMS integration plugin allows you to automatically synchronize your Vendure product catalog with an external Content Management System.
 This is done in a way that establishes Vendure as the source of truth for the ecommerce's data.

package/docs/guides/how-to/digital-products/index.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "Digital Products"
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 Digital products include things like ebooks, online courses, and software. They are products that are delivered to the customer electronically, and do not require
 physical shipping.

package/docs/guides/how-to/github-oauth-authentication/index.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "GitHub OAuth Authentication"
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 :::info
 The complete source of the following example plugin can be found here: [example-plugins/github-auth-plugin](https://github.com/vendurehq/examples/tree/publish/examples/shop-github-auth)
 :::

package/docs/guides/how-to/google-oauth-authentication/index.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "Google OAuth Authentication"
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 :::info
 The complete source of the following example plugin can be found here: [example-plugins/google-auth-plugin](https://github.com/vendurehq/examples/tree/publish/examples/shop-google-auth)
 :::

package/docs/guides/how-to/multi-vendor-marketplaces/index.mdx CHANGED Viewed

@@ -2,8 +2,6 @@
 title: "Multi-vendor Marketplaces"
 ---
-# Multi-vendor Marketplaces
 Vendure v2.0 introduced a number of changes and new APIs to enable developers to build multi-vendor marketplace apps.
 This is a type of application in which multiple sellers are able to list products, and then customers can create orders containing products from one or more of these sellers. Well-known examples include Amazon, Ebay, Etsy and Airbnb.

package/docs/guides/how-to/paginated-list/index.mdx CHANGED Viewed

@@ -2,9 +2,6 @@
 title: "Paginated lists"
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 Vendure's list queries follow a set pattern which allows for pagination, filtering & sorting. This guide will demonstrate how
 to implement your own paginated list queries.

package/docs/guides/how-to/publish-plugin/index.mdx CHANGED Viewed

@@ -2,9 +2,6 @@
 title: "Publishing a Plugin"
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 Vendure's [plugin-based architecture](/guides/developer-guide/plugins/) means you'll be writing a lot of plugins.
 Some of those plugins may be useful to others, and you may want to share them with the community.

package/docs/guides/how-to/s3-asset-storage/index.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "Integrating S3-Compatible Asset Storage"
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 This guide demonstrates how to integrate S3-compatible asset storage into your Vendure application using multiple cloud storage platforms. You'll learn to configure a single, platform-agnostic storage solution that works seamlessly with AWS S3, DigitalOcean Spaces, MinIO, CloudFlare R2, and Supabase Storage.
 ## Working Example Repository

package/docs/guides/storefront/active-order/index.mdx CHANGED Viewed

@@ -2,8 +2,6 @@
 title: "Managing the Active Order"
 ---
-import Stackblitz from '@site/src/components/Stackblitz';
 The "active order" is what is also known as the "cart" - it is the order that is currently being worked on by the customer.
 An order remains active until it is completed, and during this time it can be modified by the customer in various ways:

package/docs/guides/storefront/checkout-flow/index.mdx CHANGED Viewed

@@ -2,9 +2,6 @@
 title: "Checkout Flow"
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 Once the customer has added the desired products to the active order, it's time to check out.
 This guide assumes that you are using the [default OrderProcess](/guides/core-concepts/orders/#the-order-process), so

package/docs/guides/storefront/connect-api/index.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: Connect to the API
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import Stackblitz from '@site/src/components/Stackblitz';
 The first thing you'll need to do is to connect your storefront app to the **Shop API**. The Shop API is a GraphQL API
 that provides access to the products, collections, customer data, and exposes mutations that allow you to add items to
 the cart, checkout, manage customer accounts, and more.

package/docs/guides/storefront/customer-accounts/index.mdx CHANGED Viewed

@@ -2,9 +2,6 @@
 title: "Customer Accounts"
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 Customers can register accounts and thereby gain the ability to:
 - View past orders

package/docs/guides/storefront/listing-products/index.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "Listing Products"
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import Stackblitz from '@site/src/components/Stackblitz';
 Products are listed when:
 - Displaying the contents of a collection

package/docs/guides/storefront/navigation-menu/index.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "Navigation Menu"
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import Stackblitz from '@site/src/components/Stackblitz';
 A navigation menu allows your customers to navigate your store and find the products they are looking for.
 Typically, navigation is based on a hierarchy of [collections](/guides/core-concepts/collections/). We can get the top-level

package/docs/guides/storefront/order-workflow/index.mdx CHANGED Viewed

@@ -3,8 +3,6 @@ title: "Order Workflow"
 showtoc: true
 ---
-# Order Workflow
 An Order is a collection of one or more ProductVariants which can be purchased by a Customer. Orders are represented internally by the [Order entity](/reference/typescript-api/entities/order/) and in the GraphQL API by the [Order type](/reference/graphql-api/admin/enums/#ordertype).
 ## Order State

package/docs/guides/storefront/product-detail/index.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "Product Detail Page"
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import Stackblitz from '@site/src/components/Stackblitz';
 The product detail page (often abbreviated to PDP) is the page that shows the details of a product and allows the user to add it to their cart.
 Typically, the PDP should include:

package/docs/reference/admin-ui-api/components/chip-component.mdx CHANGED Viewed

@@ -13,7 +13,7 @@ A chip component for displaying a label with an optional action icon.
 *Example*
-```HTML
+```html
 <vdr-chip [colorFrom]="item.value"
           icon="close"
           (iconClick)="clear(item)">

package/docs/reference/admin-ui-api/components/currency-input-component.mdx CHANGED Viewed

@@ -14,7 +14,7 @@ with the integer cent value in the background.
 *Example*
-```HTML
+```html
 <vdr-currency-input
     [(ngModel)]="entityPrice"
     [currencyCode]="currencyCode"

package/docs/reference/admin-ui-api/components/data-table-component.mdx CHANGED Viewed

@@ -16,7 +16,7 @@ extend the <a href='/reference/admin-ui-api/list-detail-views/base-list-componen
 *Example*
-```HTML
+```html
 <vdr-data-table
   [items]="items$ | async"
   [itemsPerPage]="itemsPerPage$ | async"

package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx CHANGED Viewed

@@ -13,7 +13,7 @@ A form input for selecting datetime values.
 *Example*
-```HTML
+```html
 <vdr-datetime-picker [(ngModel)]="startDate"></vdr-datetime-picker>
 ```

package/docs/reference/admin-ui-api/components/dropdown-component.mdx CHANGED Viewed

@@ -13,7 +13,7 @@ Used for building dropdown menus.
 *Example*
-```HTML
+```html
 <vdr-dropdown>
   <button class="btn btn-outline" vdrDropdownTrigger>
       <clr-icon shape="plus"></clr-icon>

package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx CHANGED Viewed

@@ -13,7 +13,7 @@ A form control for selecting facet values.
 *Example*
-```HTML
+```html
 <vdr-facet-value-selector
   (selectedValuesChange)="selectedValues = $event"
 ></vdr-facet-value-selector>

package/docs/reference/admin-ui-api/components/object-tree-component.mdx CHANGED Viewed

@@ -13,7 +13,7 @@ This component displays a plain JavaScript object as an expandable tree.
 *Example*
-```HTML
+```html
 <vdr-object-tree [value]="payment.metadata"></vdr-object-tree>
 ```

package/docs/reference/admin-ui-api/components/order-state-label-component.mdx CHANGED Viewed

@@ -13,7 +13,7 @@ Displays the state of an order in a colored chip.
 *Example*
-```HTML
+```html
 <vdr-order-state-label [state]="order.state"></vdr-order-state-label>
 ```

package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx CHANGED Viewed

@@ -13,7 +13,7 @@ A component for selecting product variants via an autocomplete-style select inpu
 *Example*
-```HTML
+```html
 <vdr-product-variant-selector
   (productSelected)="selectResult($event)"></vdr-product-variant-selector>
 ```

package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx CHANGED Viewed

@@ -13,7 +13,7 @@ A rich text (HTML) editor based on Prosemirror (https://prosemirror.net/)
 *Example*
-```HTML
+```html
 <vdr-rich-text-editor
     [(ngModel)]="description"
     label="Description"

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

@@ -4,8 +4,6 @@ weight: 10
 showtoc: false
 ---
-# Vendure Admin UI API Docs
 These APIs are used when building your own custom extensions to the Admin UI provided by the AdminUiPlugin.
 :::note

package/docs/reference/admin-ui-api/pipes/asset-preview-pipe.mdx CHANGED Viewed

@@ -15,7 +15,7 @@ AssetServerPlugin.
 *Example*
-```HTML
+```html
 <img [src]="asset | assetPreview:'tiny'" />
 <img [src]="asset | assetPreview:150" />
 ```

package/docs/reference/admin-ui-api/pipes/has-permission-pipe.mdx CHANGED Viewed

@@ -14,7 +14,7 @@ Returns `true` if the current user has that permission.
 *Example*
-```HTML
+```html
 <button [disabled]="!('UpdateCatalog' | hasPermission)">Save Changes</button>
 ```

package/docs/reference/admin-ui-api/pipes/locale-currency-name-pipe.mdx CHANGED Viewed

@@ -13,7 +13,7 @@ Displays a human-readable name for a given ISO 4217 currency code.
 *Example*
-```HTML
+```html
 {{ order.currencyCode | localeCurrencyName }}
 ```

package/docs/reference/admin-ui-api/pipes/locale-currency-pipe.mdx CHANGED Viewed

@@ -14,7 +14,7 @@ locale.
 *Example*
-```HTML
+```html
 {{ variant.priceWithTax | localeCurrency }}
 ```

package/docs/reference/admin-ui-api/pipes/locale-date-pipe.mdx CHANGED Viewed

@@ -14,7 +14,7 @@ to format dates according to the selected UI language.
 *Example*
-```HTML
+```html
 {{ order.orderPlacedAt | localeDate }}
 ```

package/docs/reference/admin-ui-api/pipes/locale-language-name-pipe.mdx CHANGED Viewed

@@ -13,7 +13,7 @@ Displays a human-readable name for a given ISO 639-1 language code.
 *Example*
-```HTML
+```html
 {{ 'zh_Hant' | localeLanguageName }}
 ```

package/docs/reference/admin-ui-api/pipes/locale-region-name-pipe.mdx CHANGED Viewed

@@ -13,7 +13,7 @@ Displays a human-readable name for a given region.
 *Example*
-```HTML
+```html
 {{ 'GB' | localeRegionName }}
 ```

package/docs/reference/admin-ui-api/pipes/time-ago-pipe.mdx CHANGED Viewed

@@ -13,7 +13,7 @@ Converts a date into the format "3 minutes ago", "5 hours ago" etc.
 *Example*
-```HTML
+```html
 {{ order.orderPlacedAt | timeAgo }}
 ```

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

@@ -15,7 +15,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:
-```sh
+```bash
 npm install @aws-sdk/client-s3 @aws-sdk/lib-storage
 ```
@@ -151,7 +151,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:
-```sh
+```bash
 npm install @aws-sdk/client-s3 @aws-sdk/lib-storage
 ```

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

@@ -358,7 +358,7 @@ will extend the `SearchResultSortParameter` input type like this:
 *Example*
-```GraphQl
+```graphql
 extend input SearchResultSortParameter {
      distance: SortOrder
 }

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

@@ -53,7 +53,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 +119,7 @@ const config: VendureConfig = {
 With logging configured as above, the following query:
-```GraphQL
+```graphql
 query ProductList {
   products(options: { take: 5 }) {
     items {
@@ -134,7 +134,7 @@ query ProductList {
 ```
 will log the following breakdown:
-```sh
+```bash
 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/job-queue-plugin/bull-mqjob-queue-plugin.mdx CHANGED Viewed

@@ -30,7 +30,7 @@ in processing jobs.
 Note: To use this plugin, you need to manually install the `bullmq` package:
-```shell
+```bash
 npm install bullmq@^5.4.2
 ```
@@ -60,7 +60,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

@@ -14,7 +14,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:
-```shell
+```bash
 npm install bullmq@^5.4.2
 ```

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

@@ -14,7 +14,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:
-```shell
+```bash
 npm install
 ```ts title="Signature"

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

@@ -15,7 +15,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:
-```shell
+```bash
 npm install
 ```ts title="Signature"