@gscdump/contracts 0.39.0 → 0.40.2

package/README.md

@@ -2,7 +2,7 @@
 
 Shared protocol contracts for gscdump.com integrations.
 
-> The executable four-operation public-v1 registry is exported from
+> The executable 18-operation public-v1 registry is exported from
 > `@gscdump/contracts/v1`. Existing root route/endpoint exports still describe
 > the legacy host during the release and cutover overlap. See the
 > [v1 contract](../../docs/hosted-api-v1.md) and
@@ -23,7 +23,7 @@ and storage remains in gscdump.com.
 
 ## Public v1 bar
 
-Each of the four initial public operations has one executable descriptor covering its
+Each public operation has one executable descriptor covering its
 surface/version, method/path, query or mutation semantics, credential classes,
 static scopes, ownership policy, request/response schemas, consistency,
 idempotency, and errors. V1 has no schema-less descriptor and no two logical

package/dist/_chunks/endpoints.d.mts

@@ -821,9 +821,139 @@ declare const partnerEndpoints: {
       indexingIneligibleReason: import("zod").ZodOptional<import("zod").ZodEnum<{
         missing_indexing_scope: "missing_indexing_scope";
         insufficient_gsc_permission: "insufficient_gsc_permission";
+        free_plan: "free_plan";
       }>>;
       indexingPermissionLevel: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
       grantedScopes: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
+      site: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodObject<{
+        siteId: import("zod").ZodString;
+        intId: import("zod").ZodNullable<import("zod").ZodNumber>;
+        catalogSiteId: import("zod").ZodNullable<import("zod").ZodNumber>;
+        externalSiteId: import("zod").ZodNullable<import("zod").ZodString>;
+        requestedUrl: import("zod").ZodString;
+        gscPropertyUrl: import("zod").ZodNullable<import("zod").ZodString>;
+        permissionLevel: import("zod").ZodNullable<import("zod").ZodString>;
+        property: import("zod").ZodObject<{
+          status: import("zod").ZodEnum<{
+            no_local_site: "no_local_site";
+            no_gsc_property: "no_gsc_property";
+            unverified_property: "unverified_property";
+            verified_candidate: "verified_candidate";
+            registered: "registered";
+            linked: "linked";
+          }>;
+          nextAction: import("zod").ZodEnum<{
+            none: "none";
+            create_site: "create_site";
+            verify_gsc_property: "verify_gsc_property";
+            choose_property: "choose_property";
+            register_site: "register_site";
+          }>;
+        }, import("zod/v4/core").$loose>;
+        analytics: import("zod").ZodObject<{
+          status: import("zod").ZodEnum<{
+            ready: "ready";
+            not_registered: "not_registered";
+            queued: "queued";
+            preparing: "preparing";
+            syncing: "syncing";
+            queryable_live: "queryable_live";
+            queryable_partial: "queryable_partial";
+            failed: "failed";
+          }>;
+          progress: import("zod").ZodObject<{
+            completed: import("zod").ZodNumber;
+            failed: import("zod").ZodNumber;
+            total: import("zod").ZodNumber;
+            percent: import("zod").ZodNumber;
+          }, import("zod/v4/core").$strip>;
+          queryable: import("zod").ZodBoolean;
+          sourceMode: import("zod").ZodEnum<{
+            none: "none";
+            live: "live";
+            d1: "d1";
+            r2: "r2";
+            mixed: "mixed";
+          }>;
+          syncedRange: import("zod").ZodObject<{
+            oldest: import("zod").ZodNullable<import("zod").ZodString>;
+            newest: import("zod").ZodNullable<import("zod").ZodString>;
+          }, import("zod/v4/core").$loose>;
+          nextAction: import("zod").ZodEnum<{
+            none: "none";
+            wait_for_sync: "wait_for_sync";
+            retry_sync: "retry_sync";
+          }>;
+        }, import("zod/v4/core").$loose>;
+        sitemaps: import("zod").ZodObject<{
+          status: import("zod").ZodEnum<{
+            ready: "ready";
+            syncing: "syncing";
+            failed: "failed";
+            unknown: "unknown";
+            discovering: "discovering";
+            none_found: "none_found";
+            auto_submitted: "auto_submitted";
+          }>;
+          discoveredCount: import("zod").ZodNumber;
+          nextAction: import("zod").ZodEnum<{
+            none: "none";
+            submit_sitemap: "submit_sitemap";
+            wait_for_sitemaps: "wait_for_sitemaps";
+            retry_sitemaps: "retry_sitemaps";
+          }>;
+        }, import("zod/v4/core").$loose>;
+        indexing: import("zod").ZodObject<{
+          status: import("zod").ZodEnum<{
+            ready: "ready";
+            failed: "failed";
+            discovering: "discovering";
+            not_requested: "not_requested";
+            missing_scope: "missing_scope";
+            insufficient_permission: "insufficient_permission";
+            waiting_for_sitemaps: "waiting_for_sitemaps";
+            checking: "checking";
+            budget_exhausted: "budget_exhausted";
+            no_urls: "no_urls";
+          }>;
+          eligible: import("zod").ZodBoolean;
+          reason: import("zod").ZodNullable<import("zod").ZodString>;
+          progress: import("zod").ZodObject<{
+            completed: import("zod").ZodNumber;
+            failed: import("zod").ZodNumber;
+            total: import("zod").ZodNumber;
+            percent: import("zod").ZodNumber;
+          }, import("zod/v4/core").$strip>;
+          nextAction: import("zod").ZodEnum<{
+            reconnect_google: "reconnect_google";
+            none: "none";
+            wait_for_sitemaps: "wait_for_sitemaps";
+            fix_gsc_permission: "fix_gsc_permission";
+            wait_for_indexing: "wait_for_indexing";
+            retry_indexing: "retry_indexing";
+          }>;
+        }, import("zod/v4/core").$loose>;
+        latestError: import("zod").ZodNullable<import("zod").ZodObject<{
+          code: import("zod").ZodEnum<{
+            missing_refresh_token: "missing_refresh_token";
+            missing_analytics_scope: "missing_analytics_scope";
+            missing_indexing_scope: "missing_indexing_scope";
+            token_refresh_failed: "token_refresh_failed";
+            permission_lost: "permission_lost";
+            insufficient_gsc_permission: "insufficient_gsc_permission";
+            gsc_property_not_found: "gsc_property_not_found";
+            gsc_property_unverified: "gsc_property_unverified";
+            user_database_not_provisioned: "user_database_not_provisioned";
+            sync_failed: "sync_failed";
+            sitemap_sync_failed: "sitemap_sync_failed";
+            indexing_failed: "indexing_failed";
+          }>;
+          message: import("zod").ZodString;
+          retryable: import("zod").ZodBoolean;
+        }, import("zod/v4/core").$strip>>;
+        lifecycleRevision: import("zod").ZodNumber;
+        updatedAt: import("zod").ZodString;
+      }, import("zod/v4/core").$loose>>>;
     }, import("zod/v4/core").$loose>;
   };
   readonly bulkRegisterSites: {
@@ -874,6 +1004,7 @@ declare const partnerEndpoints: {
         indexingIneligibleReason: import("zod").ZodOptional<import("zod").ZodEnum<{
           missing_indexing_scope: "missing_indexing_scope";
           insufficient_gsc_permission: "insufficient_gsc_permission";
+          free_plan: "free_plan";
         }>>;
         indexingPermissionLevel: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
         grantedScopes: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
@@ -1025,7 +1156,7 @@ declare const partnerEndpoints: {
         syncStatus: import("zod").ZodString;
         newestDateSynced: import("zod").ZodNullable<import("zod").ZodString>;
         oldestDateSynced: import("zod").ZodNullable<import("zod").ZodString>;
-        dataDelay: import("zod").ZodString;
+        dataDelay: import("zod").ZodOptional<import("zod").ZodString>;
         dataEndDate: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
         warnings: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
         enrichment: import("zod").ZodOptional<import("zod").ZodObject<{
@@ -1081,6 +1212,13 @@ declare const partnerEndpoints: {
         ctr: import("zod").ZodNumber;
         position: import("zod").ZodNumber;
       }, import("zod/v4/core").$loose>>;
+      previousDaily: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
+        date: import("zod").ZodString;
+        clicks: import("zod").ZodNumber;
+        impressions: import("zod").ZodNumber;
+        ctr: import("zod").ZodNumber;
+        position: import("zod").ZodNumber;
+      }, import("zod/v4/core").$loose>>>;
       totals: import("zod").ZodObject<{
         clicks: import("zod").ZodNumber;
         impressions: import("zod").ZodNumber;
@@ -1098,7 +1236,7 @@ declare const partnerEndpoints: {
         syncStatus: import("zod").ZodString;
         newestDateSynced: import("zod").ZodNullable<import("zod").ZodString>;
         oldestDateSynced: import("zod").ZodNullable<import("zod").ZodString>;
-        dataDelay: import("zod").ZodString;
+        dataDelay: import("zod").ZodOptional<import("zod").ZodString>;
         dataEndDate: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
         warnings: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
         enrichment: import("zod").ZodOptional<import("zod").ZodObject<{
@@ -1117,16 +1255,6 @@ declare const partnerEndpoints: {
     path: (siteId: string) => string;
   } & {
     readonly query: import("zod").ZodObject<{
-      preset: import("zod").ZodEnum<{
-        "striking-distance": "striking-distance";
-        opportunity: "opportunity";
-        decay: "decay";
-        "zero-click": "zero-click";
-        "non-brand": "non-brand";
-        "brand-only": "brand-only";
-        "movers-rising": "movers-rising";
-        "movers-declining": "movers-declining";
-      }>;
       startDate: import("zod").ZodString;
       endDate: import("zod").ZodString;
       prevStartDate: import("zod").ZodOptional<import("zod").ZodString>;
@@ -1147,6 +1275,16 @@ declare const partnerEndpoints: {
         discover: "discover";
         googleNews: "googleNews";
       }>>;
+      preset: import("zod").ZodEnum<{
+        "striking-distance": "striking-distance";
+        opportunity: "opportunity";
+        decay: "decay";
+        "zero-click": "zero-click";
+        "non-brand": "non-brand";
+        "brand-only": "brand-only";
+        "movers-rising": "movers-rising";
+        "movers-declining": "movers-declining";
+      }>;
     }, import("zod/v4/core").$strip>;
     readonly response: import("zod").ZodObject<{
       preset: import("zod").ZodEnum<{
@@ -1161,23 +1299,17 @@ declare const partnerEndpoints: {
       }>;
       keywords: import("zod").ZodArray<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>>;
       totalCount: import("zod").ZodNumber;
-      summary: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>>;
+      summary: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>>>;
       meta: import("zod").ZodObject<{
         siteUrl: import("zod").ZodString;
-        syncStatus: import("zod").ZodString;
-        newestDateSynced: import("zod").ZodNullable<import("zod").ZodString>;
-        oldestDateSynced: import("zod").ZodNullable<import("zod").ZodString>;
-        dataDelay: import("zod").ZodString;
-        dataEndDate: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
-        warnings: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
-        enrichment: import("zod").ZodOptional<import("zod").ZodObject<{
-          lastEnriched: import("zod").ZodNumber;
-          isDue: import("zod").ZodBoolean;
-        }, import("zod/v4/core").$strip>>;
-        backfill: import("zod").ZodOptional<import("zod").ZodObject<{
-          percent: import("zod").ZodNumber;
-          daysRemaining: import("zod").ZodOptional<import("zod").ZodNumber>;
-        }, import("zod/v4/core").$strip>>;
+        params: import("zod").ZodObject<{
+          brandTerms: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
+          startDate: import("zod").ZodOptional<import("zod").ZodString>;
+          endDate: import("zod").ZodOptional<import("zod").ZodString>;
+          prevStartDate: import("zod").ZodOptional<import("zod").ZodString>;
+          prevEndDate: import("zod").ZodOptional<import("zod").ZodString>;
+        }, import("zod/v4/core").$strip>;
+        presetDescription: import("zod").ZodOptional<import("zod").ZodString>;
       }, import("zod/v4/core").$loose>;
     }, import("zod/v4/core").$loose>;
   };
@@ -1192,8 +1324,11 @@ declare const partnerEndpoints: {
         errors: import("zod").ZodNumber;
         warnings: import("zod").ZodNumber;
         isIndex: import("zod").ZodOptional<import("zod").ZodBoolean>;
-        lastSubmitted: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+        contentHash: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
         lastDownloaded: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+        lastError: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+        isPending: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        fetchedAt: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
       }, import("zod/v4/core").$loose>>;
       history: import("zod").ZodArray<import("zod").ZodObject<{
         date: import("zod").ZodString;
@@ -1210,6 +1345,7 @@ declare const partnerEndpoints: {
       }, import("zod/v4/core").$loose>>>;
       meta: import("zod").ZodObject<{
         siteUrl: import("zod").ZodString;
+        gscPropertyUrl: import("zod").ZodString;
         syncStatus: import("zod").ZodNullable<import("zod").ZodString>;
       }, import("zod/v4/core").$loose>;
     }, import("zod/v4/core").$loose>;
@@ -1327,9 +1463,9 @@ declare const partnerEndpoints: {
       limit: import("zod").ZodOptional<import("zod").ZodNumber>;
       offset: import("zod").ZodOptional<import("zod").ZodNumber>;
       status: import("zod").ZodOptional<import("zod").ZodEnum<{
+        pending: "pending";
         indexed: "indexed";
         not_indexed: "not_indexed";
-        pending: "pending";
       }>>;
       issue: import("zod").ZodOptional<import("zod").ZodString>;
       search: import("zod").ZodOptional<import("zod").ZodString>;

package/dist/_chunks/endpoints.mjs

@@ -1,4 +1,5 @@
-import { analyticsEndpointSchemas, analyticsRoutes, partnerControlEndpointSchemas, partnerRoutes } from "./schemas.mjs";
+import { analyticsEndpointSchemas, partnerControlEndpointSchemas } from "./schemas.mjs";
+import { analyticsRoutes, partnerRoutes } from "./routes.mjs";
 function defineEndpoint(method, path, schema) {
 	return {
 		method,

package/dist/_chunks/routes.mjs

@@ -0,0 +1,87 @@
+const partnerRoutes = {
+	partner: {
+		users: {
+			byId: (userId) => `/partner/users/${encodeURIComponent(userId)}`,
+			lifecycle: (userId) => `/partner/users/${encodeURIComponent(userId)}/lifecycle`,
+			siteTeam: (userId, siteId) => `/partner/users/${encodeURIComponent(userId)}/sites/${encodeURIComponent(siteId)}`
+		},
+		sites: {
+			register: "/partner/sites/register",
+			bulkRegister: "/partner/sites/bulk-register"
+		}
+	},
+	users: {
+		register: "/users/register",
+		tokens: (userId) => `/users/${encodeURIComponent(userId)}/tokens`,
+		status: (userId) => `/users/${encodeURIComponent(userId)}/status`,
+		lifecycle: (userId) => `/users/${encodeURIComponent(userId)}/lifecycle`,
+		sites: (userId) => `/users/${encodeURIComponent(userId)}/sites`,
+		availableSites: (userId) => `/users/${encodeURIComponent(userId)}/available-sites`,
+		siteTeam: (userId, siteId) => `/partner/users/${encodeURIComponent(userId)}/sites/${encodeURIComponent(siteId)}`
+	},
+	sites: {
+		register: "/sites/register",
+		bulkRegister: "/sites/bulk-register",
+		byId: (siteId) => `/sites/${encodeURIComponent(siteId)}`,
+		analysisSources: (siteId) => `/sites/${encodeURIComponent(siteId)}/analysis-sources`,
+		syncStatus: (siteId) => `/sites/${encodeURIComponent(siteId)}/sync-status`,
+		data: (siteId) => `/sites/${encodeURIComponent(siteId)}/data`,
+		dataDetail: (siteId) => `/sites/${encodeURIComponent(siteId)}/data/detail`,
+		analysis: (siteId) => `/sites/${encodeURIComponent(siteId)}/analysis`,
+		sitemaps: (siteId) => `/sites/${encodeURIComponent(siteId)}/sitemaps`,
+		sitemapChanges: (siteId) => `/sites/${encodeURIComponent(siteId)}/sitemaps/changes`,
+		indexing: (siteId) => `/sites/${encodeURIComponent(siteId)}/indexing`,
+		indexingUrls: (siteId) => `/sites/${encodeURIComponent(siteId)}/indexing/urls`,
+		indexingDiagnostics: (siteId) => `/sites/${encodeURIComponent(siteId)}/indexing/diagnostics`,
+		indexingInspect: (siteId) => `/sites/${encodeURIComponent(siteId)}/indexing/inspect`,
+		recoverPermission: (siteId) => `/sites/${encodeURIComponent(siteId)}/recover-permission`,
+		canonicalMismatches: (siteId) => `/sites/${encodeURIComponent(siteId)}/canonical-mismatches`,
+		topAssociation: (siteId) => `/sites/${encodeURIComponent(siteId)}/data/top-association`,
+		keywordSparklines: (siteId) => `/sites/${encodeURIComponent(siteId)}/data/keyword-sparklines`,
+		queryTrend: (siteId) => `/sites/${encodeURIComponent(siteId)}/data/query-trend`,
+		pageTrend: (siteId) => `/sites/${encodeURIComponent(siteId)}/data/page-trend`,
+		contentVelocity: (siteId) => `/sites/${encodeURIComponent(siteId)}/content-velocity`,
+		ctrCurve: (siteId) => `/sites/${encodeURIComponent(siteId)}/ctr-curve`,
+		darkTraffic: (siteId) => `/sites/${encodeURIComponent(siteId)}/dark-traffic`,
+		deviceGap: (siteId) => `/sites/${encodeURIComponent(siteId)}/device-gap`,
+		indexPercent: (siteId) => `/sites/${encodeURIComponent(siteId)}/index-percent`,
+		keywordBreadth: (siteId) => `/sites/${encodeURIComponent(siteId)}/keyword-breadth`,
+		positionDistribution: (siteId) => `/sites/${encodeURIComponent(siteId)}/position-distribution`
+	},
+	settings: { user: "/user/settings" },
+	teams: {
+		create: "/partner/teams",
+		byId: (teamId) => `/partner/teams/${encodeURIComponent(teamId)}`,
+		members: (teamId) => `/partner/teams/${encodeURIComponent(teamId)}/members`,
+		member: (teamId, userId) => `/partner/teams/${encodeURIComponent(teamId)}/members/${encodeURIComponent(userId)}`
+	},
+	realtime: {
+		partner: "/ws/partner",
+		user: "/ws/user"
+	}
+};
+const analyticsRoutes = {
+	whoami: "/api/__gsc/whoami",
+	sites: "/api/__gsc/sites",
+	site: {
+		sourceInfo: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/source-info`,
+		analysisSources: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/analysis-sources`,
+		analyze: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/analyze`,
+		rows: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/rows`,
+		rollup: (siteId, rollupId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/rollup/${encodeURIComponent(rollupId)}`,
+		backfill: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/backfill`,
+		sitemaps: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/sitemaps`,
+		sitemapHistory: (siteId, hash) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/sitemaps/${encodeURIComponent(hash)}`,
+		sitemapChanges: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/sitemaps/changes`,
+		inspections: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/inspections`,
+		inspectionHistory: (siteId, hash) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/inspections/${encodeURIComponent(hash)}`,
+		indexingUrls: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/indexing/urls`,
+		indexingDiagnostics: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/indexing/diagnostics`,
+		indexingInspect: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/indexing/inspect`,
+		countries: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/countries`,
+		searchAppearance: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/search-appearance`,
+		topAssociation: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/data/top-association`
+	},
+	syncProgress: "/api/sync-progress"
+};
+export { analyticsRoutes, partnerRoutes };