@vendure/docs 0.0.0-202601281114 → 0.0.0-202601291452

package/docs/guides/developer-guide/database-entity/index.mdx

@@ -39,6 +39,24 @@ class ProductReview extends VendureEntity {
 }
 ```
 
+:::caution[TypeScript ES2022+ Compatibility]
+If your `tsconfig.json` uses `"target": "ES2022"` or later (including **Node.js v24+**), you **must** also set `"useDefineForClassFields": false`.
+
+Without this setting, ES2022 class field semantics cause entity fields to be overwritten with `undefined` after the constructor runs, resulting in "null value in column violates not-null constraint" database errors.
+
+```json title="tsconfig.json"
+{
+    "compilerOptions": {
+        "target": "ES2022",
+        // highlight-next-line
+        "useDefineForClassFields": false
+    }
+}
+```
+
+See the [TypeScript documentation](https://www.typescriptlang.org/tsconfig/useDefineForClassFields.html) for more details.
+:::
+
 :::note
 Any custom entities *must* extend the [`VendureEntity`](/reference/typescript-api/entities/vendure-entity/) class.
 :::

package/docs/guides/developer-guide/plugins/index.mdx

@@ -4,7 +4,7 @@ sidebar_position: 6
 ---
 
 The heart of Vendure is its plugin system. Plugins not only allow you to instantly add new functionality to your
-Vendure server via third-part npm packages, they are also the means by which you build out the custom business
+Vendure server via third-party npm packages, they are also the means by which you build out the custom business
 logic of your application.
 
 Plugins in Vendure allow one to:

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

@@ -14,12 +14,12 @@ For example, the `articles` query of our `CmsPlugin` looks like this:
 
 ```graphql
 type ArticleList implements PaginatedList {
-  items: [Article!]!
-  totalItems: Int!
+    items: [Article!]!
+    totalItems: Int!
 }
 
 extend type Query {
-  articles(options: ArticleListOptions): ArticleList!
+    articles(options: ArticleListOptions): ArticleList!
 }
 ```
 
@@ -135,6 +135,7 @@ files to be picked up by Vite:
 q # to stop the running dev server
 npx vite # to restart
 ```
+
 :::
 
 ## The ListPage Component
@@ -158,46 +159,54 @@ more control over how the column data is rendered.
 
 ```tsx
 <ListPage
-  pageId="collection-list"
-  listQuery={collectionListDocument}
-  customizeColumns={{
-      // The key "name" matches one of the top-level fields of the
-      // list query type (Collection, in this example)
-      name: {
-          meta: {
-              // The Dashboard optimizes the list query `collectionListDocument` to
-              // only select field that are actually visible in the ListPage table.
-              // However, sometimes you want to render data from other fields, i.e.
-              // this column has a data dependency on the "children" and "breadcrumbs"
-              // fields in order to correctly render the "name" field.
-              // In this case, we can declare those data dependencies which means whenever
-              // the "name" column is visible, it will ensure the "children" and "breadcrumbs"
-              // fields are also selected in the query.
-              dependencies: ['children', 'breadcrumbs'],
-          },
-          header: 'Collection Name',
-          cell: ({ row }) => {
-              const isExpanded = row.getIsExpanded();
-              const hasChildren = !!row.original.children?.length;
-              return (
-                  <div
-                      style={{ marginLeft: (row.original.breadcrumbs?.length - 2) * 20 + 'px' }}
-                      className="flex gap-2 items-center"
-                  >
-                      <Button
-                          size="icon"
-                          variant="secondary"
-                          onClick={row.getToggleExpandedHandler()}
-                          disabled={!hasChildren}
-                          className={!hasChildren ? 'opacity-20' : ''}
-                      >
-                          {isExpanded ? <FolderOpen /> : <Folder />}
-                      </Button>
-                      <DetailPageButton id={row.original.id} label={row.original.name} />
-                  </div>
-              );
-          },
-      },
-  }}
+    pageId="collection-list"
+    listQuery={collectionListDocument}
+    customizeColumns={{
+        // Use `meta.disabled` to completely exclude a column from the table,
+        // including the column visibility toggle. This is useful when you need
+        // to fetch certain fields for use in custom cell renderers, but don't
+        // want those fields to appear as their own columns.
+        productVariantCount: {
+            meta: { disabled: true },
+        },
+        // The key "name" matches one of the top-level fields of the
+        // list query type (Collection, in this example)
+        name: {
+            meta: {
+                // The Dashboard optimizes the list query `collectionListDocument` to
+                // only select field that are actually visible in the ListPage table.
+                // However, sometimes you want to render data from other fields, i.e.
+                // this column has a data dependency on the "children" and "breadcrumbs"
+                // fields in order to correctly render the "name" field.
+                // In this case, we can declare those data dependencies which means whenever
+                // the "name" column is visible, it will ensure the "children" and "breadcrumbs"
+                // fields are also selected in the query.
+                dependencies: ['children', 'breadcrumbs'],
+            },
+
+            header: 'Collection Name',
+            cell: ({ row }) => {
+                const isExpanded = row.getIsExpanded();
+                const hasChildren = !!row.original.children?.length;
+                return (
+                    <div
+                        style={{ marginLeft: (row.original.breadcrumbs?.length - 2) * 20 + 'px' }}
+                        className="flex gap-2 items-center"
+                    >
+                        <Button
+                            size="icon"
+                            variant="secondary"
+                            onClick={row.getToggleExpandedHandler()}
+                            disabled={!hasChildren}
+                            className={!hasChildren ? 'opacity-20' : ''}
+                        >
+                            {isExpanded ? <FolderOpen /> : <Folder />}
+                        </Button>
+                        <DetailPageButton id={row.original.id} label={row.original.name} />
+                    </div>
+                );
+            },
+        },
+    }}
 />
 ```

package/docs/guides/extending-the-dashboard/custom-form-components/index.mdx

@@ -5,8 +5,8 @@ title: 'Custom Form Elements'
 The dashboard allows you to create custom form elements that provide complete control over how data is rendered and how users
 interact with forms. This includes:
 
-- **Custom Field Components** - Globally-registered components that can be used to render **custom fields** and **configurable operation arguments**
-- **Detail Form Components** - Form input components that target specific fields of detail pages.
+- **[Custom Field Components](#custom-field-components)** — Globally-registered components that can be used to render **custom fields** and **configurable operation arguments**
+- **[Detail Form Components](#detail-form-components)** — Form input components that target specific fields of detail pages
 
 ## Anatomy of a Form Component
 

package/docs/guides/extending-the-dashboard/customizing-pages/customizing-detail-pages.mdx

@@ -7,6 +7,12 @@ customize any existing detail page in the Dashboard.
 
 ## Custom form inputs
 
+:::warning[Custom Fields]
+This feature replaces inputs for **built-in entity fields** only (like `name`, `description`, `slug`).
+
+To customize the form input for a **custom field** you defined in your plugin, use the [Custom Field Components](/guides/extending-the-dashboard/custom-form-components/#custom-field-components) instead.
+:::
+
 You can replace any of the default form inputs with your own components using the `inputs` property.
 
 Let's say you want to replace the default HTML description editor with a markdown editor component:

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

@@ -2,7 +2,7 @@
 title: "MolliePlugin"
 generated: true
 ---
-<GenerationInfo sourceFile="packages/payments-plugin/src/mollie/mollie.plugin.ts" sourceLine="195" packageName="@vendure/payments-plugin" />
+<GenerationInfo sourceFile="packages/payments-plugin/src/mollie/mollie.plugin.ts" sourceLine="203" packageName="@vendure/payments-plugin" />
 
 Plugin to enable payments through the [Mollie platform](https://docs.mollie.com/).
 This plugin uses the Order API from Mollie, not the Payments API.
@@ -148,6 +148,7 @@ interface MolliePluginOptions {
         ctx: RequestContext,
         order: Order | null,
     ) => AdditionalEnabledPaymentMethodsParams | Promise<AdditionalEnabledPaymentMethodsParams>;
+    immediateCapture?: boolean;
 }
 ```
 
@@ -195,6 +196,14 @@ export const config: VendureConfig = {
   ],
 };
 ```
+### immediateCapture
+
+<MemberInfo kind="property" type={`boolean`}   />
+
+Immediate capture mode for pay-later methods like Klarna.
+Setting this option will make the plugin ignore the `immediateCapture` option in the `createMolliePaymentIntent` mutation.
+
+The default is true, unless set otherwise as input in the `createMolliePaymentIntent` mutation.
 
 
 </div>

package/docs/reference/dashboard/hooks/use-paginated-list.mdx

@@ -2,7 +2,7 @@
 title: "UsePaginatedList"
 generated: true
 ---
-<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/paginated-list-data-table.tsx" sourceLine="179" packageName="@vendure/dashboard" since="3.4.0" />
+<GenerationInfo sourceFile="packages/dashboard/src/lib/hooks/use-paginated-list.ts" sourceLine="22" packageName="@vendure/dashboard" since="3.4.0" />
 
 Returns the context for the paginated list data table. Must be used within a PaginatedListDataTable.
 

package/docs/reference/dashboard/hooks/use-widget-filters.mdx

@@ -2,7 +2,7 @@
 title: "UseWidgetFilters"
 generated: true
 ---
-<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/dashboard-widget/widget-filters-context.tsx" sourceLine="29" packageName="@vendure/dashboard" since="3.5.0" />
+<GenerationInfo sourceFile="packages/dashboard/src/lib/hooks/use-widget-filters.ts" sourceLine="14" packageName="@vendure/dashboard" since="3.5.0" />
 
 Exposes a context object for use in building Insights page widgets.
 

package/docs/reference/dashboard/list-views/data-table.mdx

@@ -2,7 +2,7 @@
 title: "DataTable"
 generated: true
 ---
-<GenerationInfo sourceFile="packages/dashboard/src/lib/components/data-table/data-table.tsx" sourceLine="164" packageName="@vendure/dashboard" since="3.4.0" />
+<GenerationInfo sourceFile="packages/dashboard/src/lib/components/data-table/data-table.tsx" sourceLine="171" packageName="@vendure/dashboard" since="3.4.0" />
 
 A data table which includes sorting, filtering, pagination, bulk actions, column controls etc.
 
@@ -17,7 +17,7 @@ Parameters
 
 <MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/list-views/data-table#datatableprops'>DataTableProps</a><TData>>`} />
 
-<GenerationInfo sourceFile="packages/dashboard/src/lib/components/data-table/data-table.tsx" sourceLine="113" packageName="@vendure/dashboard" since="3.4.0" />
+<GenerationInfo sourceFile="packages/dashboard/src/lib/components/data-table/data-table.tsx" sourceLine="120" packageName="@vendure/dashboard" since="3.4.0" />
 
 Props for configuring the [DataTable](/reference/dashboard/list-views/data-table#datatable).
 

package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx

@@ -2,7 +2,7 @@
 title: "PaginatedListDataTable"
 generated: true
 ---
-<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/paginated-list-data-table.tsx" sourceLine="366" packageName="@vendure/dashboard" since="3.4.0" />
+<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/paginated-list-data-table.tsx" sourceLine="336" packageName="@vendure/dashboard" since="3.4.0" />
 
 A wrapper around the [DataTable](/reference/dashboard/list-views/data-table#datatable) component, which automatically configures functionality common to
 list queries that implement the `PaginatedList` interface, which is the common way of representing lists
@@ -117,7 +117,7 @@ Parameters
 
 <MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/list-views/paginated-list-data-table#paginatedlistdatatableprops'>PaginatedListDataTableProps</a><T, U, V, AC>>`} />
 
-<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/paginated-list-data-table.tsx" sourceLine="202" packageName="@vendure/dashboard" since="3.4.0" />
+<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/paginated-list-data-table.tsx" sourceLine="172" packageName="@vendure/dashboard" since="3.4.0" />
 
 Props to configure the [PaginatedListDataTable](/reference/dashboard/list-views/paginated-list-data-table#paginatedlistdatatable) component.
 

package/docs/reference/graphql-api/admin/input-types.mdx

@@ -648,6 +648,7 @@ input BooleanOperators {
   position: NumberOperators
   description: StringOperators
   parentId: IDOperators
+  productVariantCount: NumberOperators
   _and: [CollectionFilterParameter!]
   _or: [CollectionFilterParameter!]
 }`}
@@ -703,6 +704,7 @@ input BooleanOperators {
   position: SortOrder
   description: SortOrder
   parentId: SortOrder
+  productVariantCount: SortOrder
 }`}
 </GraphQLDoc>
 

package/docs/reference/graphql-api/admin/object-types.mdx

@@ -601,6 +601,7 @@ type ChannelDefaultLanguageError {
   filters: [ConfigurableOperation!]!
   translations: [CollectionTranslation!]!
   productVariants(options: ProductVariantListOptions): ProductVariantList!
+  productVariantCount: Int!
   customFields: JSON
 }`}
 </GraphQLDoc>

package/docs/reference/graphql-api/shop/input-types.mdx

@@ -99,6 +99,7 @@ input BooleanOperators {
   position: NumberOperators
   description: StringOperators
   parentId: IDOperators
+  productVariantCount: NumberOperators
   _and: [CollectionFilterParameter!]
   _or: [CollectionFilterParameter!]
 }`}
@@ -154,6 +155,7 @@ input BooleanOperators {
   position: SortOrder
   description: SortOrder
   parentId: SortOrder
+  productVariantCount: SortOrder
 }`}
 </GraphQLDoc>
 

package/docs/reference/graphql-api/shop/object-types.mdx

@@ -377,6 +377,7 @@ scalar Boolean`}
   filters: [ConfigurableOperation!]!
   translations: [CollectionTranslation!]!
   productVariants(options: ProductVariantListOptions): ProductVariantList!
+  productVariantCount: Int!
   customFields: JSON
 }`}
 </GraphQLDoc>

package/docs/reference/typescript-api/common/currency-code.mdx

@@ -2,7 +2,7 @@
 title: "CurrencyCode"
 generated: true
 ---
-<GenerationInfo sourceFile="packages/common/src/generated-types.ts" sourceLine="1004" packageName="@vendure/common" />
+<GenerationInfo sourceFile="packages/common/src/generated-types.ts" sourceLine="1007" packageName="@vendure/common" />
 
 ISO 4217 currency code
 

package/docs/reference/typescript-api/common/job-state.mdx

@@ -2,7 +2,7 @@
 title: "JobState"
 generated: true
 ---
-<GenerationInfo sourceFile="packages/common/src/generated-types.ts" sourceLine="2256" packageName="@vendure/common" />
+<GenerationInfo sourceFile="packages/common/src/generated-types.ts" sourceLine="2259" packageName="@vendure/common" />
 
 The state of a Job in the JobQueue
 

package/docs/reference/typescript-api/common/language-code.mdx

@@ -2,7 +2,7 @@
 title: "LanguageCode"
 generated: true
 ---
-<GenerationInfo sourceFile="packages/common/src/generated-types.ts" sourceLine="2274" packageName="@vendure/common" />
+<GenerationInfo sourceFile="packages/common/src/generated-types.ts" sourceLine="2277" packageName="@vendure/common" />
 
 Languages in the form of a ISO 639-1 language code with optional
 region or script modifier (e.g. de_AT). The selection available is based

package/docs/reference/typescript-api/common/permission.mdx

@@ -2,7 +2,7 @@
 title: "Permission"
 generated: true
 ---
-<GenerationInfo sourceFile="packages/common/src/generated-types.ts" sourceLine="4491" packageName="@vendure/common" />
+<GenerationInfo sourceFile="packages/common/src/generated-types.ts" sourceLine="4494" packageName="@vendure/common" />
 
 Permissions for administrators and customers. Used to control access to
 GraphQL resolvers via the [Allow](/reference/typescript-api/request/allow-decorator#allow) decorator.

package/docs/reference/typescript-api/services/collection-service.mdx

@@ -16,6 +16,7 @@ class CollectionService implements OnModuleInit {
     getAvailableFilters(ctx: RequestContext) => ConfigurableOperationDefinition[];
     getParent(ctx: RequestContext, collectionId: ID) => Promise<Collection | undefined>;
     getChildren(ctx: RequestContext, collectionId: ID) => Promise<Collection[]>;
+    getProductVariantCounts(ctx: RequestContext, collectionIds: ID[]) => Promise<Map<ID, number>>;
     getBreadcrumbs(ctx: RequestContext, collection: Collection) => Promise<Array<{ name: string; id: ID; slug: string }>>;
     getCollectionsByProductId(ctx: RequestContext, productId: ID, publicOnly: boolean) => Promise<Array<Translated<Collection>>>;
     getDescendants(ctx: RequestContext, rootId: ID, maxDepth: number = Number.MAX_SAFE_INTEGER) => Promise<Array<Translated<Collection>>>;
@@ -80,6 +81,13 @@ Returns all configured CollectionFilters, as specified by the [CatalogOptions](/
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, collectionId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>[]>`}   />
 
 Returns all child Collections of the Collection with the given id.
+### getProductVariantCounts
+
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, collectionIds: <a href='/reference/typescript-api/common/id#id'>ID</a>[]) => Promise<Map<<a href='/reference/typescript-api/common/id#id'>ID</a>, number>>`}   />
+
+Returns a Map of collection IDs to their product variant counts.
+This performs a single bulk query to get counts for all provided collection IDs,
+avoiding N+1 query issues when resolving productVariantCount on multiple collections.
 ### getBreadcrumbs
 
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, collection: <a href='/reference/typescript-api/entities/collection#collection'>Collection</a>) => Promise<Array<{ name: string; id: <a href='/reference/typescript-api/common/id#id'>ID</a>; slug: string }>>`}   />

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vendure/docs",
-    "version": "0.0.0-202601281114",
+    "version": "0.0.0-202601291452",
     "type": "module",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -11,6 +11,10 @@
     "publishConfig": {
         "access": "public"
     },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/vendurehq/vendure"
+    },
     "files": [
         "dist",
         "docs",
@@ -22,8 +26,9 @@
         "prebuild": "npm run generate-dates",
         "build": "rimraf dist && tsc -p ./tsconfig.build.json",
         "prepublishOnly": "npm run test:mdx && npm run build",
-        "publish:local": "npm version 0.0.0-$(date +%Y%m%d%H%M) --no-git-tag-version && npm publish",
+        "publish:local": "npm version 0.0.0-$(date +%Y%m%d%H%M) --no-git-tag-version && npm publish --tag latest",
         "publish:local:next": "npm version 0.0.0-$(date +%Y%m%d%H%M) --no-git-tag-version && npm publish --tag next",
+        "pretest:mdx": "npm run generate-dates",
         "test:mdx": "tsx scripts/test-mdx.ts",
         "test:mdx:verbose": "tsx scripts/test-mdx.ts --verbose",
         "typecheck": "tsc --noEmit"
@@ -32,6 +37,7 @@
         "@vendure-io/docs-provider": "^0.9.0"
     },
     "devDependencies": {
+        "@types/node": "^22.10.10",
         "rimraf": "^5.0.5",
         "tsx": "^4.7.0",
         "typescript": "5.8.2"