docs: Regenerate docs

Author: michaelbromley

docs/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.md

@@ -63,12 +63,9 @@ Allows the contents of the `vendure-ui-config.json` file to be set, e.g.
 for specifying the Vendure GraphQL API host, available UI languages, etc.
 ### compatibilityMode
 
-<MemberInfo kind="property" type={`boolean`} since="3.4.0" />
+<MemberInfo kind="property" type={`boolean`}  since="3.4.0"  />
+
 
-:::warning Deprecated
-This option is deprecated and no longer has any effect.
 
-Previously used when running the AdminUiPlugin at the same time as the new `DashboardPlugin` to avoid conflicts, but this is no longer necessary as the schemas use different type names.
-:::
 
 </div>

docs/docs/reference/core-plugins/admin-ui-plugin/index.md

@@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## AdminUiPlugin
 
-<GenerationInfo sourceFile="packages/admin-ui-plugin/src/plugin.ts" sourceLine="146" packageName="@vendure/admin-ui-plugin" />
+<GenerationInfo sourceFile="packages/admin-ui-plugin/src/plugin.ts" sourceLine="147" packageName="@vendure/admin-ui-plugin" />
 
 :::warning Deprecated
 From Vendure v3.5.0, the Angular-based Admin UI has been replaced by the new [React Admin Dashboard](/guides/extending-the-dashboard/getting-started/).

docs/docs/reference/dashboard/components/channel-chip.md

@@ -0,0 +1,26 @@
+---
+title: "ChannelChip"
+isDefaultIndex: false
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+import MemberInfo from '@site/src/components/MemberInfo';
+import GenerationInfo from '@site/src/components/GenerationInfo';
+import MemberDescription from '@site/src/components/MemberDescription';
+
+
+## ChannelChip
+
+<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/channel-chip.tsx" sourceLine="18" packageName="@vendure/dashboard" since="3.5.2" />
+
+A component for displaying a channel as a chip.
+
+```ts title="Signature"
+function ChannelChip(props: Readonly<ChannelChipProps>): void
+```
+Parameters
+
+### props
+
+<MemberInfo kind="parameter" type={`Readonly&#60;ChannelChipProps&#62;`} />
+

docs/docs/reference/dashboard/detail-views/use-detail-page.md

@@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## useDetailPage
 
-<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/use-detail-page.ts" sourceLine="238" packageName="@vendure/dashboard" since="3.3.0" />
+<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/use-detail-page.ts" sourceLine="240" packageName="@vendure/dashboard" since="3.3.0" />
 
 **Status: Developer Preview**
 
@@ -104,7 +104,9 @@ interface DetailPageOptions<T extends TypedDocumentNode<any, any>, C extends Typ
     entityName?: string;
     createDocument?: C;
     updateDocument?: U;
-    setValuesForUpdate: (entity: NonNullable<ResultOf<T>[EntityField]>) => VariablesOf<U>[VarNameUpdate];
+    setValuesForUpdate: (
+        entity: NonNullable<ResultOf<T>[EntityField]>,
+    ) => WithLooseCustomFields<VariablesOf<U>[VarNameUpdate]>;
     transformCreateInput?: (input: VariablesOf<C>[VarNameCreate]) => VariablesOf<C>[VarNameCreate];
     transformUpdateInput?: (input: VariablesOf<U>[VarNameUpdate]) => VariablesOf<U>[VarNameUpdate];
     onSuccess?: (entity: ResultOf<C>[keyof ResultOf<C>] | ResultOf<U>[keyof ResultOf<U>]) => void;
@@ -154,7 +156,7 @@ The document to create the entity.
 The document to update the entity.
 ### setValuesForUpdate
 
-<MemberInfo kind="property" type={`(entity: NonNullable&#60;ResultOf&#60;T&#62;[EntityField]&#62;) =&#62; VariablesOf&#60;U&#62;[VarNameUpdate]`}   />
+<MemberInfo kind="property" type={`(         entity: NonNullable&#60;ResultOf&#60;T&#62;[EntityField]&#62;,     ) =&#62; WithLooseCustomFields&#60;VariablesOf&#60;U&#62;[VarNameUpdate]&#62;`}   />
 
 The function to set the values for the update document.
 ### transformCreateInput
@@ -184,7 +186,7 @@ The function to call when the update is successful.
 
 ## UseDetailPageResult
 
-<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/use-detail-page.ts" sourceLine="156" packageName="@vendure/dashboard" since="3.3.0" />
+<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/use-detail-page.ts" sourceLine="158" packageName="@vendure/dashboard" since="3.3.0" />
 
 
 

docs/docs/reference/dashboard/detail-views/use-generated-form.md

@@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## useGeneratedForm
 
-<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/form-engine/use-generated-form.tsx" sourceLine="80" packageName="@vendure/dashboard" since="3.3.0" />
+<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/form-engine/use-generated-form.tsx" sourceLine="86" packageName="@vendure/dashboard" since="3.3.0" />
 
 This hook is used to create a form from a document and an entity.
 It will create a form with the fields defined in the document's input type.
@@ -51,7 +51,7 @@ Parameters
 
 ## GeneratedFormOptions
 
-<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/form-engine/use-generated-form.tsx" sourceLine="20" packageName="@vendure/dashboard" since="3.3.0" />
+<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/form-engine/use-generated-form.tsx" sourceLine="24" packageName="@vendure/dashboard" since="3.3.0" />
 
 Options for the useGeneratedForm hook.
 
@@ -63,7 +63,9 @@ interface GeneratedFormOptions<T extends TypedDocumentNode<any, any>, VarName ex
     customFieldConfig?: any[];
     setValues: (
         entity: NonNullable<E>,
-    ) => VarName extends keyof VariablesOf<T> ? VariablesOf<T>[VarName] : VariablesOf<T>;
+    ) => WithLooseCustomFields<
+        VarName extends keyof VariablesOf<T> ? VariablesOf<T>[VarName] : VariablesOf<T>
+    >;
     onSubmit?: (
         values: VarName extends keyof VariablesOf<T> ? VariablesOf<T>[VarName] : VariablesOf<T>,
     ) => void;
@@ -94,7 +96,7 @@ The entity to use to generate the form.
 
 ### setValues
 
-<MemberInfo kind="property" type={`(         entity: NonNullable&#60;E&#62;,     ) =&#62; VarName extends keyof VariablesOf&#60;T&#62; ? VariablesOf&#60;T&#62;[VarName] : VariablesOf&#60;T&#62;`}   />
+<MemberInfo kind="property" type={`(         entity: NonNullable&#60;E&#62;,     ) =&#62; WithLooseCustomFields&#60;         VarName extends keyof VariablesOf&#60;T&#62; ? VariablesOf&#60;T&#62;[VarName] : VariablesOf&#60;T&#62;     &#62;`}   />
 
 
 ### onSubmit

docs/docs/reference/dashboard/extensions-api/data-tables.md

@@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## DashboardDataTableExtensionDefinition
 
-<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/data-table.ts" sourceLine="129" packageName="@vendure/dashboard" since="3.4.0" />
+<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/data-table.ts" sourceLine="131" packageName="@vendure/dashboard" since="3.4.0" />
 
 This allows you to customize aspects of existing data tables in the dashboard.
 

docs/docs/reference/dashboard/extensions-api/navigation.md

@@ -24,6 +24,7 @@ interface DashboardNavSectionDefinition {
     title: string;
     icon?: LucideIcon;
     order?: number;
+    placement?: 'top' | 'bottom';
 }
 ```
 
@@ -56,6 +57,11 @@ import { PlusIcon } from 'lucide-react';
 <MemberInfo kind="property" type={`number`}   />
 
 Optional order number to control the position of this section in the sidebar.
+### placement
+
+<MemberInfo kind="property" type={`'top' | 'bottom'`}   />
+
+Optional placement to control the position of this section in the sidebar.
 
 
 </div>

docs/docs/reference/dashboard/extensions-api/page-blocks.md

@@ -121,7 +121,7 @@ clicking the `< />` icon when hovering over a page block.
 type PageBlockLocation = {
     pageId: string;
     position: PageBlockPosition;
-    column: 'main' | 'side';
+    column: 'main' | 'side' | 'full';
 }
 ```
 
@@ -139,7 +139,7 @@ type PageBlockLocation = {
 
 ### column
 
-<MemberInfo kind="property" type={`'main' | 'side'`}   />
+<MemberInfo kind="property" type={`'main' | 'side' | 'full'`}   />
 
 
 

docs/docs/reference/dashboard/extensions-api/routes.md

@@ -20,8 +20,8 @@ interface DashboardRouteDefinition {
     component: (route: AnyRoute) => React.ReactNode;
     path: string;
     navMenuItem?: Partial<NavMenuItem> & { sectionId: string };
-    loader?: RouteOptions['loader'];
-    validateSearch?: RouteOptions['validateSearch'];
+    loader?: RouteOptions<any>['loader'];
+    validateSearch?: RouteOptions<any>['validateSearch'];
     authenticated?: boolean;
 }
 ```
@@ -50,14 +50,14 @@ this item should appear in. It can also point to custom nav menu sections that
 have been defined using the `navSections` extension property.
 ### loader
 
-<MemberInfo kind="property" type={`RouteOptions['loader']`}   />
+<MemberInfo kind="property" type={`RouteOptions&#60;any&#62;['loader']`}   />
 
 Optional loader function to fetch data before the route renders.
 The value is a Tanstack Router
 [loader function](https://tanstack.com/router/latest/docs/framework/react/guide/data-loading#route-loaders)
 ### validateSearch
 
-<MemberInfo kind="property" type={`RouteOptions['validateSearch']`}   />
+<MemberInfo kind="property" type={`RouteOptions&#60;any&#62;['validateSearch']`}   />
 
 Optional search parameter validation function.
 The value is a Tanstack Router

docs/docs/reference/dashboard/form-components/number-input.md

@@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## NumberInput
 
-<GenerationInfo sourceFile="packages/dashboard/src/lib/components/data-input/number-input.tsx" sourceLine="20" packageName="@vendure/dashboard" />
+<GenerationInfo sourceFile="packages/dashboard/src/lib/components/data-input/number-input.tsx" sourceLine="23" packageName="@vendure/dashboard" />
 
 A component for displaying a numeric value.