@sakana-y/vue-grab-shared 0.1.1 → 0.1.2

package/CHANGELOG.md

@@ -0,0 +1,42 @@
+# @sakana-y/vue-grab-shared
+
+## 0.1.2
+
+### Patch Changes
+
+- [#38](https://github.com/SaKaNa-Y/vue-grab/pull/38) [`a90677f`](https://github.com/SaKaNa-Y/vue-grab/commit/a90677f19389bb7875ca54164e4554830f80a2d7) Thanks [@SaKaNa-Y](https://github.com/SaKaNa-Y)! - Hide beta toolbar entries by default and label Magnifier, Logs, and Network as Beta in Dock settings.
+
+- [#38](https://github.com/SaKaNa-Y/vue-grab/pull/38) [`a90677f`](https://github.com/SaKaNa-Y/vue-grab/commit/a90677f19389bb7875ca54164e4554830f80a2d7) Thanks [@SaKaNa-Y](https://github.com/SaKaNa-Y)! - Add package README, license, and npm metadata so published package pages show documentation and project links.
+
+## 0.1.1
+
+### Patch Changes
+
+- [#35](https://github.com/SaKaNa-Y/vue-grab/pull/35) [`56d9d44`](https://github.com/SaKaNa-Y/vue-grab/commit/56d9d448c62ce2f11607fe7bf5b570ce4ecad40a) Thanks [@SaKaNa-Y](https://github.com/SaKaNa-Y)! - Add floating-button toolbar entry visibility and ordering preferences with a locked Settings entry, grouped shortcut settings, and drag reordering within Dock feature groups.
+
+- [#31](https://github.com/SaKaNa-Y/vue-grab/pull/31) [`151ffdb`](https://github.com/SaKaNa-Y/vue-grab/commit/151ffdbd6b8b56ecff1437debd3a38cfbc57b618) Thanks [@SaKaNa-Y](https://github.com/SaKaNa-Y)! - Expose shared protocol constants and request types for advanced integrations.
+
+- [#32](https://github.com/SaKaNa-Y/vue-grab/pull/32) [`14163a0`](https://github.com/SaKaNa-Y/vue-grab/commit/14163a075eeb8783a490b7997e8b8ce1b048b9c7) Thanks [@SaKaNa-Y](https://github.com/SaKaNa-Y)! - Add floating-button dock modes with persisted Float and Edge panel behavior plus outside-click panel closing.
+
+- [#36](https://github.com/SaKaNa-Y/vue-grab/pull/36) [`0cdf6ae`](https://github.com/SaKaNa-Y/vue-grab/commit/0cdf6ae870fa9da9b4a66de45679365dff85a978) Thanks [@SaKaNa-Y](https://github.com/SaKaNa-Y)! - Add persisted, user-configurable shortcuts for every floating-bar feature.
+
+- [#28](https://github.com/SaKaNa-Y/vue-grab/pull/28) [`4ad57b5`](https://github.com/SaKaNa-Y/vue-grab/commit/4ad57b57e86a4c3c3f37d1d951ab69b8c5151a97) Thanks [@SaKaNa-Y](https://github.com/SaKaNa-Y)! - Harden the Vite open-in-editor endpoint and make network body capture opt-in by default.
+
+## 0.1.0
+
+### Minor Changes
+
+- [#21](https://github.com/SaKaNa-Y/vue-grab/pull/21) [`6df5750`](https://github.com/SaKaNa-Y/vue-grab/commit/6df5750f22dc975340180c22a656294a4d85291d) Thanks [@SaKaNa-Y](https://github.com/SaKaNa-Y)! - Rename `errorCapture` → `consoleCapture` and broaden capture from `console.error` only to all five console levels (`log`, `info`, `warn`, `error`, `debug`). The FloatingButton panel now surfaces every captured entry with per-level filter pills and a message search input; the badge counts only `warn` + `error` entries to keep it actionable.
+
+  Breaking changes — no backwards-compatible aliases:
+  - Config key `errorCapture` → `consoleCapture`.
+  - Type `ErrorCaptureConfig` → `ConsoleCaptureConfig`:
+    - `maxErrors` (default 50) → `maxEntries` (default 200).
+    - `captureConsoleError: boolean` replaced by `levels: LogLevel[]` (default is all five levels enabled). The levels array is replaced wholesale by `mergeConfig`, not element-merged.
+    - `captureUnhandled` and `captureVueErrors` retained with identical semantics.
+  - Type `CapturedError` → `CapturedLog`. The single `type` field is replaced with two axes: `level: "log" | "info" | "warn" | "error" | "debug"` and `source: "console" | "runtime" | "promise" | "vue"`. Runtime/promise/Vue entries always carry `level: "error"`.
+  - Constant `VUE_ERROR_EVENT` retained (the underlying window-event string `"vue-grab:vue-error"` is unchanged).
+  - Standalone `init()` API: `onError` / `clearErrors` → `onLog` / `clearLogs`.
+  - FloatingButton methods: `setErrors` / `onErrorsClear` → `setLogs` / `onLogsClear` (internal, only affects code that imports `FloatingButton` directly).
+  - Dedup fingerprint now includes `source` and `level`, so the same message at different levels or from different sources produces distinct entries.
+  - Arguments passed to `console.*` are now stringified at capture time via a safe stringifier that handles circular references, Error instances (preserving `.stack`), and truncates very long values.

package/README.md

@@ -0,0 +1,66 @@
+# Vue Grab Shared
+
+[![npm version](https://img.shields.io/npm/v/@sakana-y/vue-grab-shared)](https://www.npmjs.com/package/@sakana-y/vue-grab-shared)
+[![license](https://img.shields.io/npm/l/@sakana-y/vue-grab-shared)](./LICENSE)
+
+Shared types, defaults, config merging, and protocol constants for Vue Grab integrations.
+
+Most applications should import from `@sakana-y/vue-grab`. Use this package when you are building tooling, tests, or integrations that need stable Vue Grab contracts without importing the Vue runtime.
+
+## Install
+
+```bash
+pnpm add -D @sakana-y/vue-grab-shared
+```
+
+## Exports
+
+```ts
+import {
+  DEFAULT_CONFIG,
+  DEFAULT_FLOATING_BUTTON,
+  OPEN_IN_EDITOR_CONTENT_TYPE,
+  OPEN_IN_EDITOR_ENDPOINT,
+  VUE_ERROR_EVENT,
+  mergeConfig,
+} from "@sakana-y/vue-grab-shared";
+
+import type {
+  CapturedLog,
+  CapturedRequest,
+  ComponentInfo,
+  GrabConfig,
+  GrabResult,
+  GrabUserConfig,
+  OpenInEditorRequest,
+} from "@sakana-y/vue-grab-shared";
+```
+
+## Configuration Merging
+
+Use `mergeConfig()` whenever you combine user config with defaults:
+
+```ts
+import { DEFAULT_CONFIG, mergeConfig } from "@sakana-y/vue-grab-shared";
+
+const config = mergeConfig(DEFAULT_CONFIG, {
+  floatingButton: { enabled: true },
+  networkCapture: {
+    redactHeaders: ["authorization", "x-api-key"],
+  },
+});
+```
+
+`GrabConfig` contains nested objects, so object spread is not enough for safe overrides. Array fields such as `consoleCapture.levels`, `networkCapture.redactHeaders`, and `networkCapture.urlDenyList` are replaced wholesale.
+
+## Related Packages
+
+- `@sakana-y/vue-grab`: Vue plugin, runtime APIs, and Vite integration.
+- `@sakana-y/vue-grab-cli`: CLI setup tool for Vite and Vue projects.
+
+## Links
+
+- Repository: https://github.com/SaKaNa-Y/vue-grab
+- Issues: https://github.com/SaKaNa-Y/vue-grab/issues
+- Changelog: ./CHANGELOG.md
+- License: ./LICENSE

package/dist/index.cjs

@@ -1 +1 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});var e=`/__open-in-editor`,t=`application/json`,n=8192,r=`__VUE_GRAB_ROOT__`,i=[`atom`,`code`,`cursor`,`emacs`,`idea`,`nvim`,`phpstorm`,`sublime`,`vim`,`visualstudio`,`webstorm`];function a(e){return typeof e==`string`&&i.includes(e)}var o=`#4f46e5`,s=`#ffffff`,c=`Alt+Shift+G`,l=[`grab`,`settings`,`magnifier`,`measurer`,`accessibility`,`logs`,`network`],u={enabled:!1,initialPosition:`top-center`,dockMode:`float`,dockEntries:{order:[...l],hidden:[]},shortcuts:{grab:[c],measurer:[`Alt+Shift+M`]},storageKey:`vue-grab-fab-pos`,dockModeStorageKey:`vue-grab-dock-mode`,dockEntriesStorageKey:`vue-grab-dock-entries`,shortcutsStorageKey:`vue-grab-shortcuts`,hotkeyStorageKey:`vue-grab-hotkey`,editorStorageKey:`vue-grab-editor`,measurerHotkeyStorageKey:`vue-grab-measurer-hotkey`,closeOnOutsideClick:!0,closeOnOutsideClickStorageKey:`vue-grab-close-on-outside-click`},d=`vue-grab:vue-error`,f=[`log`,`info`,`warn`,`error`,`debug`],p={enabled:!0,maxEntries:200,levels:[...f],captureUnhandled:!0,captureVueErrors:!0},m=[`2xx`,`3xx`,`4xx`,`5xx`,`failed`],h=new Set([`5xx`,`failed`]),g=new Set([`4xx`]),_=[`authorization`,`cookie`,`set-cookie`,`x-api-key`],v=[e],y={enabled:!0,maxEntries:100,captureFetch:!0,captureXhr:!0,captureBodies:!1,bodyMaxBytes:2048,redactHeaders:[..._],urlDenyList:[...v],grabSnapshot:{enabled:!0,maxEntries:20,windowMs:1e4}},b={enabled:!0,loupeSize:400,zoomLevel:3,showHtmlOverlay:!0,maxOverlayHtmlLength:200},x={enabled:!0,lineColor:`#06b6d4`,guideColor:`#a855f7`,lineWidth:1,showAlignmentGuides:!0,alignmentTolerance:3},S={highlightColor:o,labelTextColor:s,showTagHint:!0,maxHtmlLength:1e4,filter:{ignoreSelectors:[],ignoreTags:[],skipCommonComponents:!1},floatingButton:u,consoleCapture:p,networkCapture:y,magnifier:b,measurer:x};function C(e,t){let{filter:n,floatingButton:r,consoleCapture:i,networkCapture:a,magnifier:o,measurer:s,...c}=t;return{...e,...c,filter:{...e.filter,...n},floatingButton:{...e.floatingButton,...r,dockEntries:{...e.floatingButton.dockEntries,...r?.dockEntries,order:[...r?.dockEntries?.order??e.floatingButton.dockEntries.order],hidden:[...r?.dockEntries?.hidden??e.floatingButton.dockEntries.hidden]},shortcuts:Object.fromEntries(Object.entries({...e.floatingButton.shortcuts,...r?.shortcuts}).map(([e,t])=>[e,[...t??[]]]))},consoleCapture:{...e.consoleCapture,...i,levels:[...i?.levels??e.consoleCapture.levels]},networkCapture:{...e.networkCapture,...a,redactHeaders:[...a?.redactHeaders??e.networkCapture.redactHeaders],urlDenyList:[...a?.urlDenyList??e.networkCapture.urlDenyList],grabSnapshot:{...e.networkCapture.grabSnapshot,...a?.grabSnapshot}},magnifier:{...e.magnifier,...o},measurer:{...e.measurer,...s}}}exports.ALL_LOG_LEVELS=f,exports.ALL_NETWORK_STATUS_CLASSES=m,exports.DEFAULT_CONFIG=S,exports.DEFAULT_CONSOLE_CAPTURE=p,exports.DEFAULT_FLOATING_BUTTON=u,exports.DEFAULT_FLOATING_BUTTON_DOCK_ENTRY_ORDER=l,exports.DEFAULT_HIGHLIGHT_COLOR=o,exports.DEFAULT_HOTKEY=c,exports.DEFAULT_LABEL_TEXT_COLOR=s,exports.DEFAULT_MAGNIFIER=b,exports.DEFAULT_MEASURER=x,exports.DEFAULT_NETWORK_CAPTURE=y,exports.DEFAULT_REDACT_HEADERS=_,exports.DEFAULT_URL_DENY_LIST=v,exports.NETWORK_ERROR_CLASSES=h,exports.NETWORK_WARN_CLASSES=g,exports.OPEN_IN_EDITOR_ALLOWED_EDITORS=i,exports.OPEN_IN_EDITOR_CONTENT_TYPE=t,exports.OPEN_IN_EDITOR_ENDPOINT=e,exports.OPEN_IN_EDITOR_REQUEST_MAX_BYTES=n,exports.VUE_ERROR_EVENT=d,exports.VUE_GRAB_ROOT_GLOBAL=r,exports.isOpenInEditorAllowedEditor=a,exports.mergeConfig=C;
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});var e=`/__open-in-editor`,t=`application/json`,n=8192,r=`__VUE_GRAB_ROOT__`,i=[`atom`,`code`,`cursor`,`emacs`,`idea`,`nvim`,`phpstorm`,`sublime`,`vim`,`visualstudio`,`webstorm`];function a(e){return typeof e==`string`&&i.includes(e)}var o=`#4f46e5`,s=`#ffffff`,c=`Alt+Shift+G`,l=[`grab`,`settings`,`magnifier`,`measurer`,`accessibility`,`logs`,`network`],u={enabled:!1,initialPosition:`top-center`,dockMode:`float`,dockEntries:{order:[...l],hidden:[`magnifier`,`logs`,`network`]},shortcuts:{grab:[c],measurer:[`Alt+Shift+M`]},storageKey:`vue-grab-fab-pos`,dockModeStorageKey:`vue-grab-dock-mode`,dockEntriesStorageKey:`vue-grab-dock-entries`,shortcutsStorageKey:`vue-grab-shortcuts`,hotkeyStorageKey:`vue-grab-hotkey`,editorStorageKey:`vue-grab-editor`,measurerHotkeyStorageKey:`vue-grab-measurer-hotkey`,closeOnOutsideClick:!0,closeOnOutsideClickStorageKey:`vue-grab-close-on-outside-click`},d=`vue-grab:vue-error`,f=[`log`,`info`,`warn`,`error`,`debug`],p={enabled:!0,maxEntries:200,levels:[...f],captureUnhandled:!0,captureVueErrors:!0},m=[`2xx`,`3xx`,`4xx`,`5xx`,`failed`],h=new Set([`5xx`,`failed`]),g=new Set([`4xx`]),_=[`authorization`,`cookie`,`set-cookie`,`x-api-key`],v=[e],y={enabled:!0,maxEntries:100,captureFetch:!0,captureXhr:!0,captureBodies:!1,bodyMaxBytes:2048,redactHeaders:[..._],urlDenyList:[...v],grabSnapshot:{enabled:!0,maxEntries:20,windowMs:1e4}},b={enabled:!0,loupeSize:400,zoomLevel:3,showHtmlOverlay:!0,maxOverlayHtmlLength:200},x={enabled:!0,lineColor:`#06b6d4`,guideColor:`#a855f7`,lineWidth:1,showAlignmentGuides:!0,alignmentTolerance:3},S={highlightColor:o,labelTextColor:s,showTagHint:!0,maxHtmlLength:1e4,filter:{ignoreSelectors:[],ignoreTags:[],skipCommonComponents:!1},floatingButton:u,consoleCapture:p,networkCapture:y,magnifier:b,measurer:x};function C(e,t){let{filter:n,floatingButton:r,consoleCapture:i,networkCapture:a,magnifier:o,measurer:s,...c}=t;return{...e,...c,filter:{...e.filter,...n},floatingButton:{...e.floatingButton,...r,dockEntries:{...e.floatingButton.dockEntries,...r?.dockEntries,order:[...r?.dockEntries?.order??e.floatingButton.dockEntries.order],hidden:[...r?.dockEntries?.hidden??e.floatingButton.dockEntries.hidden]},shortcuts:Object.fromEntries(Object.entries({...e.floatingButton.shortcuts,...r?.shortcuts}).map(([e,t])=>[e,[...t??[]]]))},consoleCapture:{...e.consoleCapture,...i,levels:[...i?.levels??e.consoleCapture.levels]},networkCapture:{...e.networkCapture,...a,redactHeaders:[...a?.redactHeaders??e.networkCapture.redactHeaders],urlDenyList:[...a?.urlDenyList??e.networkCapture.urlDenyList],grabSnapshot:{...e.networkCapture.grabSnapshot,...a?.grabSnapshot}},magnifier:{...e.magnifier,...o},measurer:{...e.measurer,...s}}}exports.ALL_LOG_LEVELS=f,exports.ALL_NETWORK_STATUS_CLASSES=m,exports.DEFAULT_CONFIG=S,exports.DEFAULT_CONSOLE_CAPTURE=p,exports.DEFAULT_FLOATING_BUTTON=u,exports.DEFAULT_FLOATING_BUTTON_DOCK_ENTRY_ORDER=l,exports.DEFAULT_HIGHLIGHT_COLOR=o,exports.DEFAULT_HOTKEY=c,exports.DEFAULT_LABEL_TEXT_COLOR=s,exports.DEFAULT_MAGNIFIER=b,exports.DEFAULT_MEASURER=x,exports.DEFAULT_NETWORK_CAPTURE=y,exports.DEFAULT_REDACT_HEADERS=_,exports.DEFAULT_URL_DENY_LIST=v,exports.NETWORK_ERROR_CLASSES=h,exports.NETWORK_WARN_CLASSES=g,exports.OPEN_IN_EDITOR_ALLOWED_EDITORS=i,exports.OPEN_IN_EDITOR_CONTENT_TYPE=t,exports.OPEN_IN_EDITOR_ENDPOINT=e,exports.OPEN_IN_EDITOR_REQUEST_MAX_BYTES=n,exports.VUE_ERROR_EVENT=d,exports.VUE_GRAB_ROOT_GLOBAL=r,exports.isOpenInEditorAllowedEditor=a,exports.mergeConfig=C;

package/dist/index.mjs

@@ -31,7 +31,11 @@ var o = "#4f46e5", s = "#ffffff", c = "Alt+Shift+G", l = [
 	dockMode: "float",
 	dockEntries: {
 		order: [...l],
-		hidden: []
+		hidden: [
+			"magnifier",
+			"logs",
+			"network"
+		]
 	},
 	shortcuts: {
 		grab: [c],

package/package.json

@@ -1,9 +1,32 @@
 {
   "name": "@sakana-y/vue-grab-shared",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "private": false,
+  "description": "Shared types, defaults, config merging, and protocol constants for Vue Grab integrations.",
+  "keywords": [
+    "ai",
+    "configuration",
+    "devtools",
+    "protocol",
+    "types",
+    "vite",
+    "vue"
+  ],
+  "bugs": {
+    "url": "https://github.com/SaKaNa-Y/vue-grab/issues"
+  },
+  "license": "MIT",
+  "author": "SaKaNa-Y",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/SaKaNa-Y/vue-grab.git",
+    "directory": "packages/shared"
+  },
   "files": [
-    "dist"
+    "dist",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
   ],
   "type": "module",
   "main": "./dist/index.cjs",