@vue/devtools-api 8.2.0 → 9.0.0-beta.0

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/README.md CHANGED
@@ -1,7 +1,21 @@
1
1
  # @vue/devtools-api
2
2
 
3
- > Plugins API for easier DevTools integrations.
3
+ Public plugin API compatibility entry for Vue DevTools.
4
4
 
5
- ## Getting Started
5
+ ```ts
6
+ import { setupDevToolsPlugin } from '@vue/devtools-api'
6
7
 
7
- Please follow the documentation at [devtools.vuejs.org](https://devtools.vuejs.org/plugins/api).
8
+ setupDevToolsPlugin(
9
+ {
10
+ id: 'example',
11
+ label: 'Example',
12
+ app,
13
+ },
14
+ (api) => {
15
+ api.addInspector({ id: 'example', label: 'Example' })
16
+ },
17
+ )
18
+ ```
19
+
20
+ The legacy `setupDevtoolsPlugin` spelling remains available as an alias. Importing this package
21
+ from Node.js or during SSR is safe: its Node export intentionally performs no browser work.
@@ -1,20 +1,16 @@
1
1
  Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
2
2
  //#region src/index-node.ts
3
- function addCustomCommand() {}
4
- function addCustomTab() {}
5
- function onDevToolsClientConnected(_fn) {
3
+ function setupDevToolsPlugin(_pluginDescriptor, _setupFn) {}
4
+ function onDevToolsConnected(_callback) {
6
5
  return new Promise(() => {});
7
6
  }
8
- function onDevToolsConnected(_fn) {
7
+ function onDevToolsClientConnected(_callback) {
9
8
  return new Promise(() => {});
10
9
  }
11
- function removeCustomCommand() {}
12
- function setupDevToolsPlugin(_pluginDescriptor, _setupFn) {}
13
10
  //#endregion
14
- exports.addCustomCommand = addCustomCommand;
15
- exports.addCustomTab = addCustomTab;
16
11
  exports.onDevToolsClientConnected = onDevToolsClientConnected;
17
12
  exports.onDevToolsConnected = onDevToolsConnected;
18
- exports.removeCustomCommand = removeCustomCommand;
19
13
  exports.setupDevToolsPlugin = setupDevToolsPlugin;
20
14
  exports.setupDevtoolsPlugin = setupDevToolsPlugin;
15
+
16
+ //# sourceMappingURL=index-node.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index-node.cjs","names":[],"sources":["../src/index-node.ts"],"sourcesContent":["import type { PluginDescriptor, PluginSetupFunction } from '@vue/devtools-kit'\n\nexport function setupDevToolsPlugin(\n _pluginDescriptor: PluginDescriptor,\n _setupFn: PluginSetupFunction,\n): void {}\n\nexport { setupDevToolsPlugin as setupDevtoolsPlugin }\n\nexport function onDevToolsConnected(_callback: () => void): Promise<void> {\n return new Promise<void>(() => {})\n}\n\nexport function onDevToolsClientConnected(_callback: () => void): Promise<void> {\n return new Promise<void>(() => {})\n}\n"],"mappings":";;AAEA,SAAgB,oBACd,mBACA,UACM,CAAC;AAIT,SAAgB,oBAAoB,WAAsC;CACxE,OAAO,IAAI,cAAoB,CAAC,CAAC;AACnC;AAEA,SAAgB,0BAA0B,WAAsC;CAC9E,OAAO,IAAI,cAAoB,CAAC,CAAC;AACnC"}
@@ -1,11 +1,8 @@
1
- import { CustomCommand, CustomTab, PluginDescriptor, PluginSetupFunction } from "@vue/devtools-kit";
2
-
1
+ import { PluginDescriptor, PluginSetupFunction } from "@vue/devtools-kit";
3
2
  //#region src/index-node.d.ts
4
- declare function addCustomCommand(): void;
5
- declare function addCustomTab(): void;
6
- declare function onDevToolsClientConnected(_fn: () => void): Promise<void>;
7
- declare function onDevToolsConnected(_fn: () => void): Promise<void>;
8
- declare function removeCustomCommand(): void;
9
3
  declare function setupDevToolsPlugin(_pluginDescriptor: PluginDescriptor, _setupFn: PluginSetupFunction): void;
4
+ declare function onDevToolsConnected(_callback: () => void): Promise<void>;
5
+ declare function onDevToolsClientConnected(_callback: () => void): Promise<void>;
10
6
  //#endregion
11
- export { type CustomCommand, type CustomTab, addCustomCommand, addCustomTab, onDevToolsClientConnected, onDevToolsConnected, removeCustomCommand, setupDevToolsPlugin, setupDevToolsPlugin as setupDevtoolsPlugin };
7
+ export { onDevToolsClientConnected, onDevToolsConnected, setupDevToolsPlugin, setupDevToolsPlugin as setupDevtoolsPlugin };
8
+ //# sourceMappingURL=index-node.d.cts.map
@@ -0,0 +1,8 @@
1
+ import { PluginDescriptor, PluginSetupFunction } from "@vue/devtools-kit";
2
+ //#region src/index-node.d.ts
3
+ declare function setupDevToolsPlugin(_pluginDescriptor: PluginDescriptor, _setupFn: PluginSetupFunction): void;
4
+ declare function onDevToolsConnected(_callback: () => void): Promise<void>;
5
+ declare function onDevToolsClientConnected(_callback: () => void): Promise<void>;
6
+ //#endregion
7
+ export { onDevToolsClientConnected, onDevToolsConnected, setupDevToolsPlugin, setupDevToolsPlugin as setupDevtoolsPlugin };
8
+ //# sourceMappingURL=index-node.d.mts.map
@@ -0,0 +1,12 @@
1
+ //#region src/index-node.ts
2
+ function setupDevToolsPlugin(_pluginDescriptor, _setupFn) {}
3
+ function onDevToolsConnected(_callback) {
4
+ return new Promise(() => {});
5
+ }
6
+ function onDevToolsClientConnected(_callback) {
7
+ return new Promise(() => {});
8
+ }
9
+ //#endregion
10
+ export { onDevToolsClientConnected, onDevToolsConnected, setupDevToolsPlugin, setupDevToolsPlugin as setupDevtoolsPlugin };
11
+
12
+ //# sourceMappingURL=index-node.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index-node.mjs","names":[],"sources":["../src/index-node.ts"],"sourcesContent":["import type { PluginDescriptor, PluginSetupFunction } from '@vue/devtools-kit'\n\nexport function setupDevToolsPlugin(\n _pluginDescriptor: PluginDescriptor,\n _setupFn: PluginSetupFunction,\n): void {}\n\nexport { setupDevToolsPlugin as setupDevtoolsPlugin }\n\nexport function onDevToolsConnected(_callback: () => void): Promise<void> {\n return new Promise<void>(() => {})\n}\n\nexport function onDevToolsClientConnected(_callback: () => void): Promise<void> {\n return new Promise<void>(() => {})\n}\n"],"mappings":";AAEA,SAAgB,oBACd,mBACA,UACM,CAAC;AAIT,SAAgB,oBAAoB,WAAsC;CACxE,OAAO,IAAI,cAAoB,CAAC,CAAC;AACnC;AAEA,SAAgB,0BAA0B,WAAsC;CAC9E,OAAO,IAAI,cAAoB,CAAC,CAAC;AACnC"}
package/dist/index.cjs CHANGED
@@ -1,17 +1,5 @@
1
1
  Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
2
2
  let _vue_devtools_kit = require("@vue/devtools-kit");
3
- Object.defineProperty(exports, "addCustomCommand", {
4
- enumerable: true,
5
- get: function() {
6
- return _vue_devtools_kit.addCustomCommand;
7
- }
8
- });
9
- Object.defineProperty(exports, "addCustomTab", {
10
- enumerable: true,
11
- get: function() {
12
- return _vue_devtools_kit.addCustomTab;
13
- }
14
- });
15
3
  Object.defineProperty(exports, "onDevToolsClientConnected", {
16
4
  enumerable: true,
17
5
  get: function() {
@@ -24,12 +12,6 @@ Object.defineProperty(exports, "onDevToolsConnected", {
24
12
  return _vue_devtools_kit.onDevToolsConnected;
25
13
  }
26
14
  });
27
- Object.defineProperty(exports, "removeCustomCommand", {
28
- enumerable: true,
29
- get: function() {
30
- return _vue_devtools_kit.removeCustomCommand;
31
- }
32
- });
33
15
  Object.defineProperty(exports, "setupDevToolsPlugin", {
34
16
  enumerable: true,
35
17
  get: function() {
package/dist/index.d.cts CHANGED
@@ -1,2 +1,2 @@
1
- import { CustomCommand, CustomTab, addCustomCommand, addCustomTab, onDevToolsClientConnected, onDevToolsConnected, removeCustomCommand, setupDevToolsPlugin, setupDevToolsPlugin as setupDevtoolsPlugin } from "@vue/devtools-kit";
2
- export { type CustomCommand, type CustomTab, addCustomCommand, addCustomTab, onDevToolsClientConnected, onDevToolsConnected, removeCustomCommand, setupDevToolsPlugin, setupDevtoolsPlugin };
1
+ import { onDevToolsClientConnected, onDevToolsConnected, setupDevToolsPlugin, setupDevToolsPlugin as setupDevtoolsPlugin } from "@vue/devtools-kit";
2
+ export { onDevToolsClientConnected, onDevToolsConnected, setupDevToolsPlugin, setupDevtoolsPlugin };
@@ -0,0 +1,2 @@
1
+ import { onDevToolsClientConnected, onDevToolsConnected, setupDevToolsPlugin, setupDevToolsPlugin as setupDevtoolsPlugin } from "@vue/devtools-kit";
2
+ export { onDevToolsClientConnected, onDevToolsConnected, setupDevToolsPlugin, setupDevtoolsPlugin };
package/dist/index.mjs ADDED
@@ -0,0 +1,2 @@
1
+ import { onDevToolsClientConnected, onDevToolsConnected, setupDevToolsPlugin, setupDevToolsPlugin as setupDevtoolsPlugin } from "@vue/devtools-kit";
2
+ export { onDevToolsClientConnected, onDevToolsConnected, setupDevToolsPlugin, setupDevtoolsPlugin };
package/package.json CHANGED
@@ -1,38 +1,52 @@
1
1
  {
2
2
  "name": "@vue/devtools-api",
3
- "type": "module",
4
- "version": "8.2.0",
5
- "author": "webfansplz",
3
+ "version": "9.0.0-beta.0",
4
+ "description": "Public plugin API for Vue DevTools",
6
5
  "license": "MIT",
6
+ "author": "webfansplz",
7
7
  "repository": {
8
- "directory": "packages/devtools-api",
9
8
  "type": "git",
10
- "url": "git+https://github.com/vuejs/devtools.git"
9
+ "url": "git+https://github.com/vuejs/devtools.git",
10
+ "directory": "packages/devtools-api"
11
11
  },
12
+ "files": [
13
+ "dist",
14
+ "LICENSE",
15
+ "README.md"
16
+ ],
17
+ "type": "module",
12
18
  "sideEffects": false,
19
+ "main": "./dist/index.cjs",
20
+ "module": "./dist/index.mjs",
21
+ "types": "./dist/index.d.mts",
13
22
  "exports": {
14
23
  ".": {
15
24
  "node": {
16
- "import": "./dist/index-node.js",
17
- "require": "./dist/index-node.cjs"
25
+ "import": {
26
+ "types": "./dist/index-node.d.mts",
27
+ "default": "./dist/index-node.mjs"
28
+ },
29
+ "require": {
30
+ "types": "./dist/index-node.d.cts",
31
+ "default": "./dist/index-node.cjs"
32
+ }
33
+ },
34
+ "import": {
35
+ "types": "./dist/index.d.mts",
36
+ "default": "./dist/index.mjs"
18
37
  },
19
- "import": "./dist/index.js",
20
- "require": "./dist/index.cjs"
21
- }
38
+ "require": {
39
+ "types": "./dist/index.d.cts",
40
+ "default": "./dist/index.cjs"
41
+ }
42
+ },
43
+ "./package.json": "./package.json"
22
44
  },
23
- "main": "./dist/index.cjs",
24
- "module": "./dist/index.js",
25
- "unpkg": "dist/vue-devtools-api.global.js",
26
- "jsdelivr": "dist/vue-devtools-api.global.js",
27
- "files": [
28
- "dist"
29
- ],
30
45
  "dependencies": {
31
- "@vue/devtools-kit": "^8.2.0"
46
+ "@vue/devtools-kit": "9.0.0-beta.0"
32
47
  },
33
48
  "scripts": {
34
- "build": "tsdown --clean",
35
- "prepare:type": "tsdown --dts-only",
36
- "stub": "tsdown --watch --onSuccess 'tsdown --dts-only'"
49
+ "build": "vp pack",
50
+ "dev": "vp pack --watch"
37
51
  }
38
52
  }
@@ -1,11 +0,0 @@
1
- import { CustomCommand, CustomTab, PluginDescriptor, PluginSetupFunction } from "@vue/devtools-kit";
2
-
3
- //#region src/index-node.d.ts
4
- declare function addCustomCommand(): void;
5
- declare function addCustomTab(): void;
6
- declare function onDevToolsClientConnected(_fn: () => void): Promise<void>;
7
- declare function onDevToolsConnected(_fn: () => void): Promise<void>;
8
- declare function removeCustomCommand(): void;
9
- declare function setupDevToolsPlugin(_pluginDescriptor: PluginDescriptor, _setupFn: PluginSetupFunction): void;
10
- //#endregion
11
- export { type CustomCommand, type CustomTab, addCustomCommand, addCustomTab, onDevToolsClientConnected, onDevToolsConnected, removeCustomCommand, setupDevToolsPlugin, setupDevToolsPlugin as setupDevtoolsPlugin };
@@ -1,13 +0,0 @@
1
- //#region src/index-node.ts
2
- function addCustomCommand() {}
3
- function addCustomTab() {}
4
- function onDevToolsClientConnected(_fn) {
5
- return new Promise(() => {});
6
- }
7
- function onDevToolsConnected(_fn) {
8
- return new Promise(() => {});
9
- }
10
- function removeCustomCommand() {}
11
- function setupDevToolsPlugin(_pluginDescriptor, _setupFn) {}
12
- //#endregion
13
- export { addCustomCommand, addCustomTab, onDevToolsClientConnected, onDevToolsConnected, removeCustomCommand, setupDevToolsPlugin, setupDevToolsPlugin as setupDevtoolsPlugin };
package/dist/index.d.ts DELETED
@@ -1,2 +0,0 @@
1
- import { CustomCommand, CustomTab, addCustomCommand, addCustomTab, onDevToolsClientConnected, onDevToolsConnected, removeCustomCommand, setupDevToolsPlugin, setupDevToolsPlugin as setupDevtoolsPlugin } from "@vue/devtools-kit";
2
- export { type CustomCommand, type CustomTab, addCustomCommand, addCustomTab, onDevToolsClientConnected, onDevToolsConnected, removeCustomCommand, setupDevToolsPlugin, setupDevtoolsPlugin };
package/dist/index.js DELETED
@@ -1,2 +0,0 @@
1
- import { addCustomCommand, addCustomTab, onDevToolsClientConnected, onDevToolsConnected, removeCustomCommand, setupDevToolsPlugin, setupDevToolsPlugin as setupDevtoolsPlugin } from "@vue/devtools-kit";
2
- export { addCustomCommand, addCustomTab, onDevToolsClientConnected, onDevToolsConnected, removeCustomCommand, setupDevToolsPlugin, setupDevtoolsPlugin };