@gscdump/contracts 4.6.0 → 4.8.0

package/dist/schemas.mjs

@@ -1,3 +1,4 @@
+import { siteHoldReasonSchema, userAllowanceNoticeDataSchema } from "./entitlements.mjs";
 import { coverageStatesPointSchema, indexingCaptureSchema } from "./indexing-coverage.mjs";
 import { GSCDUMP_ONBOARDING_CONTRACT_VERSION, accountNextActions, accountStatuses, analyticsNextActions, analyticsStatuses, indexingNextActions, indexingStatuses, lifecycleErrorCodes, propertyNextActions, propertyStatuses, querySourceModes, sitemapNextActions, sitemapStatuses } from "./onboarding.mjs";
 import { GSC_SEARCH_TYPES } from "./search-types.mjs";
@@ -469,6 +470,7 @@ const partnerLifecycleSiteSchema = z.object({
 		progress: lifecycleProgressSchema,
 		nextAction: z.enum(indexingNextActions)
 	}).loose(),
+	hold: siteHoldReasonSchema.nullable().default(null),
 	latestError: lifecycleErrorSchema.nullable(),
 	lifecycleRevision: z.number(),
 	updatedAt: z.string()
@@ -1467,7 +1469,15 @@ const partnerWebhookEnvelopeSchema = z.object({
 	lifecycleRevision: z.number().int(),
 	occurredAt: z.iso.datetime(),
 	data: partnerWebhookDataSchema
-}).loose();
+}).loose().superRefine((envelope, context) => {
+	if (envelope.event !== "user.allowance.notice") return;
+	const data = userAllowanceNoticeDataSchema.safeParse(envelope.data);
+	for (const issue of data.error?.issues ?? []) context.addIssue({
+		code: "custom",
+		message: issue.message,
+		path: ["data", ...issue.path]
+	});
+});
 const analyticsEndpointSchemas = {
 	analyticsWhoami: { response: whoamiResponseSchema },
 	analyticsSites: { response: z.array(siteListItemSchema) },

package/dist/types.d.mts

@@ -1,4 +1,5 @@
 import { GscSearchType } from "./search-types.mjs";
+import { UserAllowanceNoticeData } from "./entitlements.mjs";
 import { FileResolutionResponse } from "./file-resolution.mjs";
 import { CoverageStatesPoint, IndexingCapture } from "./indexing-coverage.mjs";
 import { AccountNextAction, AccountStatus, PartnerLifecycleAccount, PartnerLifecycleResponse, PartnerLifecycleSite } from "./onboarding.mjs";
@@ -1394,7 +1395,7 @@ export interface BindPartnerTeamCatalogResponse {
   bucket: string;
   namespace: string;
 }
-export type CanonicalWebhookEventType = 'user.lifecycle.changed' | 'site.lifecycle.changed' | 'site.analytics.ready' | 'site.indexing.ready' | 'site.auth.failed' | 'job.failed';
+export type CanonicalWebhookEventType = 'user.lifecycle.changed' | 'site.lifecycle.changed' | 'site.analytics.ready' | 'site.indexing.ready' | 'site.auth.failed' | 'job.failed' | 'user.allowance.notice';
 export type WebhookEventType = CanonicalWebhookEventType;
 export interface WebhookEnvelope<TData extends Record<string, unknown> = Record<string, unknown>> {
   contractVersion: string;
@@ -1410,6 +1411,18 @@ export interface WebhookEnvelope<TData extends Record<string, unknown> = Record<
   data: TData;
 }
 export type PartnerWebhookData = Record<string, unknown>;
+/**
+ * The `data` type of each canonical webhook event. An event with a typed
+ * payload has its own entry; every other event carries `PartnerWebhookData`.
+ */
+export type CanonicalWebhookEventData<TEvent extends CanonicalWebhookEventType> = TEvent extends 'user.allowance.notice' ? UserAllowanceNoticeData : PartnerWebhookData;
+/**
+ * A parsed webhook envelope, discriminated on `event`. Narrow on `event` to
+ * read a typed `data`, for example `UserAllowanceNoticeData`.
+ */
+export type CanonicalWebhookEnvelope = { [TEvent in CanonicalWebhookEventType]: WebhookEnvelope<CanonicalWebhookEventData<TEvent>> & {
+  event: TEvent;
+}; }[CanonicalWebhookEventType];
 export interface CreateWebhookEnvelopeOptions<TData extends Record<string, unknown> = Record<string, unknown>> {
   event: CanonicalWebhookEventType;
   partnerId: string;