@gscdump/sdk

中文文档
7.15.0发布于 2026/11/16MITTypeScriptES Module构建来源已验证近 30 天下载 8002

Consumer SDK for hosted gscdump.com integrations.

原始使用文档

@gscdump/sdk

Consumer SDK for hosted gscdump.com integrations.

Use @gscdump/sdk/v1 for hosted HTTP and realtime clients. The package root has no export. Keep long-lived credentials on your server.

npm install @gscdump/sdk
import { createGscdumpV1Client } from '@gscdump/sdk/v1'

const gscdump = createGscdumpV1Client({
  credential: () => process.env.GSCDUMP_API_KEY!,
  fetch,
})

const lifecycle = await gscdump.getUserLifecycle({
  params: { userId: 'u_01' },
})

The v1 surface uses a server-held Bearer credential and exposes a generic operation executor plus typed convenience methods for all 55 registered HTTP operations across partner, analytics, and realtime.

Focused guides:

createPartnerClient remains at @gscdump/sdk/partner only for operations still in the compatibility inventory. Do not use it for an operation already available from @gscdump/sdk/v1.

Use focused subpaths for pure helpers, including period, period-presets, site-triage, site-baseline, search-console-stage, indexing-issues, analytics, partner, partner-errors, lifecycle, webhook, and gsc-console-url.

For example, a typed hosted report query is:

const report = await gscdump.queryAnalyticsReport({
  params: { siteId: 's_01' },
  body: { state: { dimensions: ['query'], searchType: 'web' } },
})

@gscdump/sdk/indexing holds the pure indexing dashboard maths: Portfolio stacks and issue counts, the Indexing window, the Indexing overview, the Trust gate, Index cohorts, the Regression lead, and the Portfolio Markdown export. Every function takes data and returns data. A function that needs today takes now.

import { indexingWindow, portfolioIssueCounts, readSiteIndexing } from '@gscdump/sdk/indexing'

const window = indexingWindow('28d', true, new Date())
const sites = reads.map(read => ({ id: read.siteId, label: read.name, trend: readSiteIndexing(read.response).trend }))
const issues = portfolioIssueCounts(sites, window)

Browser integration

Keep user_key and partner_key credentials on your server. Expose a same-origin proxy that preserves the upstream surface and major version, such as /api/gscdump/analytics/v1/.... The browser receives a single-use realtime ticket.

Your applyEvent callback must await every cache change before the SDK advances its cursor or sends an ACK. Your resync callback must clear the affected cache scope and reload authoritative state. See the realtime guide for the client hooks.

The SDK provides HTTP transport, realtime state, and webhook receiver helpers. Your application owns authentication, caching, and UI integration. gscdump.com owns webhook delivery, queues, and storage.

Webhooks

@gscdump/contracts owns the webhook payload schema and event constants. @gscdump/sdk provides receiver-side helpers to parse the payload, verify the signature, and normalize event names. gscdump.com owns webhook production and delivery.

import { parseWebhookPayload } from '@gscdump/sdk/webhook'

const envelope = await parseWebhookPayload(await request.text(), {
  secret: webhookSecret,
  signature: request.headers.get('x-gscdump-signature'),
})

版本与发布记录

@gscdump/sdk 共发布 249 个版本,首次发布于 2026/05/11;过去 12 个月发布了 249 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
7.15.0latest2026/11/16今天
7.14.02026/11/16今天
7.13.22026/11/152 天前
7.13.12026/11/152 天前
7.13.02026/11/124 天前
7.12.12026/11/116 天前

关于 @gscdump/sdk 的常见问题

@gscdump/sdk 是什么?

Consumer SDK for hosted gscdump.com integrations.

如何安装 @gscdump/sdk?

在项目目录运行 npm install @gscdump/sdk,或使用 pnpm add / yarn add / bun add。

@gscdump/sdk 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gscdump/sdk 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@gscdump/sdk 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.13.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@gscdump/sdk 可以商用吗?

@gscdump/sdk 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gscdump/sdk 的下载量有多少?

根据 npm 官方下载统计,@gscdump/sdk 在 2026/10/17 – 2026/11/15 这 30 天内被下载 8,002 次,日均约 267 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gscdump/sdk 还在维护吗?

最新版本 7.15.0 发布于 2026/11/16(今天);至今共发布 249 个版本,其中过去 12 个月发布了 249 个;首次发布于 2026/05/11。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。