@gscdump/sdk 2.0.2 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/client.d.mts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { AnalysisSourcesOptions, SearchTypeOptions, SourceRangeOptions } from "./hosted-query.mjs";
2
2
  import { HostedClientOptions, HostedFetch, HostedFetchOptions, HostedHeaders } from "./request.mjs";
3
- import { AddPartnerTeamMemberParams, BindPartnerSiteTeamParams, BindPartnerTeamCatalogParams, BindPartnerTeamCatalogResponse, BuilderStateWire, BulkRegisterPartnerSitesParams, BulkRegisterPartnerSitesResponse, CreatePartnerTeamParams, DataDetailOptions, DataQueryOptions, DeletePartnerUserResponse, GscAddAndVerifyResponse, GscVerificationRequest, GscVerificationTokenResponse, GscdumpAnalysisSourcesResponse, GscdumpAvailableSite, GscdumpCanonicalMismatchesResponse, GscdumpDataDetailResponse, GscdumpDataResponse, GscdumpIndexPercentResponse, GscdumpIndexingDiagnosticsResponse, GscdumpIndexingResponse, GscdumpIndexingUrlsResponse, GscdumpKeywordSparklinesParams, GscdumpKeywordSparklinesResponse, GscdumpPageTrendParams, GscdumpPageTrendResponse, GscdumpPermissionRecovery, GscdumpQueryTrendParams, GscdumpQueryTrendResponse, GscdumpSiteIntIdCrosswalkResponse, GscdumpSiteRegistration, GscdumpSyncStatusResponse, GscdumpTeamCatalogRef, GscdumpTeamMemberRow, GscdumpTeamRow, GscdumpTopAssociationParams, GscdumpTopAssociationResponse, GscdumpUserRegistration, GscdumpUserSettings, GscdumpUserSite, GscdumpUserStatus, GscdumpUserTokenUpdate, IndexingDiagnosticsParams, IndexingInspectRateLimited, IndexingInspectRequest, IndexingInspectResponse, IndexingUrlsParams, PartnerLifecycleResponse, RegisterPartnerSiteParams, RegisterPartnerUserParams, UpdatePartnerUserTokensParams } from "@gscdump/contracts";
3
+ import { BuilderStateWire, BulkRegisterPartnerSitesParams, BulkRegisterPartnerSitesResponse, DataDetailOptions, DataQueryOptions, GscAddAndVerifyResponse, GscVerificationRequest, GscVerificationTokenResponse, GscdumpAnalysisSourcesResponse, GscdumpAvailableSite, GscdumpDataDetailResponse, GscdumpDataResponse, GscdumpIndexingDiagnosticsResponse, GscdumpIndexingResponse, GscdumpIndexingUrlsResponse, GscdumpSiteRegistration, GscdumpSyncStatusResponse, GscdumpUserRegistration, GscdumpUserSettings, GscdumpUserSite, GscdumpUserStatus, GscdumpUserTokenUpdate, IndexingDiagnosticsParams, IndexingUrlsParams, PartnerLifecycleResponse, RegisterPartnerSiteParams, RegisterPartnerUserParams, UpdatePartnerUserTokensParams } from "@gscdump/contracts";
4
4
  type PartnerFetch = HostedFetch;
5
5
  type PartnerHeaders = HostedHeaders;
6
6
  type PartnerFetchOptions = HostedFetchOptions;
@@ -39,12 +39,10 @@ interface PartnerClient {
39
39
  getAvailableSites: (userId: string) => Promise<{
40
40
  sites: GscdumpAvailableSite[];
41
41
  }>;
42
- getUserSiteIntIdCrosswalk: (userId: string) => Promise<GscdumpSiteIntIdCrosswalkResponse>;
43
42
  registerSite: (params: RegisterPartnerSiteParams) => Promise<GscdumpSiteRegistration>;
44
43
  bulkRegisterSites: (params: BulkRegisterPartnerSitesParams) => Promise<BulkRegisterPartnerSitesResponse>;
45
44
  requestSiteVerificationToken: (params: GscVerificationRequest) => Promise<GscVerificationTokenResponse>;
46
45
  addAndVerifySite: (params: GscVerificationRequest) => Promise<GscAddAndVerifyResponse>;
47
- deleteUser: (userId: string) => Promise<DeletePartnerUserResponse>;
48
46
  deleteSite: (siteId: string) => Promise<{
49
47
  success: boolean;
50
48
  }>;
@@ -55,55 +53,8 @@ interface PartnerClient {
55
53
  getIndexing: (siteId: string, days?: number) => Promise<GscdumpIndexingResponse>;
56
54
  getIndexingUrls: (siteId: string, params?: IndexingUrlsParams) => Promise<GscdumpIndexingUrlsResponse>;
57
55
  getIndexingDiagnostics: (siteId: string, params?: IndexingDiagnosticsParams) => Promise<GscdumpIndexingDiagnosticsResponse>;
58
- requestIndexingInspect: (siteId: string, body: IndexingInspectRequest) => Promise<IndexingInspectResponse | IndexingInspectRateLimited>;
59
56
  getUserSettings: () => Promise<GscdumpUserSettings>;
60
57
  patchUserSettings: (body: Partial<GscdumpUserSettings>) => Promise<GscdumpUserSettings>;
61
- recoverPermission: (siteId: string) => Promise<GscdumpPermissionRecovery>;
62
- getTopAssociation: (siteId: string, params: GscdumpTopAssociationParams) => Promise<GscdumpTopAssociationResponse>;
63
- getKeywordSparklines: (siteId: string, params: GscdumpKeywordSparklinesParams) => Promise<GscdumpKeywordSparklinesResponse>;
64
- getQueryTrend: (siteId: string, params: GscdumpQueryTrendParams) => Promise<GscdumpQueryTrendResponse>;
65
- getPageTrend: (siteId: string, params: GscdumpPageTrendParams) => Promise<GscdumpPageTrendResponse>;
66
- getCanonicalMismatches: (siteId: string) => Promise<GscdumpCanonicalMismatchesResponse>;
67
- getIndexPercent: (siteId: string, params?: {
68
- invisibleLimit?: number;
69
- invisibleOffset?: number;
70
- orphanLimit?: number;
71
- }) => Promise<GscdumpIndexPercentResponse>;
72
- createTeam: (params: CreatePartnerTeamParams) => Promise<{
73
- team: GscdumpTeamRow;
74
- }>;
75
- renameTeam: (teamId: string, params: {
76
- name: string;
77
- }) => Promise<{
78
- ok: true;
79
- name: string;
80
- }>;
81
- deleteTeam: (teamId: string) => Promise<{
82
- ok: true;
83
- }>;
84
- listTeamMembers: (teamId: string) => Promise<{
85
- members: GscdumpTeamMemberRow[];
86
- }>;
87
- addTeamMember: (teamId: string, params: AddPartnerTeamMemberParams) => Promise<{
88
- ok: true;
89
- role: string;
90
- alreadyExisted?: boolean;
91
- }>;
92
- updateTeamMemberRole: (teamId: string, userId: string, params: {
93
- role: GscdumpTeamMemberRow['role'];
94
- }) => Promise<{
95
- ok: true;
96
- role: string;
97
- }>;
98
- removeTeamMember: (teamId: string, userId: string) => Promise<{
99
- ok: true;
100
- }>;
101
- bindSiteToTeam: (userId: string, siteId: string, params: BindPartnerSiteTeamParams) => Promise<{
102
- ok: true;
103
- teamId: string | null;
104
- }>;
105
- getTeamCatalog: (teamId: string) => Promise<GscdumpTeamCatalogRef>;
106
- bindTeamCatalog: (teamId: string, params: BindPartnerTeamCatalogParams) => Promise<BindPartnerTeamCatalogResponse>;
107
58
  }
108
59
  declare function createPartnerClient(options?: PartnerClientOptions): PartnerClient;
109
60
  export { PartnerClient, PartnerClientOptions, PartnerFetch, PartnerFetchOptions, PartnerHeaders, createPartnerClient };
package/dist/client.mjs CHANGED
@@ -1,4 +1,4 @@
1
- import { dataDetailQuery, dataQuery, indexingDiagnosticsQuery, indexingUrlsQuery, pageTrendQuery, queryTrendQuery, tablesQuery } from "./hosted-query.mjs";
1
+ import { dataDetailQuery, dataQuery, indexingDiagnosticsQuery, indexingUrlsQuery, tablesQuery } from "./hosted-query.mjs";
2
2
  import { PartnerApiError, partnerErrorToException } from "./errors.mjs";
3
3
  import { createHostedRequester } from "./request.mjs";
4
4
  import { findLifecycleSite, lifecycleSiteToSyncStatus } from "./lifecycle.mjs";
@@ -113,9 +113,6 @@ function createPartnerClient(options = {}) {
113
113
  getAvailableSites(userId) {
114
114
  return request(endpoints.getAvailableSites.path(userId), { method: endpoints.getAvailableSites.method }, endpoints.getAvailableSites.response);
115
115
  },
116
- getUserSiteIntIdCrosswalk(userId) {
117
- return request(endpoints.getUserSiteIntIdCrosswalk.path(userId), { method: endpoints.getUserSiteIntIdCrosswalk.method }, endpoints.getUserSiteIntIdCrosswalk.response);
118
- },
119
116
  registerSite(params) {
120
117
  const body = shouldValidate("request") ? endpoints.registerSite.body.parse(params) : params;
121
118
  return request(endpoints.registerSite.path, {
@@ -144,9 +141,6 @@ function createPartnerClient(options = {}) {
144
141
  body
145
142
  }, endpoints.addAndVerifySite.response);
146
143
  },
147
- deleteUser(userId) {
148
- return request(endpoints.deleteUser.path(userId), { method: endpoints.deleteUser.method }, endpoints.deleteUser.response);
149
- },
150
144
  deleteSite(siteId) {
151
145
  return request(endpoints.deleteSite.path(siteId), { method: endpoints.deleteSite.method });
152
146
  },
@@ -199,13 +193,6 @@ function createPartnerClient(options = {}) {
199
193
  query: indexingDiagnosticsQuery(parsed)
200
194
  }, endpoints.getIndexingDiagnostics.response);
201
195
  },
202
- requestIndexingInspect(siteId, body) {
203
- const parsed = shouldValidate("request") ? endpoints.requestIndexingInspect.body.parse(body) : body;
204
- return request(endpoints.requestIndexingInspect.path(siteId), {
205
- method: endpoints.requestIndexingInspect.method,
206
- body: parsed
207
- }, endpoints.requestIndexingInspect.response);
208
- },
209
196
  getUserSettings() {
210
197
  return request(endpoints.getUserSettings.path, { method: endpoints.getUserSettings.method }, endpoints.getUserSettings.response);
211
198
  },
@@ -215,106 +202,6 @@ function createPartnerClient(options = {}) {
215
202
  method: endpoints.patchUserSettings.method,
216
203
  body: parsed
217
204
  }, endpoints.patchUserSettings.response);
218
- },
219
- recoverPermission(siteId) {
220
- return request(endpoints.recoverPermission.path(siteId), { method: endpoints.recoverPermission.method }, endpoints.recoverPermission.response);
221
- },
222
- getTopAssociation(siteId, params) {
223
- const query = shouldValidate("request") ? endpoints.getTopAssociation.query.parse(params) : params;
224
- return request(endpoints.getTopAssociation.path(siteId), {
225
- method: endpoints.getTopAssociation.method,
226
- query
227
- }, endpoints.getTopAssociation.response);
228
- },
229
- getKeywordSparklines(siteId, params) {
230
- const withSearchType = {
231
- ...params,
232
- searchType: params.searchType ?? "web"
233
- };
234
- const body = shouldValidate("request") ? endpoints.getKeywordSparklines.body.parse(withSearchType) : withSearchType;
235
- return request(endpoints.getKeywordSparklines.path(siteId), {
236
- method: endpoints.getKeywordSparklines.method,
237
- body,
238
- dedupe: true
239
- }, endpoints.getKeywordSparklines.response);
240
- },
241
- getQueryTrend(siteId, params) {
242
- const query = shouldValidate("request") ? endpoints.getQueryTrend.query.parse(params) : params;
243
- return request(endpoints.getQueryTrend.path(siteId), {
244
- method: endpoints.getQueryTrend.method,
245
- query: queryTrendQuery(query)
246
- }, endpoints.getQueryTrend.response);
247
- },
248
- getPageTrend(siteId, params) {
249
- const query = shouldValidate("request") ? endpoints.getPageTrend.query.parse(params) : params;
250
- return request(endpoints.getPageTrend.path(siteId), {
251
- method: endpoints.getPageTrend.method,
252
- query: pageTrendQuery(query)
253
- }, endpoints.getPageTrend.response);
254
- },
255
- getCanonicalMismatches(siteId) {
256
- return request(endpoints.getCanonicalMismatches.path(siteId), { method: endpoints.getCanonicalMismatches.method }, endpoints.getCanonicalMismatches.response);
257
- },
258
- getIndexPercent(siteId, params = {}) {
259
- const query = shouldValidate("request") ? endpoints.getIndexPercent.query.parse(params) : params;
260
- return request(endpoints.getIndexPercent.path(siteId), {
261
- method: endpoints.getIndexPercent.method,
262
- query
263
- }, endpoints.getIndexPercent.response);
264
- },
265
- createTeam(params) {
266
- const body = shouldValidate("request") ? endpoints.createTeam.body.parse(params) : params;
267
- return request(endpoints.createTeam.path, {
268
- method: endpoints.createTeam.method,
269
- body
270
- }, endpoints.createTeam.response);
271
- },
272
- renameTeam(teamId, params) {
273
- const body = shouldValidate("request") ? endpoints.renameTeam.body.parse(params) : params;
274
- return request(endpoints.renameTeam.path(teamId), {
275
- method: endpoints.renameTeam.method,
276
- body
277
- }, endpoints.renameTeam.response);
278
- },
279
- deleteTeam(teamId) {
280
- return request(endpoints.deleteTeam.path(teamId), { method: endpoints.deleteTeam.method }, endpoints.deleteTeam.response);
281
- },
282
- listTeamMembers(teamId) {
283
- return request(endpoints.listTeamMembers.path(teamId), { method: endpoints.listTeamMembers.method }, endpoints.listTeamMembers.response);
284
- },
285
- addTeamMember(teamId, params) {
286
- const body = shouldValidate("request") ? endpoints.addTeamMember.body.parse(params) : params;
287
- return request(endpoints.addTeamMember.path(teamId), {
288
- method: endpoints.addTeamMember.method,
289
- body
290
- }, endpoints.addTeamMember.response);
291
- },
292
- updateTeamMemberRole(teamId, userId, params) {
293
- const body = shouldValidate("request") ? endpoints.updateTeamMemberRole.body.parse(params) : params;
294
- return request(endpoints.updateTeamMemberRole.path(teamId, userId), {
295
- method: endpoints.updateTeamMemberRole.method,
296
- body
297
- }, endpoints.updateTeamMemberRole.response);
298
- },
299
- removeTeamMember(teamId, userId) {
300
- return request(endpoints.removeTeamMember.path(teamId, userId), { method: endpoints.removeTeamMember.method }, endpoints.removeTeamMember.response);
301
- },
302
- bindSiteToTeam(userId, siteId, params) {
303
- const body = shouldValidate("request") ? endpoints.bindSiteToTeam.body.parse(params) : params;
304
- return request(endpoints.bindSiteToTeam.path(userId, siteId), {
305
- method: endpoints.bindSiteToTeam.method,
306
- body
307
- }, endpoints.bindSiteToTeam.response);
308
- },
309
- getTeamCatalog(teamId) {
310
- return request(endpoints.getTeamCatalog.path(teamId), { method: endpoints.getTeamCatalog.method }, endpoints.getTeamCatalog.response);
311
- },
312
- bindTeamCatalog(teamId, params) {
313
- const body = shouldValidate("request") ? endpoints.bindTeamCatalog.body.parse(params) : params;
314
- return request(endpoints.bindTeamCatalog.path(teamId), {
315
- method: endpoints.bindTeamCatalog.method,
316
- body
317
- }, endpoints.bindTeamCatalog.response);
318
205
  }
319
206
  };
320
207
  }
@@ -1,6 +1,6 @@
1
1
  import { RealtimeV1Cursor, RealtimeV1Event, RealtimeV1StreamHead, RealtimeV1StreamId } from "@gscdump/contracts/v1/realtime";
2
2
  type MaybePromise<T> = T | Promise<T>;
3
- declare const GSCDUMP_REALTIME_V1_SDK_VERSION: "2.0.2";
3
+ declare const GSCDUMP_REALTIME_V1_SDK_VERSION: "2.0.3";
4
4
  type GscdumpRealtimeV1TransportState = 'idle' | 'ticketing' | 'connecting' | 'handshaking' | 'replaying' | 'live' | 'waiting' | 'stopped' | 'terminal';
5
5
  type GscdumpRealtimeV1Freshness = 'unknown' | 'stale' | 'applying' | 'fresh' | 'resyncing' | 'degraded';
6
6
  type GscdumpRealtimeV1ErrorCode = 'cursor_store_failed' | 'effect_failed' | 'heartbeat_stale' | 'integration_failed' | 'protocol_error' | 'resync_failed' | 'runtime_unavailable' | 'socket_error' | 'ticket_invalid' | 'ticket_provider_failed' | 'upgrade_rejected';
@@ -1,6 +1,6 @@
1
1
  import { utf8Size } from "../utf8.mjs";
2
2
  import { GSCDUMP_REALTIME_ACK_POLICY, GSCDUMP_REALTIME_CLOSE_CODES, GSCDUMP_REALTIME_CONNECTION_POLICY, GSCDUMP_REALTIME_LIMITS, GSCDUMP_REALTIME_PING, GSCDUMP_REALTIME_PONG, GSCDUMP_REALTIME_PROTOCOL_VERSION, GSCDUMP_REALTIME_SUBPROTOCOL, REALTIME_V1_EVENT_NAMES, REALTIME_V1_RESOURCE_TYPES, createRealtimeV1Schemas } from "@gscdump/contracts/v1/realtime";
3
- const GSCDUMP_REALTIME_V1_SDK_VERSION = "2.0.2";
3
+ const GSCDUMP_REALTIME_V1_SDK_VERSION = "2.0.3";
4
4
  var GscdumpRealtimeV1Error = class extends Error {
5
5
  tag = "GscdumpRealtimeV1Error";
6
6
  code;
@@ -87,7 +87,7 @@ function createGscdumpRealtimeV1Client(options) {
87
87
  const schemas = createRealtimeV1Schemas();
88
88
  const runtime = options.runtime ?? defaultRuntime();
89
89
  const cursorStore = options.cursorStore ?? createMemoryCursorStore();
90
- const sdkVersion = options.sdkVersion ?? "2.0.2";
90
+ const sdkVersion = options.sdkVersion ?? "2.0.3";
91
91
  if (!sdkVersion) throw new TypeError("sdkVersion cannot be empty.");
92
92
  let running = false;
93
93
  let epoch = 0;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@gscdump/sdk",
3
3
  "type": "module",
4
- "version": "2.0.2",
4
+ "version": "2.0.3",
5
5
  "description": "Consumer SDK for hosted gscdump.com integrations.",
6
6
  "author": {
7
7
  "name": "Harlan Wilton",
@@ -146,9 +146,9 @@
146
146
  "dependencies": {
147
147
  "ofetch": "^1.5.1",
148
148
  "zod": "^4.4.3",
149
- "@gscdump/contracts": "^2.0.2",
150
- "@gscdump/engine": "^2.0.2",
151
- "gscdump": "^2.0.2"
149
+ "@gscdump/contracts": "^2.0.3",
150
+ "@gscdump/engine": "^2.0.3",
151
+ "gscdump": "^2.0.3"
152
152
  },
153
153
  "devDependencies": {
154
154
  "typescript": "^7.0.2",