Skip to content

Commit abb49bb

Browse files
committed
Merge remote-tracking branch 'refs/remotes/origin/fix/oss-19-elasticsearch-product-in-stock-channel-cache' into fix/oss-19-elasticsearch-product-in-stock-channel-cache
2 parents 46b2bf9 + 9e5ac0a commit abb49bb

21 files changed

Lines changed: 116 additions & 54 deletions

File tree

docs/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,15 @@ addActionBarDropdownMenuItem({
5959
label: 'Print Invoice',
6060
icon: 'printer',
6161
buttonState: context => {
62-
return context.entity$.pipe( // [!code highlight]
63-
map((order) => { // [!code highlight]
64-
return order?.state === 'PaymentSettled' // [!code highlight]
65-
? { disabled: false, visible: true } // [!code highlight]
66-
: { disabled: true, visible: true }; // [!code highlight]
67-
}), // [!code highlight]
68-
); // [!code highlight]
62+
// highlight-start
63+
return context.entity$.pipe(
64+
map((order) => {
65+
return order?.state === 'PaymentSettled'
66+
? { disabled: false, visible: true }
67+
: { disabled: true, visible: true };
68+
}),
69+
);
70+
// highlight-end
6971
},
7072
requiresPermission: ['UpdateOrder'],
7173
}),

docs/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ a custom field.
1414
import { registerFormInputComponent } from '@vendure/admin-ui/core';
1515

1616
export default [
17-
registerFormInputComponent('my-custom-input', MyCustomFieldControl), // [!code highlight]
17+
// highlight-next-line
18+
registerFormInputComponent('my-custom-input', MyCustomFieldControl),
1819
];
1920
```
2021

@@ -32,7 +33,8 @@ const config: VendureConfig = {
3233
{
3334
name: 'rrp',
3435
type: 'int',
35-
ui: { component: 'my-custom-input' }, // [!code highlight]
36+
// highlight-next-line
37+
ui: { component: 'my-custom-input' },
3638
},
3739
]
3840
}

docs/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,8 @@ import path from 'path';
9696
import { AdminUiExtension } from '@vendure/ui-devkit/compiler';
9797
9898
export const uiExtensions: AdminUiExtension = {
99-
pathAlias: '@common-ui-module', // this is the important part // [!code highlight]
99+
// highlight-next-line
100+
pathAlias: '@common-ui-module', // this is the important part
100101
extensionPath: path.join(__dirname, 'ui'),
101102
ngModules: [
102103
{
@@ -113,7 +114,8 @@ export const uiExtensions: AdminUiExtension = {
113114
"compilerOptions": {
114115
"baseUrl": ".",
115116
"paths": {
116-
"@common-ui-module/*": ["packages/common-ui-module/src/ui/*"] // [!code highlight]
117+
// highlight-next-line
118+
"@common-ui-module/*": ["packages/common-ui-module/src/ui/*"]
117119
}
118120
}
119121
}
@@ -122,9 +124,11 @@ export const uiExtensions: AdminUiExtension = {
122124
```ts title="packages/sample-plugin/src/ui/ui-extension.module.ts"
123125
import { NgModule } from '@angular/core';
124126
import { SharedModule } from '@vendure/admin-ui/core';
125-
// the import below works both in the context of the custom Admin UI app as well as the main project // [!code highlight]
126-
// '@common-ui-module' is the value of "pathAlias" and 'ui-shared.module' is the file we want to reference inside "extensionPath" // [!code highlight]
127-
import { CommonSharedUiModule, CommonUiComponent } from '@common-ui-module/ui-shared.module'; // [!code highlight]
127+
// highlight-start
128+
// the import below works both in the context of the custom Admin UI app as well as the main project
129+
// '@common-ui-module' is the value of "pathAlias" and 'ui-shared.module' is the file we want to reference inside "extensionPath"
130+
import { CommonSharedUiModule, CommonUiComponent } from '@common-ui-module/ui-shared.module';
131+
// highlight-end
128132
129133
@NgModule({
130134
imports: [

docs/docs/reference/core-plugins/sentry-plugin/index.mdx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,12 @@ export const config: VendureConfig = {
7373
// ...
7474
plugins: [
7575
// ...
76-
SentryPlugin.init({ // [!code highlight]
77-
// Optional configuration // [!code highlight]
78-
includeErrorTestMutation: true, // [!code highlight]
79-
}), // [!code highlight]
76+
// highlight-start
77+
SentryPlugin.init({
78+
// Optional configuration
79+
includeErrorTestMutation: true,
80+
}),
81+
// highlight-end
8082
],
8183
};
8284
```

docs/docs/reference/core-plugins/stellate-plugin/index.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,9 +131,11 @@ import { graphql } from '../generated/gql';
131131
export const searchProductsDocument = graphql(`
132132
query SearchProducts($input: SearchInput!) {
133133
search(input: $input) {
134-
cacheIdentifier { # [!code highlight]
135-
collectionSlug # [!code highlight]
136-
} # [!code highlight]
134+
// highlight-start
135+
cacheIdentifier {
136+
collectionSlug
137+
}
138+
// highlight-end
137139
items {
138140
# ...
139141
}

docs/docs/reference/dashboard/detail-views/detail-page.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "DetailPage"
33
generated: true
44
---
5-
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/detail-page.tsx" sourceLine="147" packageName="@vendure/dashboard" since="3.3.0" />
5+
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/detail-page.tsx" sourceLine="134" packageName="@vendure/dashboard" since="3.3.0" />
66

77
Auto-generates a detail page with a form based on the provided query and mutation documents.
88

@@ -17,7 +17,7 @@ Parameters
1717

1818
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/detail-page#detailpageprops'>DetailPageProps</a><T, C, U>`} />
1919

20-
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/detail-page.tsx" sourceLine="43" packageName="@vendure/dashboard" since="3.3.0" />
20+
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/detail-page.tsx" sourceLine="38" packageName="@vendure/dashboard" since="3.3.0" />
2121

2222
Props to configure the [DetailPage](/reference/dashboard/detail-views/detail-page#detailpage) component.
2323

docs/docs/reference/dashboard/extensions-api/form-components.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,11 @@ export const MyCustomInput: DashboardFormComponent = props => {
105105
// implementation omitted
106106
}
107107

108-
MyCustomInput.metadata = { // [!code highlight]
109-
isListInput: true // [!code highlight]
110-
} // [!code highlight]
108+
// highlight-start
109+
MyCustomInput.metadata = {
110+
isListInput: true
111+
}
112+
// highlight-end
111113
```
112114

113115
```ts title="Signature"

docs/docs/reference/dashboard/list-views/list-page.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "ListPage"
33
generated: true
44
---
5-
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/list-page.tsx" sourceLine="475" packageName="@vendure/dashboard" since="3.3.0" />
5+
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/list-page.tsx" sourceLine="483" packageName="@vendure/dashboard" since="3.3.0" />
66

77
Auto-generates a list page with columns generated based on the provided query document fields.
88

@@ -255,6 +255,7 @@ For instance, when you want the term to filter on specific fields.
255255
};
256256
}}
257257
/>
258+
```
258259
### customizeColumns
259260

260261
<MemberInfo kind="property" type={`CustomizeColumnConfig<T>`} />
@@ -309,6 +310,13 @@ more control over how the column data is rendered.
309310
);
310311
},
311312
},
313+
// Use `meta.disabled` to completely exclude a column from the table,
314+
// including the column visibility toggle. This is useful when you need
315+
// to fetch certain fields for use in custom cell renderers, but don't
316+
// want those fields to appear as their own columns.
317+
productVariantCount: {
318+
meta: { disabled: true },
319+
},
312320
```
313321
### additionalColumns
314322

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "PaginatedListDataTable"
33
generated: true
44
---
5-
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/paginated-list-data-table.tsx" sourceLine="336" packageName="@vendure/dashboard" since="3.4.0" />
5+
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/paginated-list-data-table.tsx" sourceLine="340" packageName="@vendure/dashboard" since="3.4.0" />
66

77
A wrapper around the [DataTable](/reference/dashboard/list-views/data-table#datatable) component, which automatically configures functionality common to
88
list queries that implement the `PaginatedList` interface, which is the common way of representing lists
@@ -117,7 +117,7 @@ Parameters
117117

118118
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/list-views/paginated-list-data-table#paginatedlistdatatableprops'>PaginatedListDataTableProps</a><T, U, V, AC>>`} />
119119

120-
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/paginated-list-data-table.tsx" sourceLine="172" packageName="@vendure/dashboard" since="3.4.0" />
120+
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/paginated-list-data-table.tsx" sourceLine="176" packageName="@vendure/dashboard" since="3.4.0" />
121121

122122
Props to configure the [PaginatedListDataTable](/reference/dashboard/list-views/paginated-list-data-table#paginatedlistdatatable) component.
123123

docs/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.mdx

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -304,13 +304,37 @@ An array of locales to be used on Admin UI.
304304
</div>
305305
<GenerationInfo sourceFile="packages/dashboard/vite/vite-plugin-ui-config.ts" sourceLine="124" packageName="@vendure/dashboard" since="3.4.0" />
306306

307+
Options used by the [vendureDashboardPlugin](/reference/dashboard/vite-plugin/vendure-dashboard-plugin#venduredashboardplugin) to configure order-related
308+
Dashboard UI behaviour.
309+
310+
```ts title="Signature"
311+
interface OrdersConfig {
312+
refundReasons?: Array<{ value: string; label: string }>;
313+
}
314+
```
315+
316+
<div className="members-wrapper">
317+
318+
### refundReasons
319+
320+
<MemberInfo kind="property" type={`Array<{ value: string; label: string }>`} />
321+
322+
An array of refund reasons to display in the refund order dialog.
323+
Each reason has a `value` (used as the identifier) and a `label` (displayed to the user).
324+
If not provided, default reasons will be used.
325+
326+
327+
</div>
328+
<GenerationInfo sourceFile="packages/dashboard/vite/vite-plugin-ui-config.ts" sourceLine="143" packageName="@vendure/dashboard" since="3.4.0" />
329+
307330
Options used by the [vendureDashboardPlugin](/reference/dashboard/vite-plugin/vendure-dashboard-plugin#venduredashboardplugin) to configure aspects of the
308331
Dashboard UI behaviour.
309332

310333
```ts title="Signature"
311334
interface UiConfigPluginOptions {
312335
api?: ApiConfig;
313336
i18n?: I18nConfig;
337+
orders?: OrdersConfig;
314338
}
315339
```
316340

@@ -326,6 +350,11 @@ Configuration for API connection settings
326350
<MemberInfo kind="property" type={`<a href='/reference/dashboard/vite-plugin/vendure-dashboard-plugin#i18nconfig'>I18nConfig</a>`} />
327351

328352
Configuration for internationalization settings
353+
### orders
354+
355+
<MemberInfo kind="property" type={`<a href='/reference/dashboard/vite-plugin/vendure-dashboard-plugin#ordersconfig'>OrdersConfig</a>`} />
356+
357+
Configuration for order-related settings
329358

330359

331360
</div>

0 commit comments

Comments
 (0)