@squadbase/vite-server 0.1.8 → 0.1.9-dev.3841401

package/dist/connectors/semrush.js

@@ -0,0 +1,812 @@
+// ../connectors/src/parameter-definition.ts
+var ParameterDefinition = class {
+  slug;
+  name;
+  description;
+  envVarBaseKey;
+  type;
+  secret;
+  required;
+  constructor(config) {
+    this.slug = config.slug;
+    this.name = config.name;
+    this.description = config.description;
+    this.envVarBaseKey = config.envVarBaseKey;
+    this.type = config.type;
+    this.secret = config.secret;
+    this.required = config.required;
+  }
+  /**
+   * Get the parameter value from a ConnectorConnectionObject.
+   */
+  getValue(connection2) {
+    const param = connection2.parameters.find(
+      (p) => p.parameterSlug === this.slug
+    );
+    if (!param || param.value == null) {
+      throw new Error(
+        `Parameter "${this.slug}" not found or has no value in connection "${connection2.id}"`
+      );
+    }
+    return param.value;
+  }
+  /**
+   * Try to get the parameter value. Returns undefined if not found (for optional params).
+   */
+  tryGetValue(connection2) {
+    const param = connection2.parameters.find(
+      (p) => p.parameterSlug === this.slug
+    );
+    if (!param || param.value == null) return void 0;
+    return param.value;
+  }
+};
+
+// ../connectors/src/connectors/semrush/parameters.ts
+var parameters = {
+  apiKey: new ParameterDefinition({
+    slug: "api-key",
+    name: "Semrush API Key",
+    description: "Your Semrush API key from Profile > Subscription info > API units > API key. A subscription with API units is required.",
+    envVarBaseKey: "SEMRUSH_API_KEY",
+    type: "text",
+    secret: true,
+    required: true
+  })
+};
+
+// ../connectors/src/connectors/semrush/sdk/index.ts
+var BASE_URL = "https://api.semrush.com";
+function createClient(params) {
+  const apiKey = params[parameters.apiKey.slug];
+  if (!apiKey) {
+    throw new Error(
+      `semrush: missing required parameter: ${parameters.apiKey.slug}`
+    );
+  }
+  function buildUrl(path2, query) {
+    const url = new URL(`${BASE_URL}${path2.startsWith("/") ? "" : "/"}${path2}`);
+    if (query) {
+      for (const [k, v] of Object.entries(query)) {
+        if (k === "key") continue;
+        url.searchParams.set(k, v);
+      }
+    }
+    url.searchParams.set("key", apiKey);
+    return url.toString();
+  }
+  function parseCsv(text) {
+    const trimmed = text.trim();
+    if (trimmed.length === 0) {
+      return { columns: [], rows: [], raw: text };
+    }
+    const lines = trimmed.split(/\r?\n/);
+    const columns = lines[0].split(";");
+    const rows = [];
+    for (let i = 1; i < lines.length; i++) {
+      const cells = lines[i].split(";");
+      const row = {};
+      for (let c = 0; c < columns.length; c++) {
+        row[columns[c]] = cells[c] ?? "";
+      }
+      rows.push(row);
+    }
+    return { columns, rows, raw: text };
+  }
+  async function request(path2, init) {
+    const { query, ...rest } = init ?? {};
+    return fetch(buildUrl(path2, query), rest);
+  }
+  return {
+    request,
+    async report(type, query) {
+      const res = await request("/", { query: { type, ...query ?? {} } });
+      const text = await res.text();
+      if (text.startsWith("ERROR ")) {
+        throw new Error(`semrush: ${text.trim()}`);
+      }
+      if (!res.ok) {
+        throw new Error(
+          `semrush: ${res.status} ${res.statusText}: ${text}`
+        );
+      }
+      return parseCsv(text);
+    },
+    async trends(path2, query) {
+      const trendsPath = path2.startsWith("/analytics/") ? path2 : `/analytics/v1/${path2.replace(/^\//, "")}`;
+      const res = await request(trendsPath, { query });
+      const text = await res.text();
+      if (!res.ok) {
+        throw new Error(
+          `semrush trends: ${res.status} ${res.statusText}: ${text}`
+        );
+      }
+      try {
+        return JSON.parse(text);
+      } catch {
+        throw new Error(
+          `semrush trends: response is not JSON: ${text.slice(0, 200)}`
+        );
+      }
+    },
+    async projects(path2, init) {
+      const projectsPath = path2.startsWith("/management/") ? path2 : `/management/v1/${path2.replace(/^\//, "")}`;
+      const res = await request(projectsPath, init);
+      const text = await res.text();
+      if (!res.ok) {
+        throw new Error(
+          `semrush projects: ${res.status} ${res.statusText}: ${text}`
+        );
+      }
+      try {
+        return JSON.parse(text);
+      } catch {
+        throw new Error(
+          `semrush projects: response is not JSON: ${text.slice(0, 200)}`
+        );
+      }
+    }
+  };
+}
+
+// ../connectors/src/connector-onboarding.ts
+var ConnectorOnboarding = class {
+  /** Phase 1: Connection setup instructions (optional — some connectors don't need this) */
+  connectionSetupInstructions;
+  /** Phase 2: Data overview instructions */
+  dataOverviewInstructions;
+  constructor(config) {
+    this.connectionSetupInstructions = config.connectionSetupInstructions;
+    this.dataOverviewInstructions = config.dataOverviewInstructions;
+  }
+  getConnectionSetupPrompt(language) {
+    return this.connectionSetupInstructions?.[language] ?? null;
+  }
+  getDataOverviewInstructions(language) {
+    return this.dataOverviewInstructions[language];
+  }
+};
+
+// ../connectors/src/connector-tool.ts
+var ConnectorTool = class {
+  name;
+  description;
+  inputSchema;
+  outputSchema;
+  _execute;
+  constructor(config) {
+    this.name = config.name;
+    this.description = config.description;
+    this.inputSchema = config.inputSchema;
+    this.outputSchema = config.outputSchema;
+    this._execute = config.execute;
+  }
+  createTool(connections, config) {
+    return {
+      description: this.description,
+      inputSchema: this.inputSchema,
+      outputSchema: this.outputSchema,
+      execute: (input) => this._execute(input, connections, config)
+    };
+  }
+};
+
+// ../connectors/src/connector-plugin.ts
+var ConnectorPlugin = class _ConnectorPlugin {
+  slug;
+  authType;
+  name;
+  description;
+  iconUrl;
+  parameters;
+  releaseFlag;
+  proxyPolicy;
+  experimentalAttributes;
+  categories;
+  onboarding;
+  systemPrompt;
+  tools;
+  query;
+  checkConnection;
+  constructor(config) {
+    this.slug = config.slug;
+    this.authType = config.authType;
+    this.name = config.name;
+    this.description = config.description;
+    this.iconUrl = config.iconUrl;
+    this.parameters = config.parameters;
+    this.releaseFlag = config.releaseFlag;
+    this.proxyPolicy = config.proxyPolicy;
+    this.experimentalAttributes = config.experimentalAttributes;
+    this.categories = config.categories ?? [];
+    this.onboarding = config.onboarding;
+    this.systemPrompt = config.systemPrompt;
+    this.tools = config.tools;
+    this.query = config.query;
+    this.checkConnection = config.checkConnection;
+  }
+  get connectorKey() {
+    return _ConnectorPlugin.deriveKey(this.slug, this.authType);
+  }
+  /**
+   * Create tools for connections that belong to this connector.
+   * Filters connections by connectorKey internally.
+   * Returns tools keyed as `${connectorKey}_${toolName}`.
+   */
+  createTools(connections, config, opts) {
+    const myConnections = connections.filter(
+      (c) => _ConnectorPlugin.deriveKey(c.connector.slug, c.connector.authType) === this.connectorKey
+    );
+    const result = {};
+    for (const t of Object.values(this.tools)) {
+      const tool = t.createTool(myConnections, config);
+      const originalToModelOutput = tool.toModelOutput;
+      result[`${this.connectorKey}_${t.name}`] = {
+        ...tool,
+        toModelOutput: async (options) => {
+          if (!originalToModelOutput) {
+            return opts.truncateOutput(options.output);
+          }
+          const modelOutput = await originalToModelOutput(options);
+          if (modelOutput.type === "text" || modelOutput.type === "json") {
+            return opts.truncateOutput(modelOutput.value);
+          }
+          return modelOutput;
+        }
+      };
+    }
+    return result;
+  }
+  static deriveKey(slug, authType) {
+    if (authType) return `${slug}-${authType}`;
+    const LEGACY_NULL_AUTH_TYPE_MAP = {
+      // user-password
+      "postgresql": "user-password",
+      "mysql": "user-password",
+      "clickhouse": "user-password",
+      "kintone": "user-password",
+      "squadbase-db": "user-password",
+      // service-account
+      "snowflake": "service-account",
+      "bigquery": "service-account",
+      "google-analytics": "service-account",
+      "google-calendar": "service-account",
+      "aws-athena": "service-account",
+      "redshift": "service-account",
+      // api-key
+      "databricks": "api-key",
+      "dbt": "api-key",
+      "airtable": "api-key",
+      "openai": "api-key",
+      "gemini": "api-key",
+      "anthropic": "api-key",
+      "wix-store": "api-key"
+    };
+    const fallbackAuthType = LEGACY_NULL_AUTH_TYPE_MAP[slug];
+    if (fallbackAuthType) return `${slug}-${fallbackAuthType}`;
+    return slug;
+  }
+};
+
+// ../connectors/src/auth-types.ts
+var AUTH_TYPES = {
+  OAUTH: "oauth",
+  API_KEY: "api-key",
+  JWT: "jwt",
+  SERVICE_ACCOUNT: "service-account",
+  PAT: "pat",
+  USER_PASSWORD: "user-password"
+};
+
+// ../connectors/src/connectors/semrush/tools/request.ts
+import { z } from "zod";
+var BASE_URL2 = "https://api.semrush.com";
+var REQUEST_TIMEOUT_MS = 6e4;
+var inputSchema = z.object({
+  toolUseIntent: z.string().optional().describe(
+    "Brief description of what you intend to accomplish with this tool call"
+  ),
+  connectionId: z.string().describe("ID of the Semrush connection to use"),
+  method: z.enum(["GET", "POST"]).describe(
+    "HTTP method. GET for almost all Semrush endpoints. POST is used for a few Projects API mutations."
+  ),
+  path: z.string().describe(
+    "API path appended to https://api.semrush.com (e.g., '/' for the Standard Analytics API, '/analytics/v1/' for the Trends API, '/management/v1/projects/' for the Projects API)."
+  ),
+  queryParams: z.record(z.string(), z.string()).optional().describe(
+    "Query parameters to append to the URL. The 'key' parameter is injected automatically \u2014 do not include it. Common params: 'type' (report type, e.g. 'domain_overview'), 'domain', 'phrase', 'database' (e.g. 'us', 'uk', 'jp'), 'export_columns' (comma-separated), 'display_limit', 'display_offset', 'display_date' (YYYYMM15)."
+  ),
+  body: z.string().optional().describe(
+    "Request body for POST requests. Pass a raw string (JSON for the Projects API, form-encoded otherwise). Set 'contentType' to control the Content-Type header."
+  ),
+  contentType: z.enum(["application/json", "application/x-www-form-urlencoded"]).optional().describe(
+    "Content-Type header for POST requests. Defaults to application/json."
+  ),
+  responseFormat: z.enum(["text", "json"]).optional().describe(
+    "How to parse the response body. Defaults to 'text' because the Standard Analytics API returns semicolon-separated CSV. Use 'json' for the Trends API and Projects API which return JSON."
+  )
+});
+var outputSchema = z.discriminatedUnion("success", [
+  z.object({
+    success: z.literal(true),
+    status: z.number(),
+    contentType: z.string().optional(),
+    data: z.unknown()
+  }),
+  z.object({
+    success: z.literal(false),
+    error: z.string()
+  })
+]);
+var requestTool = new ConnectorTool({
+  name: "request",
+  description: `Send authenticated requests to the Semrush API (https://api.semrush.com).
+Use this tool for all Semrush interactions across the Standard Analytics API (domain/keyword/backlink reports), the Trends API (\`/analytics/v1/\`), and the Projects API (\`/management/v1/projects/\`).
+Authentication is handled automatically \u2014 the API key is appended as the \`key\` query parameter on every request. Do NOT include \`key\` in queryParams.
+
+The Standard Analytics API returns semicolon-separated CSV with the first row being the header (use responseFormat="text"). The Trends and Projects APIs return JSON (use responseFormat="json").
+Errors from the Standard API are returned as a plain text body starting with "ERROR" and HTTP 200, so always inspect the response body even on success.`,
+  inputSchema,
+  outputSchema,
+  async execute({
+    connectionId,
+    method,
+    path: path2,
+    queryParams,
+    body,
+    contentType,
+    responseFormat
+  }, connections) {
+    const connection2 = connections.find((c) => c.id === connectionId);
+    if (!connection2) {
+      return {
+        success: false,
+        error: `Connection ${connectionId} not found`
+      };
+    }
+    console.log(
+      `[connector-request] semrush/${connection2.name}: ${method} ${path2}`
+    );
+    try {
+      const apiKey = parameters.apiKey.getValue(connection2);
+      const url = new URL(
+        `${BASE_URL2}${path2.startsWith("/") ? "" : "/"}${path2}`
+      );
+      if (queryParams) {
+        for (const [k, v] of Object.entries(queryParams)) {
+          if (k === "key") continue;
+          url.searchParams.set(k, v);
+        }
+      }
+      url.searchParams.set("key", apiKey);
+      const controller = new AbortController();
+      const timeout = setTimeout(() => controller.abort(), REQUEST_TIMEOUT_MS);
+      try {
+        const headers = {};
+        if (body) {
+          headers["Content-Type"] = contentType ?? "application/json";
+        }
+        const response = await fetch(url.toString(), {
+          method,
+          headers,
+          body: body ?? void 0,
+          signal: controller.signal
+        });
+        const responseContentType = response.headers.get("content-type") ?? void 0;
+        const text = await response.text();
+        if (text.startsWith("ERROR ")) {
+          return { success: false, error: text.trim() };
+        }
+        if (!response.ok) {
+          return {
+            success: false,
+            error: text || `HTTP ${response.status} ${response.statusText}`
+          };
+        }
+        const wantJson = responseFormat === "json" || responseFormat === void 0 && (responseContentType?.includes("application/json") ?? false);
+        let data = text;
+        if (wantJson && text.length > 0) {
+          try {
+            data = JSON.parse(text);
+          } catch {
+            data = text;
+          }
+        }
+        return {
+          success: true,
+          status: response.status,
+          contentType: responseContentType,
+          data
+        };
+      } finally {
+        clearTimeout(timeout);
+      }
+    } catch (err) {
+      const msg = err instanceof Error ? err.message : String(err);
+      return { success: false, error: msg };
+    }
+  }
+});
+
+// ../connectors/src/connectors/semrush/setup.ts
+var requestToolName = `semrush-api-key_${requestTool.name}`;
+var semrushOnboarding = new ConnectorOnboarding({
+  connectionSetupInstructions: {
+    ja: `\u4EE5\u4E0B\u306E\u624B\u9806\u3067Semrush\u30B3\u30CD\u30AF\u30B7\u30E7\u30F3\u306E\u30BB\u30C3\u30C8\u30A2\u30C3\u30D7\u3092\u884C\u3063\u3066\u304F\u3060\u3055\u3044\u3002
+
+1. \`${requestToolName}\` \u3092\u547C\u3073\u51FA\u3057\u3066\u3001API\u6B8B\u91CF\u3092\u78BA\u8A8D\u3059\u308B:
+   - \`method\`: \`"GET"\`
+   - \`path\`: \`"/"\`
+   - \`queryParams\`: \`{ "type": "user_units" }\`
+2. \u30EC\u30B9\u30DD\u30F3\u30B9\u672C\u6587\u304C \`ERROR\` \u3067\u59CB\u307E\u308B\u3001\u307E\u305F\u306FAPI\u30E6\u30CB\u30C3\u30C8\u6B8B\u91CF\u304C0\u306E\u5834\u5408\u3001\u30E6\u30FC\u30B6\u30FC\u306BAPI\u30AD\u30FC\u3068\u30B5\u30D6\u30B9\u30AF\u30EA\u30D7\u30B7\u30E7\u30F3\u72B6\u614B\uFF08API units \u304C\u4ED8\u4E0E\u3055\u308C\u3066\u3044\u308B\u304B\uFF09\u306E\u78BA\u8A8D\u3092\u4F9D\u983C\u3059\u308B
+
+#### \u5236\u7D04
+- **\u30BB\u30C3\u30C8\u30A2\u30C3\u30D7\u4E2D\u306BAPI\u30E6\u30CB\u30C3\u30C8\u3092\u5927\u91CF\u6D88\u8CBB\u3059\u308B\u30EC\u30DD\u30FC\u30C8\u3092\u5B9F\u884C\u3057\u306A\u3044\u3053\u3068**\u3002\u5B9F\u884C\u3057\u3066\u3088\u3044\u306E\u306F\u4E0A\u8A18\u624B\u9806\u3067\u6307\u5B9A\u3055\u308C\u305F\u30E1\u30BF\u30C7\u30FC\u30BF\u53D6\u5F97\u30EA\u30AF\u30A8\u30B9\u30C8\u306E\u307F
+- \u30C4\u30FC\u30EB\u9593\u306F1\u6587\u3060\u3051\u66F8\u3044\u3066\u5373\u6B21\u306E\u30C4\u30FC\u30EB\u547C\u3073\u51FA\u3057\u3002\u4E0D\u8981\u306A\u8AAC\u660E\u306F\u7701\u7565\u3057\u3001\u52B9\u7387\u7684\u306B\u9032\u3081\u308B`,
+    en: `Follow these steps to set up the Semrush connection.
+
+1. Call \`${requestToolName}\` to check the remaining API units:
+   - \`method\`: \`"GET"\`
+   - \`path\`: \`"/"\`
+   - \`queryParams\`: \`{ "type": "user_units" }\`
+2. If the response body starts with \`ERROR\` or API units are 0, ask the user to verify the API key and subscription status (API units must be granted to the account)
+
+#### Constraints
+- **Do NOT run reports that consume large amounts of API units during setup**. Only the metadata request specified above is allowed
+- Write only 1 sentence between tool calls, then immediately call the next tool. Skip unnecessary explanations and proceed efficiently`
+  },
+  dataOverviewInstructions: {
+    en: `1. Call ${requestToolName} with path "/" and queryParams \`{ "type": "domain_overview", "domain": "<example.com>", "database": "us" }\` to inspect the domain overview report (CSV)
+2. Call ${requestToolName} with path "/" and queryParams \`{ "type": "domain_organic", "domain": "<example.com>", "database": "us", "display_limit": "5" }\` to sample organic keywords
+3. Call ${requestToolName} with path "/" and queryParams \`{ "type": "phrase_this", "phrase": "<keyword>", "database": "us" }\` to inspect a keyword overview
+4. Explore other report types (backlinks_overview, domain_adwords, phrase_related) and the Trends API ("/analytics/v1/...") with responseFormat="json" as needed
+5. Remember: the Standard Analytics API returns semicolon-separated CSV with the first row as the header`,
+    ja: `1. ${requestToolName} \u3067 path "/" \u3068 queryParams \`{ "type": "domain_overview", "domain": "<example.com>", "database": "us" }\` \u3092\u547C\u3073\u51FA\u3057\u3001\u30C9\u30E1\u30A4\u30F3\u30AA\u30FC\u30D0\u30FC\u30D3\u30E5\u30FC\uFF08CSV\uFF09\u3092\u78BA\u8A8D
+2. ${requestToolName} \u3067 path "/" \u3068 queryParams \`{ "type": "domain_organic", "domain": "<example.com>", "database": "us", "display_limit": "5" }\` \u3092\u547C\u3073\u51FA\u3057\u3001\u30AA\u30FC\u30AC\u30CB\u30C3\u30AF\u30AD\u30FC\u30EF\u30FC\u30C9\u3092\u30B5\u30F3\u30D7\u30EA\u30F3\u30B0
+3. ${requestToolName} \u3067 path "/" \u3068 queryParams \`{ "type": "phrase_this", "phrase": "<keyword>", "database": "us" }\` \u3092\u547C\u3073\u51FA\u3057\u3001\u30AD\u30FC\u30EF\u30FC\u30C9\u6982\u8981\u3092\u78BA\u8A8D
+4. \u5FC5\u8981\u306B\u5FDC\u3058\u3066\u4ED6\u306E\u30EC\u30DD\u30FC\u30C8\u30BF\u30A4\u30D7\uFF08backlinks_overview\u3001domain_adwords\u3001phrase_related\uFF09\u3084 Trends API ("/analytics/v1/...", responseFormat="json") \u3092\u63A2\u7D22
+5. \u6CE8\u610F: Standard Analytics API \u306F\u30BB\u30DF\u30B3\u30ED\u30F3\u533A\u5207\u308ACSV\u3092\u8FD4\u3057\u30011\u884C\u76EE\u304C\u30D8\u30C3\u30C0\u30FC`
+  }
+});
+
+// ../connectors/src/connectors/semrush/index.ts
+var tools = { request: requestTool };
+var semrushConnector = new ConnectorPlugin({
+  slug: "semrush",
+  authType: AUTH_TYPES.API_KEY,
+  name: "Semrush",
+  description: "Connect to Semrush for SEO, paid search, content, and competitive intelligence data via the Semrush API (Standard Analytics, Trends, and Projects).",
+  iconUrl: "https://images.ctfassets.net/9ncizv60xc5y/4mrVYrg72PeaEv5F6hEF6g/b6cd050f9d97b9998ab3371cfe656988/semrush-icon.png",
+  parameters,
+  releaseFlag: { dev1: true, dev2: true, prod: true },
+  categories: ["marketing"],
+  onboarding: semrushOnboarding,
+  systemPrompt: {
+    en: `### Tools
+
+- \`semrush-api-key_request\`: The only way to call the Semrush API. Use it for the Standard Analytics API (\`/?type=...\` reports), the Trends API (\`/analytics/v1/...\`), and the Projects API (\`/management/v1/...\`). Authentication is handled automatically \u2014 the API key is appended as the \`key\` query parameter; never include it yourself. The Standard Analytics API returns semicolon-separated CSV with the first row as the header (use \`responseFormat="text"\`); the Trends and Projects APIs return JSON (use \`responseFormat="json"\`). Errors from the Standard API are returned as a body that starts with \`ERROR\`, often with HTTP 200 \u2014 the tool surfaces these as \`success: false\` automatically.
+
+### Business Logic
+
+The business logic type for this connector is "typescript". Write handler code using the connector SDK shown below. Do NOT access credentials directly from environment variables.
+
+SDK methods (client created via \`connection(connectionId)\`):
+- \`client.request(path, init?)\` \u2014 low-level authenticated fetch. Pass \`init.query\` to set query parameters; \`key\` is injected automatically
+- \`client.report(type, query?)\` \u2014 call a Standard Analytics report and parse the CSV into \`{ columns, rows, raw }\`
+- \`client.trends(path, query?)\` \u2014 call a Trends API endpoint (\`/analytics/v1/...\`) and return parsed JSON
+- \`client.projects(path, init?)\` \u2014 call a Projects API endpoint (\`/management/v1/...\`) and return parsed JSON
+
+\`\`\`ts
+import type { Context } from "hono";
+import { connection } from "@squadbase/vite-server/connectors/semrush";
+
+const semrush = connection("<connectionId>");
+
+export default async function handler(c: Context) {
+  const { domain = "example.com", database = "us" } = await c.req.json<{
+    domain?: string;
+    database?: string;
+  }>();
+
+  const overview = await semrush.report("domain_overview", { domain, database });
+
+  return c.json({ columns: overview.columns, rows: overview.rows });
+}
+\`\`\`
+
+### Semrush API Reference
+
+- Standard Analytics API: \`https://api.semrush.com/?type={report}&key={apiKey}&...\` \u2014 semicolon-separated CSV
+- Trends API: \`https://api.semrush.com/analytics/v1/...\` \u2014 JSON
+- Projects (Management) API: \`https://api.semrush.com/management/v1/...\` \u2014 JSON
+
+Authentication: API key passed as the \`key\` query parameter on every request (handled automatically).
+
+#### Common Standard Analytics report types
+- \`domain_overview\` \u2014 domain summary (organic/paid traffic, keywords, backlinks)
+- \`domain_organic\` \u2014 organic keywords for a domain
+- \`domain_adwords\` \u2014 paid keywords for a domain
+- \`domain_organic_organic\` / \`domain_adwords_adwords\` \u2014 organic / paid competitors
+- \`phrase_this\` \u2014 keyword overview (search volume, CPC, competition, trend)
+- \`phrase_related\` \u2014 related keywords
+- \`phrase_fullsearch\` \u2014 full-text keyword research
+- \`phrase_questions\` \u2014 question keywords
+- \`phrase_kdi\` \u2014 keyword difficulty index
+- \`backlinks_overview\` \u2014 backlinks summary
+- \`backlinks\` \u2014 list of backlinks
+- \`backlinks_refdomains\` \u2014 referring domains
+- \`url_organic\` / \`url_adwords\` \u2014 keywords ranking for a specific URL
+- \`user_units\` \u2014 remaining API units for the account
+
+#### Common query parameters
+- \`type\` \u2014 report type (required for the Standard API)
+- \`domain\` / \`phrase\` / \`url\` \u2014 entity to query
+- \`database\` \u2014 regional database (e.g. \`us\`, \`uk\`, \`de\`, \`fr\`, \`jp\`, \`br\`); required for most reports
+- \`display_limit\` \u2014 page size (default 10000, max 100000 depending on report)
+- \`display_offset\` \u2014 pagination offset
+- \`display_date\` \u2014 historical date in \`YYYYMM15\` format (always day 15)
+- \`export_columns\` \u2014 comma-separated columns to return (e.g. \`Ph,Po,Nq,Cp\`)
+- \`display_sort\` \u2014 sort directive (e.g. \`tr_desc\`)
+- \`display_filter\` \u2014 filter directive (e.g. \`+|Ph|Co|keyword\`)
+
+#### Tips
+- Each report consumes API units; check \`type=user_units\` first if you suspect a quota issue
+- The CSV separator is \`;\` (semicolon), NOT \`,\`. Some cells may contain commas inside them.
+- An HTTP 200 response with a body starting with \`ERROR\` indicates an API error (auth, parameters, or quota)
+- The Trends API requires a separate Trends subscription; calls without it will fail with an authorization error
+- Date strings in historical endpoints must be the 15th of the month (\`YYYYMM15\`)`,
+    ja: `### \u30C4\u30FC\u30EB
+
+- \`semrush-api-key_request\`: Semrush API\u3092\u547C\u3073\u51FA\u3059\u552F\u4E00\u306E\u624B\u6BB5\u3067\u3059\u3002Standard Analytics API\uFF08\`/?type=...\` \u5F62\u5F0F\u306E\u30EC\u30DD\u30FC\u30C8\uFF09\u3001Trends API\uFF08\`/analytics/v1/...\`\uFF09\u3001Projects API\uFF08\`/management/v1/...\`\uFF09\u3059\u3079\u3066\u306B\u4F7F\u7528\u3057\u307E\u3059\u3002\u8A8D\u8A3C\u306F\u81EA\u52D5\u7684\u306B\u884C\u308F\u308C\u3001API\u30AD\u30FC\u306F \`key\` \u30AF\u30A8\u30EA\u30D1\u30E9\u30E1\u30FC\u30BF\u3068\u3057\u3066\u4ED8\u4E0E\u3055\u308C\u308B\u305F\u3081\u3001\u81EA\u5206\u3067\u542B\u3081\u306A\u3044\u3067\u304F\u3060\u3055\u3044\u3002Standard Analytics API \u306F1\u884C\u76EE\u304C\u30D8\u30C3\u30C0\u30FC\u306E\u30BB\u30DF\u30B3\u30ED\u30F3\u533A\u5207\u308ACSV\u3092\u8FD4\u3059\u305F\u3081 \`responseFormat="text"\` \u3092\u4F7F\u7528\u3057\u3001Trends/Projects API \u306F JSON \u3092\u8FD4\u3059\u305F\u3081 \`responseFormat="json"\` \u3092\u4F7F\u7528\u3057\u3066\u304F\u3060\u3055\u3044\u3002Standard API \u306E\u30A8\u30E9\u30FC\u306F HTTP 200 \u3067\u3082\u672C\u6587\u304C \`ERROR\` \u3067\u59CB\u307E\u308B\u5F62\u5F0F\u3067\u8FD4\u308B\u3053\u3068\u304C\u3042\u308A\u307E\u3059\u304C\u3001\u30C4\u30FC\u30EB\u306F\u81EA\u52D5\u7684\u306B \`success: false\` \u3068\u3057\u3066\u8FD4\u3057\u307E\u3059\u3002
+
+### Business Logic
+
+\u3053\u306E\u30B3\u30CD\u30AF\u30BF\u306E\u30D3\u30B8\u30CD\u30B9\u30ED\u30B8\u30C3\u30AF\u30BF\u30A4\u30D7\u306F "typescript" \u3067\u3059\u3002\u4EE5\u4E0B\u306B\u793A\u3059\u30B3\u30CD\u30AF\u30BFSDK\u3092\u4F7F\u7528\u3057\u3066\u30CF\u30F3\u30C9\u30E9\u30B3\u30FC\u30C9\u3092\u8A18\u8FF0\u3057\u3066\u304F\u3060\u3055\u3044\u3002\u74B0\u5883\u5909\u6570\u304B\u3089\u76F4\u63A5\u8A8D\u8A3C\u60C5\u5831\u306B\u30A2\u30AF\u30BB\u30B9\u3057\u306A\u3044\u3067\u304F\u3060\u3055\u3044\u3002
+
+SDK\u30E1\u30BD\u30C3\u30C9 (\`connection(connectionId)\` \u3067\u4F5C\u6210\u3057\u305F\u30AF\u30E9\u30A4\u30A2\u30F3\u30C8):
+- \`client.request(path, init?)\` \u2014 \u8A8D\u8A3C\u4ED8\u304D\u306E\u4F4E\u30EC\u30D9\u30EBfetch\u3002\`init.query\` \u3067\u30AF\u30A8\u30EA\u30D1\u30E9\u30E1\u30FC\u30BF\u3092\u6307\u5B9A\u3002\`key\` \u306F\u81EA\u52D5\u4ED8\u4E0E
+- \`client.report(type, query?)\` \u2014 Standard Analytics \u306E\u30EC\u30DD\u30FC\u30C8\u3092\u547C\u3073\u51FA\u3057\u3001CSV\u3092 \`{ columns, rows, raw }\` \u306B\u30D1\u30FC\u30B9
+- \`client.trends(path, query?)\` \u2014 Trends API \u30A8\u30F3\u30C9\u30DD\u30A4\u30F3\u30C8\uFF08\`/analytics/v1/...\`\uFF09\u3092\u547C\u3073\u51FA\u3057 JSON \u3092\u8FD4\u3059
+- \`client.projects(path, init?)\` \u2014 Projects API \u30A8\u30F3\u30C9\u30DD\u30A4\u30F3\u30C8\uFF08\`/management/v1/...\`\uFF09\u3092\u547C\u3073\u51FA\u3057 JSON \u3092\u8FD4\u3059
+
+\`\`\`ts
+import type { Context } from "hono";
+import { connection } from "@squadbase/vite-server/connectors/semrush";
+
+const semrush = connection("<connectionId>");
+
+export default async function handler(c: Context) {
+  const { domain = "example.com", database = "us" } = await c.req.json<{
+    domain?: string;
+    database?: string;
+  }>();
+
+  const overview = await semrush.report("domain_overview", { domain, database });
+
+  return c.json({ columns: overview.columns, rows: overview.rows });
+}
+\`\`\`
+
+### Semrush API \u30EA\u30D5\u30A1\u30EC\u30F3\u30B9
+
+- Standard Analytics API: \`https://api.semrush.com/?type={report}&key={apiKey}&...\` \u2014 \u30BB\u30DF\u30B3\u30ED\u30F3\u533A\u5207\u308ACSV
+- Trends API: \`https://api.semrush.com/analytics/v1/...\` \u2014 JSON
+- Projects (Management) API: \`https://api.semrush.com/management/v1/...\` \u2014 JSON
+
+\u8A8D\u8A3C: API\u30AD\u30FC\u3092\u3059\u3079\u3066\u306E\u30EA\u30AF\u30A8\u30B9\u30C8\u306B \`key\` \u30AF\u30A8\u30EA\u30D1\u30E9\u30E1\u30FC\u30BF\u3068\u3057\u3066\u4ED8\u4E0E\uFF08\u81EA\u52D5\uFF09\u3002
+
+#### \u4E3B\u8981\u306A Standard Analytics \u30EC\u30DD\u30FC\u30C8\u30BF\u30A4\u30D7
+- \`domain_overview\` \u2014 \u30C9\u30E1\u30A4\u30F3\u306E\u30B5\u30DE\u30EA\u30FC\uFF08\u30AA\u30FC\u30AC\u30CB\u30C3\u30AF/\u6709\u6599\u30C8\u30E9\u30D5\u30A3\u30C3\u30AF\u3001\u30AD\u30FC\u30EF\u30FC\u30C9\u3001\u30D0\u30C3\u30AF\u30EA\u30F3\u30AF\uFF09
+- \`domain_organic\` \u2014 \u30C9\u30E1\u30A4\u30F3\u306E\u30AA\u30FC\u30AC\u30CB\u30C3\u30AF\u30AD\u30FC\u30EF\u30FC\u30C9
+- \`domain_adwords\` \u2014 \u30C9\u30E1\u30A4\u30F3\u306E\u6709\u6599\u30AD\u30FC\u30EF\u30FC\u30C9
+- \`domain_organic_organic\` / \`domain_adwords_adwords\` \u2014 \u30AA\u30FC\u30AC\u30CB\u30C3\u30AF\uFF0F\u6709\u6599\u306E\u7AF6\u5408
+- \`phrase_this\` \u2014 \u30AD\u30FC\u30EF\u30FC\u30C9\u6982\u8981\uFF08\u691C\u7D22\u30DC\u30EA\u30E5\u30FC\u30E0\u3001CPC\u3001\u7AF6\u5408\u5EA6\u3001\u30C8\u30EC\u30F3\u30C9\uFF09
+- \`phrase_related\` \u2014 \u95A2\u9023\u30AD\u30FC\u30EF\u30FC\u30C9
+- \`phrase_fullsearch\` \u2014 \u30D5\u30EB\u30C6\u30AD\u30B9\u30C8\u30AD\u30FC\u30EF\u30FC\u30C9\u30EA\u30B5\u30FC\u30C1
+- \`phrase_questions\` \u2014 \u8CEA\u554F\u5F62\u5F0F\u30AD\u30FC\u30EF\u30FC\u30C9
+- \`phrase_kdi\` \u2014 \u30AD\u30FC\u30EF\u30FC\u30C9\u96E3\u6613\u5EA6\uFF08KDI\uFF09
+- \`backlinks_overview\` \u2014 \u30D0\u30C3\u30AF\u30EA\u30F3\u30AF\u6982\u8981
+- \`backlinks\` \u2014 \u30D0\u30C3\u30AF\u30EA\u30F3\u30AF\u4E00\u89A7
+- \`backlinks_refdomains\` \u2014 \u53C2\u7167\u30C9\u30E1\u30A4\u30F3
+- \`url_organic\` / \`url_adwords\` \u2014 \u7279\u5B9AURL\u3067\u30E9\u30F3\u30AF\u30A4\u30F3\u3057\u3066\u3044\u308B\u30AD\u30FC\u30EF\u30FC\u30C9
+- \`user_units\` \u2014 \u30A2\u30AB\u30A6\u30F3\u30C8\u306E\u6B8BAPI\u30E6\u30CB\u30C3\u30C8\u6570
+
+#### \u4E3B\u8981\u306A\u30AF\u30A8\u30EA\u30D1\u30E9\u30E1\u30FC\u30BF
+- \`type\` \u2014 \u30EC\u30DD\u30FC\u30C8\u7A2E\u5225\uFF08Standard API \u3067\u306F\u5FC5\u9808\uFF09
+- \`domain\` / \`phrase\` / \`url\` \u2014 \u30AF\u30A8\u30EA\u5BFE\u8C61\u306E\u30A8\u30F3\u30C6\u30A3\u30C6\u30A3
+- \`database\` \u2014 \u5730\u57DF\u5225\u30C7\u30FC\u30BF\u30D9\u30FC\u30B9\uFF08\`us\`, \`uk\`, \`de\`, \`fr\`, \`jp\`, \`br\` \u306A\u3069\uFF09\u3002\u591A\u304F\u306E\u30EC\u30DD\u30FC\u30C8\u3067\u5FC5\u9808
+- \`display_limit\` \u2014 \u30DA\u30FC\u30B8\u30B5\u30A4\u30BA\uFF08\u30C7\u30D5\u30A9\u30EB\u30C810000\u3001\u30EC\u30DD\u30FC\u30C8\u306B\u3088\u3063\u3066\u306F\u6700\u5927100000\uFF09
+- \`display_offset\` \u2014 \u30DA\u30FC\u30B8\u30CD\u30FC\u30B7\u30E7\u30F3\u30AA\u30D5\u30BB\u30C3\u30C8
+- \`display_date\` \u2014 \u5C65\u6B74\u306E\u65E5\u4ED8\u3002\`YYYYMM15\` \u5F62\u5F0F\uFF08\u5FC5\u305A\u6708\u306E15\u65E5\uFF09
+- \`export_columns\` \u2014 \u8FD4\u5374\u30AB\u30E9\u30E0\u3092\u30AB\u30F3\u30DE\u533A\u5207\u308A\u3067\u6307\u5B9A\uFF08\u4F8B: \`Ph,Po,Nq,Cp\`\uFF09
+- \`display_sort\` \u2014 \u30BD\u30FC\u30C8\u6307\u5B9A\uFF08\u4F8B: \`tr_desc\`\uFF09
+- \`display_filter\` \u2014 \u30D5\u30A3\u30EB\u30BF\u6307\u5B9A\uFF08\u4F8B: \`+|Ph|Co|keyword\`\uFF09
+
+#### \u30D2\u30F3\u30C8
+- \u5404\u30EC\u30DD\u30FC\u30C8\u306F API \u30E6\u30CB\u30C3\u30C8\u3092\u6D88\u8CBB\u3059\u308B\u3002\u30AF\u30A9\u30FC\u30BF\u304C\u7591\u308F\u3057\u3044\u5834\u5408\u306F \`type=user_units\` \u3067\u6B8B\u91CF\u3092\u5148\u306B\u78BA\u8A8D\u3059\u308B
+- CSV \u306E\u30BB\u30D1\u30EC\u30FC\u30BF\u306F \`;\`\uFF08\u30BB\u30DF\u30B3\u30ED\u30F3\uFF09\u3067\u3042\u308A \`,\` \u3067\u306F\u306A\u3044\u3002\u30BB\u30EB\u5185\u306B\u30AB\u30F3\u30DE\u304C\u542B\u307E\u308C\u308B\u3053\u3068\u304C\u3042\u308B
+- HTTP 200 \u3067\u3082\u672C\u6587\u304C \`ERROR\` \u3067\u59CB\u307E\u308B\u5834\u5408\u306F API\u30A8\u30E9\u30FC\uFF08\u8A8D\u8A3C\u3001\u30D1\u30E9\u30E1\u30FC\u30BF\u3001\u30AF\u30A9\u30FC\u30BF\uFF09
+- Trends API \u306F\u5225\u9014 Trends \u30B5\u30D6\u30B9\u30AF\u30EA\u30D7\u30B7\u30E7\u30F3\u304C\u5FC5\u8981\u3002\u672A\u5951\u7D04\u3060\u3068\u8A8D\u53EF\u30A8\u30E9\u30FC\u306B\u306A\u308B
+- \u5C65\u6B74\u30A8\u30F3\u30C9\u30DD\u30A4\u30F3\u30C8\u306E\u65E5\u4ED8\u306F\u5FC5\u305A\u6708\u306E15\u65E5\uFF08\`YYYYMM15\`\uFF09`
+  },
+  tools,
+  async checkConnection(params) {
+    try {
+      const apiKey = params["api-key"];
+      if (!apiKey) {
+        return {
+          success: false,
+          error: "API Key is not configured"
+        };
+      }
+      const url = new URL("https://api.semrush.com/");
+      url.searchParams.set("type", "user_units");
+      url.searchParams.set("key", apiKey);
+      const res = await fetch(url.toString(), { method: "GET" });
+      const text = await res.text();
+      if (text.startsWith("ERROR ")) {
+        return { success: false, error: text.trim() };
+      }
+      if (!res.ok) {
+        return {
+          success: false,
+          error: `Semrush API failed: HTTP ${res.status} ${text || res.statusText}`
+        };
+      }
+      return { success: true };
+    } catch (error) {
+      return {
+        success: false,
+        error: error instanceof Error ? error.message : String(error)
+      };
+    }
+  }
+});
+
+// src/connectors/create-connector-sdk.ts
+import { readFileSync } from "fs";
+import path from "path";
+
+// src/connector-client/env.ts
+function resolveEnvVar(entry, key, connectionId) {
+  const envVarName = entry.envVars[key];
+  if (!envVarName) {
+    throw new Error(`Connection "${connectionId}" is missing envVars mapping for key "${key}"`);
+  }
+  const value = process.env[envVarName];
+  if (!value) {
+    throw new Error(`Environment variable "${envVarName}" (for connection "${connectionId}", key "${key}") is not set`);
+  }
+  return value;
+}
+function resolveEnvVarOptional(entry, key) {
+  const envVarName = entry.envVars[key];
+  if (!envVarName) return void 0;
+  return process.env[envVarName] || void 0;
+}
+
+// src/connector-client/proxy-fetch.ts
+import { getContext } from "hono/context-storage";
+import { getCookie } from "hono/cookie";
+var APP_SESSION_COOKIE_NAME = "__Host-squadbase-session";
+function normalizeHeaders(input) {
+  const out = {};
+  if (!input) return out;
+  new Headers(input).forEach((value, key) => {
+    out[key] = value;
+  });
+  return out;
+}
+function createSandboxProxyFetch(connectionId) {
+  return async (input, init) => {
+    const token = process.env.INTERNAL_SQUADBASE_OAUTH_MACHINE_CREDENTIAL;
+    const sandboxId = process.env.INTERNAL_SQUADBASE_SANDBOX_ID;
+    if (!token || !sandboxId) {
+      throw new Error(
+        "Connection proxy is not configured. Please check your deployment settings."
+      );
+    }
+    const originalUrl = typeof input === "string" ? input : input instanceof URL ? input.href : input.url;
+    const originalMethod = init?.method ?? "GET";
+    const originalBody = init?.body ? JSON.parse(init.body) : void 0;
+    const baseDomain = process.env["SQUADBASE_PREVIEW_BASE_DOMAIN"] ?? "preview.app.squadbase.dev";
+    const proxyUrl = `https://${sandboxId}.${baseDomain}/_sqcore/connections/${connectionId}/request`;
+    return fetch(proxyUrl, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bearer ${token}`
+      },
+      body: JSON.stringify({
+        url: originalUrl,
+        method: originalMethod,
+        headers: normalizeHeaders(init?.headers),
+        body: originalBody
+      })
+    });
+  };
+}
+function createDeployedAppProxyFetch(connectionId) {
+  const projectId = process.env["SQUADBASE_PROJECT_ID"];
+  if (!projectId) {
+    throw new Error(
+      "Connection proxy is not configured. Please check your deployment settings."
+    );
+  }
+  const baseDomain = process.env["SQUADBASE_APP_BASE_DOMAIN"] ?? "squadbase.app";
+  const proxyUrl = `https://${projectId}.${baseDomain}/_sqcore/connections/${connectionId}/request`;
+  return async (input, init) => {
+    const originalUrl = typeof input === "string" ? input : input instanceof URL ? input.href : input.url;
+    const originalMethod = init?.method ?? "GET";
+    const originalBody = init?.body ? JSON.parse(init.body) : void 0;
+    const c = getContext();
+    const appSession = getCookie(c, APP_SESSION_COOKIE_NAME);
+    if (!appSession) {
+      throw new Error(
+        "No authentication method available for connection proxy."
+      );
+    }
+    return fetch(proxyUrl, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bearer ${appSession}`
+      },
+      body: JSON.stringify({
+        url: originalUrl,
+        method: originalMethod,
+        headers: normalizeHeaders(init?.headers),
+        body: originalBody
+      })
+    });
+  };
+}
+function createProxyFetch(connectionId) {
+  if (process.env.INTERNAL_SQUADBASE_SANDBOX_ID) {
+    return createSandboxProxyFetch(connectionId);
+  }
+  return createDeployedAppProxyFetch(connectionId);
+}
+
+// src/connectors/create-connector-sdk.ts
+function loadConnectionsSync() {
+  const filePath = process.env.CONNECTIONS_PATH ?? path.join(process.cwd(), ".squadbase/connections.json");
+  try {
+    const raw = readFileSync(filePath, "utf-8");
+    return JSON.parse(raw);
+  } catch {
+    return {};
+  }
+}
+function createConnectorSdk(plugin, createClient2) {
+  return (connectionId) => {
+    const connections = loadConnectionsSync();
+    const entry = connections[connectionId];
+    if (!entry) {
+      throw new Error(
+        `Connection "${connectionId}" not found in .squadbase/connections.json`
+      );
+    }
+    if (entry.connector.slug !== plugin.slug) {
+      throw new Error(
+        `Connection "${connectionId}" is not a ${plugin.slug} connection (got "${entry.connector.slug}")`
+      );
+    }
+    const params = {};
+    for (const param of Object.values(plugin.parameters)) {
+      if (param.required) {
+        params[param.slug] = resolveEnvVar(entry, param.slug, connectionId);
+      } else {
+        const val = resolveEnvVarOptional(entry, param.slug);
+        if (val !== void 0) params[param.slug] = val;
+      }
+    }
+    return createClient2(params, createProxyFetch(connectionId));
+  };
+}
+
+// src/connectors/entries/semrush.ts
+var connection = createConnectorSdk(semrushConnector, createClient);
+export {
+  connection
+};