@chuvenger/devdock 0.1.0

package/dist/types-DYQBDvfK.d.ts

@@ -0,0 +1,73 @@
+type DockPosition = "bottom-left" | "bottom-right" | "top-left" | "top-right";
+/** A navigable destination shown in the dock's "Routes" section. */
+interface DevRoute {
+    /** Path to navigate to, e.g. "/admin/users". */
+    path: string;
+    /** Human label. Defaults to `path`. */
+    label?: string;
+    /** Optional group heading to organize the list. */
+    group?: string;
+}
+/** A custom action shown in the dock's "Commands" section. */
+interface DevCommand {
+    /** Stable id (used as key). Defaults to `label`. */
+    id?: string;
+    /** Human label shown in the list. */
+    label: string;
+    /** Called when the command is selected. May be async. */
+    run: () => void | Promise<void>;
+    /** Optional group heading to organize the list. */
+    group?: string;
+    /** Keep the popup open after running (default: false — it closes). */
+    keepOpen?: boolean;
+}
+/** Framework-agnostic configuration for the dock. */
+interface DevDockOptions {
+    /** Routes to list. */
+    routes?: DevRoute[];
+    /** Custom commands to list. */
+    commands?: DevCommand[];
+    /**
+     * Whether the dock renders at all. Accepts a boolean or a predicate
+     * (re-evaluated on every `update`). When omitted, defaults to
+     * `process.env.NODE_ENV !== "production"`.
+     *
+     * @example enabled: () => location.search.includes("debug")
+     */
+    enabled?: boolean | (() => boolean);
+    /**
+     * How to navigate when a route is selected.
+     * Defaults to `window.location.assign(path)`.
+     */
+    onNavigate?: (path: string) => void;
+    /** Corner to anchor the button. Default: "bottom-left". */
+    position?: DockPosition;
+    /** Text on the floating button. Default: "DEV". */
+    label?: string;
+    /** Heading shown at the top of the popup. Default: "Dev Menu". */
+    title?: string;
+    /**
+     * Optional keyboard shortcut to toggle the popup, e.g. "mod+." or
+     * "ctrl+k". "mod" maps to ⌘ on Mac and Ctrl elsewhere. Default: none.
+     */
+    hotkey?: string | null;
+    /** Base z-index for the floating UI. Default: 2147483000. */
+    zIndex?: number;
+    /** Where to mount the dock. Default: `document.body`. */
+    container?: HTMLElement;
+    /**
+     * Render inside a shadow root so the host page's CSS can't affect the dock
+     * (and vice versa). Default: `true` where supported. Set `false` to render
+     * in the light DOM (e.g. if you want to style it from the page).
+     */
+    shadow?: boolean;
+}
+/** A live dock instance returned by {@link createDevDock}. */
+interface DevDockInstance {
+    /** Re-render with new options (merged over the current ones). */
+    update(options: DevDockOptions): void;
+    /** Remove the dock and all its listeners. */
+    destroy(): void;
+}
+
+export type { DevCommand as D, DevDockInstance as a, DevDockOptions as b, DevRoute as c, DockPosition as d };

package/package.json

@@ -0,0 +1,105 @@
+{
+  "name": "@chuvenger/devdock",
+  "version": "0.1.0",
+  "description": "A tiny dev-only floating button that opens a popup to jump between dev routes and run custom commands.",
+  "author": "Ruven Chu",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Chubacca/devdock.git"
+  },
+  "homepage": "https://github.com/Chubacca/devdock#readme",
+  "bugs": {
+    "url": "https://github.com/Chubacca/devdock/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "dev",
+    "devtools",
+    "developer",
+    "debug",
+    "react",
+    "svelte",
+    "react-router",
+    "navigation",
+    "command-palette"
+  ],
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./react": {
+      "types": "./dist/react.d.ts",
+      "import": "./dist/react.js",
+      "require": "./dist/react.cjs"
+    },
+    "./react-router": {
+      "types": "./dist/react-router.d.ts",
+      "import": "./dist/react-router.js",
+      "require": "./dist/react-router.cjs"
+    },
+    "./svelte": {
+      "types": "./dist/svelte.d.ts",
+      "import": "./dist/svelte.js",
+      "require": "./dist/svelte.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "changeset": "changeset",
+    "version": "changeset version",
+    "release": "bash ./.github/publish-packages.sh",
+    "prepublishOnly": "bun run build"
+  },
+  "peerDependencies": {
+    "react": ">=17",
+    "react-dom": ">=17",
+    "react-router-dom": ">=6",
+    "svelte": ">=4"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    },
+    "react-router-dom": {
+      "optional": true
+    },
+    "svelte": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@changesets/cli": "^3.0.2",
+    "@testing-library/jest-dom": "^6.4.8",
+    "@testing-library/react": "^16.0.0",
+    "@testing-library/user-event": "^14.5.2",
+    "@types/react": "^18.3.3",
+    "@types/react-dom": "^18.3.0",
+    "jsdom": "^24.1.1",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "react-router-dom": "^6.26.0",
+    "tsup": "^8.2.4",
+    "typescript": "^5.5.4",
+    "vitest": "^2.0.5"
+  }
+}