@gscdump/contracts 3.1.0 → 3.2.0

package/dist/v1/route-catalog.d.mts

@@ -0,0 +1,285 @@
+import { HttpV1RouteSurfaceName } from "./route-surfaces.mjs";
+type HttpV1RouteMethod = 'DELETE' | 'GET' | 'PATCH' | 'POST';
+declare const GSCDUMP_V1_ROUTE_CATALOG: {
+  readonly surfaces: {
+    readonly partner: {
+      readonly prefix: "/api/partner/v1";
+      readonly version: "1.0";
+    };
+    readonly analytics: {
+      readonly prefix: "/api/analytics/v1";
+      readonly version: "1.0";
+    };
+    readonly realtime: {
+      readonly prefix: "/api/realtime/v1";
+      readonly version: "1.0";
+    };
+  };
+  readonly operations: {
+    readonly 'partner.users.lifecycle.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/users/{userId}/lifecycle";
+    };
+    readonly 'partner.users.sites.available.list': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/users/{userId}/available-sites";
+    };
+    readonly 'partner.users.sites.create': {
+      readonly surface: "partner";
+      readonly method: "POST";
+      readonly template: "/users/{userId}/sites";
+    };
+    readonly 'partner.users.create': {
+      readonly surface: "partner";
+      readonly method: "POST";
+      readonly template: "/users";
+    };
+    readonly 'partner.users.tokens.update': {
+      readonly surface: "partner";
+      readonly method: "PATCH";
+      readonly template: "/users/{userId}/tokens";
+    };
+    readonly 'partner.sites.indexing.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/indexing";
+    };
+    readonly 'partner.sites.indexing.urls.list': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/indexing/urls";
+    };
+    readonly 'partner.sites.indexing.bing.evidence.list': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/indexing/bing/evidence";
+    };
+    readonly 'partner.sites.indexing.transitions.list': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/indexing/transitions";
+    };
+    readonly 'partner.sites.indexing.diagnostics.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/indexing/diagnostics";
+    };
+    readonly 'partner.sites.sitemaps.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/sitemaps";
+    };
+    readonly 'partner.sites.sitemaps.changes.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/sitemaps/changes";
+    };
+    readonly 'partner.sites.analysis.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/analysis";
+    };
+    readonly 'partner.sites.analysis.bundle.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/analysis/bundle";
+    };
+    readonly 'partner.sites.delete': {
+      readonly surface: "partner";
+      readonly method: "DELETE";
+      readonly template: "/sites/{siteId}";
+    };
+    readonly 'partner.sites.canonical.mismatches.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/canonical-mismatches";
+    };
+    readonly 'partner.sites.indexing.inspect.create': {
+      readonly surface: "partner";
+      readonly method: "POST";
+      readonly template: "/sites/{siteId}/indexing/inspect";
+    };
+    readonly 'partner.sites.permission.recover': {
+      readonly surface: "partner";
+      readonly method: "POST";
+      readonly template: "/sites/{siteId}/permission/recover";
+    };
+    readonly 'partner.sites.keyword.sparklines.query': {
+      readonly surface: "partner";
+      readonly method: "POST";
+      readonly template: "/sites/{siteId}/keyword-sparklines";
+    };
+    readonly 'partner.sites.query.trend.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/query-trend";
+    };
+    readonly 'partner.sites.page.trend.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/page-trend";
+    };
+    readonly 'partner.sites.content.velocity.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/content-velocity";
+    };
+    readonly 'partner.sites.ctr.curve.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/ctr-curve";
+    };
+    readonly 'partner.sites.dark.traffic.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/dark-traffic";
+    };
+    readonly 'partner.sites.device.gap.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/device-gap";
+    };
+    readonly 'partner.sites.keyword.breadth.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/keyword-breadth";
+    };
+    readonly 'partner.sites.position.distribution.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/position-distribution";
+    };
+    readonly 'partner.sites.top.association.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/top-association";
+    };
+    readonly 'partner.sites.index.percent.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/index-percent";
+    };
+    readonly 'partner.sites.sitemaps.action.create': {
+      readonly surface: "partner";
+      readonly method: "POST";
+      readonly template: "/sites/{siteId}/sitemaps/actions";
+    };
+    readonly 'partner.sites.sitemaps.membership.query': {
+      readonly surface: "partner";
+      readonly method: "POST";
+      readonly template: "/sites/{siteId}/sitemaps/membership";
+    };
+    readonly 'partner.sites.sitemaps.urls.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/sitemaps/urls";
+    };
+    readonly 'partner.sites.sitemaps.export.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/sitemaps/export";
+    };
+    readonly 'partner.teams.create': {
+      readonly surface: "partner";
+      readonly method: "POST";
+      readonly template: "/teams";
+    };
+    readonly 'partner.teams.rename': {
+      readonly surface: "partner";
+      readonly method: "PATCH";
+      readonly template: "/teams/{teamId}";
+    };
+    readonly 'partner.teams.delete': {
+      readonly surface: "partner";
+      readonly method: "DELETE";
+      readonly template: "/teams/{teamId}";
+    };
+    readonly 'partner.teams.members.list': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/teams/{teamId}/members";
+    };
+    readonly 'partner.teams.members.add': {
+      readonly surface: "partner";
+      readonly method: "POST";
+      readonly template: "/teams/{teamId}/members";
+    };
+    readonly 'partner.teams.members.role.update': {
+      readonly surface: "partner";
+      readonly method: "PATCH";
+      readonly template: "/teams/{teamId}/members/{userId}";
+    };
+    readonly 'partner.teams.members.remove': {
+      readonly surface: "partner";
+      readonly method: "DELETE";
+      readonly template: "/teams/{teamId}/members/{userId}";
+    };
+    readonly 'partner.sites.team.update': {
+      readonly surface: "partner";
+      readonly method: "PATCH";
+      readonly template: "/sites/{siteId}/team";
+    };
+    readonly 'partner.teams.catalog.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/teams/{teamId}/catalog";
+    };
+    readonly 'partner.teams.catalog.bind': {
+      readonly surface: "partner";
+      readonly method: "POST";
+      readonly template: "/teams/{teamId}/catalog";
+    };
+    readonly 'partner.users.sites.crosswalk.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/users/{userId}/sites/crosswalk";
+    };
+    readonly 'partner.users.delete': {
+      readonly surface: "partner";
+      readonly method: "DELETE";
+      readonly template: "/users/{userId}";
+    };
+    readonly 'partner.users.verification.token.create': {
+      readonly surface: "partner";
+      readonly method: "POST";
+      readonly template: "/users/{userId}/verification-token";
+    };
+    readonly 'partner.users.sites.verify.create': {
+      readonly surface: "partner";
+      readonly method: "POST";
+      readonly template: "/users/{userId}/sites/verify";
+    };
+    readonly 'analytics.rows.query': {
+      readonly surface: "analytics";
+      readonly method: "POST";
+      readonly template: "/sites/{siteId}/rows";
+    };
+    readonly 'analytics.reports.query': {
+      readonly surface: "analytics";
+      readonly method: "POST";
+      readonly template: "/sites/{siteId}/reports";
+    };
+    readonly 'analytics.reports.detail.query': {
+      readonly surface: "analytics";
+      readonly method: "POST";
+      readonly template: "/sites/{siteId}/reports/detail";
+    };
+    readonly 'realtime.stream.head.get': {
+      readonly surface: "realtime";
+      readonly method: "GET";
+      readonly template: "/stream/head";
+    };
+    readonly 'realtime.tickets.create': {
+      readonly surface: "realtime";
+      readonly method: "POST";
+      readonly template: "/tickets";
+    };
+  };
+};
+type GscdumpV1RouteOperationId = keyof typeof GSCDUMP_V1_ROUTE_CATALOG.operations;
+type GscdumpV1Route<TId extends GscdumpV1RouteOperationId = GscdumpV1RouteOperationId> = TId extends GscdumpV1RouteOperationId ? {
+  id: TId;
+} & typeof GSCDUMP_V1_ROUTE_CATALOG.operations[TId] : never;
+export { GSCDUMP_V1_ROUTE_CATALOG, GscdumpV1Route, GscdumpV1RouteOperationId, HttpV1RouteMethod };

package/dist/v1/route-catalog.mjs

@@ -0,0 +1,290 @@
+import { unknownHttpV1OperationError } from "./http-operation-error.mjs";
+import { GSCDUMP_V1_ROUTE_SURFACES } from "./route-surfaces.mjs";
+const GSCDUMP_V1_ROUTE_CATALOG = {
+	surfaces: GSCDUMP_V1_ROUTE_SURFACES,
+	operations: {
+		"partner.users.lifecycle.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/users/{userId}/lifecycle"
+		},
+		"partner.users.sites.available.list": {
+			surface: "partner",
+			method: "GET",
+			template: "/users/{userId}/available-sites"
+		},
+		"partner.users.sites.create": {
+			surface: "partner",
+			method: "POST",
+			template: "/users/{userId}/sites"
+		},
+		"partner.users.create": {
+			surface: "partner",
+			method: "POST",
+			template: "/users"
+		},
+		"partner.users.tokens.update": {
+			surface: "partner",
+			method: "PATCH",
+			template: "/users/{userId}/tokens"
+		},
+		"partner.sites.indexing.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/indexing"
+		},
+		"partner.sites.indexing.urls.list": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/indexing/urls"
+		},
+		"partner.sites.indexing.bing.evidence.list": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/indexing/bing/evidence"
+		},
+		"partner.sites.indexing.transitions.list": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/indexing/transitions"
+		},
+		"partner.sites.indexing.diagnostics.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/indexing/diagnostics"
+		},
+		"partner.sites.sitemaps.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/sitemaps"
+		},
+		"partner.sites.sitemaps.changes.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/sitemaps/changes"
+		},
+		"partner.sites.analysis.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/analysis"
+		},
+		"partner.sites.analysis.bundle.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/analysis/bundle"
+		},
+		"partner.sites.delete": {
+			surface: "partner",
+			method: "DELETE",
+			template: "/sites/{siteId}"
+		},
+		"partner.sites.canonical.mismatches.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/canonical-mismatches"
+		},
+		"partner.sites.indexing.inspect.create": {
+			surface: "partner",
+			method: "POST",
+			template: "/sites/{siteId}/indexing/inspect"
+		},
+		"partner.sites.permission.recover": {
+			surface: "partner",
+			method: "POST",
+			template: "/sites/{siteId}/permission/recover"
+		},
+		"partner.sites.keyword.sparklines.query": {
+			surface: "partner",
+			method: "POST",
+			template: "/sites/{siteId}/keyword-sparklines"
+		},
+		"partner.sites.query.trend.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/query-trend"
+		},
+		"partner.sites.page.trend.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/page-trend"
+		},
+		"partner.sites.content.velocity.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/content-velocity"
+		},
+		"partner.sites.ctr.curve.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/ctr-curve"
+		},
+		"partner.sites.dark.traffic.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/dark-traffic"
+		},
+		"partner.sites.device.gap.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/device-gap"
+		},
+		"partner.sites.keyword.breadth.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/keyword-breadth"
+		},
+		"partner.sites.position.distribution.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/position-distribution"
+		},
+		"partner.sites.top.association.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/top-association"
+		},
+		"partner.sites.index.percent.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/index-percent"
+		},
+		"partner.sites.sitemaps.action.create": {
+			surface: "partner",
+			method: "POST",
+			template: "/sites/{siteId}/sitemaps/actions"
+		},
+		"partner.sites.sitemaps.membership.query": {
+			surface: "partner",
+			method: "POST",
+			template: "/sites/{siteId}/sitemaps/membership"
+		},
+		"partner.sites.sitemaps.urls.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/sitemaps/urls"
+		},
+		"partner.sites.sitemaps.export.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/sitemaps/export"
+		},
+		"partner.teams.create": {
+			surface: "partner",
+			method: "POST",
+			template: "/teams"
+		},
+		"partner.teams.rename": {
+			surface: "partner",
+			method: "PATCH",
+			template: "/teams/{teamId}"
+		},
+		"partner.teams.delete": {
+			surface: "partner",
+			method: "DELETE",
+			template: "/teams/{teamId}"
+		},
+		"partner.teams.members.list": {
+			surface: "partner",
+			method: "GET",
+			template: "/teams/{teamId}/members"
+		},
+		"partner.teams.members.add": {
+			surface: "partner",
+			method: "POST",
+			template: "/teams/{teamId}/members"
+		},
+		"partner.teams.members.role.update": {
+			surface: "partner",
+			method: "PATCH",
+			template: "/teams/{teamId}/members/{userId}"
+		},
+		"partner.teams.members.remove": {
+			surface: "partner",
+			method: "DELETE",
+			template: "/teams/{teamId}/members/{userId}"
+		},
+		"partner.sites.team.update": {
+			surface: "partner",
+			method: "PATCH",
+			template: "/sites/{siteId}/team"
+		},
+		"partner.teams.catalog.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/teams/{teamId}/catalog"
+		},
+		"partner.teams.catalog.bind": {
+			surface: "partner",
+			method: "POST",
+			template: "/teams/{teamId}/catalog"
+		},
+		"partner.users.sites.crosswalk.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/users/{userId}/sites/crosswalk"
+		},
+		"partner.users.delete": {
+			surface: "partner",
+			method: "DELETE",
+			template: "/users/{userId}"
+		},
+		"partner.users.verification.token.create": {
+			surface: "partner",
+			method: "POST",
+			template: "/users/{userId}/verification-token"
+		},
+		"partner.users.sites.verify.create": {
+			surface: "partner",
+			method: "POST",
+			template: "/users/{userId}/sites/verify"
+		},
+		"analytics.rows.query": {
+			surface: "analytics",
+			method: "POST",
+			template: "/sites/{siteId}/rows"
+		},
+		"analytics.reports.query": {
+			surface: "analytics",
+			method: "POST",
+			template: "/sites/{siteId}/reports"
+		},
+		"analytics.reports.detail.query": {
+			surface: "analytics",
+			method: "POST",
+			template: "/sites/{siteId}/reports/detail"
+		},
+		"realtime.stream.head.get": {
+			surface: "realtime",
+			method: "GET",
+			template: "/stream/head"
+		},
+		"realtime.tickets.create": {
+			surface: "realtime",
+			method: "POST",
+			template: "/tickets"
+		}
+	}
+};
+function getGscdumpV1Route(id) {
+	const operations = GSCDUMP_V1_ROUTE_CATALOG.operations;
+	if (!Object.hasOwn(operations, id)) throw unknownHttpV1OperationError(id);
+	return {
+		id,
+		...operations[id]
+	};
+}
+function gscdumpV1OperationRoute(id) {
+	const route = getGscdumpV1Route(id);
+	return {
+		id,
+		method: route.method,
+		path: route.template
+	};
+}
+function gscdumpV1Surface(name) {
+	return {
+		name,
+		...GSCDUMP_V1_ROUTE_CATALOG.surfaces[name]
+	};
+}
+export { GSCDUMP_V1_ROUTE_CATALOG, getGscdumpV1Route, gscdumpV1OperationRoute, gscdumpV1Surface };

package/dist/v1/route-surfaces.d.mts

@@ -0,0 +1,3 @@
+declare const HTTP_V1_ROUTE_SURFACE_NAMES: readonly ["partner", "analytics", "realtime"];
+type HttpV1RouteSurfaceName = typeof HTTP_V1_ROUTE_SURFACE_NAMES[number];
+export { HTTP_V1_ROUTE_SURFACE_NAMES, HttpV1RouteSurfaceName };

package/dist/v1/route-surfaces.mjs

@@ -0,0 +1,21 @@
+import "./version.mjs";
+const HTTP_V1_ROUTE_SURFACE_NAMES = [
+	"partner",
+	"analytics",
+	"realtime"
+];
+const GSCDUMP_V1_ROUTE_SURFACES = {
+	partner: {
+		prefix: "/api/partner/v1",
+		version: "1.0"
+	},
+	analytics: {
+		prefix: "/api/analytics/v1",
+		version: "1.0"
+	},
+	realtime: {
+		prefix: "/api/realtime/v1",
+		version: "1.0"
+	}
+};
+export { GSCDUMP_V1_ROUTE_SURFACES, HTTP_V1_ROUTE_SURFACE_NAMES };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gscdump/contracts",
   "type": "module",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "Shared gscdump.com API, webhook, realtime, and lifecycle contracts.",
   "author": {
     "name": "Harlan Wilton",
@@ -61,6 +61,11 @@
       "import": "./dist/v1/http.mjs",
       "default": "./dist/v1/http.mjs"
     },
+    "./v1/paths": {
+      "types": "./dist/v1/paths.d.mts",
+      "import": "./dist/v1/paths.mjs",
+      "default": "./dist/v1/paths.mjs"
+    },
     "./v1/realtime": {
       "types": "./dist/v1/realtime.d.mts",
       "import": "./dist/v1/realtime.mjs",