@gscdump/contracts 4.7.0 → 5.0.0

package/dist/v1/sitemap-submission.d.mts

@@ -0,0 +1,301 @@
+import { CompatibleResponseSchema } from "./http-core.mjs";
+import { z } from "zod";
+/** The Google OAuth scope that lets a stored grant submit a Sitemap. */
+export declare const GSC_SITEMAP_SUBMIT_SCOPE: "https://www.googleapis.com/auth/webmasters";
+/** The Search Console permission levels that may submit a Sitemap: Owner and Full. */
+export declare const GSC_SITEMAP_SUBMIT_PERMISSION_LEVELS: readonly ["siteOwner", "siteFullUser"];
+/**
+ * The Google account whose stored grant submits for the Site: the caller's
+ * own, or the Site owner's, with the email and name gscdump stores for it.
+ */
+export declare const sitemapGrantHolderV1Schemas: {
+  producer: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"caller">;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"site-owner">;
+    readonly email: z.ZodEmail;
+    readonly name: z.ZodNullable<z.ZodString>;
+  }, z.core.$strip>], "_tag">;
+  client: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"caller">;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"site-owner">;
+    readonly email: z.ZodEmail;
+    readonly name: z.ZodNullable<z.ZodString>;
+  }, z.core.$strip>], "_tag">;
+};
+export declare const sitemapSubmissionStateV1Schemas: {
+  producer: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"listed">;
+    readonly checkedOn: z.ZodISODate;
+    readonly sitemapCount: z.ZodNumber;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"awaiting-google">;
+    readonly checkedOn: z.ZodISODate;
+    readonly sitemapUrl: z.ZodURL;
+    readonly sitemapCount: z.ZodNumber;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"ready">;
+    readonly sitemapUrl: z.ZodURL;
+    readonly writeAccess: z.ZodEnum<{
+      unknown: "unknown";
+      granted: "granted";
+    }>;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly grantHolder: z.ZodDiscriminatedUnion<[z.ZodObject<{
+      readonly _tag: z.ZodLiteral<"caller">;
+    }, z.core.$strip>, z.ZodObject<{
+      readonly _tag: z.ZodLiteral<"site-owner">;
+      readonly email: z.ZodEmail;
+      readonly name: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>], "_tag">;
+    readonly _tag: z.ZodLiteral<"needs-write-access">;
+    readonly sitemapUrl: z.ZodURL;
+    readonly requiredScope: z.ZodLiteral<"https://www.googleapis.com/auth/webmasters">;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly grantHolder: z.ZodDiscriminatedUnion<[z.ZodObject<{
+      readonly _tag: z.ZodLiteral<"caller">;
+    }, z.core.$strip>, z.ZodObject<{
+      readonly _tag: z.ZodLiteral<"site-owner">;
+      readonly email: z.ZodEmail;
+      readonly name: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>], "_tag">;
+    readonly _tag: z.ZodLiteral<"insufficient-permission">;
+    readonly sitemapUrl: z.ZodURL;
+    readonly permissionLevel: z.ZodString;
+    readonly requiredPermissionLevels: z.ZodArray<z.ZodEnum<{
+      siteOwner: "siteOwner";
+      siteFullUser: "siteFullUser";
+    }>>;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"no-sitemap-found">;
+    readonly checkedOn: z.ZodISODate;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"not-checked">;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"unavailable">;
+    readonly reason: z.ZodEnum<{
+      "permission-lost": "permission-lost";
+      "grant-missing": "grant-missing";
+    }>;
+  }, z.core.$strip>], "_tag">;
+  client: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"listed">;
+    readonly checkedOn: z.ZodISODate;
+    readonly sitemapCount: z.ZodNumber;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"awaiting-google">;
+    readonly checkedOn: z.ZodISODate;
+    readonly sitemapUrl: z.ZodURL;
+    readonly sitemapCount: z.ZodNumber;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"ready">;
+    readonly sitemapUrl: z.ZodURL;
+    readonly writeAccess: z.ZodEnum<{
+      unknown: "unknown";
+      granted: "granted";
+    }>;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly grantHolder: z.ZodDiscriminatedUnion<[z.ZodObject<{
+      readonly _tag: z.ZodLiteral<"caller">;
+    }, z.core.$strip>, z.ZodObject<{
+      readonly _tag: z.ZodLiteral<"site-owner">;
+      readonly email: z.ZodEmail;
+      readonly name: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>], "_tag">;
+    readonly _tag: z.ZodLiteral<"needs-write-access">;
+    readonly sitemapUrl: z.ZodURL;
+    readonly requiredScope: z.ZodLiteral<"https://www.googleapis.com/auth/webmasters">;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly grantHolder: z.ZodDiscriminatedUnion<[z.ZodObject<{
+      readonly _tag: z.ZodLiteral<"caller">;
+    }, z.core.$strip>, z.ZodObject<{
+      readonly _tag: z.ZodLiteral<"site-owner">;
+      readonly email: z.ZodEmail;
+      readonly name: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>], "_tag">;
+    readonly _tag: z.ZodLiteral<"insufficient-permission">;
+    readonly sitemapUrl: z.ZodURL;
+    readonly permissionLevel: z.ZodString;
+    readonly requiredPermissionLevels: z.ZodArray<z.ZodEnum<{
+      siteOwner: "siteOwner";
+      siteFullUser: "siteFullUser";
+    }>>;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"no-sitemap-found">;
+    readonly checkedOn: z.ZodISODate;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"not-checked">;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"unavailable">;
+    readonly reason: z.ZodEnum<{
+      "permission-lost": "permission-lost";
+      "grant-missing": "grant-missing";
+    }>;
+  }, z.core.$strip>], "_tag">;
+};
+/**
+ * `partner.sites.sitemaps.submission.get`. `callerCanAct` says whether the
+ * caller may run `partner.sites.sitemaps.submission.create` for the Site.
+ */
+export declare const sitemapSubmissionV1Schemas: CompatibleResponseSchema<z.ZodObject<{
+  readonly searchEngine: z.ZodLiteral<"google">;
+  readonly gscPropertyUrl: z.ZodString;
+  readonly callerCanAct: z.ZodBoolean;
+  readonly state: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"listed">;
+    readonly checkedOn: z.ZodISODate;
+    readonly sitemapCount: z.ZodNumber;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"awaiting-google">;
+    readonly checkedOn: z.ZodISODate;
+    readonly sitemapUrl: z.ZodURL;
+    readonly sitemapCount: z.ZodNumber;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"ready">;
+    readonly sitemapUrl: z.ZodURL;
+    readonly writeAccess: z.ZodEnum<{
+      unknown: "unknown";
+      granted: "granted";
+    }>;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly grantHolder: z.ZodDiscriminatedUnion<[z.ZodObject<{
+      readonly _tag: z.ZodLiteral<"caller">;
+    }, z.core.$strip>, z.ZodObject<{
+      readonly _tag: z.ZodLiteral<"site-owner">;
+      readonly email: z.ZodEmail;
+      readonly name: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>], "_tag">;
+    readonly _tag: z.ZodLiteral<"needs-write-access">;
+    readonly sitemapUrl: z.ZodURL;
+    readonly requiredScope: z.ZodLiteral<"https://www.googleapis.com/auth/webmasters">;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly grantHolder: z.ZodDiscriminatedUnion<[z.ZodObject<{
+      readonly _tag: z.ZodLiteral<"caller">;
+    }, z.core.$strip>, z.ZodObject<{
+      readonly _tag: z.ZodLiteral<"site-owner">;
+      readonly email: z.ZodEmail;
+      readonly name: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>], "_tag">;
+    readonly _tag: z.ZodLiteral<"insufficient-permission">;
+    readonly sitemapUrl: z.ZodURL;
+    readonly permissionLevel: z.ZodString;
+    readonly requiredPermissionLevels: z.ZodArray<z.ZodEnum<{
+      siteOwner: "siteOwner";
+      siteFullUser: "siteFullUser";
+    }>>;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"no-sitemap-found">;
+    readonly checkedOn: z.ZodISODate;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"not-checked">;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"unavailable">;
+    readonly reason: z.ZodEnum<{
+      "permission-lost": "permission-lost";
+      "grant-missing": "grant-missing";
+    }>;
+  }, z.core.$strip>], "_tag">;
+}, z.core.$strip>, z.ZodObject<{
+  readonly searchEngine: z.ZodLiteral<"google">;
+  readonly gscPropertyUrl: z.ZodString;
+  readonly callerCanAct: z.ZodBoolean;
+  readonly state: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"listed">;
+    readonly checkedOn: z.ZodISODate;
+    readonly sitemapCount: z.ZodNumber;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"awaiting-google">;
+    readonly checkedOn: z.ZodISODate;
+    readonly sitemapUrl: z.ZodURL;
+    readonly sitemapCount: z.ZodNumber;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"ready">;
+    readonly sitemapUrl: z.ZodURL;
+    readonly writeAccess: z.ZodEnum<{
+      unknown: "unknown";
+      granted: "granted";
+    }>;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly grantHolder: z.ZodDiscriminatedUnion<[z.ZodObject<{
+      readonly _tag: z.ZodLiteral<"caller">;
+    }, z.core.$strip>, z.ZodObject<{
+      readonly _tag: z.ZodLiteral<"site-owner">;
+      readonly email: z.ZodEmail;
+      readonly name: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>], "_tag">;
+    readonly _tag: z.ZodLiteral<"needs-write-access">;
+    readonly sitemapUrl: z.ZodURL;
+    readonly requiredScope: z.ZodLiteral<"https://www.googleapis.com/auth/webmasters">;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly grantHolder: z.ZodDiscriminatedUnion<[z.ZodObject<{
+      readonly _tag: z.ZodLiteral<"caller">;
+    }, z.core.$strip>, z.ZodObject<{
+      readonly _tag: z.ZodLiteral<"site-owner">;
+      readonly email: z.ZodEmail;
+      readonly name: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>], "_tag">;
+    readonly _tag: z.ZodLiteral<"insufficient-permission">;
+    readonly sitemapUrl: z.ZodURL;
+    readonly permissionLevel: z.ZodString;
+    readonly requiredPermissionLevels: z.ZodArray<z.ZodEnum<{
+      siteOwner: "siteOwner";
+      siteFullUser: "siteFullUser";
+    }>>;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"no-sitemap-found">;
+    readonly checkedOn: z.ZodISODate;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"not-checked">;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"unavailable">;
+    readonly reason: z.ZodEnum<{
+      "permission-lost": "permission-lost";
+      "grant-missing": "grant-missing";
+    }>;
+  }, z.core.$strip>], "_tag">;
+}, z.core.$strip>>;
+export declare const sitemapSubmitResultV1Schemas: {
+  producer: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"submitted">;
+    readonly sitemapUrl: z.ZodURL;
+    readonly sitemapCount: z.ZodNumber;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"failed">;
+    readonly reason: z.ZodEnum<{
+      "permission-lost": "permission-lost";
+      "grant-missing": "grant-missing";
+      "no-sitemap-found": "no-sitemap-found";
+      "provider-unavailable": "provider-unavailable";
+      rejected: "rejected";
+      "needs-write-access": "needs-write-access";
+      "insufficient-permission": "insufficient-permission";
+      "already-listed": "already-listed";
+    }>;
+    readonly retryable: z.ZodBoolean;
+    readonly sitemapUrl: z.ZodNullable<z.ZodURL>;
+  }, z.core.$strip>], "_tag">;
+  client: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"submitted">;
+    readonly sitemapUrl: z.ZodURL;
+    readonly sitemapCount: z.ZodNumber;
+  }, z.core.$strip>, z.ZodObject<{
+    readonly _tag: z.ZodLiteral<"failed">;
+    readonly reason: z.ZodEnum<{
+      "permission-lost": "permission-lost";
+      "grant-missing": "grant-missing";
+      "no-sitemap-found": "no-sitemap-found";
+      "provider-unavailable": "provider-unavailable";
+      rejected: "rejected";
+      "needs-write-access": "needs-write-access";
+      "insufficient-permission": "insufficient-permission";
+      "already-listed": "already-listed";
+    }>;
+    readonly retryable: z.ZodBoolean;
+    readonly sitemapUrl: z.ZodNullable<z.ZodURL>;
+  }, z.core.$strip>], "_tag">;
+};
+export type SitemapGrantHolderV1 = z.infer<typeof sitemapGrantHolderV1Schemas.producer>;
+export type SitemapSubmissionStateV1 = z.infer<typeof sitemapSubmissionStateV1Schemas.producer>;
+export type SitemapSubmissionV1 = z.infer<typeof sitemapSubmissionV1Schemas.producer>;
+export type SitemapSubmitResultV1 = z.infer<typeof sitemapSubmitResultV1Schemas.producer>;

package/dist/v1/sitemap-submission.mjs

@@ -0,0 +1,123 @@
+import { defineResponseObject } from "./http-core.mjs";
+import { z } from "zod";
+const GSC_SITEMAP_SUBMIT_SCOPE = "https://www.googleapis.com/auth/webmasters";
+const GSC_SITEMAP_SUBMIT_PERMISSION_LEVELS = ["siteOwner", "siteFullUser"];
+const sitemapUrl = z.url({ protocol: /^https?$/ });
+const callerGrantHolder = defineResponseObject({ _tag: z.literal("caller") });
+const siteOwnerGrantHolder = defineResponseObject({
+	_tag: z.literal("site-owner"),
+	email: z.email(),
+	name: z.string().min(1).nullable()
+});
+const sitemapGrantHolderV1Schemas = {
+	producer: z.discriminatedUnion("_tag", [callerGrantHolder.producer, siteOwnerGrantHolder.producer]),
+	client: z.discriminatedUnion("_tag", [callerGrantHolder.client, siteOwnerGrantHolder.client])
+};
+const listed = defineResponseObject({
+	_tag: z.literal("listed"),
+	checkedOn: z.iso.date(),
+	sitemapCount: z.number().int().positive()
+});
+const awaitingGoogle = defineResponseObject({
+	_tag: z.literal("awaiting-google"),
+	checkedOn: z.iso.date(),
+	sitemapUrl,
+	sitemapCount: z.number().int().positive()
+});
+const ready = defineResponseObject({
+	_tag: z.literal("ready"),
+	sitemapUrl,
+	writeAccess: z.enum(["granted", "unknown"])
+});
+const needsWriteAccessShape = {
+	_tag: z.literal("needs-write-access"),
+	sitemapUrl,
+	requiredScope: z.literal(GSC_SITEMAP_SUBMIT_SCOPE)
+};
+const needsWriteAccess = defineResponseObject({
+	...needsWriteAccessShape,
+	grantHolder: sitemapGrantHolderV1Schemas.producer
+}, {
+	...needsWriteAccessShape,
+	grantHolder: sitemapGrantHolderV1Schemas.client
+});
+const insufficientPermissionShape = {
+	_tag: z.literal("insufficient-permission"),
+	sitemapUrl,
+	permissionLevel: z.string().min(1),
+	requiredPermissionLevels: z.array(z.enum(GSC_SITEMAP_SUBMIT_PERMISSION_LEVELS)).min(1)
+};
+const insufficientPermission = defineResponseObject({
+	...insufficientPermissionShape,
+	grantHolder: sitemapGrantHolderV1Schemas.producer
+}, {
+	...insufficientPermissionShape,
+	grantHolder: sitemapGrantHolderV1Schemas.client
+});
+const noSitemapFound = defineResponseObject({
+	_tag: z.literal("no-sitemap-found"),
+	checkedOn: z.iso.date()
+});
+const notChecked = defineResponseObject({ _tag: z.literal("not-checked") });
+const unavailable = defineResponseObject({
+	_tag: z.literal("unavailable"),
+	reason: z.enum(["permission-lost", "grant-missing"])
+});
+const sitemapSubmissionStateV1Schemas = {
+	producer: z.discriminatedUnion("_tag", [
+		listed.producer,
+		awaitingGoogle.producer,
+		ready.producer,
+		needsWriteAccess.producer,
+		insufficientPermission.producer,
+		noSitemapFound.producer,
+		notChecked.producer,
+		unavailable.producer
+	]),
+	client: z.discriminatedUnion("_tag", [
+		listed.client,
+		awaitingGoogle.client,
+		ready.client,
+		needsWriteAccess.client,
+		insufficientPermission.client,
+		noSitemapFound.client,
+		notChecked.client,
+		unavailable.client
+	])
+};
+const sitemapSubmissionV1Schemas = defineResponseObject({
+	searchEngine: z.literal("google"),
+	gscPropertyUrl: z.string().min(1),
+	callerCanAct: z.boolean(),
+	state: sitemapSubmissionStateV1Schemas.producer
+}, {
+	searchEngine: z.literal("google"),
+	gscPropertyUrl: z.string().min(1),
+	callerCanAct: z.boolean(),
+	state: sitemapSubmissionStateV1Schemas.client
+});
+const submitted = defineResponseObject({
+	_tag: z.literal("submitted"),
+	sitemapUrl,
+	sitemapCount: z.number().int().nonnegative()
+});
+const failed = defineResponseObject({
+	_tag: z.literal("failed"),
+	reason: z.enum([
+		"already-listed",
+		"no-sitemap-found",
+		"needs-write-access",
+		"insufficient-permission",
+		"permission-lost",
+		"grant-missing",
+		"rejected",
+		"provider-unavailable"
+	]),
+	retryable: z.boolean(),
+	sitemapUrl: sitemapUrl.nullable()
+});
+const sitemapSubmitResultV1Schemas = {
+	producer: z.discriminatedUnion("_tag", [submitted.producer, failed.producer]),
+	client: z.discriminatedUnion("_tag", [submitted.client, failed.client])
+};
+export { GSC_SITEMAP_SUBMIT_PERMISSION_LEVELS, GSC_SITEMAP_SUBMIT_SCOPE, sitemapGrantHolderV1Schemas, sitemapSubmissionStateV1Schemas, sitemapSubmissionV1Schemas, sitemapSubmitResultV1Schemas };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gscdump/contracts",
   "type": "module",
-  "version": "4.7.0",
+  "version": "5.0.0",
   "description": "Shared gscdump.com API, webhook, realtime, and lifecycle contracts.",
   "author": {
     "name": "Harlan Wilton",