@vue/devtools-kit 7.3.9 → 7.4.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 CHANGED
@@ -171,6 +171,9 @@ interface DevToolsState {
171
171
  tabs: CustomTab[];
172
172
  commands: CustomCommand[];
173
173
  highPerfModeEnabled: boolean;
174
+ devtoolsClientDetected: {
175
+ [key: string]: boolean;
176
+ };
174
177
  }
175
178
  declare const callStateUpdatedHook: (state: DevToolsState) => Promise<void>;
176
179
  declare const callConnectedUpdatedHook: (state: DevToolsState, oldState: DevToolsState) => Promise<void>;
@@ -406,6 +409,28 @@ declare function createDevToolsApi(hooks: Hookable<DevToolsContextHooks & DevToo
406
409
  getVueInspector: typeof getComponentInspector;
407
410
  toggleApp(id: string): void;
408
411
  inspectDOM(instanceId: string): void;
412
+ updatePluginSettings(pluginId: string, key: string, value: string): void;
413
+ getPluginSettings(pluginId: string): {
414
+ options: Record<string, {
415
+ label: string;
416
+ description?: string;
417
+ } & ({
418
+ type: "boolean";
419
+ defaultValue: boolean;
420
+ } | {
421
+ type: "choice";
422
+ defaultValue: string | number;
423
+ options: {
424
+ value: string | number;
425
+ label: string;
426
+ }[];
427
+ component?: "select" | "button-group";
428
+ } | {
429
+ type: "text";
430
+ defaultValue: string;
431
+ })> | null;
432
+ values: any;
433
+ };
409
434
  };
410
435
  type DevToolsApiType = ReturnType<typeof createDevToolsApi>;
411
436
 
@@ -504,7 +529,7 @@ declare class DevToolsV6PluginAPI {
504
529
  now(): number;
505
530
  addTimelineLayer(options: TimelineLayerOptions): void;
506
531
  addTimelineEvent(options: TimelineEventOptions): void;
507
- getSettings(pluginId?: string): {};
532
+ getSettings(pluginId?: string): any;
508
533
  getComponentInstances(app: App): Promise<ComponentInstance[]>;
509
534
  getComponentBounds(instance: ComponentInstance): Promise<ComponentBounds>;
510
535
  getComponentName(instance: ComponentInstance): Promise<string>;
@@ -1010,6 +1035,8 @@ declare const NAN = "__vue_devtool_nan__";
1010
1035
 
1011
1036
  declare function isPlainObject(obj: unknown): obj is object;
1012
1037
 
1038
+ declare function updateDevToolsClientDetected(params: Record<string, boolean>): void;
1039
+
1013
1040
  declare const devtools: {
1014
1041
  hook: VueHooks;
1015
1042
  init: () => void;
@@ -1027,7 +1054,29 @@ declare const devtools: {
1027
1054
  getVueInspector: typeof getComponentInspector;
1028
1055
  toggleApp(id: string): void;
1029
1056
  inspectDOM(instanceId: string): void;
1057
+ updatePluginSettings(pluginId: string, key: string, value: string): void;
1058
+ getPluginSettings(pluginId: string): {
1059
+ options: Record<string, {
1060
+ label: string;
1061
+ description?: string;
1062
+ } & ({
1063
+ type: "boolean";
1064
+ defaultValue: boolean;
1065
+ } | {
1066
+ type: "choice";
1067
+ defaultValue: string | number;
1068
+ options: {
1069
+ value: string | number;
1070
+ label: string;
1071
+ }[];
1072
+ component?: "select" | "button-group";
1073
+ } | {
1074
+ type: "text";
1075
+ defaultValue: string;
1076
+ })> | null;
1077
+ values: any;
1078
+ };
1030
1079
  };
1031
1080
  };
1032
1081
 
1033
- export { type AddInspectorApiPayload, type App, type AppRecord, type ComponentBoundingRect, type ComponentBoundingRectApiPayload, type ComponentBounds, type ComponentHighLighterOptions, type ComponentInspector, type ComponentInstance, type ComponentState, type ComponentTreeNode, type CreateRpcClientOptions, type CreateRpcServerOptions, type CustomCommand, type CustomCommandAction, type CustomInspectorNode, type CustomInspectorOptions, type CustomInspectorState, type CustomTab, type DevToolsApiType, type DevToolsAppRecords, DevToolsContextHookKeys, type DevToolsContextHookPayloads, type DevToolsContextHooks, type DevToolsEvent, type DevToolsHook, DevToolsHooks, DevToolsMessagingHookKeys, type DevToolsMessagingHookPayloads, type DevToolsMessagingHooks, type DevToolsPlugin, type DevToolsState, DevToolsV6PluginAPIHookKeys, type DevToolsV6PluginAPIHookPayloads, type DevToolsV6PluginAPIHooks, type DevtoolsContext, type EditStatePayload, INFINITY, type InspectedComponentData, type InspectorCustomState, type InspectorNodeTag, type InspectorState, type InspectorStateApiPayload, type InspectorStateEditorPayload, type InspectorTree, type InspectorTreeApiPayload, type ModuleIframeView, type ModuleVNodeView, type ModuleView, NAN, NEGATIVE_INFINITY, type OpenInEditorOptions, type PluginDescriptor, type PluginSetupFunction, type Presets, type PropPath, ROUTER_INFO_KEY, ROUTER_KEY, type RouterInfo, type ScreenshotData, type ScreenshotOverlayEvent, type ScreenshotOverlayRenderContext, type ScreenshotOverlayRenderResult, type ScrollToComponentOptions, type StateBase, type TimelineEvent, type TimelineEventOptions, type TimelineLayerOptions, UNDEFINED, type VueAppInstance, type VueHooks, activeAppRecord, addCustomCommand, addCustomTab, addDevToolsAppRecord, addDevToolsPluginToBuffer, addInspector, callConnectedUpdatedHook, callDevToolsPluginSetupFn, callInspectorUpdatedHook, callStateUpdatedHook, cancelInspectComponentHighLighter, createComponentsDevToolsPlugin, createDevToolsApi, createDevToolsCtxHooks, createRpcClient, createRpcProxy, createRpcServer, type customTypeEnums, devtools, devtoolsAppRecords, devtoolsContext, devtoolsInspector, devtoolsPluginBuffer, devtoolsRouter, devtoolsRouterInfo, devtoolsState, formatInspectorStateValue, getActiveInspectors, getComponentInspector, getDevToolsEnv, getExtensionClientContext, getInspector, getInspectorActions, getInspectorInfo, getInspectorNodeActions, getInspectorStateValueType, getRaw, getRpcClient, getRpcServer, getViteRpcClient, getViteRpcServer, highlight, initDevTools, inspectComponentHighLighter, isPlainObject, onDevToolsClientConnected, onDevToolsConnected, openInEditor, parse, registerDevToolsPlugin, removeCustomCommand, removeDevToolsAppRecord, removeRegisteredPluginApp, resetDevToolsState, scrollToComponent, setActiveAppRecord, setActiveAppRecordId, setDevToolsEnv, setElectronClientContext, setElectronProxyContext, setElectronServerContext, setExtensionClientContext, setIframeServerContext, setOpenInEditorBaseUrl, setRpcServerToGlobal, setViteClientContext, setViteRpcClientToGlobal, setViteRpcServerToGlobal, setViteServerContext, setupDevToolsPlugin, stringify, toEdit, toSubmit, toggleClientConnected, toggleComponentHighLighter, toggleComponentInspectorEnabled, toggleHighPerfMode, unhighlight, updateDevToolsState };
1082
+ export { type AddInspectorApiPayload, type App, type AppRecord, type ComponentBoundingRect, type ComponentBoundingRectApiPayload, type ComponentBounds, type ComponentHighLighterOptions, type ComponentInspector, type ComponentInstance, type ComponentState, type ComponentTreeNode, type CreateRpcClientOptions, type CreateRpcServerOptions, type CustomCommand, type CustomCommandAction, type CustomInspectorNode, type CustomInspectorOptions, type CustomInspectorState, type CustomTab, type DevToolsApiType, type DevToolsAppRecords, DevToolsContextHookKeys, type DevToolsContextHookPayloads, type DevToolsContextHooks, type DevToolsEvent, type DevToolsHook, DevToolsHooks, DevToolsMessagingHookKeys, type DevToolsMessagingHookPayloads, type DevToolsMessagingHooks, type DevToolsPlugin, type DevToolsState, DevToolsV6PluginAPIHookKeys, type DevToolsV6PluginAPIHookPayloads, type DevToolsV6PluginAPIHooks, type DevtoolsContext, type EditStatePayload, INFINITY, type InspectedComponentData, type InspectorCustomState, type InspectorNodeTag, type InspectorState, type InspectorStateApiPayload, type InspectorStateEditorPayload, type InspectorTree, type InspectorTreeApiPayload, type ModuleIframeView, type ModuleVNodeView, type ModuleView, NAN, NEGATIVE_INFINITY, type OpenInEditorOptions, type PluginDescriptor, type PluginSetupFunction, type Presets, type PropPath, ROUTER_INFO_KEY, ROUTER_KEY, type RouterInfo, type ScreenshotData, type ScreenshotOverlayEvent, type ScreenshotOverlayRenderContext, type ScreenshotOverlayRenderResult, type ScrollToComponentOptions, type StateBase, type TimelineEvent, type TimelineEventOptions, type TimelineLayerOptions, UNDEFINED, type VueAppInstance, type VueHooks, activeAppRecord, addCustomCommand, addCustomTab, addDevToolsAppRecord, addDevToolsPluginToBuffer, addInspector, callConnectedUpdatedHook, callDevToolsPluginSetupFn, callInspectorUpdatedHook, callStateUpdatedHook, cancelInspectComponentHighLighter, createComponentsDevToolsPlugin, createDevToolsApi, createDevToolsCtxHooks, createRpcClient, createRpcProxy, createRpcServer, type customTypeEnums, devtools, devtoolsAppRecords, devtoolsContext, devtoolsInspector, devtoolsPluginBuffer, devtoolsRouter, devtoolsRouterInfo, devtoolsState, formatInspectorStateValue, getActiveInspectors, getComponentInspector, getDevToolsEnv, getExtensionClientContext, getInspector, getInspectorActions, getInspectorInfo, getInspectorNodeActions, getInspectorStateValueType, getRaw, getRpcClient, getRpcServer, getViteRpcClient, getViteRpcServer, highlight, initDevTools, inspectComponentHighLighter, isPlainObject, onDevToolsClientConnected, onDevToolsConnected, openInEditor, parse, registerDevToolsPlugin, removeCustomCommand, removeDevToolsAppRecord, removeRegisteredPluginApp, resetDevToolsState, scrollToComponent, setActiveAppRecord, setActiveAppRecordId, setDevToolsEnv, setElectronClientContext, setElectronProxyContext, setElectronServerContext, setExtensionClientContext, setIframeServerContext, setOpenInEditorBaseUrl, setRpcServerToGlobal, setViteClientContext, setViteRpcClientToGlobal, setViteRpcServerToGlobal, setViteServerContext, setupDevToolsPlugin, stringify, toEdit, toSubmit, toggleClientConnected, toggleComponentHighLighter, toggleComponentInspectorEnabled, toggleHighPerfMode, unhighlight, updateDevToolsClientDetected, updateDevToolsState };
package/dist/index.d.ts CHANGED
@@ -171,6 +171,9 @@ interface DevToolsState {
171
171
  tabs: CustomTab[];
172
172
  commands: CustomCommand[];
173
173
  highPerfModeEnabled: boolean;
174
+ devtoolsClientDetected: {
175
+ [key: string]: boolean;
176
+ };
174
177
  }
175
178
  declare const callStateUpdatedHook: (state: DevToolsState) => Promise<void>;
176
179
  declare const callConnectedUpdatedHook: (state: DevToolsState, oldState: DevToolsState) => Promise<void>;
@@ -406,6 +409,28 @@ declare function createDevToolsApi(hooks: Hookable<DevToolsContextHooks & DevToo
406
409
  getVueInspector: typeof getComponentInspector;
407
410
  toggleApp(id: string): void;
408
411
  inspectDOM(instanceId: string): void;
412
+ updatePluginSettings(pluginId: string, key: string, value: string): void;
413
+ getPluginSettings(pluginId: string): {
414
+ options: Record<string, {
415
+ label: string;
416
+ description?: string;
417
+ } & ({
418
+ type: "boolean";
419
+ defaultValue: boolean;
420
+ } | {
421
+ type: "choice";
422
+ defaultValue: string | number;
423
+ options: {
424
+ value: string | number;
425
+ label: string;
426
+ }[];
427
+ component?: "select" | "button-group";
428
+ } | {
429
+ type: "text";
430
+ defaultValue: string;
431
+ })> | null;
432
+ values: any;
433
+ };
409
434
  };
410
435
  type DevToolsApiType = ReturnType<typeof createDevToolsApi>;
411
436
 
@@ -504,7 +529,7 @@ declare class DevToolsV6PluginAPI {
504
529
  now(): number;
505
530
  addTimelineLayer(options: TimelineLayerOptions): void;
506
531
  addTimelineEvent(options: TimelineEventOptions): void;
507
- getSettings(pluginId?: string): {};
532
+ getSettings(pluginId?: string): any;
508
533
  getComponentInstances(app: App): Promise<ComponentInstance[]>;
509
534
  getComponentBounds(instance: ComponentInstance): Promise<ComponentBounds>;
510
535
  getComponentName(instance: ComponentInstance): Promise<string>;
@@ -1010,6 +1035,8 @@ declare const NAN = "__vue_devtool_nan__";
1010
1035
 
1011
1036
  declare function isPlainObject(obj: unknown): obj is object;
1012
1037
 
1038
+ declare function updateDevToolsClientDetected(params: Record<string, boolean>): void;
1039
+
1013
1040
  declare const devtools: {
1014
1041
  hook: VueHooks;
1015
1042
  init: () => void;
@@ -1027,7 +1054,29 @@ declare const devtools: {
1027
1054
  getVueInspector: typeof getComponentInspector;
1028
1055
  toggleApp(id: string): void;
1029
1056
  inspectDOM(instanceId: string): void;
1057
+ updatePluginSettings(pluginId: string, key: string, value: string): void;
1058
+ getPluginSettings(pluginId: string): {
1059
+ options: Record<string, {
1060
+ label: string;
1061
+ description?: string;
1062
+ } & ({
1063
+ type: "boolean";
1064
+ defaultValue: boolean;
1065
+ } | {
1066
+ type: "choice";
1067
+ defaultValue: string | number;
1068
+ options: {
1069
+ value: string | number;
1070
+ label: string;
1071
+ }[];
1072
+ component?: "select" | "button-group";
1073
+ } | {
1074
+ type: "text";
1075
+ defaultValue: string;
1076
+ })> | null;
1077
+ values: any;
1078
+ };
1030
1079
  };
1031
1080
  };
1032
1081
 
1033
- export { type AddInspectorApiPayload, type App, type AppRecord, type ComponentBoundingRect, type ComponentBoundingRectApiPayload, type ComponentBounds, type ComponentHighLighterOptions, type ComponentInspector, type ComponentInstance, type ComponentState, type ComponentTreeNode, type CreateRpcClientOptions, type CreateRpcServerOptions, type CustomCommand, type CustomCommandAction, type CustomInspectorNode, type CustomInspectorOptions, type CustomInspectorState, type CustomTab, type DevToolsApiType, type DevToolsAppRecords, DevToolsContextHookKeys, type DevToolsContextHookPayloads, type DevToolsContextHooks, type DevToolsEvent, type DevToolsHook, DevToolsHooks, DevToolsMessagingHookKeys, type DevToolsMessagingHookPayloads, type DevToolsMessagingHooks, type DevToolsPlugin, type DevToolsState, DevToolsV6PluginAPIHookKeys, type DevToolsV6PluginAPIHookPayloads, type DevToolsV6PluginAPIHooks, type DevtoolsContext, type EditStatePayload, INFINITY, type InspectedComponentData, type InspectorCustomState, type InspectorNodeTag, type InspectorState, type InspectorStateApiPayload, type InspectorStateEditorPayload, type InspectorTree, type InspectorTreeApiPayload, type ModuleIframeView, type ModuleVNodeView, type ModuleView, NAN, NEGATIVE_INFINITY, type OpenInEditorOptions, type PluginDescriptor, type PluginSetupFunction, type Presets, type PropPath, ROUTER_INFO_KEY, ROUTER_KEY, type RouterInfo, type ScreenshotData, type ScreenshotOverlayEvent, type ScreenshotOverlayRenderContext, type ScreenshotOverlayRenderResult, type ScrollToComponentOptions, type StateBase, type TimelineEvent, type TimelineEventOptions, type TimelineLayerOptions, UNDEFINED, type VueAppInstance, type VueHooks, activeAppRecord, addCustomCommand, addCustomTab, addDevToolsAppRecord, addDevToolsPluginToBuffer, addInspector, callConnectedUpdatedHook, callDevToolsPluginSetupFn, callInspectorUpdatedHook, callStateUpdatedHook, cancelInspectComponentHighLighter, createComponentsDevToolsPlugin, createDevToolsApi, createDevToolsCtxHooks, createRpcClient, createRpcProxy, createRpcServer, type customTypeEnums, devtools, devtoolsAppRecords, devtoolsContext, devtoolsInspector, devtoolsPluginBuffer, devtoolsRouter, devtoolsRouterInfo, devtoolsState, formatInspectorStateValue, getActiveInspectors, getComponentInspector, getDevToolsEnv, getExtensionClientContext, getInspector, getInspectorActions, getInspectorInfo, getInspectorNodeActions, getInspectorStateValueType, getRaw, getRpcClient, getRpcServer, getViteRpcClient, getViteRpcServer, highlight, initDevTools, inspectComponentHighLighter, isPlainObject, onDevToolsClientConnected, onDevToolsConnected, openInEditor, parse, registerDevToolsPlugin, removeCustomCommand, removeDevToolsAppRecord, removeRegisteredPluginApp, resetDevToolsState, scrollToComponent, setActiveAppRecord, setActiveAppRecordId, setDevToolsEnv, setElectronClientContext, setElectronProxyContext, setElectronServerContext, setExtensionClientContext, setIframeServerContext, setOpenInEditorBaseUrl, setRpcServerToGlobal, setViteClientContext, setViteRpcClientToGlobal, setViteRpcServerToGlobal, setViteServerContext, setupDevToolsPlugin, stringify, toEdit, toSubmit, toggleClientConnected, toggleComponentHighLighter, toggleComponentInspectorEnabled, toggleHighPerfMode, unhighlight, updateDevToolsState };
1082
+ export { type AddInspectorApiPayload, type App, type AppRecord, type ComponentBoundingRect, type ComponentBoundingRectApiPayload, type ComponentBounds, type ComponentHighLighterOptions, type ComponentInspector, type ComponentInstance, type ComponentState, type ComponentTreeNode, type CreateRpcClientOptions, type CreateRpcServerOptions, type CustomCommand, type CustomCommandAction, type CustomInspectorNode, type CustomInspectorOptions, type CustomInspectorState, type CustomTab, type DevToolsApiType, type DevToolsAppRecords, DevToolsContextHookKeys, type DevToolsContextHookPayloads, type DevToolsContextHooks, type DevToolsEvent, type DevToolsHook, DevToolsHooks, DevToolsMessagingHookKeys, type DevToolsMessagingHookPayloads, type DevToolsMessagingHooks, type DevToolsPlugin, type DevToolsState, DevToolsV6PluginAPIHookKeys, type DevToolsV6PluginAPIHookPayloads, type DevToolsV6PluginAPIHooks, type DevtoolsContext, type EditStatePayload, INFINITY, type InspectedComponentData, type InspectorCustomState, type InspectorNodeTag, type InspectorState, type InspectorStateApiPayload, type InspectorStateEditorPayload, type InspectorTree, type InspectorTreeApiPayload, type ModuleIframeView, type ModuleVNodeView, type ModuleView, NAN, NEGATIVE_INFINITY, type OpenInEditorOptions, type PluginDescriptor, type PluginSetupFunction, type Presets, type PropPath, ROUTER_INFO_KEY, ROUTER_KEY, type RouterInfo, type ScreenshotData, type ScreenshotOverlayEvent, type ScreenshotOverlayRenderContext, type ScreenshotOverlayRenderResult, type ScrollToComponentOptions, type StateBase, type TimelineEvent, type TimelineEventOptions, type TimelineLayerOptions, UNDEFINED, type VueAppInstance, type VueHooks, activeAppRecord, addCustomCommand, addCustomTab, addDevToolsAppRecord, addDevToolsPluginToBuffer, addInspector, callConnectedUpdatedHook, callDevToolsPluginSetupFn, callInspectorUpdatedHook, callStateUpdatedHook, cancelInspectComponentHighLighter, createComponentsDevToolsPlugin, createDevToolsApi, createDevToolsCtxHooks, createRpcClient, createRpcProxy, createRpcServer, type customTypeEnums, devtools, devtoolsAppRecords, devtoolsContext, devtoolsInspector, devtoolsPluginBuffer, devtoolsRouter, devtoolsRouterInfo, devtoolsState, formatInspectorStateValue, getActiveInspectors, getComponentInspector, getDevToolsEnv, getExtensionClientContext, getInspector, getInspectorActions, getInspectorInfo, getInspectorNodeActions, getInspectorStateValueType, getRaw, getRpcClient, getRpcServer, getViteRpcClient, getViteRpcServer, highlight, initDevTools, inspectComponentHighLighter, isPlainObject, onDevToolsClientConnected, onDevToolsConnected, openInEditor, parse, registerDevToolsPlugin, removeCustomCommand, removeDevToolsAppRecord, removeRegisteredPluginApp, resetDevToolsState, scrollToComponent, setActiveAppRecord, setActiveAppRecordId, setDevToolsEnv, setElectronClientContext, setElectronProxyContext, setElectronServerContext, setExtensionClientContext, setIframeServerContext, setOpenInEditorBaseUrl, setRpcServerToGlobal, setViteClientContext, setViteRpcClientToGlobal, setViteRpcServerToGlobal, setViteServerContext, setupDevToolsPlugin, stringify, toEdit, toSubmit, toggleClientConnected, toggleComponentHighLighter, toggleComponentInspectorEnabled, toggleHighPerfMode, unhighlight, updateDevToolsClientDetected, updateDevToolsState };