npm - @vendure/docs - Versions diffs - 0.0.0-202601211551 → 0.0.0-202601211609 - Mend

@vendure/docs 0.0.0-202601211551 → 0.0.0-202601211609

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

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

@@ -29,21 +29,21 @@ creating a new Queue, Worker and Scheduler instance.
 If omitted, it will attempt to connect to Redis at `127.0.0.1:6379`.
 ### queueOptions
-<MemberInfo kind="property" type={`Omit<QueueOptions, 'connection'>`}   />
+<MemberInfo kind="property" type={``Omit<QueueOptions, 'connection'>``}   />
 Additional options used when instantiating the BullMQ
 Queue instance.
 See the [BullMQ QueueOptions docs](https://github.com/taskforcesh/bullmq/blob/master/docs/gitbook/api/bullmq.queueoptions.md)
 ### workerOptions
-<MemberInfo kind="property" type={`Omit<WorkerOptions, 'connection'>`}   />
+<MemberInfo kind="property" type={``Omit<WorkerOptions, 'connection'>``}   />
 Additional options used when instantiating the BullMQ
 Worker instance.
 See the [BullMQ WorkerOptions docs](https://github.com/taskforcesh/bullmq/blob/master/docs/gitbook/api/bullmq.workeroptions.md)
 ### setRetries
-<MemberInfo kind="property" type={`(queueName: string, job: Job) => number`}  since="1.3.0"  />
+<MemberInfo kind="property" type={``(queueName: string, job: Job) => number``}  since="1.3.0"  />
 When a job is added to the JobQueue using `JobQueue.add()`, the calling
 code may specify the number of retries in case of failure. This option allows
@@ -65,7 +65,7 @@ setRetries: (queueName, job) => {
  ```
 ### setBackoff
-<MemberInfo kind="property" type={`(queueName: string, job: Job) => <a href='/reference/core-plugins/job-queue-plugin/bull-mqplugin-options#backoffoptions'>BackoffOptions</a> | undefined`} default={`'exponential', 1000`}  since="1.3.0"  />
+<MemberInfo kind="property" type={``(queueName: string, job: Job) => `<a href='/reference/core-plugins/job-queue-plugin/bull-mqplugin-options#backoffoptions'>BackoffOptions</a> | undefined`} default={`'exponential', 1000`}  since="1.3.0"  />
 This allows you to specify the backoff settings when a failed job gets retried.
 In other words, this determines how much time should pass before attempting to
@@ -84,7 +84,7 @@ setBackoff: (queueName, job) => {
 ```
 ### setJobOptions
-<MemberInfo kind="property" type={`(queueName: string, job: Job) => BullJobsOptions`}  since="3.2.0"  />
+<MemberInfo kind="property" type={``(queueName: string, job: Job) => BullJobsOptions``}  since="3.2.0"  />
 This allows you to specify additional options for a job when it is added to the queue.
 The object returned is the BullMQ [JobsOptions](https://api.docs.bullmq.io/types/v5.JobsOptions.html)

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

@@ -42,17 +42,17 @@ class PubSubJobQueueStrategy extends InjectableJobQueueStrategy implements JobQu
 ### add
-<MemberInfo kind="method" type={`(job: Job<Data>) => Promise<Job<Data>>`}   />
+<MemberInfo kind="method" type={`(job: `Job<Data>`) => `Promise<Job<Data>>``}   />
 ### start
-<MemberInfo kind="method" type={`(queueName: string, process: (job: Job<Data>) => Promise<any>) => `}   />
+<MemberInfo kind="method" type={`(queueName: string, process: `(job: Job<Data>) => Promise<any>`) => `}   />
 ### stop
-<MemberInfo kind="method" type={`(queueName: string, process: (job: Job<Data>) => Promise<any>) => `}   />
+<MemberInfo kind="method" type={`(queueName: string, process: `(job: Job<Data>) => Promise<any>`) => `}   />

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

@@ -23,7 +23,7 @@ class PubSubPlugin {
 ### init
-<MemberInfo kind="method" type={`(options: PubSubOptions) => Type<<a href='/reference/core-plugins/job-queue-plugin/pub-sub-plugin#pubsubplugin'>PubSubPlugin</a>>`}   />
+<MemberInfo kind="method" type={`(options: PubSubOptions) => `Type<`<a href='/reference/core-plugins/job-queue-plugin/pub-sub-plugin#pubsubplugin'>PubSubPlugin</a>`>``}   />

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

@@ -247,7 +247,7 @@ class BraintreePlugin {
 ### init
-<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/payments-plugin/braintree-plugin#braintreepluginoptions'>BraintreePluginOptions</a>) => Type<<a href='/reference/core-plugins/payments-plugin/braintree-plugin#braintreeplugin'>BraintreePlugin</a>>`}   />
+<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/payments-plugin/braintree-plugin#braintreepluginoptions'>BraintreePluginOptions</a>) => `Type<`<a href='/reference/core-plugins/payments-plugin/braintree-plugin#braintreeplugin'>BraintreePlugin</a>`>``}   />
@@ -285,7 +285,7 @@ Since v1.8, it is possible to override vaulting on a per-payment basis by passin
 `generateBraintreeClientToken` mutation.
 ### extractMetadata
-<MemberInfo kind="property" type={`(transaction: <a href='/reference/typescript-api/request/transaction-decorator#transaction'>Transaction</a>) => PaymentMetadata`}  since="1.7.0"  />
+<MemberInfo kind="property" type={`(transaction: <a href='/reference/typescript-api/request/transaction-decorator#transaction'>Transaction</a>`) => PaymentMetadata``}  since="1.7.0"  />
 Allows you to configure exactly what information from the Braintree
 [Transaction object](https://developer.paypal.com/braintree/docs/reference/response/transaction#result-object) (which is returned by the

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

@@ -161,7 +161,7 @@ The host of your Vendure server, e.g. `'https://my-vendure.io'`.
 This is used by Mollie to send webhook events to the Vendure server
 ### enabledPaymentMethodsParams
-<MemberInfo kind="property" type={`(         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,         order: <a href='/reference/typescript-api/entities/order#order'>Order</a> | null,     ) => AdditionalEnabledPaymentMethodsParams | Promise<AdditionalEnabledPaymentMethodsParams>`}  since="2.2.0"  />
+<MemberInfo kind="property" type={`(         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,         order: <a href='/reference/typescript-api/entities/order#order'>Order</a>` | null,     ) => AdditionalEnabledPaymentMethodsParams | Promise<AdditionalEnabledPaymentMethodsParams>``}  since="2.2.0"  />
 Provide additional parameters to the Mollie enabled payment methods API call. By default,
 the plugin will already pass the `resource` parameter.

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

@@ -163,7 +163,7 @@ class StripePlugin {
 ### init
-<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/payments-plugin/stripe-plugin#stripepluginoptions'>StripePluginOptions</a>) => Type<<a href='/reference/core-plugins/payments-plugin/stripe-plugin#stripeplugin'>StripePlugin</a>>`}   />
+<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/payments-plugin/stripe-plugin#stripepluginoptions'>StripePluginOptions</a>) => `Type<`<a href='/reference/core-plugins/payments-plugin/stripe-plugin#stripeplugin'>StripePlugin</a>`>``}   />
 Initialize the Stripe payment plugin
@@ -212,7 +212,7 @@ to be used with the same PaymentIntent. This is done by adding a custom field to
 the Stripe customer ID, so switching this on will require a database migration / synchronization.
 ### metadata
-<MemberInfo kind="property" type={`(         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,         order: <a href='/reference/typescript-api/entities/order#order'>Order</a>,     ) => Stripe.MetadataParam | Promise<Stripe.MetadataParam>`}  since="1.9.7"  />
+<MemberInfo kind="property" type={`(         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,         order: <a href='/reference/typescript-api/entities/order#order'>Order</a>`,     ) => Stripe.MetadataParam | Promise<Stripe.MetadataParam>``}  since="1.9.7"  />
 Attach extra metadata to Stripe payment intent creation call.
@@ -242,7 +242,7 @@ Note: If the `paymentIntentCreateParams` is also used and returns a `metadata` k
 returned by both functions will be merged.
 ### paymentIntentCreateParams
-<MemberInfo kind="property" type={`(         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,         order: <a href='/reference/typescript-api/entities/order#order'>Order</a>,     ) => AdditionalPaymentIntentCreateParams | Promise<AdditionalPaymentIntentCreateParams>`}  since="2.1.0"  />
+<MemberInfo kind="property" type={`(         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,         order: <a href='/reference/typescript-api/entities/order#order'>Order</a>`,     ) => AdditionalPaymentIntentCreateParams | Promise<AdditionalPaymentIntentCreateParams>``}  since="2.1.0"  />
 Provide additional parameters to the Stripe payment intent creation. By default,
 the plugin will already pass the `amount`, `currency`, `customer` and `automatic_payment_methods: { enabled: true }` parameters.
@@ -270,7 +270,7 @@ export const config: VendureConfig = {
 ```
 ### requestOptions
-<MemberInfo kind="property" type={`(         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,         order: <a href='/reference/typescript-api/entities/order#order'>Order</a>,     ) => AdditionalRequestOptions | Promise<AdditionalRequestOptions>`}  since="3.1.0"  />
+<MemberInfo kind="property" type={`(         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,         order: <a href='/reference/typescript-api/entities/order#order'>Order</a>`,     ) => AdditionalRequestOptions | Promise<AdditionalRequestOptions>``}  since="3.1.0"  />
 Provide additional options to the Stripe payment intent creation. By default,
 the plugin will already pass the `idempotencyKey` parameter.
@@ -298,7 +298,7 @@ export const config: VendureConfig = {
 ```
 ### customerCreateParams
-<MemberInfo kind="property" type={`(         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,         order: <a href='/reference/typescript-api/entities/order#order'>Order</a>,     ) => AdditionalCustomerCreateParams | Promise<AdditionalCustomerCreateParams>`}  since="2.1.0"  />
+<MemberInfo kind="property" type={`(         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,         order: <a href='/reference/typescript-api/entities/order#order'>Order</a>`,     ) => AdditionalCustomerCreateParams | Promise<AdditionalCustomerCreateParams>``}  since="2.1.0"  />
 Provide additional parameters to the Stripe customer creation. By default,
 the plugin will already pass the `email` and `name` parameters.

package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx CHANGED Viewed

@@ -21,7 +21,7 @@ class PurgeRule<Event extends VendureEvent = VendureEvent> {
 ### eventType
-<MemberInfo kind="property" type={`Type<Event>`}   />
+<MemberInfo kind="property" type={``Type<Event>``}   />
 ### bufferTimeMs
@@ -62,7 +62,7 @@ interface PurgeRuleConfig<Event extends VendureEvent> {
 ### eventType
-<MemberInfo kind="property" type={`Type<Event>`}   />
+<MemberInfo kind="property" type={``Type<Event>``}   />
 Specifies which VendureEvent will trigger this purge rule.
 ### bufferTime
@@ -73,7 +73,7 @@ How long to buffer events for in milliseconds before executing the handler. This
 us to efficiently batch calls to the Stellate Purge API.
 ### handler
-<MemberInfo kind="property" type={`(handlerArgs: {         events: Event[];         stellateService: <a href='/reference/core-plugins/stellate-plugin/stellate-service#stellateservice'>StellateService</a>;         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>;     }) => void | Promise<void>`}   />
+<MemberInfo kind="property" type={`(handlerArgs: {         events: Event[];         stellateService: <a href='/reference/core-plugins/stellate-plugin/stellate-service#stellateservice'>StellateService</a>;         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>`;     }) => void | Promise<void>``}   />
 The function to invoke when the specified event is published. This function should use the
 <DocsLink href="/reference/core-plugins/stellate-plugin/stellate-service#stellateservice">StellateService</DocsLink> instance to call the Stellate Purge API.

package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx CHANGED Viewed

@@ -38,7 +38,7 @@ Purges the cache for the given Products.
 Purges the cache for the given ProductVariants.
 ### purgeSearchResults
-<MemberInfo kind="method" type={`(items: Array<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a> | <a href='/reference/typescript-api/entities/product#product'>Product</a>>) => `}   />
+<MemberInfo kind="method" type={`(items: `Array<`<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a> | <a href='/reference/typescript-api/entities/product#product'>Product</a>`>`) => `}   />
 Purges the cache for SearchResults which contain the given Products or ProductVariants.
 ### purgeAllOfType

package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx CHANGED Viewed

@@ -75,7 +75,7 @@ When set to `true`, the SDK will log spans to the console instead of sending the
 exporter. This should just be used for debugging purposes.
 ### config
-<MemberInfo kind="property" type={`Partial<NodeSDKConfiguration>`}   />
+<MemberInfo kind="property" type={``Partial<NodeSDKConfiguration>``}   />
 The configuration object for the OpenTelemetry Node SDK.

package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx CHANGED Viewed

@@ -33,9 +33,9 @@ Parameters
 ### target
-<MemberInfo kind="parameter" type={`Type<T>`} />
+<MemberInfo kind="parameter" type={``Type<T>``} />
 ### hooks
-<MemberInfo kind="parameter" type={`MethodHooksForType<T>`} />
+<MemberInfo kind="parameter" type={``MethodHooksForType<T>``} />

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

@@ -34,7 +34,7 @@ TelemetryPlugin.init({
 ```
 ### methodHooks
-<MemberInfo kind="property" type={`Array<MethodHookConfig<any>>`}  experimental="true" />
+<MemberInfo kind="property" type={``Array<MethodHookConfig<any>>``}  experimental="true" />
 **Status: Developer Preview**

package/docs/reference/dashboard/components/asset-gallery.mdx CHANGED Viewed

@@ -52,7 +52,7 @@ interface AssetGalleryProps {
 ### onSelect
-<MemberInfo kind="property" type={`(assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]) => void`}   />
+<MemberInfo kind="property" type={`(assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>`[]) => void``}   />
 ### selectable
@@ -95,7 +95,7 @@ Whether the gallery should show a header.
 The class name to apply to the gallery.
 ### onFilesDropped
-<MemberInfo kind="property" type={`(files: File[]) => void`}   />
+<MemberInfo kind="property" type={``(files: File[]) => void``}   />
 The function to call when files are dropped.
 ### bulkActions
@@ -110,7 +110,7 @@ The bulk actions to display in the gallery.
 Whether the gallery should display bulk actions.
 ### onPageSizeChange
-<MemberInfo kind="property" type={`(pageSize: number) => void`}   />
+<MemberInfo kind="property" type={``(pageSize: number) => void``}   />
 The function to call when the page size changes.

package/docs/reference/dashboard/components/asset-picker-dialog.mdx CHANGED Viewed

@@ -39,12 +39,12 @@ interface AssetPickerDialogProps {
 Whether the dialog is open.
 ### onClose
-<MemberInfo kind="property" type={`() => void`}   />
+<MemberInfo kind="property" type={``() => void``}   />
 The function to call when the dialog is closed.
 ### onSelect
-<MemberInfo kind="property" type={`(assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]) => void`}   />
+<MemberInfo kind="property" type={`(assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>`[]) => void``}   />
 The function to call when assets are selected.
 ### multiSelect

package/docs/reference/dashboard/components/channel-chip.mdx CHANGED Viewed

@@ -13,5 +13,5 @@ Parameters
 ### props
-<MemberInfo kind="parameter" type={`Readonly<ChannelChipProps>`} />
+<MemberInfo kind="parameter" type={``Readonly<ChannelChipProps>``} />

package/docs/reference/dashboard/components/detail-page-button.mdx CHANGED Viewed

@@ -40,5 +40,5 @@ Parameters
 ### props
-<MemberInfo kind="parameter" type={`Readonly<{     label: string | React.ReactNode;     id?: string;     href?: string;     disabled?: boolean;     search?: Record<string, string>;     className?: string; }>`} />
+<MemberInfo kind="parameter" type={``Readonly<{     label: string | React.ReactNode;     id?: string;     href?: string;     disabled?: boolean;     search?: Record<string, string>;     className?: string; }>``} />

package/docs/reference/dashboard/components/facet-value-selector.mdx CHANGED Viewed

@@ -38,7 +38,7 @@ interface FacetValueSelectorProps {
 ### onValueSelect
-<MemberInfo kind="property" type={`(value: <a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>) => void`}   />
+<MemberInfo kind="property" type={`(value: <a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>`) => void``}   />
 The function to call when a facet value is selected.

package/docs/reference/dashboard/components/permission-guard.mdx CHANGED Viewed

@@ -24,7 +24,7 @@ Parameters
 ### props
-<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/components/permission-guard#permissionguardprops'>PermissionGuardProps</a>>`} />
+<MemberInfo kind="parameter" type={``Readonly<`<a href='/reference/dashboard/components/permission-guard#permissionguardprops'>PermissionGuardProps</a>`>``} />
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/permission-guard.tsx" sourceLine="12" packageName="@vendure/dashboard" since="3.4.0" />

package/docs/reference/dashboard/components/vendure-image.mdx CHANGED Viewed

@@ -107,7 +107,7 @@ The fallback to show if no asset is provided. If no fallback is provided,
 a default placeholder will be shown.
 ### ref
-<MemberInfo kind="property" type={`React.Ref<HTMLImageElement>`}   />
+<MemberInfo kind="property" type={``React.Ref<HTMLImageElement>``}   />
 The ref to the image element.

package/docs/reference/dashboard/detail-views/detail-page.mdx CHANGED Viewed

@@ -54,7 +54,7 @@ A unique identifier for the page.
 The Tanstack Router route used to navigate to this page.
 ### title
-<MemberInfo kind="property" type={`(entity: ResultOf<T>[EntityField]) => string`}   />
+<MemberInfo kind="property" type={``(entity: ResultOf<T>[EntityField]) => string``}   />
 The title of the page.
 ### queryDocument
@@ -74,7 +74,7 @@ The mutation document used to create the entity.
 The mutation document used to update the entity.
 ### setValuesForUpdate
-<MemberInfo kind="property" type={`(entity: ResultOf<T>[EntityField]) => VariablesOf<U>['input']`}   />
+<MemberInfo kind="property" type={``(entity: ResultOf<T>[EntityField]) => VariablesOf<U>['input']``}   />
 A function that sets the values for the update input type based on the entity.

package/docs/reference/dashboard/detail-views/use-detail-page.mdx CHANGED Viewed

@@ -143,27 +143,27 @@ The document to create the entity.
 The document to update the entity.
 ### setValuesForUpdate
-<MemberInfo kind="property" type={`(         entity: NonNullable<ResultOf<T>[EntityField]>,     ) => WithLooseCustomFields<VariablesOf<U>[VarNameUpdate]>`}   />
+<MemberInfo kind="property" type={``(         entity: NonNullable<ResultOf<T>[EntityField]>,     ) => WithLooseCustomFields<VariablesOf<U>[VarNameUpdate]>``}   />
 The function to set the values for the update document.
 ### transformCreateInput
-<MemberInfo kind="property" type={`(input: VariablesOf<C>[VarNameCreate]) => VariablesOf<C>[VarNameCreate]`}   />
+<MemberInfo kind="property" type={``(input: VariablesOf<C>[VarNameCreate]) => VariablesOf<C>[VarNameCreate]``}   />
 ### transformUpdateInput
-<MemberInfo kind="property" type={`(input: VariablesOf<U>[VarNameUpdate]) => VariablesOf<U>[VarNameUpdate]`}   />
+<MemberInfo kind="property" type={``(input: VariablesOf<U>[VarNameUpdate]) => VariablesOf<U>[VarNameUpdate]``}   />
 ### onSuccess
-<MemberInfo kind="property" type={`(entity: ResultOf<C>[keyof ResultOf<C>] | ResultOf<U>[keyof ResultOf<U>]) => void`}   />
+<MemberInfo kind="property" type={``(entity: ResultOf<C>[keyof ResultOf<C>] | ResultOf<U>[keyof ResultOf<U>]) => void``}   />
 The function to call when the update is successful.
 ### onError
-<MemberInfo kind="property" type={`(error: unknown) => void`}   />
+<MemberInfo kind="property" type={``(error: unknown) => void``}   />
 The function to call when the update is successful.
@@ -188,17 +188,17 @@ interface UseDetailPageResult<T extends TypedDocumentNode<any, any>, U extends T
 ### form
-<MemberInfo kind="property" type={`UseFormReturn<RemoveNullFields<VariablesOf<U>['input']>>`}   />
+<MemberInfo kind="property" type={``UseFormReturn<RemoveNullFields<VariablesOf<U>['input']>>``}   />
 ### submitHandler
-<MemberInfo kind="property" type={`(event: FormEvent<HTMLFormElement>) => void`}   />
+<MemberInfo kind="property" type={``(event: FormEvent<HTMLFormElement>) => void``}   />
 ### entity
-<MemberInfo kind="property" type={`DetailPageEntity<T, EntityField>`}   />
+<MemberInfo kind="property" type={``DetailPageEntity<T, EntityField>``}   />
 ### isPending
@@ -208,12 +208,12 @@ interface UseDetailPageResult<T extends TypedDocumentNode<any, any>, U extends T
 ### refreshEntity
-<MemberInfo kind="property" type={`() => void`}   />
+<MemberInfo kind="property" type={``() => void``}   />
 ### resetForm
-<MemberInfo kind="property" type={`() => void`}   />
+<MemberInfo kind="property" type={``() => void``}   />

package/docs/reference/dashboard/detail-views/use-generated-form.mdx CHANGED Viewed

@@ -83,12 +83,12 @@ The entity to use to generate the form.
 ### setValues
-<MemberInfo kind="property" type={`(         entity: NonNullable<E>,     ) => WithLooseCustomFields<         VarName extends keyof VariablesOf<T> ? VariablesOf<T>[VarName] : VariablesOf<T>     >`}   />
+<MemberInfo kind="property" type={``(         entity: NonNullable<E>,     ) => WithLooseCustomFields<         VarName extends keyof VariablesOf<T> ? VariablesOf<T>[VarName] : VariablesOf<T>     >``}   />
 ### onSubmit
-<MemberInfo kind="property" type={`(         values: VarName extends keyof VariablesOf<T> ? VariablesOf<T>[VarName] : VariablesOf<T>,     ) => void`}   />
+<MemberInfo kind="property" type={``(         values: VarName extends keyof VariablesOf<T> ? VariablesOf<T>[VarName] : VariablesOf<T>,     ) => void``}   />

package/docs/reference/dashboard/extensions-api/action-bar.mdx CHANGED Viewed

@@ -28,7 +28,7 @@ interface DashboardActionBarItem {
 The ID of the page where the action bar item should be displayed.
 ### component
-<MemberInfo kind="property" type={`React.FunctionComponent<{ context: PageContextValue }>`}   />
+<MemberInfo kind="property" type={``React.FunctionComponent<{ context: PageContextValue }>``}   />
 A React component that will be rendered in the action bar. Typically, you would use
 the default Shadcn `<Button>` component.

package/docs/reference/dashboard/extensions-api/alerts.mdx CHANGED Viewed

@@ -31,27 +31,27 @@ interface DashboardAlertDefinition<TResponse = any> {
 A unique identifier for the alert.
 ### title
-<MemberInfo kind="property" type={`string | ((data: TResponse) => string)`}   />
+<MemberInfo kind="property" type={``string | ((data: TResponse) => string)``}   />
 The title of the alert. Can be a string or a function that returns a string based on the response data.
 ### description
-<MemberInfo kind="property" type={`string | ((data: TResponse) => string)`}   />
+<MemberInfo kind="property" type={``string | ((data: TResponse) => string)``}   />
 The description of the alert. Can be a string or a function that returns a string based on the response data.
 ### severity
-<MemberInfo kind="property" type={`AlertSeverity | ((data: TResponse) => AlertSeverity)`}   />
+<MemberInfo kind="property" type={``AlertSeverity | ((data: TResponse) => AlertSeverity)``}   />
 The severity level of the alert.
 ### check
-<MemberInfo kind="property" type={`() => Promise<TResponse> | TResponse`}   />
+<MemberInfo kind="property" type={``() => Promise<TResponse> | TResponse``}   />
 A function that checks the condition and returns the response data.
 ### shouldShow
-<MemberInfo kind="property" type={`(data: TResponse) => boolean`}   />
+<MemberInfo kind="property" type={``(data: TResponse) => boolean``}   />
 A function that determines whether the alert should be rendered based on the response data.
 ### recheckInterval
@@ -61,7 +61,7 @@ A function that determines whether the alert should be rendered based on the res
 The interval in milliseconds to recheck the condition.
 ### actions
-<MemberInfo kind="property" type={`Array<{         label: string;         onClick: (args: { data: TResponse; dismiss: () => void }) => void | Promise<any>;     }>`}   />
+<MemberInfo kind="property" type={``Array<{         label: string;         onClick: (args: { data: TResponse; dismiss: () => void }) => void | Promise<any>;     }>``}   />
 Optional actions that can be performed when the alert is shown.

package/docs/reference/dashboard/extensions-api/data-tables.mdx CHANGED Viewed

@@ -37,7 +37,7 @@ such as `'product-variants-table'` on the `'product-detail'` page.
 An array of additional bulk actions that will be available on the data table.
 ### extendListDocument
-<MemberInfo kind="property" type={`string | DocumentNode | (() => DocumentNode | string)`}   />
+<MemberInfo kind="property" type={``string | DocumentNode | (() => DocumentNode | string)``}   />
 Allows you to extend the list document for the data table.
 ### displayComponents

package/docs/reference/dashboard/extensions-api/detail-forms.mdx CHANGED Viewed

@@ -58,7 +58,7 @@ interface DashboardDetailFormExtensionDefinition {
 The ID of the page where the detail form is located, e.g. `'product-detail'`, `'order-detail'`.
 ### extendDetailDocument
-<MemberInfo kind="property" type={`string | DocumentNode | (() => DocumentNode | string)`}   />
+<MemberInfo kind="property" type={``string | DocumentNode | (() => DocumentNode | string)``}   />
 Extends the GraphQL query used to fetch data for the detail page, allowing you to add additional
 fields that can be used by custom input or display components.

package/docs/reference/dashboard/extensions-api/history-entries.mdx CHANGED Viewed

@@ -58,7 +58,7 @@ The `type` should correspond to a valid `HistoryEntryType`, such as
   how to define custom history entry types.
 ### component
-<MemberInfo kind="property" type={`React.ComponentType<{         entry: <a href='/reference/dashboard/extensions-api/history-entries#historyentryitem'>HistoryEntryItem</a>;         entity: OrderHistoryOrderDetail | CustomerHistoryCustomerDetail;     }>`}   />
+<MemberInfo kind="property" type={``React.ComponentType<{         entry: `<a href='/reference/dashboard/extensions-api/history-entries#historyentryitem'>HistoryEntryItem</a>`;         entity: OrderHistoryOrderDetail | CustomerHistoryCustomerDetail;     }>``}   />
 The component which is used to render the timeline entry. It should use the
 <DocsLink href="/reference/dashboard/extensions-api/history-entries#historyentry">HistoryEntry</DocsLink> component and pass the appropriate props to configure
@@ -225,5 +225,5 @@ Parameters
 ### props
-<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/history-entries#historyentryprops'>HistoryEntryProps</a>>`} />
+<MemberInfo kind="parameter" type={``Readonly<`<a href='/reference/dashboard/extensions-api/history-entries#historyentryprops'>HistoryEntryProps</a>`>``} />

package/docs/reference/dashboard/extensions-api/page-blocks.mdx CHANGED Viewed

@@ -39,12 +39,12 @@ The location of the page block. It specifies the pageId, and then the
 relative location compared to another existing block.
 ### component
-<MemberInfo kind="property" type={`React.FunctionComponent<{ context: PageContextValue }>`}   />
+<MemberInfo kind="property" type={``React.FunctionComponent<{ context: PageContextValue }>``}   />
 The component to be rendered inside the page block.
 ### shouldRender
-<MemberInfo kind="property" type={`(context: PageContextValue) => boolean`}  since="3.5.0"  />
+<MemberInfo kind="property" type={``(context: PageContextValue) => boolean``}  since="3.5.0"  />
 Control whether to render the page block depending on your custom
 logic.

package/docs/reference/dashboard/extensions-api/routes.mdx CHANGED Viewed

@@ -21,7 +21,7 @@ interface DashboardRouteDefinition {
 ### component
-<MemberInfo kind="property" type={`(route: AnyRoute) => React.ReactNode`}   />
+<MemberInfo kind="property" type={``(route: AnyRoute) => React.ReactNode``}   />
 The React component that will be rendered for this route.
 ### path
@@ -31,7 +31,7 @@ The React component that will be rendered for this route.
 The URL path for this route, e.g. '/my-custom-page'.
 ### navMenuItem
-<MemberInfo kind="property" type={`Partial<<a href='/reference/dashboard/extensions-api/navigation#navmenuitem'>NavMenuItem</a>> &#38; { sectionId: string }`}   />
+<MemberInfo kind="property" type={``Partial<`<a href='/reference/dashboard/extensions-api/navigation#navmenuitem'>NavMenuItem</a>`> &#38; { sectionId: string }``}   />
 Optional navigation menu item configuration to add this route to the nav menu
 on the left side of the dashboard.
@@ -41,14 +41,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<any>['loader']`}   />
+<MemberInfo kind="property" type={``RouteOptions<any>['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<any>['validateSearch']`}   />
+<MemberInfo kind="property" type={``RouteOptions<any>['validateSearch']``}   />
 Optional search parameter validation function.
 The value is a Tanstack Router

package/docs/reference/dashboard/extensions-api/widgets.mdx CHANGED Viewed

@@ -33,7 +33,7 @@ A unique identifier for the widget.
 The display name of the widget.
 ### component
-<MemberInfo kind="property" type={`React.ComponentType<<a href='/reference/dashboard/extensions-api/widgets#dashboardbasewidgetprops'>DashboardBaseWidgetProps</a>>`}   />
+<MemberInfo kind="property" type={``React.ComponentType<`<a href='/reference/dashboard/extensions-api/widgets#dashboardbasewidgetprops'>DashboardBaseWidgetProps</a>`>``}   />
 The React component that renders the widget.
 ### defaultSize

package/docs/reference/dashboard/form-components/affixed-input.mdx CHANGED Viewed

@@ -25,5 +25,5 @@ Parameters
 ### props
-<MemberInfo kind="parameter" type={`Readonly<AffixedInputProps>`} />
+<MemberInfo kind="parameter" type={``Readonly<AffixedInputProps>``} />

package/docs/reference/dashboard/form-components/boolean-input.mdx CHANGED Viewed

@@ -13,5 +13,5 @@ Parameters
 ### props
-<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
+<MemberInfo kind="parameter" type={``Readonly<`<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>`>``} />

package/docs/reference/dashboard/form-components/checkbox-input.mdx CHANGED Viewed

@@ -13,5 +13,5 @@ Parameters
 ### props
-<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
+<MemberInfo kind="parameter" type={``Readonly<`<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>`>``} />

package/docs/reference/dashboard/form-components/date-time-input.mdx CHANGED Viewed

@@ -13,5 +13,5 @@ Parameters
 ### props
-<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
+<MemberInfo kind="parameter" type={``Readonly<`<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>`>``} />