@ogygia/devtools 0.0.0-stage → 0.11.0

package/dist/report.d.ts

@@ -0,0 +1,5 @@
+import { is_ogp, ogp_decode } from "./profiler/crypto.js";
+import { is_dump, report_json } from "./profiler/report.js";
+import { fix_impact } from "./profiler/patterns.js";
+import { Forecast } from "./profiler/forecast.js";
+export { type Forecast, fix_impact, is_dump, is_ogp, ogp_decode, report_json };

package/dist/report.js

@@ -0,0 +1,4 @@
+import { is_ogp, ogp_decode } from "./profiler/crypto.js";
+import { is_dump, report_json } from "./profiler/report.js";
+import { fix_impact } from "./profiler/patterns.js";
+export { fix_impact, is_dump, is_ogp, ogp_decode, report_json };

package/dist/server.d.ts

@@ -0,0 +1,11 @@
+import { ProfilerOptions } from "./profiler/index.js";
+import { ServerPlugin } from "@ogygia/core/plugin";
+/** What `devtools()` hands its server half (vite.config → `virtual:ogygia/server-plugins`). The
+ *  profiler's `secret` is here only when the app passed one (then it IS baked into the server build,
+ *  on purpose — a serverless host may have no runtime env); left out, the profiler reads
+ *  OGYGIA_PROFILER_SECRET at runtime. */
+export interface DevtoolsServerOptions {
+  profiler: ProfilerOptions | null;
+}
+declare const server: ServerPlugin<DevtoolsServerOptions>;
+export { server as default };

package/dist/server.js

@@ -0,0 +1,38 @@
+import { profiler_demand_skip } from "./profiler/on-demand.js";
+import { defineServer } from "@ogygia/core/plugin";
+import { want_request_stats } from "@ogygia/core/internal/server";
+// src/server.ts
+/** the mounted profiler; `undefined` until the first request resolves it, `null` when unavailable */
+let mounted;
+async function mount(options) {
+	if (mounted !== void 0) return mounted;
+	try {
+		const { profiler } = await import("./profiler/index.js");
+		const { getProfilerStore } = await import("./profiler/storage/index.js").catch(() => ({ getProfilerStore: () => void 0 }));
+		const store = getProfilerStore();
+		mounted = profiler({
+			...options,
+			...store ? { store } : {}
+		});
+	} catch {
+		mounted = null;
+	}
+	return mounted;
+}
+const server = defineServer({
+	setup(app) {
+		if (app.options.profiler) want_request_stats();
+	},
+	async handle({ event, options }, next) {
+		const config = options.profiler;
+		if (!config) return next();
+		if (profiler_demand_skip(!!config.onDemand, mounted !== void 0, event.url.pathname, config.path || "/__profiler")) return next();
+		const prof = await mount(config);
+		if (!prof) return next();
+		return prof({
+			event,
+			resolve: (_event, opts) => next(opts)
+		});
+	}
+});
+export { server as default };

package/dist/vite.d.ts

@@ -0,0 +1,12 @@
+import { ProfilerOptions } from "./profiler/index.js";
+import { DevtoolsServerOptions } from "./server.js";
+import { OgygiaPlugin } from "@ogygia/core/vite";
+import { Plugin } from "vite";
+export interface DevtoolsOptions {
+  /** The dock and core's events (default true). */
+  dock?: boolean;
+  /** The SSR profiler: `true` or its options (default off). */
+  profiler?: boolean | ProfilerOptions;
+}
+export declare function devtools(options?: DevtoolsOptions): [OgygiaPlugin<DevtoolsServerOptions>, Plugin];
+export type { ProfilerOptions };

package/dist/vite.js

@@ -0,0 +1,78 @@
+import fs from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { isMainThread } from "node:worker_threads";
+import { definePlugin } from "@ogygia/core/vite";
+// src/vite.ts
+/**
+* `devtools()` — the in-page dock and the SSR profiler, listed beside `ogygia()`
+* in vite.config. List it only where you want it:
+*
+*   plugins: [...(mode !== 'production' ? [devtools({ profiler: true })] : [])]
+*
+* - `dock` (default true): core's events compiled in, browser and server, and the dock that reads
+*   them (Alt+O). In a build the pages carry only a small launcher: the dock's code loads when
+*   someone opens it, and the page is measured from the next load on.
+* - `profiler` (default off): `true` or its options. The server half wraps every request, times the
+*   render and serves its UI at `/__profiler`; the build records what it reads (maps, island
+*   detail). Its secret defaults to the OGYGIA_PROFILER_SECRET env var at runtime.
+*/
+/** this package's directory (from `dist/vite.js` or `src/vite.ts`) */
+const PKG_ROOT = fileURLToPath(new URL("..", import.meta.url));
+/** the workspace checkout ships `src`; an install, `dist` */
+const FROM_SRC = fs.existsSync(path.join(PKG_ROOT, "src/profiler/profiler-router.ts"));
+const posix = (p) => p.split(path.sep).join("/");
+/** the server half's dynamic import of the profiler (src `.ts` or built `.js`) */
+const PROFILER_IMPORT_RE = /import\((['"])\.\/profiler\/index\.(ts|js)\1\)/;
+function devtools(options = {}) {
+	const dock = options.dock !== false;
+	const profiler = options.profiler ? options.profiler === true ? {} : { ...options.profiler } : null;
+	return [definePlugin({
+		name: "@ogygia/devtools",
+		server: import.meta.resolve("./server.js"),
+		client: import.meta.resolve("./client.js"),
+		options: { profiler },
+		build(b) {
+			if (dock) b.events({ lazy: !b.dev });
+			if (profiler) {
+				b.measure();
+				const profiler_router = path.join(PKG_ROOT, FROM_SRC ? "src/profiler/profiler-router.ts" : "dist/profiler/profiler-router.js");
+				b.files({
+					root: PKG_ROOT,
+					dirs: [path.join(PKG_ROOT, FROM_SRC ? "src/profiler/ui" : "dist/profiler/ui")],
+					files: [profiler_router]
+				});
+				b.pageModules({ files: [profiler_router] });
+			}
+		}
+	}), devtools_vite(dock, profiler)];
+}
+/** The plugin's own Vite side: its client dependencies for the dev optimizer, the build warnings, and
+*  the dev CSS-crawl guard on its server half. */
+function devtools_vite(dock, profiler) {
+	const server_ids = /* @__PURE__ */ new Set([posix(path.join(PKG_ROOT, "src/server.ts")), posix(path.join(PKG_ROOT, "dist/server.js"))]);
+	let dev = false;
+	return {
+		name: "ogygia:devtools",
+		enforce: "pre",
+		config(_config, env) {
+			dev = env.command === "serve";
+			if (env.command === "build" && isMainThread) {
+				if (dock) console.warn("[ogygia] devtools is ON for this build: its pages carry the devtools launcher (the dock loads only when opened). Keep it off for production: list `devtools()` only when `mode !== 'production'`.");
+				if (profiler && "secret" in profiler && !profiler.secret) console.warn("[ogygia] profiler: `profiler.secret` is EMPTY in this build — the variable it reads is not set in the BUILD environment. The UI will be DISABLED in production unless OGYGIA_PROFILER_SECRET exists at runtime (on Amplify / Lambda it does not): /__profiler will answer \"installed but disabled\". Set the variable where the build runs, and keep the `profiler` option unconditional.");
+			}
+			const out = {};
+			if (dock && env.command === "serve") out.optimizeDeps = { include: ["@ogygia/devtools > @neodrag/svelte", "@ogygia/devtools > @neodrag/svelte/resize"] };
+			if (profiler) out.ssr = { noExternal: ["@ogygia/router"] };
+			return out;
+		},
+		transform(code, id, opts) {
+			if (!dev || !opts?.ssr || !server_ids.has(id.split("?")[0])) return null;
+			return {
+				code: code.replace(PROFILER_IMPORT_RE, "import(/* @vite-ignore */ ((s) => s)($1./profiler/index.$2$1))"),
+				map: null
+			};
+		}
+	};
+}
+export { devtools };

package/package.json

@@ -1,6 +1,106 @@
 {
   "name": "@ogygia/devtools",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.11.0",
+  "description": "Devtools for ogygia: the in-page dock, and the SSR profiler with its report, client marks and storage adapters",
+  "keywords": [
+    "devtools",
+    "ogygia",
+    "performance",
+    "profiler",
+    "sveltekit"
+  ],
+  "homepage": "https://ogygiajs.dev",
+  "license": "MIT",
+  "author": "Puru Vijayvargia <devpuruvj@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ogygiajs/ogygia.git",
+    "directory": "packages/devtools"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/devtools/index.d.ts",
+      "svelte": "./dist/devtools/index.js",
+      "default": "./dist/devtools/index.js"
+    },
+    "./vite": {
+      "types": "./dist/vite.d.ts",
+      "default": "./dist/vite.js"
+    },
+    "./report": {
+      "types": "./dist/report.d.ts",
+      "default": "./dist/report.js"
+    },
+    "./profiler": {
+      "types": "./dist/profiler/span.d.ts",
+      "default": "./dist/profiler/span.js"
+    },
+    "./profiler/client": {
+      "types": "./dist/profiler/client.d.ts",
+      "default": "./dist/profiler/client.js"
+    },
+    "./profiler/storage": {
+      "types": "./dist/profiler/storage/index.d.ts",
+      "default": "./dist/profiler/storage/index.js"
+    },
+    "./profiler/storage/sqlite": {
+      "types": "./dist/profiler/storage/sqlite.d.ts",
+      "default": "./dist/profiler/storage/sqlite.js"
+    },
+    "./profiler/storage/redis": {
+      "types": "./dist/profiler/storage/redis.d.ts",
+      "default": "./dist/profiler/storage/redis.js"
+    },
+    "./profiler/storage/postgres": {
+      "types": "./dist/profiler/storage/postgres.d.ts",
+      "default": "./dist/profiler/storage/postgres.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@neodrag/svelte": "3.0.0-next.12",
+    "devalue": "^5.9.3"
+  },
+  "devDependencies": {
+    "@playwright/test": "1.62.1",
+    "@sveltejs/kit": "^2.70.2",
+    "@sveltejs/vite-plugin-svelte": "^7.2.0",
+    "@types/node": "^26.1.2",
+    "@typescript/native": "npm:typescript@^7.0.2",
+    "svelte": "5.56.8",
+    "svelte-check": "^4.7.4",
+    "tsdown": "^0.23.4",
+    "typescript": "^6.0.3",
+    "vite": "^8.3.5",
+    "vitest": "^4.1.12",
+    "@ogygia/core": "0.11.0",
+    "@ogygia/router": "0.11.0",
+    "@ogygia/tooling": "0.0.0",
+    "@ogygia/tsdown-plugin-svelte": "1.1.0"
+  },
+  "peerDependencies": {
+    "@sveltejs/kit": ">=2.70.2 <4",
+    "svelte": "^5.56.8",
+    "vite": "^8.2.4",
+    "@ogygia/core": "^0.11.0",
+    "@ogygia/router": "^0.11.0"
+  },
+  "peerDependenciesMeta": {
+    "@ogygia/router": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "tsdown",
+    "check": "tsc -p . && svelte-check --tsconfig ./tsconfig.check.json --fail-on-warnings && tsc -p test && tsc -p e2e && vitest run",
+    "test": "vitest run",
+    "e2e": "playwright test"
+  }
 }