diff --git a/.agents/skills/competitive-landscape/SKILL.md b/.agents/skills/competitive-landscape/SKILL.md index 40c3f71..0883708 100644 --- a/.agents/skills/competitive-landscape/SKILL.md +++ b/.agents/skills/competitive-landscape/SKILL.md @@ -21,10 +21,11 @@ Use this when the user wants a market-level view across several competitors. For ## OpenSEO MCP tools - `research_keywords`: discover representative market queries. -- `get_keyword_search_volume`: validate known query sets and trend/metric priority. +- `get_keyword_metrics`: validate known query sets with volume, difficulty, intent, and trends. - `get_serp_results`: identify recurring ranking domains across target queries. - `find_serp_competitors`: compare domains competing across supplied keywords; use this before manual SERP counting when a keyword set is available. - `get_domain_overview`: size organic footprint for candidate leaders. +- `get_search_console_performance`: when the user's own domain is in the comparison and Search Console is connected, anchor their position with first-party clicks/impressions/CTR rather than third-party estimates. - `get_ranked_keywords`: find exact ranking keywords, URLs, ranks, intents, and SERP result types for leaders. - `get_backlinks_overview`: compare backlink/referring-domain strength where relevant. - `search_local_businesses`, `get_local_serp_results`, and `get_google_business_questions`: use for local SEO markets where proximity, Maps rankings, business categories, reviews, or Google Q&A affect who is winning. @@ -35,7 +36,7 @@ Use this when the user wants a market-level view across several competitors. For - Use provided keywords, or call `research_keywords` to build 5-10 representative queries. - Include mixed intent: informational, commercial, comparison, and tool/software terms when applicable. - For local SEO, include neighborhood/city/service-area queries and identify the priority locations or coordinates. -2. If the query set is already known, use `get_keyword_search_volume` to validate relative demand and `find_serp_competitors` to identify recurring domains at scale. +2. If the query set is already known, use `get_keyword_metrics` to validate relative demand and difficulty and `find_serp_competitors` to identify recurring domains at scale. 3. For local SEO, call `search_local_businesses` and `get_local_serp_results` for the highest-priority location(s) before synthesizing winners. Use `get_serp_results` as a complement for organic pages, not as the only local evidence. 4. Call `get_serp_results` for representative queries when live SERP composition, ranking URLs, or SERP features need inspection. Send at most 10 queries per call. 5. Identify recurring domains and group them by type: diff --git a/.agents/skills/competitor-analysis/SKILL.md b/.agents/skills/competitor-analysis/SKILL.md index 2d16955..1ca9333 100644 --- a/.agents/skills/competitor-analysis/SKILL.md +++ b/.agents/skills/competitor-analysis/SKILL.md @@ -21,6 +21,7 @@ Use this for a named competitor. For identifying the market leaders first, use ` ## OpenSEO MCP tools - `get_domain_overview`: baseline organic traffic and keyword count. +- `get_search_console_performance`: when comparing to the user's own domain and Search Console is connected, use it as the first-party baseline (real clicks/impressions/CTR/position) instead of estimating the user's own performance from third-party data. - `get_ranked_keywords`: exact keyword, URL, rank, intent, traffic, CPC, and SERP-type rows for the competitor domain or page. - `get_backlinks_overview`: backlink/referring-domain profile. - `find_serp_competitors`: validate whether the named competitor is a real search competitor across the target keyword set. @@ -31,7 +32,7 @@ Use this for a named competitor. For identifying the market leaders first, use ` ## Workflow 1. Call `get_domain_overview` for the competitor, passing provided location/language when supported. -2. If comparing to the user, call `get_domain_overview` for the user's domain too. +2. If comparing to the user, call `get_domain_overview` for the user's domain too — and if Search Console is connected, `get_search_console_performance` for the user's real baseline. 3. Call `get_ranked_keywords` for the competitor. Use filters like `maxRank`, `minSearchVolume`, `excludeBrandTerms`, and `resultTypes` to keep rows relevant. 4. If comparing to the user, call `get_ranked_keywords` for the user's domain/page too, or use `get_serp_results` for the shared terms when a lighter check is enough. 5. For local SEO, use `search_local_businesses` and `get_local_serp_results` around the relevant business location(s) before drawing local-pack conclusions. Add `get_google_business_questions` only when Q&A evidence matters. diff --git a/.agents/skills/keyword-clustering/SKILL.md b/.agents/skills/keyword-clustering/SKILL.md index 936dbdf..0fbadf7 100644 --- a/.agents/skills/keyword-clustering/SKILL.md +++ b/.agents/skills/keyword-clustering/SKILL.md @@ -22,6 +22,7 @@ If keywords are not provided, use `list_saved_keywords` for saved sets, `researc - `list_saved_keywords`: fetch an existing keyword set, optionally filtered by tags. - `research_keywords`: expand a seed when the user starts from a topic. - `get_ranked_keywords`: gather exact ranking keywords and URLs when the user starts from a domain or page. +- `get_search_console_performance`: when Search Console is connected, pull real queries with `dimensions: ["query","page"]` to map terms to the pages already earning impressions and to surface cannibalization (one query splitting clicks across multiple URLs). - `get_serp_results`: validate whether keywords belong on the same page by checking SERP overlap and intent. - `get_local_serp_results`: use for local SEO clusters when Maps/local-pack intent should affect page mapping. - `save_keywords`: optionally tag final clusters after user confirmation. @@ -29,6 +30,7 @@ If keywords are not provided, use `list_saved_keywords` for saved sets, `researc ## Workflow 1. Gather the candidate keyword set. + - Use `get_search_console_performance` (dimensions `["query","page"]`) when Search Console is connected to start from real queries and the pages already ranking for them. - Use `get_ranked_keywords` for domain/page-driven clustering. - Use `search_local_businesses` and `get_local_serp_results` when proximity, local packs, or Google Business results determine whether terms belong on location pages. 2. Remove duplicates, irrelevant terms, and terms that clearly require a different product or audience. @@ -41,7 +43,7 @@ If keywords are not provided, use `list_saved_keywords` for saved sets, `researc - Existing URL, if supplied and appropriate - New page recommendation, if no existing page fits - Do-not-target / later bucket, if weak or off-strategy -6. Identify cannibalization risk when multiple pages would target the same intent. +6. Identify cannibalization risk when multiple pages would target the same intent. When Search Console is connected, confirm it from real data with `get_search_console_performance` (`dimensions: ["query","page"]`) — the same query sending impressions to multiple URLs. 7. Ask before applying cluster tags with `save_keywords`. ## Output format diff --git a/.agents/skills/keyword-research/SKILL.md b/.agents/skills/keyword-research/SKILL.md index 4a864ec..4bdfc40 100644 --- a/.agents/skills/keyword-research/SKILL.md +++ b/.agents/skills/keyword-research/SKILL.md @@ -20,8 +20,9 @@ If `projectId` is missing, use `list_projects` first. If the target market/locat ## OpenSEO MCP tools - `research_keywords`: primary discovery tool. Use 1-5 seeds per call and prefer 150 results unless the user asks for exhaustive research. -- `get_keyword_search_volume`: validate known keywords, compare CPC/competition, or refresh monthly trends without broad discovery. +- `get_keyword_metrics`: hydrate up to 700 known keywords with volume, keyword difficulty (KD), search intent, CPC, and monthly trends in one call. Use it to score candidate or known terms — including the Search Console striking-distance queries from step 1. - `get_ranked_keywords`: pull exact ranking keyword rows when a target domain or page is part of the research brief. +- `get_search_console_performance`: when Search Console is connected, start from the project's real first-party demand — queries already earning impressions and near-ranking ("striking distance") terms. Request a high `rowLimit` and filter average position 5-20 client-side, since the API sorts by clicks and can't filter by position. Then hydrate those striking-distance queries with `get_keyword_metrics` to attach difficulty and intent. - `get_serp_results`: inspect SERPs for the top candidate terms, especially when intent is ambiguous. - `search_local_businesses`, `get_local_serp_results`, and `get_google_business_questions`: use for local SEO topics when a business/location radius matters. - `list_saved_keywords`: avoid duplicating already-saved work or use existing tags as context. @@ -29,10 +30,10 @@ If `projectId` is missing, use `list_projects` first. If the target market/locat ## Workflow -1. Normalize seeds into a small set of distinct research angles. +1. Normalize seeds into a small set of distinct research angles. If Search Console is connected for the project, first pull `get_search_console_performance` (high `rowLimit`, default lookback), filter to striking-distance positions (~5–20) client-side, and hydrate those queries with `get_keyword_metrics` to attach KD and intent. That ranked, hydrated list is your fastest opportunity set — work it before broad discovery. 2. If the request is local SEO, identify the business, location/coordinates or service area, and local categories. Use `search_local_businesses` and `get_local_serp_results` for the most important location/keyword set instead of relying only on national keyword/SERP data. 3. Call `research_keywords` for exploratory seeds. Use bulk calls when possible. -4. Use `get_keyword_search_volume` when the user provides a fixed keyword list or when exact known-term metrics/trends are more useful than related-keyword expansion. +4. Use `get_keyword_metrics` to hydrate a fixed keyword list — or the striking-distance queries from step 1 — with volume, KD, and intent before prioritizing. 5. Use `get_ranked_keywords` when the user provides a domain/page and wants opportunities based on current rankings, near-misses, or competitor-owned terms. 6. Remove irrelevant, duplicate, branded-only, and off-intent terms. 7. Prioritize by practical opportunity, not volume alone: diff --git a/.agents/skills/seo-coach/SKILL.md b/.agents/skills/seo-coach/SKILL.md index 9899b12..8688416 100644 --- a/.agents/skills/seo-coach/SKILL.md +++ b/.agents/skills/seo-coach/SKILL.md @@ -37,7 +37,7 @@ Good starting points: ## What each workflow does -- `seo-project-setup`: sets up the workspace, verifies MCP, captures goals, positioning, and GSC exports. +- `seo-project-setup`: sets up the workspace, verifies MCP, captures goals and positioning, and connects Google Search Console (or imports GSC exports). - `keyword-research`: finds search opportunities from seed topics and evaluates volume, difficulty, CPC, intent, and SERPs. - `keyword-clustering`: groups keywords by intent and maps clusters to existing or proposed pages. - `competitive-landscape`: identifies who wins across a market and what content/backlink patterns are working. @@ -49,6 +49,7 @@ Good starting points: Explain the difference between data sources: - OpenSEO MCP tools provide SEO data such as keyword research, exact ranked keywords, search volume, SERPs, SERP competitors, local business and Maps data, domain overviews, backlinks, saved keywords, projects, and rank trackers. +- Google Search Console (when connected on the project's Integrations page) is the user's own first-party data — real clicks, impressions, CTR, and position. Read it live with `get_search_console_performance` instead of asking for CSV exports. It's free (no credits) and the best starting point for "what already ranks" and near-ranking opportunities. - Web search can find current market context, recent pages, reviews, docs, social profiles, and contact paths outside OpenSEO. - Browser/page scraping can extract page copy, headings, author names, contact links, schema, and content structure. - Local files can preserve strategy, GSC CSVs, content briefs, crawls, prospect lists, and prior decisions over time. diff --git a/.agents/skills/seo-project-setup/SKILL.md b/.agents/skills/seo-project-setup/SKILL.md index e35397d..9101f14 100644 --- a/.agents/skills/seo-project-setup/SKILL.md +++ b/.agents/skills/seo-project-setup/SKILL.md @@ -94,9 +94,13 @@ After the user has described the company, website, goals, and positioning, check Do not run research tools just to test connectivity; `whoami` and `list_projects` are enough. -### 6. Request Google Search Console export +### 6. Connect Google Search Console -Ask the user to export a CSV from Google Search Console and place it in the SEO working folder. +GSC is the richest first-party signal: existing impressions, near-ranking terms, cannibalization, and pages that already have search demand. + +**Preferred (hosted): connect it natively.** On the project's Integrations page, connect Google Search Console and pull live data with `get_search_console_performance`. Once connected, the agent reads it directly in `keyword-research` and `keyword-clustering` — no manual files to maintain. + +**Fallback (self-hosted, or if the user prefers files):** ask the user to export CSVs from Search Console into the SEO working folder. Recommended exports: @@ -114,8 +118,6 @@ gsc/queries-last-16-months.csv gsc/pages-last-16-months.csv ``` -Explain that GSC data reveals existing impressions, near-ranking terms, cannibalization, and pages that already have search demand. - ### 7. Inventory existing assets Ask for or discover: @@ -158,6 +160,6 @@ Then summarize: ## Guardrails - Keep setup lightweight. The user should feel oriented, not assigned homework. -- Do not pretend a GSC CSV has been uploaded unless you can see it. +- Do not pretend a GSC CSV has been uploaded unless you can see it, and do not claim Search Console is connected unless `get_search_console_performance` confirms it (it returns a "not connected" message otherwise). - Keep project setup focused on setup and context unless the user asks for live research. - If web search or scraping is used for positioning research, distinguish source evidence from inference. diff --git a/adr/0003-google-search-console-integration.md b/adr/0003-google-search-console-integration.md new file mode 100644 index 0000000..96c44f4 --- /dev/null +++ b/adr/0003-google-search-console-integration.md @@ -0,0 +1,37 @@ +# Google Search Console integration + +## Status + +Accepted + +## Context + +Users previously got Search Console data into OpenSEO by manually exporting CSVs. We want the agent to read a project's real first-party search data (clicks, impressions, CTR, position) directly. Google does not charge for this data, so it should not consume credits the way DataForSEO does. + +## Decision + +Add a native GSC connection plus two read-only MCP tools. + +**Auth (incremental OAuth grant).** Connecting requests a read-only Search Console scope through a dedicated Better Auth `genericOAuth` provider (`google-search-console`), separate from logging in with Google. `allowDifferentEmails` lets a user connect a Google account whose email differs from their OpenSEO login (an agency connecting a client). OAuth tokens are encrypted at rest. + +**Scoping.** A connection maps one verified property to one project (`gsc_connections`, unique per project). The connection belongs to the project/workspace; any member can query it, and requests run under the connecting member's grant. Property selection lives in the Integrations UI (account dropdown), not an MCP tool. + +**MCP tools** — read-only, free (no Autumn metering), scoped to a project the caller's workspace owns: + +- `get_search_console_performance`: thin pass-through of Search Analytics (group by query/page/country/device/date, simple AND filters, ≤1000 rows with offset paging, 16-month and ~3-day-lag clamps). +- `inspect_urls`: URL Inspection for 1–10 URLs with per-URL partial results; connection-level failures (not connected / expired grant) abort the call with a reconnect prompt. + +Whether an inspected URL belongs to the property is enforced by Google's API, not re-checked locally, so both `sc-domain:` and URL-prefix properties work. + +**Disconnect** removes the project's property mapping and unlinks the OAuth grant only when its connector has no other connected project — never as a side effect of a different member disconnecting. + +## Rationale + +Leaning on Better Auth's incremental OAuth keeps token storage and refresh out of feature code. Per-project property mapping matches how teams work (a different site per project) and keeps queries scoped to a workspace the caller owns. Treating GSC reads as free reflects that Google doesn't bill for them and makes connecting an activation hook rather than a metered cost. + +## Consequences + +- The read-only scope is a Google "sensitive" scope: until the OAuth app clears verification, only test users can connect and their grant expires ~weekly. +- "Connected by" surfaces the OpenSEO member who connected, not the Google account's email. +- One property per project (re-selecting replaces it); no history or caching — every query hits Google live. +- New GSC capabilities should extend `GscService` and the MCP tools, keeping reads free and project-scoped. diff --git a/drizzle/0019_true_absorbing_man.sql b/drizzle/0019_true_absorbing_man.sql new file mode 100644 index 0000000..113d74b --- /dev/null +++ b/drizzle/0019_true_absorbing_man.sql @@ -0,0 +1,16 @@ +CREATE TABLE `gsc_connections` ( + `id` text PRIMARY KEY NOT NULL, + `project_id` text NOT NULL, + `organization_id` text NOT NULL, + `site_url` text NOT NULL, + `connected_by_user_id` text NOT NULL, + `connected_account_email` text, + `created_at` text DEFAULT (current_timestamp) NOT NULL, + `updated_at` text DEFAULT (current_timestamp) NOT NULL, + FOREIGN KEY (`project_id`) REFERENCES `projects`(`id`) ON UPDATE no action ON DELETE cascade, + FOREIGN KEY (`organization_id`) REFERENCES `organization`(`id`) ON UPDATE no action ON DELETE cascade +); +--> statement-breakpoint +CREATE UNIQUE INDEX `gsc_connections_project_idx` ON `gsc_connections` (`project_id`);--> statement-breakpoint +CREATE INDEX `gsc_connections_organization_idx` ON `gsc_connections` (`organization_id`);--> statement-breakpoint +ALTER TABLE `user_onboarding_answers` ADD `gsc_nudge_dismissed_at` text; \ No newline at end of file diff --git a/drizzle/meta/0019_snapshot.json b/drizzle/meta/0019_snapshot.json new file mode 100644 index 0000000..7dbd6ca --- /dev/null +++ b/drizzle/meta/0019_snapshot.json @@ -0,0 +1,2568 @@ +{ + "version": "6", + "dialect": "sqlite", + "id": "a19ea19a-33fb-4180-bf79-fa704388d24a", + "prevId": "0356fb98-b07a-48a9-b12d-25015fcec53f", + "tables": { + "audit_lighthouse_results": { + "name": "audit_lighthouse_results", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true, + "autoincrement": false + }, + "audit_id": { + "name": "audit_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "page_id": { + "name": "page_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "strategy": { + "name": "strategy", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "performance_score": { + "name": "performance_score", + "type": "integer", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "accessibility_score": { + "name": "accessibility_score", + "type": "integer", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "best_practices_score": { + "name": "best_practices_score", + "type": "integer", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "seo_score": { + "name": "seo_score", + "type": "integer", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "lcp_ms": { + "name": "lcp_ms", + "type": "real", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "cls": { + "name": "cls", + "type": "real", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "inp_ms": { + "name": "inp_ms", + "type": "real", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "ttfb_ms": { + "name": "ttfb_ms", + "type": "real", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "error_message": { + "name": "error_message", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "r2_key": { + "name": "r2_key", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "payload_size_bytes": { + "name": "payload_size_bytes", + "type": "integer", + "primaryKey": false, + "notNull": false, + "autoincrement": false + } + }, + "indexes": { + "audit_lighthouse_results_audit_id_idx": { + "name": "audit_lighthouse_results_audit_id_idx", + "columns": [ + "audit_id" + ], + "isUnique": false + } + }, + "foreignKeys": { + "audit_lighthouse_results_audit_id_audits_id_fk": { + "name": "audit_lighthouse_results_audit_id_audits_id_fk", + "tableFrom": "audit_lighthouse_results", + "tableTo": "audits", + "columnsFrom": [ + "audit_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "audit_lighthouse_results_page_id_audit_pages_id_fk": { + "name": "audit_lighthouse_results_page_id_audit_pages_id_fk", + "tableFrom": "audit_lighthouse_results", + "tableTo": "audit_pages", + "columnsFrom": [ + "page_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "audit_pages": { + "name": "audit_pages", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true, + "autoincrement": false + }, + "audit_id": { + "name": "audit_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "url": { + "name": "url", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "status_code": { + "name": "status_code", + "type": "integer", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "redirect_url": { + "name": "redirect_url", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "meta_description": { + "name": "meta_description", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "canonical_url": { + "name": "canonical_url", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "robots_meta": { + "name": "robots_meta", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "og_title": { + "name": "og_title", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "og_description": { + "name": "og_description", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "og_image": { + "name": "og_image", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "h1_count": { + "name": "h1_count", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": 0 + }, + "h2_count": { + "name": "h2_count", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": 0 + }, + "h3_count": { + "name": "h3_count", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": 0 + }, + "h4_count": { + "name": "h4_count", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": 0 + }, + "h5_count": { + "name": "h5_count", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": 0 + }, + "h6_count": { + "name": "h6_count", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": 0 + }, + "heading_order_json": { + "name": "heading_order_json", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "word_count": { + "name": "word_count", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": 0 + }, + "images_total": { + "name": "images_total", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": 0 + }, + "images_missing_alt": { + "name": "images_missing_alt", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": 0 + }, + "images_json": { + "name": "images_json", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "internal_link_count": { + "name": "internal_link_count", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": 0 + }, + "external_link_count": { + "name": "external_link_count", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": 0 + }, + "has_structured_data": { + "name": "has_structured_data", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": false + }, + "hreflang_tags_json": { + "name": "hreflang_tags_json", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "is_indexable": { + "name": "is_indexable", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": true + }, + "response_time_ms": { + "name": "response_time_ms", + "type": "integer", + "primaryKey": false, + "notNull": false, + "autoincrement": false + } + }, + "indexes": { + "audit_pages_audit_id_idx": { + "name": "audit_pages_audit_id_idx", + "columns": [ + "audit_id" + ], + "isUnique": false + } + }, + "foreignKeys": { + "audit_pages_audit_id_audits_id_fk": { + "name": "audit_pages_audit_id_audits_id_fk", + "tableFrom": "audit_pages", + "tableTo": "audits", + "columnsFrom": [ + "audit_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "audits": { + "name": "audits", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true, + "autoincrement": false + }, + "project_id": { + "name": "project_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "started_by_user_id": { + "name": "started_by_user_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "start_url": { + "name": "start_url", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "status": { + "name": "status", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "'running'" + }, + "workflow_instance_id": { + "name": "workflow_instance_id", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "config": { + "name": "config", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "'{}'" + }, + "pages_crawled": { + "name": "pages_crawled", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": 0 + }, + "pages_total": { + "name": "pages_total", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": 0 + }, + "lighthouse_total": { + "name": "lighthouse_total", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": 0 + }, + "lighthouse_completed": { + "name": "lighthouse_completed", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": 0 + }, + "lighthouse_failed": { + "name": "lighthouse_failed", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": 0 + }, + "current_phase": { + "name": "current_phase", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false, + "default": "'discovery'" + }, + "started_at": { + "name": "started_at", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(current_timestamp)" + }, + "completed_at": { + "name": "completed_at", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + } + }, + "indexes": { + "audits_project_id_idx": { + "name": "audits_project_id_idx", + "columns": [ + "project_id" + ], + "isUnique": false + }, + "audits_started_by_user_id_idx": { + "name": "audits_started_by_user_id_idx", + "columns": [ + "started_by_user_id" + ], + "isUnique": false + } + }, + "foreignKeys": { + "audits_project_id_projects_id_fk": { + "name": "audits_project_id_projects_id_fk", + "tableFrom": "audits", + "tableTo": "projects", + "columnsFrom": [ + "project_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "delegated_users": { + "name": "delegated_users", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true, + "autoincrement": false + }, + "email": { + "name": "email", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "created_at": { + "name": "created_at", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(current_timestamp)" + } + }, + "indexes": { + "delegated_users_email_unique": { + "name": "delegated_users_email_unique", + "columns": [ + "email" + ], + "isUnique": true + } + }, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "keyword_metrics": { + "name": "keyword_metrics", + "columns": { + "id": { + "name": "id", + "type": "integer", + "primaryKey": true, + "notNull": true, + "autoincrement": true + }, + "project_id": { + "name": "project_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "keyword": { + "name": "keyword", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "location_code": { + "name": "location_code", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "language_code": { + "name": "language_code", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "'en'" + }, + "search_volume": { + "name": "search_volume", + "type": "integer", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "cpc": { + "name": "cpc", + "type": "real", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "competition": { + "name": "competition", + "type": "real", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "keyword_difficulty": { + "name": "keyword_difficulty", + "type": "integer", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "intent": { + "name": "intent", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "monthly_searches": { + "name": "monthly_searches", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "fetched_at": { + "name": "fetched_at", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(current_timestamp)" + } + }, + "indexes": { + "keyword_metrics_unique_project_keyword_location_language": { + "name": "keyword_metrics_unique_project_keyword_location_language", + "columns": [ + "project_id", + "keyword", + "location_code", + "language_code" + ], + "isUnique": true + }, + "keyword_metrics_lookup_idx": { + "name": "keyword_metrics_lookup_idx", + "columns": [ + "project_id", + "keyword", + "location_code", + "language_code", + "fetched_at" + ], + "isUnique": false + } + }, + "foreignKeys": { + "keyword_metrics_project_id_projects_id_fk": { + "name": "keyword_metrics_project_id_projects_id_fk", + "tableFrom": "keyword_metrics", + "tableTo": "projects", + "columnsFrom": [ + "project_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "projects": { + "name": "projects", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true, + "autoincrement": false + }, + "organization_id": { + "name": "organization_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "domain": { + "name": "domain", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "created_at": { + "name": "created_at", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(current_timestamp)" + } + }, + "indexes": { + "projects_one_default_per_organization_idx": { + "name": "projects_one_default_per_organization_idx", + "columns": [ + "organization_id" + ], + "isUnique": true, + "where": "\"projects\".\"name\" = 'Default' AND \"projects\".\"domain\" IS NULL" + } + }, + "foreignKeys": { + "projects_organization_id_organization_id_fk": { + "name": "projects_organization_id_organization_id_fk", + "tableFrom": "projects", + "tableTo": "organization", + "columnsFrom": [ + "organization_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "rank_check_runs": { + "name": "rank_check_runs", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true, + "autoincrement": false + }, + "config_id": { + "name": "config_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "project_id": { + "name": "project_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "status": { + "name": "status", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "'pending'" + }, + "keywords_total": { + "name": "keywords_total", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": 0 + }, + "keywords_checked": { + "name": "keywords_checked", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": 0 + }, + "is_subset_run": { + "name": "is_subset_run", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": false + }, + "error_message": { + "name": "error_message", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "started_at": { + "name": "started_at", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(current_timestamp)" + }, + "completed_at": { + "name": "completed_at", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + } + }, + "indexes": { + "rank_check_runs_config_idx": { + "name": "rank_check_runs_config_idx", + "columns": [ + "config_id", + "started_at" + ], + "isUnique": false + }, + "rank_check_runs_project_idx": { + "name": "rank_check_runs_project_idx", + "columns": [ + "project_id", + "started_at" + ], + "isUnique": false + }, + "rank_check_runs_one_active_per_config_idx": { + "name": "rank_check_runs_one_active_per_config_idx", + "columns": [ + "config_id" + ], + "isUnique": true, + "where": "\"rank_check_runs\".\"status\" IN ('pending', 'running')" + } + }, + "foreignKeys": { + "rank_check_runs_config_id_rank_tracking_configs_id_fk": { + "name": "rank_check_runs_config_id_rank_tracking_configs_id_fk", + "tableFrom": "rank_check_runs", + "tableTo": "rank_tracking_configs", + "columnsFrom": [ + "config_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "rank_check_runs_project_id_projects_id_fk": { + "name": "rank_check_runs_project_id_projects_id_fk", + "tableFrom": "rank_check_runs", + "tableTo": "projects", + "columnsFrom": [ + "project_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "rank_snapshots": { + "name": "rank_snapshots", + "columns": { + "id": { + "name": "id", + "type": "integer", + "primaryKey": true, + "notNull": true, + "autoincrement": true + }, + "run_id": { + "name": "run_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "tracking_keyword_id": { + "name": "tracking_keyword_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "keyword": { + "name": "keyword", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "device": { + "name": "device", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "position": { + "name": "position", + "type": "integer", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "url": { + "name": "url", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "serp_features": { + "name": "serp_features", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "checked_at": { + "name": "checked_at", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(current_timestamp)" + } + }, + "indexes": { + "rank_snapshots_run_idx": { + "name": "rank_snapshots_run_idx", + "columns": [ + "run_id" + ], + "isUnique": false + }, + "rank_snapshots_keyword_device_idx": { + "name": "rank_snapshots_keyword_device_idx", + "columns": [ + "tracking_keyword_id", + "device", + "checked_at" + ], + "isUnique": false + }, + "rank_snapshots_run_keyword_device_idx": { + "name": "rank_snapshots_run_keyword_device_idx", + "columns": [ + "run_id", + "tracking_keyword_id", + "device" + ], + "isUnique": true + } + }, + "foreignKeys": { + "rank_snapshots_run_id_rank_check_runs_id_fk": { + "name": "rank_snapshots_run_id_rank_check_runs_id_fk", + "tableFrom": "rank_snapshots", + "tableTo": "rank_check_runs", + "columnsFrom": [ + "run_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "rank_tracking_configs": { + "name": "rank_tracking_configs", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true, + "autoincrement": false + }, + "project_id": { + "name": "project_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "domain": { + "name": "domain", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "location_code": { + "name": "location_code", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": 2840 + }, + "language_code": { + "name": "language_code", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "'en'" + }, + "devices": { + "name": "devices", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "'both'" + }, + "serp_depth": { + "name": "serp_depth", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "schedule_interval": { + "name": "schedule_interval", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "'weekly'" + }, + "is_active": { + "name": "is_active", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": true + }, + "last_checked_at": { + "name": "last_checked_at", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "next_check_at": { + "name": "next_check_at", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "last_skip_reason": { + "name": "last_skip_reason", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "created_at": { + "name": "created_at", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(current_timestamp)" + } + }, + "indexes": { + "rank_tracking_configs_project_domain_location_idx": { + "name": "rank_tracking_configs_project_domain_location_idx", + "columns": [ + "project_id", + "domain", + "location_code" + ], + "isUnique": true + } + }, + "foreignKeys": { + "rank_tracking_configs_project_id_projects_id_fk": { + "name": "rank_tracking_configs_project_id_projects_id_fk", + "tableFrom": "rank_tracking_configs", + "tableTo": "projects", + "columnsFrom": [ + "project_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "rank_tracking_keywords": { + "name": "rank_tracking_keywords", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true, + "autoincrement": false + }, + "config_id": { + "name": "config_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "keyword": { + "name": "keyword", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "search_volume": { + "name": "search_volume", + "type": "integer", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "keyword_difficulty": { + "name": "keyword_difficulty", + "type": "integer", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "cpc": { + "name": "cpc", + "type": "real", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "metrics_fetched_at": { + "name": "metrics_fetched_at", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "created_at": { + "name": "created_at", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(current_timestamp)" + } + }, + "indexes": { + "rank_tracking_keywords_config_keyword_idx": { + "name": "rank_tracking_keywords_config_keyword_idx", + "columns": [ + "config_id", + "keyword" + ], + "isUnique": true + } + }, + "foreignKeys": { + "rank_tracking_keywords_config_id_rank_tracking_configs_id_fk": { + "name": "rank_tracking_keywords_config_id_rank_tracking_configs_id_fk", + "tableFrom": "rank_tracking_keywords", + "tableTo": "rank_tracking_configs", + "columnsFrom": [ + "config_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "saved_keyword_tag_assignments": { + "name": "saved_keyword_tag_assignments", + "columns": { + "saved_keyword_id": { + "name": "saved_keyword_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "tag_id": { + "name": "tag_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "created_at": { + "name": "created_at", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(current_timestamp)" + } + }, + "indexes": { + "saved_keyword_tag_assignments_unique_idx": { + "name": "saved_keyword_tag_assignments_unique_idx", + "columns": [ + "saved_keyword_id", + "tag_id" + ], + "isUnique": true + }, + "saved_keyword_tag_assignments_keyword_idx": { + "name": "saved_keyword_tag_assignments_keyword_idx", + "columns": [ + "saved_keyword_id" + ], + "isUnique": false + }, + "saved_keyword_tag_assignments_tag_idx": { + "name": "saved_keyword_tag_assignments_tag_idx", + "columns": [ + "tag_id" + ], + "isUnique": false + } + }, + "foreignKeys": { + "saved_keyword_tag_assignments_saved_keyword_id_saved_keywords_id_fk": { + "name": "saved_keyword_tag_assignments_saved_keyword_id_saved_keywords_id_fk", + "tableFrom": "saved_keyword_tag_assignments", + "tableTo": "saved_keywords", + "columnsFrom": [ + "saved_keyword_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "saved_keyword_tag_assignments_tag_id_saved_keyword_tags_id_fk": { + "name": "saved_keyword_tag_assignments_tag_id_saved_keyword_tags_id_fk", + "tableFrom": "saved_keyword_tag_assignments", + "tableTo": "saved_keyword_tags", + "columnsFrom": [ + "tag_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "saved_keyword_tags": { + "name": "saved_keyword_tags", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true, + "autoincrement": false + }, + "project_id": { + "name": "project_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "normalized_name": { + "name": "normalized_name", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "color": { + "name": "color", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "created_at": { + "name": "created_at", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(current_timestamp)" + } + }, + "indexes": { + "saved_keyword_tags_project_normalized_name_idx": { + "name": "saved_keyword_tags_project_normalized_name_idx", + "columns": [ + "project_id", + "normalized_name" + ], + "isUnique": true + }, + "saved_keyword_tags_project_name_idx": { + "name": "saved_keyword_tags_project_name_idx", + "columns": [ + "project_id", + "name" + ], + "isUnique": false + } + }, + "foreignKeys": { + "saved_keyword_tags_project_id_projects_id_fk": { + "name": "saved_keyword_tags_project_id_projects_id_fk", + "tableFrom": "saved_keyword_tags", + "tableTo": "projects", + "columnsFrom": [ + "project_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "saved_keywords": { + "name": "saved_keywords", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true, + "autoincrement": false + }, + "project_id": { + "name": "project_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "keyword": { + "name": "keyword", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "location_code": { + "name": "location_code", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": 2840 + }, + "language_code": { + "name": "language_code", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "'en'" + }, + "created_at": { + "name": "created_at", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(current_timestamp)" + } + }, + "indexes": { + "saved_keywords_unique_project_keyword_location_language": { + "name": "saved_keywords_unique_project_keyword_location_language", + "columns": [ + "project_id", + "keyword", + "location_code", + "language_code" + ], + "isUnique": true + }, + "saved_keywords_project_created_idx": { + "name": "saved_keywords_project_created_idx", + "columns": [ + "project_id", + "created_at" + ], + "isUnique": false + } + }, + "foreignKeys": { + "saved_keywords_project_id_projects_id_fk": { + "name": "saved_keywords_project_id_projects_id_fk", + "tableFrom": "saved_keywords", + "tableTo": "projects", + "columnsFrom": [ + "project_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "user_onboarding_answers": { + "name": "user_onboarding_answers", + "columns": { + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": true, + "notNull": true, + "autoincrement": false + }, + "organization_id": { + "name": "organization_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "interested_features": { + "name": "interested_features", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "'[]'" + }, + "work_for": { + "name": "work_for", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "client_website_count": { + "name": "client_website_count", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "found_via": { + "name": "found_via", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "mcp_setup_intent": { + "name": "mcp_setup_intent", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "completed_at": { + "name": "completed_at", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "gsc_nudge_dismissed_at": { + "name": "gsc_nudge_dismissed_at", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "created_at": { + "name": "created_at", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(current_timestamp)" + }, + "updated_at": { + "name": "updated_at", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(current_timestamp)" + } + }, + "indexes": { + "user_onboarding_answers_organization_idx": { + "name": "user_onboarding_answers_organization_idx", + "columns": [ + "organization_id" + ], + "isUnique": false + } + }, + "foreignKeys": { + "user_onboarding_answers_user_id_user_id_fk": { + "name": "user_onboarding_answers_user_id_user_id_fk", + "tableFrom": "user_onboarding_answers", + "tableTo": "user", + "columnsFrom": [ + "user_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "user_onboarding_answers_organization_id_organization_id_fk": { + "name": "user_onboarding_answers_organization_id_organization_id_fk", + "tableFrom": "user_onboarding_answers", + "tableTo": "organization", + "columnsFrom": [ + "organization_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "account": { + "name": "account", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true, + "autoincrement": false + }, + "account_id": { + "name": "account_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "provider_id": { + "name": "provider_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "access_token": { + "name": "access_token", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "refresh_token": { + "name": "refresh_token", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "id_token": { + "name": "id_token", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "access_token_expires_at": { + "name": "access_token_expires_at", + "type": "integer", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "refresh_token_expires_at": { + "name": "refresh_token_expires_at", + "type": "integer", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "scope": { + "name": "scope", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "password": { + "name": "password", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "created_at": { + "name": "created_at", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(cast(unixepoch('subsecond') * 1000 as integer))" + }, + "updated_at": { + "name": "updated_at", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false + } + }, + "indexes": { + "account_userId_idx": { + "name": "account_userId_idx", + "columns": [ + "user_id" + ], + "isUnique": false + } + }, + "foreignKeys": { + "account_user_id_user_id_fk": { + "name": "account_user_id_user_id_fk", + "tableFrom": "account", + "tableTo": "user", + "columnsFrom": [ + "user_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "invitation": { + "name": "invitation", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true, + "autoincrement": false + }, + "organization_id": { + "name": "organization_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "email": { + "name": "email", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "role": { + "name": "role", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "status": { + "name": "status", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "'pending'" + }, + "expires_at": { + "name": "expires_at", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "created_at": { + "name": "created_at", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(cast(unixepoch('subsecond') * 1000 as integer))" + }, + "inviter_id": { + "name": "inviter_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + } + }, + "indexes": { + "invitation_organizationId_idx": { + "name": "invitation_organizationId_idx", + "columns": [ + "organization_id" + ], + "isUnique": false + }, + "invitation_email_idx": { + "name": "invitation_email_idx", + "columns": [ + "email" + ], + "isUnique": false + } + }, + "foreignKeys": { + "invitation_organization_id_organization_id_fk": { + "name": "invitation_organization_id_organization_id_fk", + "tableFrom": "invitation", + "tableTo": "organization", + "columnsFrom": [ + "organization_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "invitation_inviter_id_user_id_fk": { + "name": "invitation_inviter_id_user_id_fk", + "tableFrom": "invitation", + "tableTo": "user", + "columnsFrom": [ + "inviter_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "member": { + "name": "member", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true, + "autoincrement": false + }, + "organization_id": { + "name": "organization_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "role": { + "name": "role", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "'member'" + }, + "created_at": { + "name": "created_at", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false + } + }, + "indexes": { + "member_organizationId_idx": { + "name": "member_organizationId_idx", + "columns": [ + "organization_id" + ], + "isUnique": false + }, + "member_userId_idx": { + "name": "member_userId_idx", + "columns": [ + "user_id" + ], + "isUnique": false + } + }, + "foreignKeys": { + "member_organization_id_organization_id_fk": { + "name": "member_organization_id_organization_id_fk", + "tableFrom": "member", + "tableTo": "organization", + "columnsFrom": [ + "organization_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "member_user_id_user_id_fk": { + "name": "member_user_id_user_id_fk", + "tableFrom": "member", + "tableTo": "user", + "columnsFrom": [ + "user_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "organization": { + "name": "organization", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true, + "autoincrement": false + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "slug": { + "name": "slug", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "logo": { + "name": "logo", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "created_at": { + "name": "created_at", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "metadata": { + "name": "metadata", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + } + }, + "indexes": { + "organization_slug_unique": { + "name": "organization_slug_unique", + "columns": [ + "slug" + ], + "isUnique": true + }, + "organization_slug_uidx": { + "name": "organization_slug_uidx", + "columns": [ + "slug" + ], + "isUnique": true + } + }, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "session": { + "name": "session", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true, + "autoincrement": false + }, + "expires_at": { + "name": "expires_at", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "token": { + "name": "token", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "created_at": { + "name": "created_at", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(cast(unixepoch('subsecond') * 1000 as integer))" + }, + "updated_at": { + "name": "updated_at", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "ip_address": { + "name": "ip_address", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "user_agent": { + "name": "user_agent", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "active_organization_id": { + "name": "active_organization_id", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + } + }, + "indexes": { + "session_token_unique": { + "name": "session_token_unique", + "columns": [ + "token" + ], + "isUnique": true + }, + "session_userId_idx": { + "name": "session_userId_idx", + "columns": [ + "user_id" + ], + "isUnique": false + } + }, + "foreignKeys": { + "session_user_id_user_id_fk": { + "name": "session_user_id_user_id_fk", + "tableFrom": "session", + "tableTo": "user", + "columnsFrom": [ + "user_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "user": { + "name": "user", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true, + "autoincrement": false + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "email": { + "name": "email", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "email_verified": { + "name": "email_verified", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": false + }, + "image": { + "name": "image", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "created_at": { + "name": "created_at", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(cast(unixepoch('subsecond') * 1000 as integer))" + }, + "updated_at": { + "name": "updated_at", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(cast(unixepoch('subsecond') * 1000 as integer))" + }, + "analytics_opted_out": { + "name": "analytics_opted_out", + "type": "integer", + "primaryKey": false, + "notNull": false, + "autoincrement": false + } + }, + "indexes": { + "user_email_unique": { + "name": "user_email_unique", + "columns": [ + "email" + ], + "isUnique": true + } + }, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "verification": { + "name": "verification", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true, + "autoincrement": false + }, + "identifier": { + "name": "identifier", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "value": { + "name": "value", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "expires_at": { + "name": "expires_at", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "created_at": { + "name": "created_at", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(cast(unixepoch('subsecond') * 1000 as integer))" + }, + "updated_at": { + "name": "updated_at", + "type": "integer", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(cast(unixepoch('subsecond') * 1000 as integer))" + } + }, + "indexes": { + "verification_identifier_idx": { + "name": "verification_identifier_idx", + "columns": [ + "identifier" + ], + "isUnique": false + } + }, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "gsc_connections": { + "name": "gsc_connections", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true, + "autoincrement": false + }, + "project_id": { + "name": "project_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "organization_id": { + "name": "organization_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "site_url": { + "name": "site_url", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "connected_by_user_id": { + "name": "connected_by_user_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "connected_account_email": { + "name": "connected_account_email", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "created_at": { + "name": "created_at", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(current_timestamp)" + }, + "updated_at": { + "name": "updated_at", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(current_timestamp)" + } + }, + "indexes": { + "gsc_connections_project_idx": { + "name": "gsc_connections_project_idx", + "columns": [ + "project_id" + ], + "isUnique": true + }, + "gsc_connections_organization_idx": { + "name": "gsc_connections_organization_idx", + "columns": [ + "organization_id" + ], + "isUnique": false + } + }, + "foreignKeys": { + "gsc_connections_project_id_projects_id_fk": { + "name": "gsc_connections_project_id_projects_id_fk", + "tableFrom": "gsc_connections", + "tableTo": "projects", + "columnsFrom": [ + "project_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "gsc_connections_organization_id_organization_id_fk": { + "name": "gsc_connections_organization_id_organization_id_fk", + "tableFrom": "gsc_connections", + "tableTo": "organization", + "columnsFrom": [ + "organization_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + }, + "reddit_attributions": { + "name": "reddit_attributions", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true, + "autoincrement": false + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "organization_id": { + "name": "organization_id", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false + }, + "click_id": { + "name": "click_id", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "uuid": { + "name": "uuid", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "landing_page": { + "name": "landing_page", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "referrer": { + "name": "referrer", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "utm_source": { + "name": "utm_source", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "utm_medium": { + "name": "utm_medium", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "utm_campaign": { + "name": "utm_campaign", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "utm_term": { + "name": "utm_term", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "utm_content": { + "name": "utm_content", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "signup_sent_at": { + "name": "signup_sent_at", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "purchase_sent_at": { + "name": "purchase_sent_at", + "type": "text", + "primaryKey": false, + "notNull": false, + "autoincrement": false + }, + "created_at": { + "name": "created_at", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(current_timestamp)" + }, + "updated_at": { + "name": "updated_at", + "type": "text", + "primaryKey": false, + "notNull": true, + "autoincrement": false, + "default": "(current_timestamp)" + } + }, + "indexes": { + "reddit_attributions_user_idx": { + "name": "reddit_attributions_user_idx", + "columns": [ + "user_id" + ], + "isUnique": true + }, + "reddit_attributions_organization_idx": { + "name": "reddit_attributions_organization_idx", + "columns": [ + "organization_id" + ], + "isUnique": false + } + }, + "foreignKeys": { + "reddit_attributions_user_id_user_id_fk": { + "name": "reddit_attributions_user_id_user_id_fk", + "tableFrom": "reddit_attributions", + "tableTo": "user", + "columnsFrom": [ + "user_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "reddit_attributions_organization_id_organization_id_fk": { + "name": "reddit_attributions_organization_id_organization_id_fk", + "tableFrom": "reddit_attributions", + "tableTo": "organization", + "columnsFrom": [ + "organization_id" + ], + "columnsTo": [ + "id" + ], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "checkConstraints": {} + } + }, + "views": {}, + "enums": {}, + "_meta": { + "schemas": {}, + "tables": {}, + "columns": {} + }, + "internal": { + "indexes": {} + } +} \ No newline at end of file diff --git a/drizzle/meta/_journal.json b/drizzle/meta/_journal.json index 0b4077c..c7c3c1c 100644 --- a/drizzle/meta/_journal.json +++ b/drizzle/meta/_journal.json @@ -134,6 +134,13 @@ "when": 1779849000462, "tag": "0018_minor_mad_thinker", "breakpoints": true + }, + { + "idx": 19, + "version": "6", + "when": 1780519331717, + "tag": "0019_true_absorbing_man", + "breakpoints": true } ] } \ No newline at end of file diff --git a/src/client/features/ai-mcp/AvailableTools.tsx b/src/client/features/ai-mcp/AvailableTools.tsx index f1fda82..df9447a 100644 --- a/src/client/features/ai-mcp/AvailableTools.tsx +++ b/src/client/features/ai-mcp/AvailableTools.tsx @@ -24,9 +24,10 @@ const toolCategories: ToolCategory[] = [ description: "Read tracked keyword positions.", }, { - name: "get_keyword_search_volume", - title: "Get keyword search volume", - description: "Check Google Ads volume and CPC for keyword demand.", + name: "get_keyword_metrics", + title: "Get keyword metrics", + description: + "Volume, difficulty, intent, CPC, and trends for any keyword list.", }, { name: "list_saved_keywords", @@ -95,6 +96,23 @@ const toolCategories: ToolCategory[] = [ }, ], }, + { + label: "Search Console", + tools: [ + { + name: "get_search_console_performance", + title: "Get Search Console performance", + description: + "Read clicks, impressions, CTR, and position from Search Console.", + }, + { + name: "inspect_urls", + title: "Inspect URLs", + description: + "Check index status, crawl, and canonical for up to 10 URLs.", + }, + ], + }, ]; export function AvailableTools() { diff --git a/src/client/features/gsc/GoogleGlyph.tsx b/src/client/features/gsc/GoogleGlyph.tsx new file mode 100644 index 0000000..474d971 --- /dev/null +++ b/src/client/features/gsc/GoogleGlyph.tsx @@ -0,0 +1,28 @@ +/** Google "G" brand mark, shared across the Search Console connect surfaces. */ +export function GoogleGlyph({ className }: { className?: string }) { + return ( + + ); +} diff --git a/src/client/features/gsc/GscReEngagementModal.tsx b/src/client/features/gsc/GscReEngagementModal.tsx new file mode 100644 index 0000000..0cb80ac --- /dev/null +++ b/src/client/features/gsc/GscReEngagementModal.tsx @@ -0,0 +1,124 @@ +import * as React from "react"; +import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query"; +import { Modal } from "@/client/components/Modal"; +import { GoogleGlyph } from "@/client/features/gsc/GoogleGlyph"; +import { startGscLink } from "@/client/features/gsc/startGscLink"; +import { onboardingAnswersQueryOptions } from "@/client/features/onboarding/onboardingModel"; +import { captureClientEvent } from "@/client/lib/posthog"; +import { isHostedClientAuthMode } from "@/lib/auth-mode"; +import { getGscGrantStatus } from "@/serverFunctions/gsc"; +import { dismissGscNudge } from "@/serverFunctions/onboarding"; + +/** + * One-time re-engagement prompt nudging users who finished onboarding *before* + * the Search Console step existed to connect GSC. Hosted-only (the connect flow + * needs Better Auth). Shows once — server-persisted dismissal means it never + * reappears after the user connects or dismisses, on any device. + * + * `suppressed` lets the layout hide this when another modal (e.g. the missing + * DataForSEO key prompt) is already showing so the two never stack. + */ +export function GscReEngagementModal({ + projectId, + suppressed, +}: { + projectId: string | null; + suppressed: boolean; +}) { + const hosted = isHostedClientAuthMode(); + const queryClient = useQueryClient(); + const [closed, setClosed] = React.useState(false); + const shownRef = React.useRef(false); + + const onboardingQuery = useQuery({ + ...onboardingAnswersQueryOptions(), + enabled: hosted, + }); + const grantQuery = useQuery({ + queryKey: ["gscGrantStatus"], + queryFn: () => getGscGrantStatus(), + enabled: hosted, + }); + + const dismissMutation = useMutation({ + mutationFn: () => dismissGscNudge(), + onSettled: () => { + void queryClient.invalidateQueries({ queryKey: ["onboardingAnswers"] }); + }, + }); + + const eligible = + hosted && + !suppressed && + !closed && + onboardingQuery.isSuccess && + grantQuery.isSuccess && + Boolean(onboardingQuery.data?.completedAt) && + !onboardingQuery.data?.gscNudgeDismissedAt && + !grantQuery.data?.connected; + + React.useEffect(() => { + if (eligible && !shownRef.current) { + shownRef.current = true; + captureClientEvent("gsc:nudge_shown"); + } + }, [eligible]); + + if (!eligible) return null; + + function persistDismiss() { + setClosed(true); + dismissMutation.mutate(); + } + + function handleDismiss() { + captureClientEvent("gsc:nudge_dismissed"); + persistDismiss(); + } + + function handleConnect() { + captureClientEvent("gsc:nudge_connect_clicked"); + // Resolve the nudge up front: the user is leaving for Google's consent + // screen, and on return they'll either have a grant (which suppresses this + // anyway) or have abandoned it — neither case should re-nag. + persistDismiss(); + // Land them on the project's Integrations page so they can pick a property + // right after granting access (the grant alone has no property bound yet). + const callbackURL = projectId + ? `${window.location.origin}/p/${projectId}/integrations` + : window.location.href; + void startGscLink(callbackURL); + } + + return ( + +
+

+ New: Connect Google Search Console +

+

+ Bring your real clicks, impressions, and rankings into OpenSEO and + query them from Claude or Codex over MCP. It's free. +

+
+ +
+ + +
+ + ); +} diff --git a/src/client/features/gsc/SearchConsoleConnectionCard.tsx b/src/client/features/gsc/SearchConsoleConnectionCard.tsx new file mode 100644 index 0000000..be79adc --- /dev/null +++ b/src/client/features/gsc/SearchConsoleConnectionCard.tsx @@ -0,0 +1,253 @@ +import * as React from "react"; +import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query"; +import { toast } from "sonner"; +import { isHostedClientAuthMode } from "@/lib/auth-mode"; +import { getStandardErrorMessage } from "@/client/lib/error-messages"; +import { captureClientEvent } from "@/client/lib/posthog"; +import { GoogleGlyph } from "@/client/features/gsc/GoogleGlyph"; +import { SitePicker } from "@/client/features/gsc/SitePicker"; +import { startGscLink } from "@/client/features/gsc/startGscLink"; +import { + disconnectGsc, + getGscConnection, + listGscSites, + setGscSite, +} from "@/serverFunctions/gsc"; + +const GRANT_STATUS_KEY = ["gscGrantStatus"]; + +export function SearchConsoleConnectionCard({ + projectId, +}: { + projectId: string; +}) { + const hosted = isHostedClientAuthMode(); + const queryClient = useQueryClient(); + const [picking, setPicking] = React.useState(false); + const [selectedSiteUrl, setSelectedSiteUrl] = React.useState(""); + + const connectionKey = ["gscConnection", projectId]; + const connectionQuery = useQuery({ + queryKey: connectionKey, + queryFn: () => getGscConnection({ data: { projectId } }), + enabled: hosted, + }); + const connection = connectionQuery.data; + const connected = Boolean(connection?.connected); + + const showPicker = picking || (connection?.currentUserHasGrant && !connected); + const sitesQuery = useQuery({ + queryKey: ["gscSites", projectId], + queryFn: () => listGscSites({ data: { projectId } }), + enabled: Boolean(showPicker), + }); + + const setSiteMutation = useMutation({ + mutationFn: (siteUrl: string) => + setGscSite({ data: { projectId, siteUrl } }), + onSuccess: () => { + captureClientEvent("gsc:property_select"); + toast.success("Search Console connected"); + setPicking(false); + void queryClient.invalidateQueries({ queryKey: connectionKey }); + void queryClient.invalidateQueries({ queryKey: GRANT_STATUS_KEY }); + }, + onError: (error) => toast.error(getStandardErrorMessage(error)), + }); + + const disconnectMutation = useMutation({ + mutationFn: () => disconnectGsc({ data: { projectId } }), + onSuccess: () => { + toast.success("Search Console disconnected"); + setPicking(false); + void queryClient.invalidateQueries({ queryKey: connectionKey }); + // Disconnect can drop the account-level grant server-side; keep the + // shared grant-status cache (onboarding step + re-engagement nudge) honest. + void queryClient.invalidateQueries({ queryKey: GRANT_STATUS_KEY }); + }, + onError: (error) => toast.error(getStandardErrorMessage(error)), + }); + + const handleConnect = () => void startGscLink(window.location.href); + + if (!hosted) { + return ( + +

+ Available on hosted OpenSEO. Self-hosted? Use a CSV export. +

+ + ); + } + + return ( + + {connectionQuery.isLoading ? ( +
+ + Checking… +
+ ) : connected && !picking ? ( + { + setSelectedSiteUrl(connection?.siteUrl ?? ""); + setPicking(true); + }} + onDisconnect={() => disconnectMutation.mutate()} + disconnecting={disconnectMutation.isPending} + /> + ) : showPicker ? ( + + selectedSiteUrl && setSiteMutation.mutate(selectedSiteUrl) + } + saving={setSiteMutation.isPending} + onReconnect={handleConnect} + secondaryAction={ + connected + ? { label: "Cancel", onClick: () => setPicking(false) } + : { + label: "Disconnect", + destructive: true, + disabled: disconnectMutation.isPending, + onClick: () => disconnectMutation.mutate(), + } + } + /> + ) : ( +
+

+ Real clicks, impressions, and rankings. Free. +

+ +
+ )} + + ); +} + +// --------------------------------------------------------------------------- +// Card shell +// --------------------------------------------------------------------------- + +function IntegrationCard({ + status, + children, +}: { + status?: "connected" | "disconnected"; + children: React.ReactNode; +}) { + return ( +
+
+
+

+ Google Search Console +

+

+ Your search data, straight from Google. +

+
+ {status ? : null} +
+
{children}
+
+ ); +} + +function StatusPill({ status }: { status: "connected" | "disconnected" }) { + const connected = status === "connected"; + return ( + + + {connected ? "Connected" : "Not connected"} + + ); +} + +// --------------------------------------------------------------------------- +// Connected state +// --------------------------------------------------------------------------- + +function ConnectedState({ + siteUrl, + connectedByEmail, + onChange, + onDisconnect, + disconnecting, +}: { + siteUrl: string; + connectedByEmail: string | null; + onChange: () => void; + onDisconnect: () => void; + disconnecting: boolean; +}) { + return ( +
+
+
+ +
+
+

{siteUrl}

+ {connectedByEmail ? ( +

+ Connected by {connectedByEmail} +

+ ) : null} +
+
+
+ + +
+
+ ); +} diff --git a/src/client/features/gsc/SitePicker.tsx b/src/client/features/gsc/SitePicker.tsx new file mode 100644 index 0000000..187aba0 --- /dev/null +++ b/src/client/features/gsc/SitePicker.tsx @@ -0,0 +1,119 @@ +import { GoogleGlyph } from "@/client/features/gsc/GoogleGlyph"; + +type SiteOption = { + siteUrl: string; + permissionLevel: string; + selectable: boolean; + isSelected: boolean; +}; + +type SecondaryAction = { + label: string; + onClick: () => void; + destructive?: boolean; + disabled?: boolean; +}; + +/** + * Verified-property selector for a connected Google account. Shared by the + * Integrations card and the onboarding step. `secondaryAction` is optional — + * omit it where there's nothing to cancel/disconnect (e.g. onboarding). + */ +export function SitePicker({ + loading, + error, + sites, + selectedSiteUrl, + onSelect, + onSave, + saving, + onReconnect, + secondaryAction, +}: { + loading: boolean; + error: boolean; + sites: SiteOption[]; + selectedSiteUrl: string; + onSelect: (siteUrl: string) => void; + onSave: () => void; + saving: boolean; + onReconnect: () => void; + secondaryAction?: SecondaryAction; +}) { + if (loading) { + return ( +
+ + Loading properties… +
+ ); + } + if (error) { + return ( +
+

+ Connection expired. Reconnect to continue. +

+ +
+ ); + } + return ( +
+ +
+ + {secondaryAction ? ( + + ) : null} +
+
+ ); +} diff --git a/src/client/features/gsc/startGscLink.ts b/src/client/features/gsc/startGscLink.ts new file mode 100644 index 0000000..4de8837 --- /dev/null +++ b/src/client/features/gsc/startGscLink.ts @@ -0,0 +1,29 @@ +import { toast } from "sonner"; +import { getStandardErrorMessage } from "@/client/lib/error-messages"; +import { authClient } from "@/lib/auth-client"; +import { GSC_OAUTH_PROVIDER_ID } from "@/shared/gsc"; + +/** + * Kick off the incremental Google Search Console OAuth grant. On success this + * redirects the whole page to Google's consent screen; `callbackURL` is where + * Google returns the user afterward. Shared by the connect card, the onboarding + * step, and the re-engagement nudge so the link/error/redirect flow stays in + * one place — callers keep their own analytics/dismissal at the call site. + */ +export async function startGscLink(callbackURL: string): Promise { + try { + const res = await authClient.oauth2.link({ + providerId: GSC_OAUTH_PROVIDER_ID, + callbackURL, + }); + if (res.error) { + toast.error(res.error.message ?? "Could not start Google sign-in"); + return; + } + if (res.data?.url) { + window.location.href = res.data.url; + } + } catch (error) { + toast.error(getStandardErrorMessage(error)); + } +} diff --git a/src/client/features/onboarding/PostSignupOnboarding.tsx b/src/client/features/onboarding/PostSignupOnboarding.tsx index 6dbb17b..a522e70 100644 --- a/src/client/features/onboarding/PostSignupOnboarding.tsx +++ b/src/client/features/onboarding/PostSignupOnboarding.tsx @@ -5,10 +5,12 @@ import { CLIENT_WEBSITE_COUNT_OPTIONS, CLIENT_WORK_FOR, INTEREST_OPTIONS, + ONBOARDING_LAST_STEP, type OnboardingAnswers, SOURCE_OPTIONS, WORK_FOR_OPTIONS, } from "@/client/features/onboarding/onboardingModel"; +import { SearchConsoleOnboardingStep } from "@/client/features/onboarding/SearchConsoleOnboardingStep"; type PostSignupOnboardingProps = { firstName: string; @@ -62,7 +64,7 @@ export function PostSignupOnboarding({ className="mx-auto size-10 rounded-lg" />

- Step {step + 1} of 4 + Step {step + 1} of {ONBOARDING_LAST_STEP + 1}

{title ?? @@ -120,6 +122,8 @@ export function PostSignupOnboarding({ otherValue={answers.sourceOther} onOtherChange={(sourceOther) => updateAnswers({ sourceOther })} /> + ) : step === 3 ? ( + ) : ( )} - {step < 3 ? ( + {step < ONBOARDING_LAST_STEP ? (
+ ); +} + +function Checking() { + return ( +
+ + Checking… +
+ ); +} diff --git a/src/client/features/onboarding/onboardingModel.ts b/src/client/features/onboarding/onboardingModel.ts index 2224327..7cc9ff5 100644 --- a/src/client/features/onboarding/onboardingModel.ts +++ b/src/client/features/onboarding/onboardingModel.ts @@ -1,7 +1,7 @@ import { queryOptions } from "@tanstack/react-query"; import { getOnboardingAnswers } from "@/serverFunctions/onboarding"; -export const ONBOARDING_LAST_STEP = 3; +export const ONBOARDING_LAST_STEP = 4; export const INTEREST_OPTIONS = [ "AI workflows with Claude or Codex (MCP)", diff --git a/src/client/layout/AppShell.tsx b/src/client/layout/AppShell.tsx index 34c8f22..bd041f9 100644 --- a/src/client/layout/AppShell.tsx +++ b/src/client/layout/AppShell.tsx @@ -7,6 +7,7 @@ import { CircleHelp, CreditCard, Menu, + Plug, Settings, User, } from "lucide-react"; @@ -15,7 +16,11 @@ import { MissingSeoSetupModal, SeoApiStatusBanners, } from "@/client/layout/AppShellParts"; -import { getProjectNavGroups } from "@/client/navigation/items"; +import { GscReEngagementModal } from "@/client/features/gsc/GscReEngagementModal"; +import { + getProjectNavGroups, + integrationsLinkOptions, +} from "@/client/navigation/items"; import { signOutAndRedirect, useSession } from "@/lib/auth-client"; import { isHostedClientAuthMode } from "@/lib/auth-mode"; import { BILLING_ROUTE } from "@/shared/billing"; @@ -138,6 +143,11 @@ export function AuthenticatedAppLayout({ isOpen={shouldShowMissingSeoApiKeyModal} onClose={() => setShowMissingSeoApiKeyModal(false)} /> + +
); } @@ -290,16 +300,22 @@ function TopNav({ - + - + ); } -function AccountMenu({ mobileOnly = false }: { mobileOnly?: boolean }) { +function AccountMenu({ + mobileOnly = false, + projectId, +}: { + mobileOnly?: boolean; + projectId?: string | null; +}) { const { data: session } = useSession(); const isHostedMode = isHostedClientAuthMode(); const email = session?.user?.email; @@ -344,6 +360,17 @@ function AccountMenu({ mobileOnly = false }: { mobileOnly?: boolean }) { ) : null} + {projectId ? ( +
  • + + + Integrations + +
    • + ) : null}
  • diff --git a/src/client/navigation/items.ts b/src/client/navigation/items.ts index 9635dff..74158fc 100644 --- a/src/client/navigation/items.ts +++ b/src/client/navigation/items.ts @@ -120,6 +120,16 @@ export function getProjectNavGroups(projectId: string) { ]; } +// Integrations is a setup surface, so it lives in the account dropdown rather +// than the workflow nav — but it's still project-scoped (a property is bound +// per project), hence the projectId param. +export function integrationsLinkOptions(projectId: string) { + return linkOptions({ + to: "/p/$projectId/integrations" as const, + params: { projectId }, + }); +} + export const dataforseoHelpLinkOptions = linkOptions({ to: "/help/dataforseo-api-key", }); diff --git a/src/db/app.schema.ts b/src/db/app.schema.ts index 5300e51..3a1cbf9 100644 --- a/src/db/app.schema.ts +++ b/src/db/app.schema.ts @@ -34,6 +34,10 @@ export const userOnboardingAnswers = sqliteTable( foundVia: text("found_via"), mcpSetupIntent: text("mcp_setup_intent"), completedAt: text("completed_at"), + // Set when the user dismisses (or acts on) the one-time "connect Search + // Console" nudge shown to people who finished onboarding before the GSC + // step existed. Null = never shown/dismissed. + gscNudgeDismissedAt: text("gsc_nudge_dismissed_at"), createdAt: text("created_at") .notNull() .default(sql`(current_timestamp)`), diff --git a/src/db/gsc.schema.ts b/src/db/gsc.schema.ts new file mode 100644 index 0000000..6257581 --- /dev/null +++ b/src/db/gsc.schema.ts @@ -0,0 +1,38 @@ +import { sqliteTable, text, uniqueIndex, index } from "drizzle-orm/sqlite-core"; +import { sql } from "drizzle-orm"; +import { organization } from "./better-auth-schema"; +import { projects } from "./app.schema"; + +// Connected Google Search Console property per project (hosted-only). +// OAuth tokens live in the better-auth `account` table under providerId +// "google-search-console"; this row only records which verified property maps +// to a project and whose grant to use when calling the GSC API. +export const gscConnections = sqliteTable( + "gsc_connections", + { + id: text("id").primaryKey(), + projectId: text("project_id") + .notNull() + .references(() => projects.id, { onDelete: "cascade" }), + organizationId: text("organization_id") + .notNull() + .references(() => organization.id, { onDelete: "cascade" }), + // Stored verbatim from sites.list — "sc-domain:example.com" or + // "https://example.com/". Never normalize; GSC matches it byte-for-byte. + siteUrl: text("site_url").notNull(), + // Whose google-search-console grant getAccessToken should use. + connectedByUserId: text("connected_by_user_id").notNull(), + connectedAccountEmail: text("connected_account_email"), + createdAt: text("created_at") + .notNull() + .default(sql`(current_timestamp)`), + updatedAt: text("updated_at") + .notNull() + .default(sql`(current_timestamp)`), + }, + (table) => [ + // One selected property per project in v1; switching replaces the row. + uniqueIndex("gsc_connections_project_idx").on(table.projectId), + index("gsc_connections_organization_idx").on(table.organizationId), + ], +); diff --git a/src/db/schema.ts b/src/db/schema.ts index 1dc1f9b..af34761 100644 --- a/src/db/schema.ts +++ b/src/db/schema.ts @@ -1,3 +1,4 @@ export * from "./app.schema"; export * from "./better-auth-schema"; +export * from "./gsc.schema"; export * from "./reddit-attribution.schema"; diff --git a/src/lib/auth-client.ts b/src/lib/auth-client.ts index f30dfb1..c128aa4 100644 --- a/src/lib/auth-client.ts +++ b/src/lib/auth-client.ts @@ -1,5 +1,6 @@ import { createAuthClient } from "better-auth/react"; import { + genericOAuthClient, inferAdditionalFields, organizationClient, } from "better-auth/client/plugins"; @@ -11,6 +12,7 @@ export const authClient = createAuthClient({ baseURL: typeof window !== "undefined" ? window.location.origin : "", plugins: [ organizationClient(), + genericOAuthClient(), inferAdditionalFields({ user: userAdditionalFields }), ], }); diff --git a/src/lib/auth-config.ts b/src/lib/auth-config.ts index 52703bb..a53abb2 100644 --- a/src/lib/auth-config.ts +++ b/src/lib/auth-config.ts @@ -1,9 +1,47 @@ -import { organization } from "better-auth/plugins"; +import { env } from "cloudflare:workers"; +import { genericOAuth, organization } from "better-auth/plugins"; import { baseAuthOptions } from "@/lib/auth-options"; +import { GSC_OAUTH_PROVIDER_ID } from "@/shared/gsc"; + +/** Read-only Search Console scope. openid/email/profile are also required — + * the genericOAuth callback rejects with `name_is_missing` without a name claim. */ +const GSC_OAUTH_SCOPES = [ + "openid", + "email", + "profile", + "https://www.googleapis.com/auth/webmasters.readonly", +]; export function createBaseAuthConfig() { return { ...baseAuthOptions, - plugins: [organization()], + account: { + // Encrypt OAuth access/refresh tokens at rest in D1. Also covers the + // google social-login tokens; the key derives from BETTER_AUTH_SECRET. + encryptOAuthTokens: true, + accountLinking: { + // Allow connecting a Google account whose email differs from the + // logged-in user's (agency/freelancer managing a client's property). + allowDifferentEmails: true, + }, + }, + plugins: [ + organization(), + genericOAuth({ + config: [ + { + providerId: GSC_OAUTH_PROVIDER_ID, + clientId: env.GOOGLE_CLIENT_ID?.trim() ?? "", + clientSecret: env.GOOGLE_CLIENT_SECRET?.trim() ?? "", + discoveryUrl: + "https://accounts.google.com/.well-known/openid-configuration", + scopes: GSC_OAUTH_SCOPES, + accessType: "offline", // request a refresh token + prompt: "consent", // force refresh-token issuance on re-consent + pkce: true, + }, + ], + }), + ], }; } diff --git a/src/lib/auth-mode.ts b/src/lib/auth-mode.ts index f8053b3..6dfa903 100644 --- a/src/lib/auth-mode.ts +++ b/src/lib/auth-mode.ts @@ -24,5 +24,9 @@ export function isHostedClientAuthMode() { } export function isEmailVerificationBypassed() { + // Local-dev escape hatch (BYPASS_EMAIL_VERIFICATION=true). The server skips + // verification and never marks users emailVerified, so the client must treat + // the session as verified too — otherwise route guards and /verify-email + // bounce each other in an infinite redirect loop. return import.meta.env.BYPASS_EMAIL_VERIFICATION === "true"; } diff --git a/src/routeTree.gen.ts b/src/routeTree.gen.ts index 694028a..b4fa29f 100644 --- a/src/routeTree.gen.ts +++ b/src/routeTree.gen.ts @@ -36,6 +36,7 @@ import { Route as ProjectPProjectIdSavedRouteImport } from './routes/_project/p/ import { Route as ProjectPProjectIdRankTrackingRouteImport } from './routes/_project/p/$projectId/rank-tracking' import { Route as ProjectPProjectIdPromptExplorerRouteImport } from './routes/_project/p/$projectId/prompt-explorer' import { Route as ProjectPProjectIdKeywordsRouteImport } from './routes/_project/p/$projectId/keywords' +import { Route as ProjectPProjectIdIntegrationsRouteImport } from './routes/_project/p/$projectId/integrations' import { Route as ProjectPProjectIdDomainRouteImport } from './routes/_project/p/$projectId/domain' import { Route as ProjectPProjectIdBrandLookupRouteImport } from './routes/_project/p/$projectId/brand-lookup' import { Route as ProjectPProjectIdBacklinksRouteImport } from './routes/_project/p/$projectId/backlinks' @@ -181,6 +182,12 @@ const ProjectPProjectIdKeywordsRoute = path: '/keywords', getParentRoute: () => ProjectPProjectIdRouteRoute, } as any) +const ProjectPProjectIdIntegrationsRoute = + ProjectPProjectIdIntegrationsRouteImport.update({ + id: '/integrations', + path: '/integrations', + getParentRoute: () => ProjectPProjectIdRouteRoute, + } as any) const ProjectPProjectIdDomainRoute = ProjectPProjectIdDomainRouteImport.update({ id: '/domain', path: '/domain', @@ -251,6 +258,7 @@ export interface FileRoutesByFullPath { '/p/$projectId/backlinks': typeof ProjectPProjectIdBacklinksRoute '/p/$projectId/brand-lookup': typeof ProjectPProjectIdBrandLookupRoute '/p/$projectId/domain': typeof ProjectPProjectIdDomainRoute + '/p/$projectId/integrations': typeof ProjectPProjectIdIntegrationsRoute '/p/$projectId/keywords': typeof ProjectPProjectIdKeywordsRoute '/p/$projectId/prompt-explorer': typeof ProjectPProjectIdPromptExplorerRoute '/p/$projectId/rank-tracking': typeof ProjectPProjectIdRankTrackingRouteWithChildren @@ -282,6 +290,7 @@ export interface FileRoutesByTo { '/p/$projectId/backlinks': typeof ProjectPProjectIdBacklinksRoute '/p/$projectId/brand-lookup': typeof ProjectPProjectIdBrandLookupRoute '/p/$projectId/domain': typeof ProjectPProjectIdDomainRoute + '/p/$projectId/integrations': typeof ProjectPProjectIdIntegrationsRoute '/p/$projectId/keywords': typeof ProjectPProjectIdKeywordsRoute '/p/$projectId/prompt-explorer': typeof ProjectPProjectIdPromptExplorerRoute '/p/$projectId/saved': typeof ProjectPProjectIdSavedRoute @@ -319,6 +328,7 @@ export interface FileRoutesById { '/_project/p/$projectId/backlinks': typeof ProjectPProjectIdBacklinksRoute '/_project/p/$projectId/brand-lookup': typeof ProjectPProjectIdBrandLookupRoute '/_project/p/$projectId/domain': typeof ProjectPProjectIdDomainRoute + '/_project/p/$projectId/integrations': typeof ProjectPProjectIdIntegrationsRoute '/_project/p/$projectId/keywords': typeof ProjectPProjectIdKeywordsRoute '/_project/p/$projectId/prompt-explorer': typeof ProjectPProjectIdPromptExplorerRoute '/_project/p/$projectId/rank-tracking': typeof ProjectPProjectIdRankTrackingRouteWithChildren @@ -354,6 +364,7 @@ export interface FileRouteTypes { | '/p/$projectId/backlinks' | '/p/$projectId/brand-lookup' | '/p/$projectId/domain' + | '/p/$projectId/integrations' | '/p/$projectId/keywords' | '/p/$projectId/prompt-explorer' | '/p/$projectId/rank-tracking' @@ -385,6 +396,7 @@ export interface FileRouteTypes { | '/p/$projectId/backlinks' | '/p/$projectId/brand-lookup' | '/p/$projectId/domain' + | '/p/$projectId/integrations' | '/p/$projectId/keywords' | '/p/$projectId/prompt-explorer' | '/p/$projectId/saved' @@ -421,6 +433,7 @@ export interface FileRouteTypes { | '/_project/p/$projectId/backlinks' | '/_project/p/$projectId/brand-lookup' | '/_project/p/$projectId/domain' + | '/_project/p/$projectId/integrations' | '/_project/p/$projectId/keywords' | '/_project/p/$projectId/prompt-explorer' | '/_project/p/$projectId/rank-tracking' @@ -636,6 +649,13 @@ declare module '@tanstack/react-router' { preLoaderRoute: typeof ProjectPProjectIdKeywordsRouteImport parentRoute: typeof ProjectPProjectIdRouteRoute } + '/_project/p/$projectId/integrations': { + id: '/_project/p/$projectId/integrations' + path: '/integrations' + fullPath: '/p/$projectId/integrations' + preLoaderRoute: typeof ProjectPProjectIdIntegrationsRouteImport + parentRoute: typeof ProjectPProjectIdRouteRoute + } '/_project/p/$projectId/domain': { id: '/_project/p/$projectId/domain' path: '/domain' @@ -757,6 +777,7 @@ interface ProjectPProjectIdRouteRouteChildren { ProjectPProjectIdBacklinksRoute: typeof ProjectPProjectIdBacklinksRoute ProjectPProjectIdBrandLookupRoute: typeof ProjectPProjectIdBrandLookupRoute ProjectPProjectIdDomainRoute: typeof ProjectPProjectIdDomainRoute + ProjectPProjectIdIntegrationsRoute: typeof ProjectPProjectIdIntegrationsRoute ProjectPProjectIdKeywordsRoute: typeof ProjectPProjectIdKeywordsRoute ProjectPProjectIdPromptExplorerRoute: typeof ProjectPProjectIdPromptExplorerRoute ProjectPProjectIdRankTrackingRoute: typeof ProjectPProjectIdRankTrackingRouteWithChildren @@ -770,6 +791,7 @@ const ProjectPProjectIdRouteRouteChildren: ProjectPProjectIdRouteRouteChildren = ProjectPProjectIdBacklinksRoute: ProjectPProjectIdBacklinksRoute, ProjectPProjectIdBrandLookupRoute: ProjectPProjectIdBrandLookupRoute, ProjectPProjectIdDomainRoute: ProjectPProjectIdDomainRoute, + ProjectPProjectIdIntegrationsRoute: ProjectPProjectIdIntegrationsRoute, ProjectPProjectIdKeywordsRoute: ProjectPProjectIdKeywordsRoute, ProjectPProjectIdPromptExplorerRoute: ProjectPProjectIdPromptExplorerRoute, ProjectPProjectIdRankTrackingRoute: diff --git a/src/routes/_app/ai.tsx b/src/routes/_app/ai.tsx index 82fa898..5d03e92 100644 --- a/src/routes/_app/ai.tsx +++ b/src/routes/_app/ai.tsx @@ -12,7 +12,7 @@ const DISCORD_URL = "https://discord.gg/c9uGs3cFXr"; const SUPPORT_EMAIL = "ben@openseo.so"; const SAM_GITHUB_URL = "https://github.com/every-app/sam"; const SKILL_NAMES = [ - "onboarding-checklist", + "seo-project-setup", "seo-coach", "keyword-research", "keyword-clustering", @@ -222,7 +222,7 @@ function AiPage() {

    Start with{" "} - /onboarding-checklist + /seo-project-setup . It will ask about your project and help configure your workspace. diff --git a/src/routes/_project/p/$projectId/integrations.tsx b/src/routes/_project/p/$projectId/integrations.tsx new file mode 100644 index 0000000..4ef1ff2 --- /dev/null +++ b/src/routes/_project/p/$projectId/integrations.tsx @@ -0,0 +1,25 @@ +import { createFileRoute } from "@tanstack/react-router"; +import { SearchConsoleConnectionCard } from "@/client/features/gsc/SearchConsoleConnectionCard"; + +export const Route = createFileRoute("/_project/p/$projectId/integrations")({ + component: IntegrationsRoute, +}); + +function IntegrationsRoute() { + const { projectId } = Route.useParams(); + + return ( +

    +
    +

    Integrations

    +

    + Connect your data sources. +

    +
    + +
    + ); +} diff --git a/src/server/features/gsc/repositories/GscConnectionRepository.ts b/src/server/features/gsc/repositories/GscConnectionRepository.ts new file mode 100644 index 0000000..feacdae --- /dev/null +++ b/src/server/features/gsc/repositories/GscConnectionRepository.ts @@ -0,0 +1,66 @@ +import { eq, sql } from "drizzle-orm"; +import { db } from "@/db"; +import { gscConnections } from "@/db/schema"; + +export type GscConnection = typeof gscConnections.$inferSelect; + +async function getByProjectId( + projectId: string, +): Promise { + const rows = await db + .select() + .from(gscConnections) + .where(eq(gscConnections.projectId, projectId)) + .limit(1); + return rows[0] ?? null; +} + +async function upsert(input: { + projectId: string; + organizationId: string; + siteUrl: string; + connectedByUserId: string; + connectedAccountEmail: string | null; +}): Promise { + const [row] = await db + .insert(gscConnections) + .values({ id: crypto.randomUUID(), ...input }) + .onConflictDoUpdate({ + target: gscConnections.projectId, + set: { + siteUrl: input.siteUrl, + organizationId: input.organizationId, + connectedByUserId: input.connectedByUserId, + connectedAccountEmail: input.connectedAccountEmail, + updatedAt: sql`(current_timestamp)`, + }, + }) + .returning(); + if (!row) { + throw new Error("Failed to upsert gsc_connection"); + } + return row; +} + +async function deleteByProjectId(projectId: string): Promise { + await db + .delete(gscConnections) + .where(eq(gscConnections.projectId, projectId)); +} + +/** Whether this user is still the connector for any project's GSC property. */ +async function existsForConnector(userId: string): Promise { + const rows = await db + .select({ id: gscConnections.id }) + .from(gscConnections) + .where(eq(gscConnections.connectedByUserId, userId)) + .limit(1); + return rows.length > 0; +} + +export const GscConnectionRepository = { + getByProjectId, + upsert, + deleteByProjectId, + existsForConnector, +}; diff --git a/src/server/features/gsc/searchAnalytics.test.ts b/src/server/features/gsc/searchAnalytics.test.ts new file mode 100644 index 0000000..3536c6e --- /dev/null +++ b/src/server/features/gsc/searchAnalytics.test.ts @@ -0,0 +1,116 @@ +import { describe, expect, it } from "vitest"; +import { + buildSearchAnalyticsRequest, + resolveDateRange, +} from "@/server/features/gsc/searchAnalytics"; + +const TODAY = new Date("2026-05-28T00:00:00Z"); + +describe("resolveDateRange", () => { + it("ends convenience ranges 3 days back for GSC data lag", () => { + const { endDate } = resolveDateRange({ dateRange: "last_28_days" }, TODAY); + expect(endDate).toBe("2026-05-25"); + }); + + it("computes a 28-day window from the lagged end", () => { + const { startDate, endDate } = resolveDateRange( + { dateRange: "last_28_days" }, + TODAY, + ); + expect(startDate).toBe("2026-04-27"); + expect(endDate).toBe("2026-05-25"); + }); + + it("clamps the start to the 16-month floor", () => { + const { startDate } = resolveDateRange( + { dateRange: "last_16_months" }, + TODAY, + ); + // end (2026-05-25) - 16 months = 2025-01-25, but floor is today - 16 months. + expect(startDate).toBe("2025-01-28"); + }); + + it("passes explicit dates through, clamping start to the floor", () => { + const { startDate, endDate } = resolveDateRange( + { startDate: "2020-01-01", endDate: "2026-05-01" }, + TODAY, + ); + expect(startDate).toBe("2025-01-28"); // clamped + expect(endDate).toBe("2026-05-01"); + }); + + it("leaves an in-range explicit start untouched", () => { + const { startDate } = resolveDateRange( + { startDate: "2026-01-01", endDate: "2026-05-01" }, + TODAY, + ); + expect(startDate).toBe("2026-01-01"); + }); +}); + +describe("buildSearchAnalyticsRequest", () => { + it("wraps flat filters into a single AND dimensionFilterGroup", () => { + const request = buildSearchAnalyticsRequest( + { + projectId: "p1", + dimensions: ["query"], + filters: [ + { + dimension: "page", + operator: "equals", + expression: "https://example.com/post", + }, + ], + }, + TODAY, + ); + // The whole point: GSC ignores a top-level `filters` field. + expect(request).not.toHaveProperty("filters"); + expect(request.dimensionFilterGroups).toEqual([ + { + groupType: "and", + filters: [ + { + dimension: "page", + operator: "equals", + expression: "https://example.com/post", + }, + ], + }, + ]); + }); + + it("omits dimensionFilterGroups when no filters are given", () => { + const request = buildSearchAnalyticsRequest({ projectId: "p1" }, TODAY); + expect(request.dimensionFilterGroups).toBeUndefined(); + }); + + it("defaults dimensions, type, dataState, and rowLimit", () => { + const request = buildSearchAnalyticsRequest({ projectId: "p1" }, TODAY); + expect(request.dimensions).toEqual(["query"]); + expect(request.type).toBe("web"); + expect(request.dataState).toBe("all"); + expect(request.rowLimit).toBe(1000); + }); + + it("clamps rowLimit to the 1000 ceiling", () => { + expect( + buildSearchAnalyticsRequest({ projectId: "p1", rowLimit: 99999 }, TODAY) + .rowLimit, + ).toBe(1000); + expect( + buildSearchAnalyticsRequest({ projectId: "p1", rowLimit: 0 }, TODAY) + .rowLimit, + ).toBe(1); + }); + + it("only includes startRow when positive", () => { + expect( + buildSearchAnalyticsRequest({ projectId: "p1" }, TODAY).startRow, + ).toBeUndefined(); + expect( + buildSearchAnalyticsRequest({ projectId: "p1", startRow: 1000 }, TODAY) + .startRow, + ).toBe(1000); + }); +}); diff --git a/src/server/features/gsc/searchAnalytics.ts b/src/server/features/gsc/searchAnalytics.ts new file mode 100644 index 0000000..40b0f8b --- /dev/null +++ b/src/server/features/gsc/searchAnalytics.ts @@ -0,0 +1,162 @@ +import type { GscSearchAnalyticsRequest } from "@/server/lib/gscClient"; + +// Shared option sets — also drive the MCP tool Zod schemas so the two stay in sync. +export const GSC_DIMENSIONS = [ + "query", + "page", + "country", + "device", + "date", + "searchAppearance", +] as const; +export const GSC_FILTER_OPERATORS = [ + "equals", + "notEquals", + "contains", + "notContains", +] as const; +export const GSC_SEARCH_TYPES = [ + "web", + "image", + "video", + "news", + "googleNews", + "discover", +] as const; +export const GSC_DATE_RANGES = [ + "last_7_days", + "last_28_days", + "last_3_months", + "last_6_months", + "last_12_months", + "last_16_months", +] as const; + +export const GSC_DEFAULT_ROW_LIMIT = 1000; +// v1 caps rows-per-call at 1000 to protect the MCP context window. The GSC API +// supports up to 25000, but we keep fetched == returned so counts stay honest; +// the agent paginates with `startRow` for more. +export const GSC_MAX_ROW_LIMIT = 1000; +// GSC data trails by ~2-3 days; default the end of convenience ranges before it. +const GSC_DATA_LAG_DAYS = 3; + +export type GscDimension = (typeof GSC_DIMENSIONS)[number]; +type GscFilterOperator = (typeof GSC_FILTER_OPERATORS)[number]; +export type GscSearchType = (typeof GSC_SEARCH_TYPES)[number]; +export type GscDateRange = (typeof GSC_DATE_RANGES)[number]; + +export type GscPerformanceFilter = { + dimension: GscDimension; + operator: GscFilterOperator; + expression: string; +}; + +export type GscPerformanceInput = { + projectId: string; + dimensions?: GscDimension[]; + dateRange?: GscDateRange; + startDate?: string; + endDate?: string; + filters?: GscPerformanceFilter[]; + rowLimit?: number; + startRow?: number; + type?: GscSearchType; + dataState?: "all" | "final"; +}; + +function clamp(value: number, min: number, max: number): number { + return Math.min(Math.max(value, min), max); +} + +function formatDate(date: Date): string { + return date.toISOString().slice(0, 10); +} + +function subtractRange(end: Date, range: GscDateRange): Date { + const d = new Date(end); + switch (range) { + case "last_7_days": + d.setUTCDate(d.getUTCDate() - 7); + break; + case "last_28_days": + d.setUTCDate(d.getUTCDate() - 28); + break; + case "last_3_months": + d.setUTCMonth(d.getUTCMonth() - 3); + break; + case "last_6_months": + d.setUTCMonth(d.getUTCMonth() - 6); + break; + case "last_12_months": + d.setUTCMonth(d.getUTCMonth() - 12); + break; + case "last_16_months": + d.setUTCMonth(d.getUTCMonth() - 16); + break; + } + return d; +} + +function sixteenMonthFloor(today: Date): string { + const d = new Date(today); + d.setUTCMonth(d.getUTCMonth() - 16); + return formatDate(d); +} + +/** Resolve a convenience `dateRange` or explicit start/end into GSC dates. + * `today` is injectable for deterministic tests. */ +export function resolveDateRange( + input: Pick, + today: Date = new Date(), +): { startDate: string; endDate: string } { + const floor = sixteenMonthFloor(today); + + if (input.startDate && input.endDate) { + // Clamp the start to GSC's 16-month lower bound. + const startDate = input.startDate < floor ? floor : input.startDate; + return { startDate, endDate: input.endDate }; + } + + const end = new Date(today); + end.setUTCDate(end.getUTCDate() - GSC_DATA_LAG_DAYS); + const start = subtractRange(end, input.dateRange ?? "last_28_days"); + const startDate = formatDate(start); + return { + startDate: startDate < floor ? floor : startDate, + endDate: formatDate(end), + }; +} + +/** Build the GSC `searchAnalytics.query` body from validated tool input. + * Critically, flat `filters` are wrapped into `dimensionFilterGroups` — GSC + * silently ignores a top-level `filters` field. */ +export function buildSearchAnalyticsRequest( + input: GscPerformanceInput, + today: Date = new Date(), +): GscSearchAnalyticsRequest { + const { startDate, endDate } = resolveDateRange(input, today); + const request: GscSearchAnalyticsRequest = { + startDate, + endDate, + dimensions: + input.dimensions && input.dimensions.length > 0 + ? input.dimensions + : ["query"], + rowLimit: clamp( + input.rowLimit ?? GSC_DEFAULT_ROW_LIMIT, + 1, + GSC_MAX_ROW_LIMIT, + ), + type: input.type ?? "web", + dataState: input.dataState ?? "all", + }; + if (input.startRow && input.startRow > 0) { + request.startRow = input.startRow; + } + if (input.filters && input.filters.length > 0) { + request.dimensionFilterGroups = [ + { groupType: "and", filters: input.filters }, + ]; + } + return request; +} diff --git a/src/server/features/gsc/services/GscService.test.ts b/src/server/features/gsc/services/GscService.test.ts new file mode 100644 index 0000000..ce6935d --- /dev/null +++ b/src/server/features/gsc/services/GscService.test.ts @@ -0,0 +1,138 @@ +import { beforeEach, describe, expect, it, vi } from "vitest"; + +const mocks = vi.hoisted(() => ({ + listSites: vi.fn(), + upsert: vi.fn(), + getByProjectId: vi.fn(), + deleteByProjectId: vi.fn(), + existsForConnector: vi.fn(), + dbDelete: vi.fn(() => ({ where: vi.fn().mockResolvedValue(undefined) })), +})); + +vi.mock("cloudflare:workers", () => ({ env: {} })); +vi.mock("@/db", () => ({ db: { delete: mocks.dbDelete } })); +vi.mock("@/server/lib/gscClient", () => ({ + createGscClient: () => ({ listSites: mocks.listSites }), + GscApiError: class extends Error {}, + GscTokenError: class extends Error {}, +})); +vi.mock("@/server/features/gsc/repositories/GscConnectionRepository", () => ({ + GscConnectionRepository: { + upsert: mocks.upsert, + getByProjectId: mocks.getByProjectId, + deleteByProjectId: mocks.deleteByProjectId, + existsForConnector: mocks.existsForConnector, + }, +})); + +const baseInput = { + projectId: "p1", + organizationId: "org1", + userId: "u1", + userEmail: "alice@example.com", +}; + +describe("GscService.setSite", () => { + beforeEach(() => { + mocks.listSites.mockReset(); + mocks.upsert.mockReset(); + }); + + it("upserts a verified property using the connector's identity", async () => { + mocks.listSites.mockResolvedValue([ + { siteUrl: "https://x/", permissionLevel: "siteOwner" }, + ]); + mocks.upsert.mockResolvedValue({ siteUrl: "https://x/" }); + const { GscService } = await import("./GscService"); + + await GscService.setSite({ ...baseInput, siteUrl: "https://x/" }); + + expect(mocks.upsert).toHaveBeenCalledWith( + expect.objectContaining({ + projectId: "p1", + siteUrl: "https://x/", + connectedByUserId: "u1", + connectedAccountEmail: "alice@example.com", + }), + ); + }); + + it("rejects an unverified property with FORBIDDEN", async () => { + mocks.listSites.mockResolvedValue([ + { siteUrl: "https://x/", permissionLevel: "siteUnverifiedUser" }, + ]); + const { GscService } = await import("./GscService"); + + await expect( + GscService.setSite({ ...baseInput, siteUrl: "https://x/" }), + ).rejects.toMatchObject({ code: "FORBIDDEN" }); + expect(mocks.upsert).not.toHaveBeenCalled(); + }); + + it("rejects a property not on the grant with NOT_FOUND", async () => { + mocks.listSites.mockResolvedValue([ + { siteUrl: "https://x/", permissionLevel: "siteOwner" }, + ]); + const { GscService } = await import("./GscService"); + + await expect( + GscService.setSite({ ...baseInput, siteUrl: "https://not-mine/" }), + ).rejects.toMatchObject({ code: "NOT_FOUND" }); + expect(mocks.upsert).not.toHaveBeenCalled(); + }); +}); + +describe("GscService.disconnect", () => { + beforeEach(() => { + mocks.getByProjectId.mockReset(); + mocks.deleteByProjectId.mockReset().mockResolvedValue(undefined); + mocks.existsForConnector.mockReset(); + mocks.dbDelete.mockClear(); + }); + + it("unlinks the connector's grant when they disconnect their last project", async () => { + mocks.getByProjectId.mockResolvedValue({ connectedByUserId: "u1" }); + mocks.existsForConnector.mockResolvedValue(false); + const { GscService } = await import("./GscService"); + + await GscService.disconnect({ projectId: "p1", userId: "u1" }); + + expect(mocks.deleteByProjectId).toHaveBeenCalledWith("p1"); + expect(mocks.existsForConnector).toHaveBeenCalledWith("u1"); + expect(mocks.dbDelete).toHaveBeenCalled(); // grant unlinked + }); + + it("keeps the grant when the connector still has another connected project", async () => { + mocks.getByProjectId.mockResolvedValue({ connectedByUserId: "u1" }); + mocks.existsForConnector.mockResolvedValue(true); + const { GscService } = await import("./GscService"); + + await GscService.disconnect({ projectId: "p1", userId: "u1" }); + + expect(mocks.dbDelete).not.toHaveBeenCalled(); + }); + + it("never revokes a grant when a different member disconnects the connection", async () => { + mocks.getByProjectId.mockResolvedValue({ connectedByUserId: "owner" }); + const { GscService } = await import("./GscService"); + + await GscService.disconnect({ projectId: "p1", userId: "other-member" }); + + expect(mocks.deleteByProjectId).toHaveBeenCalledWith("p1"); + expect(mocks.existsForConnector).not.toHaveBeenCalled(); + expect(mocks.dbDelete).not.toHaveBeenCalled(); + }); + + it("unlinks the caller's dangling grant when no property was ever bound", async () => { + // Linked Google but never picked a property → no connection row. Disconnect + // should still drop the caller's own grant. + mocks.getByProjectId.mockResolvedValue(null); + mocks.existsForConnector.mockResolvedValue(false); + const { GscService } = await import("./GscService"); + + await GscService.disconnect({ projectId: "p1", userId: "u1" }); + + expect(mocks.existsForConnector).toHaveBeenCalledWith("u1"); + expect(mocks.dbDelete).toHaveBeenCalled(); // grant unlinked + }); +}); diff --git a/src/server/features/gsc/services/GscService.ts b/src/server/features/gsc/services/GscService.ts new file mode 100644 index 0000000..a521233 --- /dev/null +++ b/src/server/features/gsc/services/GscService.ts @@ -0,0 +1,218 @@ +import { and, eq } from "drizzle-orm"; +import { db } from "@/db"; +import { account } from "@/db/schema"; +import { GSC_OAUTH_PROVIDER_ID } from "@/shared/gsc"; +import { AppError } from "@/server/lib/errors"; +import { + createGscClient, + GscTokenError, + type GscSite, + type UrlInspectionResult, +} from "@/server/lib/gscClient"; +import { + buildSearchAnalyticsRequest, + type GscPerformanceInput, +} from "@/server/features/gsc/searchAnalytics"; +import { + GscConnectionRepository, + type GscConnection, +} from "@/server/features/gsc/repositories/GscConnectionRepository"; +import type { + GscSearchAnalyticsRequest, + GscSearchAnalyticsRow, +} from "@/server/lib/gscClient"; + +const SITE_UNVERIFIED_PERMISSION = "siteUnverifiedUser"; + +type GscPerformanceResult = { + siteUrl: string; + connectedBy: string | null; + request: GscSearchAnalyticsRequest; + rows: GscSearchAnalyticsRow[]; +}; + +/** Thrown when a project has no connected GSC property. */ +export class GscNotConnectedError extends Error { + constructor(public readonly projectId: string) { + super("Search Console is not connected for this project"); + this.name = "GscNotConnectedError"; + } +} + +async function getConnection(projectId: string): Promise { + return GscConnectionRepository.getByProjectId(projectId); +} + +/** Whether this user has linked a google-search-console grant (regardless of + * whether they've picked a property yet). Drives the connect-vs-pick UI. */ +async function userHasGrant(userId: string): Promise { + const rows = await db + .select({ id: account.id }) + .from(account) + .where( + and( + eq(account.userId, userId), + eq(account.providerId, GSC_OAUTH_PROVIDER_ID), + ), + ) + .limit(1); + return rows.length > 0; +} + +/** List verified properties available on a user's google-search-console grant. */ +async function listSitesForUser(userId: string): Promise { + return createGscClient({ userId }).listSites(); +} + +/** Map a verified property to a project. Rejects unverified properties and + * properties not present on the connector's grant. */ +async function setSite(input: { + projectId: string; + organizationId: string; + siteUrl: string; + userId: string; + userEmail: string; +}): Promise { + const sites = await listSitesForUser(input.userId); + const match = sites.find((s) => s.siteUrl === input.siteUrl); + if (!match) { + throw new AppError( + "NOT_FOUND", + "That Search Console property isn't available on your connected Google account.", + ); + } + if (match.permissionLevel === SITE_UNVERIFIED_PERMISSION) { + throw new AppError( + "FORBIDDEN", + "You don't have verified access to that Search Console property.", + ); + } + return GscConnectionRepository.upsert({ + projectId: input.projectId, + organizationId: input.organizationId, + siteUrl: input.siteUrl, + connectedByUserId: input.userId, + connectedAccountEmail: input.userEmail, + }); +} + +/** Remove this user's google-search-console grant (stored OAuth tokens). */ +async function unlinkUserGrant(userId: string): Promise { + await db + .delete(account) + .where( + and( + eq(account.userId, userId), + eq(account.providerId, GSC_OAUTH_PROVIDER_ID), + ), + ); +} + +async function disconnect(input: { + projectId: string; + userId: string; +}): Promise { + const connection = await GscConnectionRepository.getByProjectId( + input.projectId, + ); + await GscConnectionRepository.deleteByProjectId(input.projectId); + // Clean up the caller's *own* OAuth grant once none of their projects still + // use it. Safe by construction: unlinkUserGrant only ever deletes the + // caller's account row, never another member's. We skip cleanup only when the + // binding we removed belonged to a *different* member, so unbinding their + // property never revokes the caller's unrelated grant. A null connection + // means the caller linked Google but never picked a property — that dangling + // grant is theirs to drop. + if (!connection || connection.connectedByUserId === input.userId) { + const stillUsed = await GscConnectionRepository.existsForConnector( + input.userId, + ); + if (!stillUsed) { + await unlinkUserGrant(input.userId); + } + } +} + +/** Pass-through of GSC `searchAnalytics.query` for a project's connected property. */ +async function getPerformance( + input: GscPerformanceInput, +): Promise { + const connection = await GscConnectionRepository.getByProjectId( + input.projectId, + ); + if (!connection) { + throw new GscNotConnectedError(input.projectId); + } + const request = buildSearchAnalyticsRequest(input); + const client = createGscClient({ userId: connection.connectedByUserId }); + const rows = await client.querySearchAnalytics(connection.siteUrl, request); + return { + siteUrl: connection.siteUrl, + connectedBy: connection.connectedAccountEmail, + request, + rows, + }; +} + +type GscUrlInspection = { + url: string; + result: UrlInspectionResult | null; + error?: string; +}; + +type GscInspectUrlsResult = { + siteUrl: string; + connectedBy: string | null; + results: GscUrlInspection[]; +}; + +/** Inspect 1–N URLs against a project's connected property. Resolves the + * connection once, then inspects each URL; per-URL failures are captured + * inline so one bad URL doesn't fail the batch. Token/grant failures + * propagate so the caller can prompt a reconnect. */ +async function inspectUrls(input: { + projectId: string; + urls: string[]; + languageCode?: string; +}): Promise { + const connection = await GscConnectionRepository.getByProjectId( + input.projectId, + ); + if (!connection) { + throw new GscNotConnectedError(input.projectId); + } + const client = createGscClient({ userId: connection.connectedByUserId }); + const results: GscUrlInspection[] = []; + for (const url of input.urls) { + try { + const result = await client.inspectUrl( + connection.siteUrl, + url, + input.languageCode, + ); + results.push({ url, result }); + } catch (error) { + if (error instanceof GscTokenError) throw error; + results.push({ + url, + result: null, + error: error instanceof Error ? error.message : "Inspection failed", + }); + } + } + return { + siteUrl: connection.siteUrl, + connectedBy: connection.connectedAccountEmail, + results, + }; +} + +export const GscService = { + getConnection, + userHasGrant, + listSitesForUser, + setSite, + disconnect, + getPerformance, + inspectUrls, +}; diff --git a/src/server/lib/dataforseo/client.test.ts b/src/server/lib/dataforseo/client.test.ts index 3d527ce..fcdf0db 100644 --- a/src/server/lib/dataforseo/client.test.ts +++ b/src/server/lib/dataforseo/client.test.ts @@ -62,9 +62,6 @@ vi.mock("@/server/lib/dataforseo/serp", () => ({ fetchRankCheckSerp: vi.fn(), fetchLocalSerp: vi.fn(), })); -vi.mock("@/server/lib/dataforseo/keywordsData", () => ({ - fetchKeywordSearchVolume: vi.fn(), -})); vi.mock("@/server/lib/dataforseo/business", () => ({ fetchBusinessListingsSearch: vi.fn(), fetchQuestionsAnswers: vi.fn(), diff --git a/src/server/lib/dataforseo/client.ts b/src/server/lib/dataforseo/client.ts index 6eccc0c..2ef3768 100644 --- a/src/server/lib/dataforseo/client.ts +++ b/src/server/lib/dataforseo/client.ts @@ -38,7 +38,6 @@ import { fetchLocalSerp, fetchRankCheckSerp, } from "@/server/lib/dataforseo/serp"; -import { fetchKeywordSearchVolume } from "@/server/lib/dataforseo/keywordsData"; import { fetchLighthouseResult } from "@/server/lib/dataforseo/lighthouse"; import { fetchLlmAggregatedMetrics, @@ -59,16 +58,25 @@ export { mapDataforseoPathToCreditFeature }; /** * Wraps a section fetcher with billing metering. Each entry on the client is - * `meter(customer, fetcher, creditFeature?)`, which returns a function with the + * `meter(customer, fetcher, defaultFeature?)`, which returns a function with the * fetcher's own input type and resolves to its unwrapped `.data`. + * + * `defaultFeature` is the fallback credit feature; a caller can override it per + * call by passing `creditFeature` in the input (e.g. an MCP tool attributing + * spend to its own feature). The extra field is ignored by the fetchers, which + * read named fields rather than spreading the input. */ function meter( customer: BillingCustomerContext, fetcher: (input: I) => Promise>, - creditFeature?: CreditFeature, -): (input: I) => Promise { - return (input: I) => - meterDataforseoCall(customer, () => fetcher(input), creditFeature); + defaultFeature?: CreditFeature, +): (input: I & { creditFeature?: CreditFeature }) => Promise { + return (input) => + meterDataforseoCall( + customer, + () => fetcher(input), + input.creditFeature ?? defaultFeature, + ); } export function createDataforseoClient(customer: BillingCustomerContext) { @@ -103,10 +111,10 @@ export function createDataforseoClient(customer: BillingCustomerContext) { rankCheck: meter(customer, fetchRankCheckSerp, "rank_tracking"), local: meter(customer, fetchLocalSerp, "local_seo"), }, - keywordData: { - searchVolume: meter(customer, fetchKeywordSearchVolume), - }, labs: { + // Callers (e.g. the keyword-metrics MCP tool) can attribute the spend to + // their own feature by passing `creditFeature` in the input; defaults to + // rank_tracking when omitted. keywordOverview: meter(customer, fetchKeywordOverview, "rank_tracking"), serpCompetitors: meter(customer, fetchSerpCompetitors), }, diff --git a/src/server/lib/dataforseo/core.ts b/src/server/lib/dataforseo/core.ts index 627c7f7..db8df8d 100644 --- a/src/server/lib/dataforseo/core.ts +++ b/src/server/lib/dataforseo/core.ts @@ -3,7 +3,6 @@ import { BacklinksApi, BusinessDataApi, DataforseoLabsApi, - KeywordsDataApi, OnPageApi, SerpApi, } from "dataforseo-client"; @@ -101,7 +100,6 @@ function http(classify?: DataforseoErrorClassifier) { // read lazily (it lives in the Worker env, not in module scope). export const labsApi = () => new DataforseoLabsApi(API_BASE, http()); export const serpApi = () => new SerpApi(API_BASE, http()); -export const keywordsDataApi = () => new KeywordsDataApi(API_BASE, http()); export const businessDataApi = () => new BusinessDataApi(API_BASE, http()); export const onPageApi = () => new OnPageApi(API_BASE, http()); export const backlinksApi = (classify?: DataforseoErrorClassifier) => diff --git a/src/server/lib/dataforseo/endpoints.test.ts b/src/server/lib/dataforseo/endpoints.test.ts index cd2a7c3..0881bb4 100644 --- a/src/server/lib/dataforseo/endpoints.test.ts +++ b/src/server/lib/dataforseo/endpoints.test.ts @@ -12,7 +12,6 @@ import { fetchLlmResponse, fetchLlmTopPages, } from "@/server/lib/dataforseo/ai"; -import { fetchKeywordSearchVolume } from "@/server/lib/dataforseo/keywordsData"; function parseDataforseoRequestBody(init: RequestInit | undefined): unknown { const body = init?.body; @@ -84,53 +83,6 @@ describe("DataForSEO SDK-backed endpoints", () => { }); }); - it("does not send location_name for keyword search volume", async () => { - const fetchMock = vi.fn().mockResolvedValue( - Response.json({ - status_code: 20000, - tasks: [ - { - status_code: 20000, - path: [ - "v3", - "keywords_data", - "google_ads", - "search_volume", - "live", - ], - cost: 0.0001, - result_count: 1, - result: [ - { - keyword: "storage units", - location_code: 2840, - language_code: "en", - search_volume: 1000, - }, - ], - }, - ], - }), - ); - vi.stubGlobal("fetch", fetchMock); - - await fetchKeywordSearchVolume({ - keywords: ["storage units"], - locationCode: 2840, - languageCode: "en", - }); - - const payload = parseDataforseoRequestBody(fetchMock.mock.calls[0]?.[1]); - expect(payload).toEqual([ - { - keywords: ["storage units"], - location_code: 2840, - language_code: "en", - }, - ]); - expect(JSON.stringify(payload)).not.toContain("location_name"); - }); - it("serializes LLM mentions domain targets for all live endpoints", async () => { const fetchMock = vi.fn().mockImplementation((url) => { const path = diff --git a/src/server/lib/dataforseo/index.ts b/src/server/lib/dataforseo/index.ts index 27aa81a..a960c42 100644 --- a/src/server/lib/dataforseo/index.ts +++ b/src/server/lib/dataforseo/index.ts @@ -1,5 +1,5 @@ // Public surface of the DataForSEO integration. Internals live in the -// per-section files (labs / serp / keywordsData / business / backlinks / ai / +// per-section files (labs / serp / business / backlinks / ai / // lighthouse); everything funnels through envelope.ts (status + billing) and is // metered in client.ts. @@ -9,6 +9,7 @@ export { type LabsKeywordDataItem, type DomainRankedKeywordItem, type RelevantPagesItem, + type KeywordOverviewItem, } from "@/server/lib/dataforseo/labs"; export { diff --git a/src/server/lib/dataforseo/keywordsData.ts b/src/server/lib/dataforseo/keywordsData.ts deleted file mode 100644 index ad814c6..0000000 --- a/src/server/lib/dataforseo/keywordsData.ts +++ /dev/null @@ -1,34 +0,0 @@ -import { - KeywordsDataGoogleAdsSearchVolumeLiveRequestInfo, - type KeywordsDataGoogleAdsSearchVolumeLiveResultInfo, -} from "dataforseo-client"; -import { keywordsDataApi } from "@/server/lib/dataforseo/core"; -import { - assertOk, - buildTaskBilling, - type DataforseoApiResponse, -} from "@/server/lib/dataforseo/envelope"; - -// The search_volume live response returns keyword rows directly as the task -// result array (no nested `items`). `competition` is a string enum here -// ("LOW"/"MEDIUM"/"HIGH"), distinct from the numeric Labs competition. -type KeywordSearchVolumeRow = KeywordsDataGoogleAdsSearchVolumeLiveResultInfo; - -export async function fetchKeywordSearchVolume(input: { - keywords: string[]; - locationCode?: number; - languageCode?: string; -}): Promise> { - const response = await keywordsDataApi().googleAdsSearchVolumeLive([ - new KeywordsDataGoogleAdsSearchVolumeLiveRequestInfo({ - keywords: input.keywords, - location_code: input.locationCode, - language_code: input.languageCode, - }), - ]); - const task = assertOk(response); - return { - data: task.result ?? [], - billing: buildTaskBilling(task), - }; -} diff --git a/src/server/lib/dataforseo/labs.ts b/src/server/lib/dataforseo/labs.ts index 2e522d3..5fb9fc9 100644 --- a/src/server/lib/dataforseo/labs.ts +++ b/src/server/lib/dataforseo/labs.ts @@ -29,7 +29,7 @@ export type LabsKeywordDataItem = KeywordDataInfo; type RelatedKeywordItem = DataforseoLabsRelatedKeywordsLiveItem; type DomainMetricsItem = DataforseoLabsDomainRankOverviewLiveItem; export type RelevantPagesItem = DataforseoLabsRelevantPagesLiveItem; -type KeywordOverviewItem = DataforseoLabsGoogleKeywordOverviewLiveItem; +export type KeywordOverviewItem = DataforseoLabsGoogleKeywordOverviewLiveItem; type SerpCompetitorItem = DataforseoLabsSerpCompetitorsLiveItem; // Ranked keywords is the one Labs endpoint the SDK types loosely: its diff --git a/src/server/lib/gscClient.test.ts b/src/server/lib/gscClient.test.ts new file mode 100644 index 0000000..c87a391 --- /dev/null +++ b/src/server/lib/gscClient.test.ts @@ -0,0 +1,124 @@ +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; + +const mocks = vi.hoisted(() => ({ + getAccessToken: vi.fn(), + fetch: vi.fn(), +})); + +vi.mock("@/lib/auth", () => ({ + getAuth: () => ({ api: { getAccessToken: mocks.getAccessToken } }), +})); + +function jsonResponse(body: unknown, status = 200) { + return Response.json(body, { status }); +} + +describe("gscClient", () => { + beforeEach(() => { + mocks.getAccessToken.mockReset(); + mocks.getAccessToken.mockResolvedValue({ accessToken: "tok_123" }); + mocks.fetch.mockReset(); + vi.stubGlobal("fetch", mocks.fetch); + }); + afterEach(() => { + vi.unstubAllGlobals(); + }); + + it("lists sites with a bearer token", async () => { + mocks.fetch.mockResolvedValue( + jsonResponse({ + siteEntry: [{ siteUrl: "https://x/", permissionLevel: "siteOwner" }], + }), + ); + const { createGscClient } = await import("./gscClient"); + const sites = await createGscClient({ userId: "u1" }).listSites(); + + expect(sites).toHaveLength(1); + const [url, init] = mocks.fetch.mock.calls[0]; + expect(url).toBe("https://www.googleapis.com/webmasters/v3/sites"); + expect(init?.headers).toMatchObject({ Authorization: "Bearer tok_123" }); + }); + + it("encodes the siteUrl in the searchAnalytics path (both property forms)", async () => { + mocks.fetch.mockImplementation(async () => jsonResponse({ rows: [] })); + const { createGscClient } = await import("./gscClient"); + const client = createGscClient({ userId: "u1" }); + + await client.querySearchAnalytics("sc-domain:example.com", { + startDate: "2026-01-01", + endDate: "2026-01-28", + }); + expect(mocks.fetch.mock.calls[0][0]).toBe( + "https://www.googleapis.com/webmasters/v3/sites/sc-domain%3Aexample.com/searchAnalytics/query", + ); + + await client.querySearchAnalytics("https://example.com/", { + startDate: "2026-01-01", + endDate: "2026-01-28", + }); + expect(mocks.fetch.mock.calls[1][0]).toBe( + "https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fexample.com%2F/searchAnalytics/query", + ); + }); + + it("posts to the URL Inspection endpoint and returns the result", async () => { + mocks.fetch.mockResolvedValue( + jsonResponse({ + inspectionResult: { + indexStatusResult: { verdict: "PASS", coverageState: "Indexed" }, + }, + }), + ); + const { createGscClient } = await import("./gscClient"); + const result = await createGscClient({ userId: "u1" }).inspectUrl( + "sc-domain:example.com", + "https://example.com/post", + "en-US", + ); + + const [url, init] = mocks.fetch.mock.calls[0]; + expect(url).toBe( + "https://searchconsole.googleapis.com/v1/urlInspection/index:inspect", + ); + expect(init?.method).toBe("POST"); + expect(init?.headers).toMatchObject({ Authorization: "Bearer tok_123" }); + const body = init?.body; + const payload = + typeof body === "string" ? (JSON.parse(body) as unknown) : null; + expect(payload).toEqual({ + siteUrl: "sc-domain:example.com", + inspectionUrl: "https://example.com/post", + languageCode: "en-US", + }); + expect(result?.indexStatusResult?.verdict).toBe("PASS"); + }); + + it("maps 403 to a no-access GscApiError", async () => { + mocks.fetch.mockImplementation(async () => + jsonResponse({ error: "forbidden" }, 403), + ); + const { createGscClient, GscApiError } = await import("./gscClient"); + await expect( + createGscClient({ userId: "u1" }).listSites(), + ).rejects.toMatchObject({ status: 403 }); + await expect( + createGscClient({ userId: "u1" }).listSites(), + ).rejects.toBeInstanceOf(GscApiError); + }); + + it("maps 429 to a rate-limit GscApiError", async () => { + mocks.fetch.mockResolvedValue(jsonResponse({ error: "slow down" }, 429)); + const { createGscClient } = await import("./gscClient"); + await expect( + createGscClient({ userId: "u1" }).listSites(), + ).rejects.toMatchObject({ status: 429 }); + }); + + it("throws GscTokenError when no access token can be minted", async () => { + mocks.getAccessToken.mockRejectedValue(new Error("revoked")); + const { createGscClient, GscTokenError } = await import("./gscClient"); + await expect( + createGscClient({ userId: "u1" }).listSites(), + ).rejects.toBeInstanceOf(GscTokenError); + }); +}); diff --git a/src/server/lib/gscClient.ts b/src/server/lib/gscClient.ts new file mode 100644 index 0000000..9cb85ef --- /dev/null +++ b/src/server/lib/gscClient.ts @@ -0,0 +1,193 @@ +import { getAuth } from "@/lib/auth"; +import { GSC_OAUTH_PROVIDER_ID } from "@/shared/gsc"; + +const GSC_API_BASE = "https://www.googleapis.com/webmasters/v3"; + +/** A GSC REST call returned a non-2xx status. `status` drives user-facing messaging. */ +export class GscApiError extends Error { + constructor( + public readonly status: number, + message: string, + public readonly body?: string, + ) { + super(message); + this.name = "GscApiError"; + } +} + +/** No fresh access token could be minted — the user revoked the grant, or the + * refresh token expired (e.g. weekly in Google's OAuth "Testing" mode). */ +export class GscTokenError extends Error { + constructor( + message: string, + public readonly cause?: unknown, + ) { + super(message); + this.name = "GscTokenError"; + } +} + +export type GscSite = { + siteUrl: string; + permissionLevel: string; +}; + +export type GscSearchAnalyticsRow = { + keys?: string[]; + clicks: number; + impressions: number; + ctr: number; + position: number; +}; + +export type GscDimensionFilter = { + dimension: string; + operator: string; + expression: string; +}; + +export type GscSearchAnalyticsRequest = { + startDate: string; + endDate: string; + dimensions?: string[]; + dimensionFilterGroups?: Array<{ + groupType: "and" | "or"; + filters: GscDimensionFilter[]; + }>; + rowLimit?: number; + startRow?: number; + type?: string; + dataState?: string; + aggregationType?: string; +}; + +/** Subset of the URL Inspection API `inspectionResult` we surface. The wire + * shape is richer; extra fields are ignored. */ +export type UrlInspectionResult = { + indexStatusResult?: { + verdict?: string; + coverageState?: string; + robotsTxtState?: string; + indexingState?: string; + lastCrawlTime?: string; + pageFetchState?: string; + googleCanonical?: string; + userCanonical?: string; + crawledAs?: string; + sitemap?: string[]; + referringUrls?: string[]; + }; + mobileUsabilityResult?: { verdict?: string }; + richResultsResult?: { verdict?: string }; + inspectionResultLink?: string; +}; + +function messageForStatus(status: number, body: string): string { + if (status === 401 || status === 403) { + return "Search Console denied access to this property (no verified permission, or the connection was revoked)."; + } + if (status === 429) { + return "Search Console rate limit reached. Retry shortly."; + } + if (status === 404) { + return "Search Console property not found. It may have been removed in Search Console."; + } + return `Search Console API error (${status}): ${body.slice(0, 300)}`; +} + +/** Free Google Search Console client. Unlike the DataForSEO client it does NOT + * meter credits — GSC is first-party data with no per-call cost. Access tokens + * are minted (and auto-refreshed) by Better Auth from the connector's stored + * google-search-console grant. */ +export function createGscClient(opts: { userId: string }) { + async function getToken(): Promise { + let result: { accessToken?: string } | undefined; + try { + // Headerless call: getAccessToken trusts body.userId only when no request + // session is present, and auto-refreshes via the genericOAuth provider. + result = await getAuth().api.getAccessToken({ + body: { providerId: GSC_OAUTH_PROVIDER_ID, userId: opts.userId }, + }); + } catch (error) { + throw new GscTokenError( + "Could not mint a Search Console access token (grant revoked or expired).", + error, + ); + } + if (!result?.accessToken) { + throw new GscTokenError( + "Search Console returned no access token (grant revoked or expired).", + ); + } + return result.accessToken; + } + + async function request( + url: string, + init?: { method?: string; body?: unknown }, + ): Promise { + const token = await getToken(); + const hasBody = init?.body !== undefined; + const response = await fetch(url, { + method: init?.method ?? "GET", + headers: { + Authorization: `Bearer ${token}`, + ...(hasBody ? { "Content-Type": "application/json" } : {}), + }, + body: hasBody ? JSON.stringify(init?.body) : undefined, + }); + if (!response.ok) { + const body = await response.text().catch(() => ""); + throw new GscApiError( + response.status, + messageForStatus(response.status, body), + body, + ); + } + return (await response.json()) as T; + } + + return { + /** Webmasters API `sites.list` — the verified properties on the grant. */ + async listSites(): Promise { + const data = await request<{ siteEntry?: GscSite[] }>( + `${GSC_API_BASE}/sites`, + ); + return data.siteEntry ?? []; + }, + + /** Webmasters API `searchAnalytics.query`. siteUrl is used verbatim. */ + async querySearchAnalytics( + siteUrl: string, + body: GscSearchAnalyticsRequest, + ): Promise { + const data = await request<{ rows?: GscSearchAnalyticsRow[] }>( + `${GSC_API_BASE}/sites/${encodeURIComponent(siteUrl)}/searchAnalytics/query`, + { method: "POST", body }, + ); + return data.rows ?? []; + }, + + /** URL Inspection API `urlInspection.index.inspect`. This lives on a + * different host than the Webmasters v3 base, so the full URL is passed to + * the request helper. Same `webmasters.readonly` scope. */ + async inspectUrl( + siteUrl: string, + inspectionUrl: string, + languageCode?: string, + ): Promise { + const data = await request<{ inspectionResult?: UrlInspectionResult }>( + "https://searchconsole.googleapis.com/v1/urlInspection/index:inspect", + { + method: "POST", + body: { + siteUrl, + inspectionUrl, + ...(languageCode ? { languageCode } : {}), + }, + }, + ); + return data.inspectionResult ?? null; + }, + }; +} diff --git a/src/server/mcp/project-auth.test.ts b/src/server/mcp/project-auth.test.ts index 24cc25a..6ae3956 100644 --- a/src/server/mcp/project-auth.test.ts +++ b/src/server/mcp/project-auth.test.ts @@ -42,6 +42,11 @@ describe("withMcpProjectAuth", () => { beforeEach(() => { vi.resetModules(); mocks.getProjectForOrganization.mockReset(); + // Default: the project belongs to the org. Individual tests override. + mocks.getProjectForOrganization.mockResolvedValue({ + id: "project_123", + name: "Test", + }); }); it("checks project access for the authenticated organization", async () => { @@ -102,4 +107,20 @@ describe("withMcpProjectAuth", () => { expect(handler).not.toHaveBeenCalled(); }); + + // Defense-in-depth: even if the project lookup ever resolves falsy instead of + // throwing (e.g. a future refactor returns null), the wrapper must still deny + // access rather than run the handler with an unauthorized projectId. + it("rejects when the project lookup resolves no project, without calling the handler", async () => { + mocks.getProjectForOrganization.mockResolvedValue(null); + const { withMcpProjectAuth } = await import("@/server/mcp/project-auth"); + const handler = vi.fn(); + + const wrapped = withMcpProjectAuth(handler); + await expect( + wrapped({ projectId: "someone-elses-project" }, toolExtra), + ).rejects.toThrow(); + + expect(handler).not.toHaveBeenCalled(); + }); }); diff --git a/src/server/mcp/project-auth.ts b/src/server/mcp/project-auth.ts index 665df47..2326a42 100644 --- a/src/server/mcp/project-auth.ts +++ b/src/server/mcp/project-auth.ts @@ -1,4 +1,5 @@ import { ProjectService } from "@/server/features/projects/services/ProjectService"; +import { AppError } from "@/server/lib/errors"; import { buildBillingCustomer, requireMcpToolAuthContext, @@ -12,11 +13,16 @@ type ProjectScopedArgs = { async function requireProjectAccess(extra: ToolExtra, projectId: string) { const { baseUrl, ...auth } = requireMcpToolAuthContext(extra); - // This lookup enforces that the project belongs to the authenticated org. - await ProjectService.getProjectForOrganization( + // Authorize the caller-supplied projectId against the token's organization. + // Assert on the result instead of relying on the lookup throwing, so this + // stays a hard gate even if the service's error behavior ever changes. + const project = await ProjectService.getProjectForOrganization( auth.organizationId, projectId, ); + if (!project) { + throw new AppError("FORBIDDEN"); + } return { auth, diff --git a/src/server/mcp/server.ts b/src/server/mcp/server.ts index 5e2bac8..21334d4 100644 --- a/src/server/mcp/server.ts +++ b/src/server/mcp/server.ts @@ -9,13 +9,17 @@ import { listSavedKeywordsTool } from "@/server/mcp/tools/list-saved-keywords"; import { findSerpCompetitorsTool, getGoogleBusinessQuestionsTool, - getKeywordSearchVolumeTool, + getKeywordMetricsTool, getLocalSerpResultsTool, getRankedKeywordsTool, searchLocalBusinessesTool, } from "@/server/mcp/tools/dataforseo-research-tools"; import { researchKeywordsTool } from "@/server/mcp/tools/research-keywords"; import { saveKeywordsTool } from "@/server/mcp/tools/save-keywords"; +import { + getSearchConsolePerformanceTool, + inspectUrlsTool, +} from "@/server/mcp/tools/search-console-tools"; import { whoamiTool } from "@/server/mcp/tools/whoami"; export function registerOpenSeoMcpTools(server: McpServer) { @@ -91,8 +95,18 @@ export function registerOpenSeoMcpTools(server: McpServer) { getGoogleBusinessQuestionsTool.handler, ); server.registerTool( - getKeywordSearchVolumeTool.name, - getKeywordSearchVolumeTool.config, - getKeywordSearchVolumeTool.handler, + getKeywordMetricsTool.name, + getKeywordMetricsTool.config, + getKeywordMetricsTool.handler, + ); + server.registerTool( + getSearchConsolePerformanceTool.name, + getSearchConsolePerformanceTool.config, + getSearchConsolePerformanceTool.handler, + ); + server.registerTool( + inspectUrlsTool.name, + inspectUrlsTool.config, + inspectUrlsTool.handler, ); } diff --git a/src/server/mcp/tools/dataforseo-research-tools.test.ts b/src/server/mcp/tools/dataforseo-research-tools.test.ts index 5dea9d8..cd72933 100644 --- a/src/server/mcp/tools/dataforseo-research-tools.test.ts +++ b/src/server/mcp/tools/dataforseo-research-tools.test.ts @@ -273,24 +273,81 @@ describe("DataForSEO research MCP tools", () => { ).toBe(true); }); - it("sorts keyword volume rows by numeric competition index", async () => { - const searchVolume = vi.fn().mockResolvedValue([ - { keyword: "low", competition: "LOW", competition_index: 10 }, - { keyword: "high", competition: "HIGH", competition_index: 90 }, - { keyword: "medium", competition: "MEDIUM", competition_index: 50 }, + it("normalizes keyword_overview rows with difficulty and intent", async () => { + const keywordOverview = vi.fn().mockResolvedValue([ + { + keyword: "seo automation", + keyword_info: { + search_volume: 2400, + cpc: 25.6, + competition: 0.24, + competition_level: "LOW", + }, + keyword_properties: { keyword_difficulty: 18 }, + search_intent_info: { main_intent: "commercial" }, + }, ]); mocks.createDataforseoClient.mockReturnValue({ - keywordData: { searchVolume }, + labs: { keywordOverview }, }); - const { getKeywordSearchVolumeTool } = + const { getKeywordMetricsTool } = await import("./dataforseo-research-tools"); - const result = await getKeywordSearchVolumeTool.handler( + const result = await getKeywordMetricsTool.handler( + { projectId: "project_1", keywords: ["seo automation"] }, + toolExtra, + ); + + expect(keywordOverview).toHaveBeenCalledWith( + expect.objectContaining({ + keywords: ["seo automation"], + locationCode: 2840, + languageCode: "en", + creditFeature: "keyword_research", + }), + ); + const rows = z + .object({ + keywords: z.array( + z + .object({ + keyword: z.string(), + search_volume: z.number().nullable(), + keyword_difficulty: z.number().nullable(), + main_intent: z.string().nullable(), + }) + .passthrough(), + ), + }) + .passthrough() + .parse(result.structuredContent).keywords; + expect(rows[0]).toMatchObject({ + keyword: "seo automation", + search_volume: 2400, + keyword_difficulty: 18, + main_intent: "commercial", + }); + }); + + it("sorts keyword metric rows by the requested numeric field", async () => { + const keywordOverview = vi.fn().mockResolvedValue([ + { keyword: "low", keyword_info: { search_volume: 10 } }, + { keyword: "high", keyword_info: { search_volume: 90 } }, + { keyword: "medium", keyword_info: { search_volume: 50 } }, + ]); + + mocks.createDataforseoClient.mockReturnValue({ + labs: { keywordOverview }, + }); + const { getKeywordMetricsTool } = + await import("./dataforseo-research-tools"); + + const result = await getKeywordMetricsTool.handler( { projectId: "project_1", keywords: ["low", "high", "medium"], - sortBy: "competition", + sortBy: "search_volume", }, toolExtra, ); @@ -302,42 +359,36 @@ describe("DataForSEO research MCP tools", () => { expect(rows.map((row) => row.keyword)).toEqual(["high", "medium", "low"]); }); - it("defaults empty keyword volume market objects to United States", async () => { - const searchVolume = vi - .fn() - .mockResolvedValue([{ keyword: "storage units", search_volume: 1000 }]); + it("drops monthly trends when includeMonthlyTrends is false", async () => { + const keywordOverview = vi.fn().mockResolvedValue([ + { + keyword: "seo", + keyword_info: { + search_volume: 100, + monthly_searches: [{ year: 2026, month: 1, search_volume: 100 }], + }, + }, + ]); mocks.createDataforseoClient.mockReturnValue({ - keywordData: { searchVolume }, + labs: { keywordOverview }, }); - const { getKeywordSearchVolumeTool } = + const { getKeywordMetricsTool } = await import("./dataforseo-research-tools"); - await getKeywordSearchVolumeTool.handler( + const result = await getKeywordMetricsTool.handler( { projectId: "project_1", - keywords: ["storage units"], - market: {}, + keywords: ["seo"], + includeMonthlyTrends: false, }, toolExtra, ); - expect(searchVolume).toHaveBeenCalledWith( - expect.objectContaining({ - locationCode: 2840, - }), - ); - }); - - it("does not accept keyword volume location names", async () => { - const { getKeywordSearchVolumeTool } = - await import("./dataforseo-research-tools"); - - expect( - getKeywordSearchVolumeTool.config.inputSchema.market?.safeParse({ - country: "US", - locationName: "Pittsburgh,PA,United States", - }).success, - ).toBe(false); + const rows = z + .object({ keywords: z.array(z.record(z.string(), z.unknown())) }) + .passthrough() + .parse(result.structuredContent).keywords; + expect(rows[0]).not.toHaveProperty("monthly_searches"); }); }); diff --git a/src/server/mcp/tools/dataforseo-research-tools.ts b/src/server/mcp/tools/dataforseo-research-tools.ts index 5cf93f5..2880125 100644 --- a/src/server/mcp/tools/dataforseo-research-tools.ts +++ b/src/server/mcp/tools/dataforseo-research-tools.ts @@ -1,6 +1,9 @@ /* eslint-disable max-lines */ import { z } from "zod"; -import { createDataforseoClient } from "@/server/lib/dataforseo"; +import { + createDataforseoClient, + type KeywordOverviewItem, +} from "@/server/lib/dataforseo"; import { buildProjectMeta } from "@/server/mcp/context"; import { mcpResponse } from "@/server/mcp/formatters"; import { @@ -12,6 +15,7 @@ import { DEFAULT_LANGUAGE_CODE, DEFAULT_LOCATION_CODE, languageCodeSchema, + locationCodeSchema, projectIdSchema, } from "@/server/mcp/schemas"; @@ -51,16 +55,6 @@ const localSerpNearSchema = z.object({ zoom: z.number().int().min(4).max(18).optional(), }); -const keywordMarketSchema = z - .object({ - country: z - .enum(["US", "USA", "United States", "United States of America"]) - .optional(), - }) - .strict() - .optional() - .describe("Optional Google Ads market. Defaults to United States."); - const domainTargetSchema = z .string() .min(1) @@ -146,13 +140,20 @@ const findSerpCompetitorsInputSchema = { offset: z.number().int().min(0).max(1000).optional(), } as const; -const getKeywordSearchVolumeInputSchema = { +const keywordMetricsSortSchema = z.enum([ + "search_volume", + "keyword_difficulty", + "cpc", + "competition", +]); + +const getKeywordMetricsInputSchema = { projectId: projectIdSchema, - keywords: z.array(z.string().min(1).max(80)).min(1).max(100), - market: keywordMarketSchema, - includeMonthlyTrends: z.boolean().optional(), - sortBy: z.enum(["search_volume", "cpc", "competition"]).optional(), + keywords: z.array(z.string().min(1).max(80)).min(1).max(700), + locationCode: locationCodeSchema.optional(), languageCode: languageCodeSchema.optional(), + includeMonthlyTrends: z.boolean().optional(), + sortBy: keywordMetricsSortSchema.optional(), } as const; type Market = z.infer; @@ -162,8 +163,8 @@ type GetRankedKeywordsArgs = z.infer< type FindSerpCompetitorsArgs = z.infer< z.ZodObject >; -type GetKeywordSearchVolumeArgs = z.infer< - z.ZodObject +type GetKeywordMetricsArgs = z.infer< + z.ZodObject >; type SearchLocalBusinessesArgs = z.infer< z.ZodObject @@ -302,20 +303,32 @@ function sortCompetitors( }); } -function sortKeywordRows( - items: Record[], - sortBy: GetKeywordSearchVolumeArgs["sortBy"], +function normalizeKeywordOverview(item: KeywordOverviewItem) { + const info = item.keyword_info; + return { + keyword: item.keyword, + search_volume: info?.search_volume ?? null, + keyword_difficulty: item.keyword_properties?.keyword_difficulty ?? null, + main_intent: item.search_intent_info?.main_intent ?? null, + cpc: info?.cpc ?? null, + competition: info?.competition ?? null, + competition_level: info?.competition_level ?? null, + monthly_searches: info?.monthly_searches ?? null, + }; +} + +type KeywordMetricRow = ReturnType; + +function sortKeywordMetricRows( + rows: KeywordMetricRow[], + sortBy: NonNullable = "search_volume", ) { - const field = - sortBy === "cpc" - ? "cpc" - : sortBy === "competition" - ? "competition_index" - : "search_volume"; - return items.toSorted((a, b) => { - const aValue = typeof a[field] === "number" ? a[field] : 0; - const bValue = typeof b[field] === "number" ? b[field] : 0; - return bValue - aValue; + return rows.toSorted((a, b) => { + const aValue = a[sortBy]; + const bValue = b[sortBy]; + const aNum = typeof aValue === "number" ? aValue : 0; + const bNum = typeof bValue === "number" ? bValue : 0; + return bNum - aNum; }); } @@ -552,13 +565,13 @@ export const findSerpCompetitorsTool = { ), }; -export const getKeywordSearchVolumeTool = { - name: "get_keyword_search_volume", +export const getKeywordMetricsTool = { + name: "get_keyword_metrics", config: { - title: "Get keyword search volume", + title: "Get keyword metrics", description: - "Checks Google Ads keyword planner-style search volume, CPC, competition, and monthly trends for known keywords. This is demand prioritization data, not local-radius rank data. Charges DataForSEO Keywords Data credits.", - inputSchema: getKeywordSearchVolumeInputSchema, + "Hydrate up to 700 known keywords with search volume, keyword difficulty (KD), search intent, CPC, competition, and monthly trends in a single call. Use it to score candidate or known keywords — including Search Console striking-distance queries — by real demand and ranking difficulty. Charges DataForSEO Labs credits.", + inputSchema: getKeywordMetricsInputSchema, outputSchema: { keywords: z.array(looseObjectOutputSchema), ...optionalMetaOutputSchema, @@ -569,36 +582,33 @@ export const getKeywordSearchVolumeTool = { destructiveHint: false, }, }, - handler: withMcpProjectAuth( - async (args: GetKeywordSearchVolumeArgs, context) => { - const client = createDataforseoClient(context.billing); - const keywords = await client.keywordData.searchVolume({ - keywords: args.keywords, - locationCode: resolveMarketLocationCode(args.market), - languageCode: args.languageCode ?? DEFAULT_LANGUAGE_CODE, - }); - const rows = sortKeywordRows( - keywords, - args.sortBy ?? "search_volume", - ).map((item) => - args.includeMonthlyTrends === false - ? Object.fromEntries( - Object.entries(item).filter( - ([key]) => key !== "monthly_searches", - ), - ) - : item, - ); + handler: withMcpProjectAuth(async (args: GetKeywordMetricsArgs, context) => { + const client = createDataforseoClient(context.billing); + const items = await client.labs.keywordOverview({ + keywords: args.keywords, + locationCode: args.locationCode ?? DEFAULT_LOCATION_CODE, + languageCode: args.languageCode ?? DEFAULT_LANGUAGE_CODE, + creditFeature: "keyword_research", + }); + const rows = sortKeywordMetricRows( + items.map(normalizeKeywordOverview), + args.sortBy ?? "search_volume", + ).map((row) => + args.includeMonthlyTrends === false + ? Object.fromEntries( + Object.entries(row).filter(([key]) => key !== "monthly_searches"), + ) + : row, + ); - return mcpResponse({ - text: `Fetched search volume for ${rows.length} keyword rows.`, - meta: buildProjectMeta( - context, - args.projectId, - `/p/${args.projectId}/keywords`, - ), - structuredContent: { keywords: rows }, - }); - }, - ), + return mcpResponse({ + text: `Fetched metrics (volume, difficulty, intent) for ${rows.length} keywords.`, + meta: buildProjectMeta( + context, + args.projectId, + `/p/${args.projectId}/keywords`, + ), + structuredContent: { keywords: rows }, + }); + }), }; diff --git a/src/server/mcp/tools/search-console-tools.test.ts b/src/server/mcp/tools/search-console-tools.test.ts new file mode 100644 index 0000000..9f07b07 --- /dev/null +++ b/src/server/mcp/tools/search-console-tools.test.ts @@ -0,0 +1,300 @@ +import type { AuthInfo } from "@modelcontextprotocol/sdk/server/auth/types.js"; +import { beforeEach, describe, expect, it, vi } from "vitest"; +import type { ToolExtra } from "@/server/mcp/context"; +import { MCP_AUTH_CONTEXT_PROP } from "@/server/mcp/context"; + +const mocks = vi.hoisted(() => ({ + getProjectForOrganization: vi.fn(), + isHostedServerAuthMode: vi.fn(), + GscService: { + getPerformance: vi.fn(), + inspectUrls: vi.fn(), + }, +})); + +class GscNotConnectedError extends Error { + constructor(public readonly projectId: string) { + super("not connected"); + this.name = "GscNotConnectedError"; + } +} +class GscApiError extends Error { + constructor( + public readonly status: number, + message: string, + ) { + super(message); + this.name = "GscApiError"; + } +} +class GscTokenError extends Error {} + +vi.mock("cloudflare:workers", () => ({ env: {} })); +vi.mock("@/server/lib/runtime-env", () => ({ + isHostedServerAuthMode: mocks.isHostedServerAuthMode, +})); +vi.mock("@/server/features/projects/services/ProjectService", () => ({ + ProjectService: { + getProjectForOrganization: mocks.getProjectForOrganization, + }, +})); +vi.mock("@/server/features/gsc/services/GscService", () => ({ + GscService: mocks.GscService, + GscNotConnectedError, +})); +vi.mock("@/server/lib/gscClient", () => ({ GscApiError, GscTokenError })); + +const authContext = { + userId: "user_123", + userEmail: "alice@example.com", + organizationId: "org_123", + clientId: "client_123", + scopes: ["mcp"], + audience: "https://open-seo.test/mcp", + subject: "user_123", + baseUrl: "https://open-seo.test", +}; + +const toolExtra: ToolExtra = { + signal: new AbortController().signal, + requestId: 1, + sendNotification: vi.fn(), + sendRequest: vi.fn(), + authInfo: { + token: "token", + clientId: "client_123", + scopes: ["mcp"], + resource: new URL("https://open-seo.test/mcp"), + extra: { [MCP_AUTH_CONTEXT_PROP]: authContext }, + } satisfies AuthInfo, +}; + +describe("search console MCP tools", () => { + beforeEach(() => { + mocks.getProjectForOrganization.mockReset(); + mocks.getProjectForOrganization.mockResolvedValue({ id: "project_1" }); + mocks.isHostedServerAuthMode.mockReset(); + mocks.isHostedServerAuthMode.mockResolvedValue(true); + mocks.GscService.getPerformance.mockReset(); + mocks.GscService.inspectUrls.mockReset(); + }); + + it("returns performance rows on success and passes filters through", async () => { + mocks.GscService.getPerformance.mockResolvedValue({ + siteUrl: "https://example.com/", + connectedBy: "alice@example.com", + request: { + dimensions: ["query"], + startDate: "2026-04-27", + endDate: "2026-05-25", + rowLimit: 1000, + }, + rows: [ + { + keys: ["seo tools"], + clicks: 12, + impressions: 300, + ctr: 0.04, + position: 7.5, + }, + ], + }); + const { getSearchConsolePerformanceTool } = + await import("./search-console-tools"); + + const result = await getSearchConsolePerformanceTool.handler( + { + projectId: "project_1", + dimensions: ["query"], + filters: [ + { + dimension: "page", + operator: "equals", + expression: "https://example.com/x", + }, + ], + }, + toolExtra, + ); + + expect(mocks.GscService.getPerformance).toHaveBeenCalledWith( + expect.objectContaining({ + projectId: "project_1", + filters: [ + { + dimension: "page", + operator: "equals", + expression: "https://example.com/x", + }, + ], + }), + ); + expect(result.structuredContent).toMatchObject({ + ok: true, + siteUrl: "https://example.com/", + rowCount: 1, + }); + }); + + it("surfaces a not-connected message with a connect URL", async () => { + mocks.GscService.getPerformance.mockRejectedValue( + new GscNotConnectedError("project_1"), + ); + const { getSearchConsolePerformanceTool } = + await import("./search-console-tools"); + + const result = await getSearchConsolePerformanceTool.handler( + { projectId: "project_1" }, + toolExtra, + ); + + expect(result.structuredContent).toMatchObject({ + ok: false, + reason: "not_connected", + }); + const first = result.content[0]; + expect(first.type).toBe("text"); + expect(first.type === "text" && first.text).toContain( + "/p/project_1/integrations", + ); + }); + + it("renders an api_error with a reconnect URL on a GSC API failure", async () => { + mocks.GscService.getPerformance.mockRejectedValue( + new GscApiError(403, "no access"), + ); + const { getSearchConsolePerformanceTool } = + await import("./search-console-tools"); + + const result = await getSearchConsolePerformanceTool.handler( + { projectId: "project_1" }, + toolExtra, + ); + + expect(result.structuredContent).toMatchObject({ + ok: false, + reason: "api_error", + }); + const first = result.content[0]; + expect(first.type === "text" && first.text).toContain( + "/p/project_1/integrations", + ); + }); + + it("rejects searchAppearance combined with another dimension", async () => { + const { getSearchConsolePerformanceTool } = + await import("./search-console-tools"); + + const result = await getSearchConsolePerformanceTool.handler( + { projectId: "project_1", dimensions: ["query", "searchAppearance"] }, + toolExtra, + ); + + expect(result.structuredContent).toMatchObject({ + reason: "invalid_request", + }); + expect(mocks.GscService.getPerformance).not.toHaveBeenCalled(); + }); + + it("rejects a half-specified explicit date range", async () => { + const { getSearchConsolePerformanceTool } = + await import("./search-console-tools"); + + const result = await getSearchConsolePerformanceTool.handler( + { projectId: "project_1", startDate: "2026-01-01" }, + toolExtra, + ); + + expect(result.structuredContent).toMatchObject({ + reason: "invalid_request", + }); + expect(mocks.GscService.getPerformance).not.toHaveBeenCalled(); + }); + + it("returns a hosted-only message in self-hosted mode", async () => { + mocks.isHostedServerAuthMode.mockResolvedValue(false); + const { getSearchConsolePerformanceTool } = + await import("./search-console-tools"); + + const result = await getSearchConsolePerformanceTool.handler( + { projectId: "project_1" }, + toolExtra, + ); + + expect(result.structuredContent).toMatchObject({ reason: "hosted_only" }); + expect(mocks.GscService.getPerformance).not.toHaveBeenCalled(); + }); + + it("inspects multiple URLs and reports partial failures inline", async () => { + mocks.GscService.inspectUrls.mockResolvedValue({ + siteUrl: "sc-domain:example.com", + connectedBy: "alice@example.com", + results: [ + { + url: "https://example.com/a", + result: { + indexStatusResult: { verdict: "PASS", coverageState: "Indexed" }, + }, + }, + { + url: "https://example.com/bad", + result: null, + error: "Search Console API error (400)", + }, + ], + }); + const { inspectUrlsTool } = await import("./search-console-tools"); + + const result = await inspectUrlsTool.handler( + { + projectId: "project_1", + urls: ["https://example.com/a", "https://example.com/bad"], + }, + toolExtra, + ); + + expect(mocks.GscService.inspectUrls).toHaveBeenCalledWith( + expect.objectContaining({ + projectId: "project_1", + urls: ["https://example.com/a", "https://example.com/bad"], + }), + ); + expect(result.structuredContent).toMatchObject({ + ok: true, + siteUrl: "sc-domain:example.com", + }); + const first = result.content[0]; + expect(first.type === "text" && first.text).toContain("PASS"); + expect(first.type === "text" && first.text).toContain("error:"); + }); + + it("surfaces a not-connected message from inspect_urls", async () => { + mocks.GscService.inspectUrls.mockRejectedValue( + new GscNotConnectedError("project_1"), + ); + const { inspectUrlsTool } = await import("./search-console-tools"); + + const result = await inspectUrlsTool.handler( + { projectId: "project_1", urls: ["https://example.com/a"] }, + toolExtra, + ); + + expect(result.structuredContent).toMatchObject({ + ok: false, + reason: "not_connected", + }); + }); + + it("returns a hosted-only message for inspect_urls in self-hosted mode", async () => { + mocks.isHostedServerAuthMode.mockResolvedValue(false); + const { inspectUrlsTool } = await import("./search-console-tools"); + + const result = await inspectUrlsTool.handler( + { projectId: "project_1", urls: ["https://example.com/a"] }, + toolExtra, + ); + + expect(result.structuredContent).toMatchObject({ reason: "hosted_only" }); + expect(mocks.GscService.inspectUrls).not.toHaveBeenCalled(); + }); +}); diff --git a/src/server/mcp/tools/search-console-tools.ts b/src/server/mcp/tools/search-console-tools.ts new file mode 100644 index 0000000..88dbb4e --- /dev/null +++ b/src/server/mcp/tools/search-console-tools.ts @@ -0,0 +1,365 @@ +/* eslint-disable max-lines */ +import { z } from "zod"; +import { buildProjectMeta } from "@/server/mcp/context"; +import { mcpResponse } from "@/server/mcp/formatters"; +import { optionalMetaOutputSchema } from "@/server/mcp/output-schemas"; +import { withMcpProjectAuth } from "@/server/mcp/project-auth"; +import { projectIdSchema } from "@/server/mcp/schemas"; +import { buildDashboardUrl } from "@/server/mcp/urls"; +import { isHostedServerAuthMode } from "@/server/lib/runtime-env"; +import { + GscNotConnectedError, + GscService, +} from "@/server/features/gsc/services/GscService"; +import { + GSC_DATE_RANGES, + GSC_DEFAULT_ROW_LIMIT, + GSC_DIMENSIONS, + GSC_FILTER_OPERATORS, + GSC_MAX_ROW_LIMIT, + GSC_SEARCH_TYPES, + type GscPerformanceInput, +} from "@/server/features/gsc/searchAnalytics"; +import { GscApiError, GscTokenError } from "@/server/lib/gscClient"; + +const TEXT_SUMMARY_ROWS = 15; + +type ProjectAuthContext = { + auth: { organizationId: string }; + baseUrl: string; +}; + +function integrationsUrl(baseUrl: string, projectId: string): string { + return buildDashboardUrl(baseUrl, `/p/${projectId}/integrations`); +} + +/** GSC connect requires Better Auth, which only runs in hosted mode. In + * self-hosted deployments the tools return this instead of a broken flow. */ +async function hostedOnlyResponse( + context: ProjectAuthContext, + projectId: string, +) { + if (await isHostedServerAuthMode()) return null; + return mcpResponse({ + text: "Google Search Console connect is only available on the hosted OpenSEO service, not in self-hosted mode. Use a GSC CSV export instead.", + meta: buildProjectMeta(context, projectId), + structuredContent: { ok: false, connected: false, reason: "hosted_only" }, + }); +} + +function invalidRequest( + meta: ReturnType, + message: string, +) { + return mcpResponse({ + text: message, + meta, + structuredContent: { ok: false, reason: "invalid_request" }, + }); +} + +function describeGscError(error: unknown): string { + if (error instanceof GscNotConnectedError) { + return "Search Console is not connected for this project."; + } + if (error instanceof GscTokenError) { + return "The Search Console connection has expired or was revoked. Reconnect it to continue."; + } + if (error instanceof GscApiError) { + return error.message; + } + return error instanceof Error ? error.message : String(error); +} + +// --------------------------------------------------------------------------- +// get_search_console_performance +// --------------------------------------------------------------------------- + +const filterSchema = z.object({ + dimension: z.enum(GSC_DIMENSIONS), + operator: z.enum(GSC_FILTER_OPERATORS).default("equals"), + expression: z.string().min(1), +}); + +const perfInputSchema = { + projectId: projectIdSchema, + dimensions: z + .array(z.enum(GSC_DIMENSIONS)) + .min(1) + .max(4) + .optional() + .describe( + "Group rows by these dimensions. Default ['query']. Use ['page'] for top pages, ['query','page'] to map queries to pages / spot cannibalization, ['date'] for a time series.", + ), + dateRange: z + .enum(GSC_DATE_RANGES) + .optional() + .describe( + "Convenience window (default last_28_days). End is set ~3 days back for GSC data lag. Ignored if startDate+endDate are given. Max lookback is 16 months.", + ), + startDate: z + .string() + .regex(/^\d{4}-\d{2}-\d{2}$/) + .optional() + .describe("Explicit start (YYYY-MM-DD, Pacific Time). Use with endDate."), + endDate: z + .string() + .regex(/^\d{4}-\d{2}-\d{2}$/) + .optional() + .describe("Explicit end (YYYY-MM-DD, Pacific Time). Use with startDate."), + filters: z + .array(filterSchema) + .max(5) + .optional() + .describe( + "AND-combined filters. To get the queries for one page: [{dimension:'page',operator:'equals',expression:'https://example.com/post'}] with dimensions ['query'].", + ), + rowLimit: z + .number() + .int() + .min(1) + .max(GSC_MAX_ROW_LIMIT) + .optional() + .describe( + "Rows per call (default 1000, max 1000). GSC sorts by clicks desc and can't filter by position — filter 'striking distance' positions client-side, and paginate with startRow when hasMore is true.", + ), + startRow: z.number().int().min(0).optional().describe("Pagination offset."), + type: z + .enum(GSC_SEARCH_TYPES) + .optional() + .describe("Search type (default web)."), + dataState: z + .enum(["all", "final"]) + .optional() + .describe("'all' (default) includes fresh/incomplete recent data."), +} as const; + +type PerfArgs = z.infer>; + +export const getSearchConsolePerformanceTool = { + name: "get_search_console_performance", + config: { + title: "Get Google Search Console performance", + description: + "Query the connected Search Console property's Search Analytics: clicks, impressions, CTR, and average position by query/page/country/device/date. First-party data — use it for what already ranks, near-ranking queries, and pages with real demand. ctr is a 0-1 fraction; position is a 1-based average; dates are Pacific Time; the last ~3 days may be incomplete. Read-only and free (no credits).", + inputSchema: perfInputSchema, + outputSchema: { + ok: z.boolean(), + reason: z.string().optional(), + connectUrl: z.string().optional(), + siteUrl: z.string().optional(), + startDate: z.string().optional(), + endDate: z.string().optional(), + dimensions: z.array(z.string()).optional(), + rowCount: z.number().optional(), + rows: z + .array( + z + .object({ + keys: z.array(z.string()).optional(), + clicks: z.number(), + impressions: z.number(), + ctr: z.number(), + position: z.number(), + }) + .passthrough(), + ) + .optional(), + hasMore: z.boolean().optional(), + nextStartRow: z.number().optional(), + ...optionalMetaOutputSchema, + }, + annotations: { + readOnlyHint: true, + openWorldHint: true, + destructiveHint: false, + }, + }, + handler: withMcpProjectAuth(async (args: PerfArgs, context) => { + const blocked = await hostedOnlyResponse(context, args.projectId); + if (blocked) return blocked; + + const connectUrl = integrationsUrl(context.baseUrl, args.projectId); + const meta = buildProjectMeta( + context, + args.projectId, + `/p/${args.projectId}/integrations`, + ); + + // GSC rejects searchAppearance combined with any other dimension. + if ( + args.dimensions && + args.dimensions.includes("searchAppearance") && + args.dimensions.length > 1 + ) { + return invalidRequest( + meta, + "searchAppearance must be the only dimension when used.", + ); + } + // A half-specified explicit range would silently fall back to a default window. + if (Boolean(args.startDate) !== Boolean(args.endDate)) { + return invalidRequest( + meta, + "Provide both startDate and endDate, or neither (use dateRange instead).", + ); + } + + try { + const result = await GscService.getPerformance( + args satisfies GscPerformanceInput, + ); + const dimensions = result.request.dimensions ?? ["query"]; + // rowLimit is clamped to the agent cap in buildSearchAnalyticsRequest, so + // result.rows is already <= the cap — every count below reflects what we return. + const rows = result.rows; + const requestedLimit = result.request.rowLimit ?? GSC_DEFAULT_ROW_LIMIT; + const hasMore = rows.length >= requestedLimit; + const nextStartRow = (result.request.startRow ?? 0) + rows.length; + + const summaryLines = rows.slice(0, TEXT_SUMMARY_ROWS).map((r) => { + const label = r.keys?.join(" / ") ?? "(total)"; + const ctrPct = (r.ctr * 100).toFixed(1); + return ` ${label} — ${r.clicks} clicks, ${r.impressions} impr, ${ctrPct}% CTR, pos ${r.position.toFixed(1)}`; + }); + const header = + `${result.siteUrl} · ${dimensions.join("+")} · ${result.request.startDate}→${result.request.endDate} · ` + + `${rows.length} row${rows.length === 1 ? "" : "s"}${hasMore ? " (more available — paginate with startRow)" : ""}`; + const text = + summaryLines.length > 0 + ? `${header}\n${summaryLines.join("\n")}${rows.length > summaryLines.length ? `\n …and ${rows.length - summaryLines.length} more` : ""}` + : `${header}\nNo rows for this query/date range.`; + + return mcpResponse({ + text, + meta, + structuredContent: { + ok: true, + siteUrl: result.siteUrl, + startDate: result.request.startDate, + endDate: result.request.endDate, + dimensions, + rowCount: rows.length, + rows, + hasMore, + nextStartRow: hasMore ? nextStartRow : undefined, + }, + }); + } catch (error) { + const isNotConnected = error instanceof GscNotConnectedError; + return mcpResponse({ + text: `${describeGscError(error)}${isNotConnected ? ` Connect it here: ${connectUrl}` : ` (reconnect at ${connectUrl})`}`, + meta, + structuredContent: { + ok: false, + reason: isNotConnected ? "not_connected" : "api_error", + connectUrl, + }, + }); + } + }), +}; + +// --------------------------------------------------------------------------- +// inspect_urls +// --------------------------------------------------------------------------- + +const inspectInputSchema = { + projectId: projectIdSchema, + urls: z + .array(z.string().url()) + .min(1) + .max(10) + .describe( + "1–10 absolute URLs to inspect. Each must belong to the connected property.", + ), + languageCode: z + .string() + .optional() + .describe("BCP-47 language for the inspection result (e.g. 'en-US')."), +} as const; + +type InspectArgs = z.infer>; + +export const inspectUrlsTool = { + name: "inspect_urls", + config: { + title: "Inspect URLs in Google Search Console", + description: + "Run Google Search Console's URL Inspection on up to 10 URLs of the connected property: index/coverage state, last crawl time, Google-selected vs declared canonical, and mobile/rich-results verdicts. Use it to answer 'is this page indexed? why not?'. Per-URL failures are reported inline. Read-only and free (no credits).", + inputSchema: inspectInputSchema, + outputSchema: { + ok: z.boolean(), + reason: z.string().optional(), + connectUrl: z.string().optional(), + siteUrl: z.string().optional(), + results: z + .array( + z + .object({ + url: z.string(), + result: z.unknown().nullable().optional(), + error: z.string().optional(), + }) + .passthrough(), + ) + .optional(), + ...optionalMetaOutputSchema, + }, + annotations: { + readOnlyHint: true, + openWorldHint: true, + destructiveHint: false, + }, + }, + handler: withMcpProjectAuth(async (args: InspectArgs, context) => { + const blocked = await hostedOnlyResponse(context, args.projectId); + if (blocked) return blocked; + + const connectUrl = integrationsUrl(context.baseUrl, args.projectId); + const meta = buildProjectMeta( + context, + args.projectId, + `/p/${args.projectId}/integrations`, + ); + + try { + const { siteUrl, results } = await GscService.inspectUrls({ + projectId: args.projectId, + urls: args.urls, + languageCode: args.languageCode, + }); + + const summaryLines = results.slice(0, TEXT_SUMMARY_ROWS).map((r) => { + if (r.error) return ` ${r.url} — error: ${r.error}`; + const index = r.result?.indexStatusResult; + const verdict = index?.verdict ?? "UNKNOWN"; + const coverage = index?.coverageState ?? "—"; + const canonical = index?.googleCanonical + ? `, google-canonical ${index.googleCanonical}` + : ""; + return ` ${r.url} — ${verdict}: ${coverage}${canonical}`; + }); + const text = + `${siteUrl} · inspected ${results.length} URL${results.length === 1 ? "" : "s"}\n` + + summaryLines.join("\n"); + + return mcpResponse({ + text, + meta, + structuredContent: { ok: true, siteUrl, results }, + }); + } catch (error) { + const isNotConnected = error instanceof GscNotConnectedError; + return mcpResponse({ + text: `${describeGscError(error)}${isNotConnected ? ` Connect it here: ${connectUrl}` : ` (reconnect at ${connectUrl})`}`, + meta, + structuredContent: { + ok: false, + reason: isNotConnected ? "not_connected" : "api_error", + connectUrl, + }, + }); + } + }), +}; diff --git a/src/serverFunctions/gsc.ts b/src/serverFunctions/gsc.ts new file mode 100644 index 0000000..546f1c5 --- /dev/null +++ b/src/serverFunctions/gsc.ts @@ -0,0 +1,99 @@ +import { createServerFn } from "@tanstack/react-start"; +import { waitUntil } from "cloudflare:workers"; +import { z } from "zod"; +import { GscService } from "@/server/features/gsc/services/GscService"; +import { captureServerEvent } from "@/server/lib/posthog"; +import { + requireAuthenticatedContext, + requireProjectContext, +} from "@/serverFunctions/middleware"; + +const projectScopedSchema = z.object({ projectId: z.string().min(1) }); +const setSiteSchema = projectScopedSchema.extend({ + siteUrl: z.string().min(1), +}); + +// Account-level grant check (no project needed) for surfaces like onboarding +// where the user hasn't picked a project yet. The OAuth grant is per-account; +// binding a property to a project happens later in Integrations. +export const getGscGrantStatus = createServerFn({ method: "GET" }) + .middleware(requireAuthenticatedContext) + .handler(async ({ context }) => { + return { connected: await GscService.userHasGrant(context.userId) }; + }); + +export const getGscConnection = createServerFn({ method: "POST" }) + .middleware(requireProjectContext) + .inputValidator((data: unknown) => projectScopedSchema.parse(data)) + .handler(async ({ context }) => { + const [connection, currentUserHasGrant] = await Promise.all([ + GscService.getConnection(context.projectId), + GscService.userHasGrant(context.userId), + ]); + return { + connected: Boolean(connection), + currentUserHasGrant, + siteUrl: connection?.siteUrl ?? null, + connectedByEmail: connection?.connectedAccountEmail ?? null, + connectedAt: connection?.createdAt ?? null, + }; + }); + +export const listGscSites = createServerFn({ method: "POST" }) + .middleware(requireProjectContext) + .inputValidator((data: unknown) => projectScopedSchema.parse(data)) + .handler(async ({ context }) => { + const [sites, connection] = await Promise.all([ + GscService.listSitesForUser(context.userId), + GscService.getConnection(context.projectId), + ]); + return { + sites: sites.map((s) => ({ + siteUrl: s.siteUrl, + permissionLevel: s.permissionLevel, + selectable: s.permissionLevel !== "siteUnverifiedUser", + isSelected: s.siteUrl === connection?.siteUrl, + })), + }; + }); + +export const setGscSite = createServerFn({ method: "POST" }) + .middleware(requireProjectContext) + .inputValidator((data: unknown) => setSiteSchema.parse(data)) + .handler(async ({ data, context }) => { + const connection = await GscService.setSite({ + projectId: context.projectId, + organizationId: context.organizationId, + siteUrl: data.siteUrl, + userId: context.userId, + userEmail: context.userEmail, + }); + waitUntil( + captureServerEvent({ + distinctId: context.userId, + event: "gsc:property_select", + organizationId: context.organizationId, + properties: { project_id: context.projectId, site_url: data.siteUrl }, + }), + ); + return { connected: true as const, siteUrl: connection.siteUrl }; + }); + +export const disconnectGsc = createServerFn({ method: "POST" }) + .middleware(requireProjectContext) + .inputValidator((data: unknown) => projectScopedSchema.parse(data)) + .handler(async ({ context }) => { + await GscService.disconnect({ + projectId: context.projectId, + userId: context.userId, + }); + waitUntil( + captureServerEvent({ + distinctId: context.userId, + event: "gsc:disconnect", + organizationId: context.organizationId, + properties: { project_id: context.projectId }, + }), + ); + return { connected: false as const }; + }); diff --git a/src/serverFunctions/onboarding.ts b/src/serverFunctions/onboarding.ts index 120a4f6..2414470 100644 --- a/src/serverFunctions/onboarding.ts +++ b/src/serverFunctions/onboarding.ts @@ -20,6 +20,7 @@ export const getOnboardingAnswers = createServerFn({ method: "GET" }) const answers = await db.query.userOnboardingAnswers.findFirst({ columns: { completedAt: true, + gscNudgeDismissedAt: true, interestedFeatures: true, workFor: true, clientWebsiteCount: true, @@ -51,6 +52,7 @@ export const getOnboardingAnswers = createServerFn({ method: "GET" }) return { completedAt: answers?.completedAt ?? null, + gscNudgeDismissedAt: answers?.gscNudgeDismissedAt ?? null, userCreatedAt: hostedUser?.createdAt?.toISOString() ?? null, answers: { interestedFeatures, @@ -104,3 +106,25 @@ export const saveOnboardingAnswers = createServerFn({ method: "POST" }) return { ok: true }; }); + +// Records that the one-time "connect Search Console" nudge has been shown and +// resolved (dismissed or acted on) so it never reappears for this user. +export const dismissGscNudge = createServerFn({ method: "POST" }) + .middleware(requireAuthenticatedContext) + .handler(async ({ context }) => { + const now = new Date().toISOString(); + await db + .insert(userOnboardingAnswers) + .values({ + userId: context.userId, + organizationId: context.organizationId, + gscNudgeDismissedAt: now, + updatedAt: now, + }) + .onConflictDoUpdate({ + target: userOnboardingAnswers.userId, + set: { gscNudgeDismissedAt: now, updatedAt: now }, + }); + + return { ok: true }; + }); diff --git a/src/shared/gsc.ts b/src/shared/gsc.ts new file mode 100644 index 0000000..46e8af3 --- /dev/null +++ b/src/shared/gsc.ts @@ -0,0 +1,4 @@ +/** Better Auth providerId for the incremental Google Search Console connection. + * Kept in `shared` so both server (auth config, GSC client) and client (connect + * button) can reference it without importing the server-only auth config. */ +export const GSC_OAUTH_PROVIDER_ID = "google-search-console"; diff --git a/web/content/docs/mcp.md b/web/content/docs/mcp.md index 70dafda..76ca7dd 100644 --- a/web/content/docs/mcp.md +++ b/web/content/docs/mcp.md @@ -3,7 +3,7 @@ title: "Set up OpenSEO MCP" description: "Connect OpenSEO MCP to Claude, Codex, and other AI clients." --- -OpenSEO MCP lets compatible AI clients call OpenSEO tools for keyword research, SERP inspection, local business research, competitive search intelligence, domain research, backlink overview, saved keywords, and rank tracking. +OpenSEO MCP lets compatible AI clients call OpenSEO tools for keyword research, SERP inspection, local business research, competitive search intelligence, domain research, backlink overview, saved keywords, rank tracking, and Google Search Console performance and URL inspection. The hosted MCP server URL is: @@ -60,13 +60,15 @@ OpenSEO MCP exposes tools for SEO research workflows: - Find exact keyword, page, rank, volume, CPC, intent, and traffic rows for a domain or page. - Compare SERP competitors across a supplied keyword set. - Search local businesses near a coordinate, fetch one Maps or Local Finder SERP, and read Google Business Q&A when needed. -- Check Google Ads keyword volume and CPC for demand prioritization. +- Hydrate keywords with search volume, difficulty, intent, CPC, and trends. - List saved keywords from an OpenSEO project. - Save useful keywords back to OpenSEO. - Read rank tracker configs and latest keyword positions. - Summarize a domain's organic footprint. - Find keywords a domain already ranks for. - Check backlink and referring-domain overview data. +- Read first-party Google Search Console performance (clicks, impressions, CTR, position). +- Inspect index status, crawl, and canonical for specific URLs (up to 10 per call). ## What to do after setup