@mercurjs/dashboard-sdk 2.0.0 → 2.0.1
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.
- package/dist/index.d.cts +29 -0
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1,19 +1,48 @@
|
|
|
1
1
|
import * as Vite from 'vite';
|
|
2
2
|
import { ComponentType } from 'react';
|
|
3
3
|
|
|
4
|
+
/**
|
|
5
|
+
* Configuration for the Mercur dashboard plugin.
|
|
6
|
+
*
|
|
7
|
+
* Passed to `mercurDashboardPlugin()` in `vite.config.ts` to configure
|
|
8
|
+
* the vendor or admin dashboard at build time.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* mercurDashboardPlugin({
|
|
13
|
+
* medusaConfigPath: '../../packages/api/medusa-config.ts',
|
|
14
|
+
* enableSellerRegistration: true,
|
|
15
|
+
* })
|
|
16
|
+
* ```
|
|
17
|
+
*/
|
|
4
18
|
interface MercurConfig {
|
|
19
|
+
/** Path to the MedusaJS config file, resolved relative to the project root. */
|
|
5
20
|
medusaConfigPath: string;
|
|
21
|
+
/**
|
|
22
|
+
* Backend URL for API requests.
|
|
23
|
+
* @default "http://localhost:9000"
|
|
24
|
+
*/
|
|
6
25
|
backendUrl?: string;
|
|
26
|
+
/** Dashboard display name. */
|
|
7
27
|
name?: string;
|
|
28
|
+
/** Path to a logo asset for the dashboard. */
|
|
8
29
|
logo?: string;
|
|
30
|
+
/**
|
|
31
|
+
* Override built-in layout components with custom implementations.
|
|
32
|
+
* Paths are resolved relative to `src/`.
|
|
33
|
+
*/
|
|
9
34
|
components?: {
|
|
10
35
|
MainSidebar?: string;
|
|
11
36
|
SettingsSidebar?: string;
|
|
12
37
|
TopbarActions?: string;
|
|
38
|
+
StoreSetup?: string;
|
|
13
39
|
};
|
|
40
|
+
/** Internationalization settings. */
|
|
14
41
|
i18n?: {
|
|
42
|
+
/** The default language code (e.g. `"en"`). */
|
|
15
43
|
defaultLanguage: string;
|
|
16
44
|
};
|
|
45
|
+
/** Whether to allow new sellers to register from the login screen. */
|
|
17
46
|
enableSellerRegistration?: boolean;
|
|
18
47
|
}
|
|
19
48
|
interface BuiltMercurConfig extends MercurConfig {
|