@gscdump/devframe 0.0.0-stage → 5.7.1

package/dist/sources/hosted.mjs

@@ -0,0 +1,118 @@
+import { bearerOf, dashboardOrigin, resolveCredential } from "../credential.mjs";
+import { readAccount } from "../account.mjs";
+import { parseRecordReadRefusal } from "@gscdump/contracts";
+import { createGscdumpV1Client, isGscdumpV1Error } from "@gscdump/sdk/v1";
+function rowsBody(dimension, path, window, rowLimit) {
+	return {
+		dimensions: [dimension],
+		filter: { _filters: [{
+			dimension: "date",
+			operator: "between",
+			expression: window.start,
+			expression2: window.end
+		}, {
+			dimension: "page",
+			operator: "equals",
+			expression: path
+		}] },
+		orderBy: dimension === "date" ? {
+			column: "date",
+			dir: "asc"
+		} : {
+			column: "clicks",
+			dir: "desc"
+		},
+		rowLimit
+	};
+}
+function createHostedSource(options, deps) {
+	const apiRoot = (options.apiRoot ?? deps.env.GSCDUMP_API_ROOT ?? "https://gscdump.com/api").replace(/\/+$/, "");
+	let ready = null;
+	async function sites() {
+		const read = await readSites();
+		if (read._tag === "Blocked") ready = null;
+		return read;
+	}
+	async function readSites() {
+		const credential = await resolveCredential({
+			apiKey: options.apiKey,
+			apiRoot: options.apiRoot,
+			env: deps.env,
+			readCliAuthentication: deps.readCliAuthentication
+		});
+		if (!credential) return {
+			_tag: "Blocked",
+			context: { _tag: "CredentialMissing" }
+		};
+		const account = await readAccount(credential, deps.fetch);
+		if (account._tag === "Rejected") return {
+			_tag: "Blocked",
+			context: {
+				_tag: "CredentialRejected",
+				source: credential.source
+			}
+		};
+		if (account._tag === "Unavailable") return {
+			_tag: "Blocked",
+			context: {
+				_tag: "Unavailable",
+				message: account.message
+			}
+		};
+		ready = {
+			credential,
+			client: createGscdumpV1Client({
+				apiRoot: credential.apiRoot,
+				credential: bearerOf(credential),
+				fetch: deps.fetch
+			})
+		};
+		return {
+			_tag: "Ok",
+			sites: account.sites
+		};
+	}
+	async function readRows(siteId, body) {
+		if (!ready) return {
+			_tag: "Unauthorized",
+			context: { _tag: "CredentialMissing" }
+		};
+		const { client, credential } = ready;
+		return client.queryAnalyticsRows({
+			params: { siteId },
+			body
+		}).then((response) => ({
+			_tag: "Ok",
+			rows: response.data.rows
+		}), (error) => {
+			if (!isGscdumpV1Error(error)) throw error;
+			const refusal = parseRecordReadRefusal(error.details);
+			if (refusal) return {
+				_tag: "Refused",
+				refusal
+			};
+			if (error.code === "rate_limited") return { _tag: "RateLimited" };
+			if (error.status === 401 || error.status === 403) return {
+				_tag: "Unauthorized",
+				context: {
+					_tag: "CredentialRejected",
+					source: credential.source
+				}
+			};
+			return {
+				_tag: "Failed",
+				message: error.message,
+				requestId: error.requestId ?? null
+			};
+		});
+	}
+	return {
+		sites,
+		dailyRows: (siteId, path, window) => readRows(siteId, rowsBody("date", path, window, 400)),
+		queryRows: (siteId, path, window, limit) => readRows(siteId, rowsBody("query", path, window, limit)),
+		get dashboardOrigin() {
+			return dashboardOrigin(ready?.credential.apiRoot ?? apiRoot);
+		}
+	};
+}
+export { createHostedSource };

package/dist/vite.d.mts

@@ -0,0 +1,17 @@
+import { GscdumpDevframeOptions } from "./index.mjs";
+import { createPluginFromDevframe } from "@vitejs/devtools-kit/node";
+/**
+ * The gscdump devframe as a Vite plugin. Vite DevTools mounts it as a dock.
+ *
+ * ```ts
+ * // vite.config.ts
+ * import { gscdump } from '@gscdump/devframe/vite'
+ *
+ * export default defineConfig({
+ *   devtools: true,
+ *   plugins: [gscdump({ site: 'example.com' })],
+ * })
+ * ```
+ */
+export declare function gscdump(options?: GscdumpDevframeOptions): ReturnType<typeof createPluginFromDevframe>;
+export { gscdump as default };

package/dist/vite.mjs

@@ -0,0 +1,6 @@
+import { createGscdumpDevframe } from "./index.mjs";
+import { createPluginFromDevframe } from "@vitejs/devtools-kit/node";
+function gscdump(options = {}) {
+	return createPluginFromDevframe(createGscdumpDevframe(options));
+}
+export { gscdump as default, gscdump };

package/package.json

@@ -1,6 +1,84 @@
 {
   "name": "@gscdump/devframe",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "type": "module",
+  "version": "5.7.1",
+  "description": "Search Console clicks, impressions, and queries for the page you are developing, in Vite DevTools and any devframe hub.",
+  "author": {
+    "name": "Harlan Wilton",
+    "email": "harlan@harlanzw.com",
+    "url": "https://harlanzw.com/"
+  },
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/harlan-zw",
+  "homepage": "https://github.com/harlan-zw/gscdump/tree/main/packages/devframe#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/harlan-zw/gscdump.git",
+    "directory": "packages/devframe"
+  },
+  "bugs": {
+    "url": "https://github.com/harlan-zw/gscdump/issues"
+  },
+  "keywords": [
+    "devframe",
+    "devframe-plugin",
+    "devtools",
+    "vite-devtools",
+    "google-search-console",
+    "seo"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs",
+      "default": "./dist/index.mjs"
+    },
+    "./vite": {
+      "types": "./dist/vite.d.mts",
+      "import": "./dist/vite.mjs",
+      "default": "./dist/vite.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=22.13.0"
+  },
+  "peerDependencies": {
+    "@vitejs/devtools-kit": ">=0.7.6"
+  },
+  "peerDependenciesMeta": {
+    "@vitejs/devtools-kit": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@gscdump/contracts": "^5.7.1",
+    "@gscdump/sdk": "^5.7.1",
+    "devframe": "^1.2.0",
+    "zod": "^4.6.5"
+  },
+  "devDependencies": {
+    "@types/chrome": "^0.3.4",
+    "@types/ws": "^8.18.2",
+    "@vitejs/devtools": "^0.7.6",
+    "@vitejs/devtools-kit": "^0.7.6",
+    "@vitejs/plugin-vue": "^6.0.9",
+    "typescript": "npm:@typescript/typescript6@^6.0.2",
+    "vite": "^8.3.2",
+    "vitest": "^5.0.1",
+    "vue": "^3.5.43",
+    "ws": "^8.22.0"
+  },
+  "scripts": {
+    "build": "obuild && vite build --config app/vite.config.ts && vite build --config src/client-script/vite.config.ts",
+    "dev": "vite --config playground/vite.config.ts",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest",
+    "build:extension": "vite build --config extension/vite.config.ts"
+  }
 }