@8ux-co/eelzap 0.10.0 → 0.10.1

package/dist/index.d.cts

@@ -154,6 +154,14 @@ interface SeoImage {
 interface Seo {
     metaTitle: string | null;
     metaDescription: string | null;
+    /**
+     * Always an absolute URL, or null when the site has no URL or the record has
+     * no page (a document without a preview path is site-wide, such as a header
+     * and footer document). The record's own URL (the site URL plus its preview
+     * path, else `/{collectionKey}/{slug}` for an entry) unless an editor set
+     * one: a path set in Zap arrives resolved against the site URL, a full URL
+     * as typed.
+     */
     canonicalUrl: string | null;
     ogUrl: string | null;
     ogType: string | null;
@@ -307,6 +315,13 @@ interface SeoInput {
     ogType?: string | null;
     ogImageId?: string | null;
     ogImageAlt?: string | null;
+    /**
+     * Optional, SEO only. A path starting with `/` (stored as sent and resolved
+     * against the site URL on delivery, so it follows a change of address) or a
+     * full https URL (http only on localhost), kept as sent. `null` or `''`
+     * clears it, and delivery falls back to the record's own URL. Never changes
+     * the page Zap's preview opens.
+     */
     canonicalUrl?: string | null;
     twitterCard?: 'SUMMARY' | 'SUMMARY_LARGE_IMAGE';
     noIndex?: boolean;
@@ -992,8 +1007,15 @@ interface OnPageComment {
 }
 /** `onPage`: what the site's suggestion client needs on one page. */
 interface OnPageComments {
+    /**
+     * The signed-in person: their own name and email, and `editorUrl`, the
+     * absolute Zap editor URL of the entry or document this page is (an entry
+     * first when several are), or null.
+     */
     viewer: {
         name: string | null;
+        email: string | null;
+        editorUrl: string | null;
     };
     /** Whether the site lets people save straight to the draft. */
     liveEditing: boolean;
@@ -1177,6 +1199,7 @@ interface VersionSeo {
     ogType: string | null;
     ogImageId: string | null;
     ogImageAlt: string | null;
+    /** As stored: a path (`/blog/x`) or a full URL; null when unset. */
     canonicalUrl: string | null;
     twitterCard: string;
     noIndex: boolean;
@@ -2285,21 +2308,92 @@ interface WebhookMediaEventData {
         filename?: string;
     }>;
 }
-/** The kind of content a {@link WebhookChange} is about. */
-type WebhookEventType = 'item' | 'document' | 'media';
+/**
+ * `data` of `zap.seo.updated`. Entry targets hang off their collection
+ * (`collection` set, `key` the slug); document targets off the site
+ * (`collection` null, `key` the document key). Never the SEO text.
+ */
+interface WebhookSeoEventData {
+    site: WebhookSiteRef;
+    collection: WebhookCollectionRef | null;
+    targets: Array<{
+        kind: 'item' | 'document';
+        id: string;
+        key: string;
+        url: ZapLink;
+    }>;
+}
+/** `data` of the `zap.collection.*` events. */
+interface WebhookCollectionEventData {
+    site: WebhookSiteRef;
+    collection: WebhookCollectionRef & {
+        name?: string;
+        url: ZapLink;
+    };
+    /** On `zap.collection.updated`: the names of what changed. */
+    changed?: string[];
+}
+/**
+ * `data` of `zap.schema.field_changed`: one entry per field or section
+ * change, on a collection (`collection_id`, `collection_key`) or a document
+ * (`document_id`, `document_key`). The keys are the owner's key when the event
+ * was emitted; payloads from before they were added carry the ids only.
+ */
+interface WebhookSchemaEventData {
+    site: WebhookSiteRef;
+    changes: Array<{
+        action: 'created' | 'updated' | 'deleted' | 'restored' | 'reordered';
+        kind: 'field' | 'section';
+        id: string | null;
+        /** The field or section key. */
+        key?: string | null;
+        collection_id: string | null;
+        /** The collection's key. Absent on older payloads. */
+        collection_key?: string | null;
+        document_id: string | null;
+        /** The document's key. Absent on older payloads. */
+        document_key?: string | null;
+    }>;
+}
+/** `data` of the `zap.site.*` events (not the API-key ones). */
+interface WebhookSiteEventData {
+    site: WebhookSiteRef & {
+        name?: string;
+    };
+    /** On `zap.site.updated`: the names of the settings that changed. */
+    changed?: string[];
+}
+/**
+ * What a {@link WebhookChange} is about: an item, a document or a file, a
+ * whole collection (its settings or its fields), or the whole site.
+ */
+type WebhookEventType = 'item' | 'document' | 'media' | 'collection' | 'site';
 /** What happened to it: the verb of the event name. */
-type WebhookAction = 'created' | 'updated' | 'draft_updated' | 'published' | 'unpublished' | 'deleted' | 'rolled_back' | 'uploaded';
+type WebhookAction = 'created' | 'updated' | 'draft_updated' | 'published' | 'unpublished' | 'deleted' | 'rolled_back' | 'uploaded' | 'field_changed';
 /**
- * One changed item, document or file, flattened out of a payload by
- * `webhookChanges` — the unit a site invalidates its cache by.
+ * One changed item, document, file, collection or site, flattened out of a
+ * payload by `webhookChanges`: the unit a site invalidates its cache by.
+ *
+ * - `item`: an entry; `resourceKey` is its slug, `collectionKey` its collection.
+ * - `document`: `resourceKey` is the document key. Also from
+ *   `zap.schema.field_changed` on a document's fields (action `field_changed`).
+ * - `media`: `resourceKey` is the file id.
+ * - `collection`: everything in one collection; `resourceKey` and
+ *   `collectionKey` are the collection key. From `zap.collection.*`, and from
+ *   `zap.schema.field_changed` on a collection's fields (action
+ *   `field_changed`). An older schema payload without the key names the
+ *   collection by id: `resourceKey` is its id and `collectionKey` is absent.
+ * - `site`: everything on the site; `id` and `resourceKey` are the site's id
+ *   and key. From `zap.site.updated`, and from an older
+ *   `zap.schema.field_changed` on a document's fields that has no document key.
  */
 interface WebhookChange {
     type: WebhookEventType;
     action: WebhookAction;
     id: string;
-    /** The item's slug, the document's key, or the file's id. */
+    /** The item's slug, the document's key, the file's id, the collection's key (its id on an older schema payload), or the site's key. */
     resourceKey: string;
-    /** The item's collection. Items only. */
+    /** The item's collection, or the collection itself. Items and collections only. */
     collectionKey?: string;
     siteKey: string;
 }
@@ -2399,11 +2493,24 @@ interface VerifyWebhookOptions {
  */
 declare function verifyWebhookSignature(payload: string, headers: WebhookHeaders, secret: string, options?: VerifyWebhookOptions): Promise<boolean>;
 /**
- * Flattens a Zap content event into one {@link WebhookChange} per item,
- * document or file it names — what a site walks to invalidate its cache.
- * Every other event (`ping`, schema, site, SEO, assignment, comment
- * events) yields an empty list.
+ * Flattens a Zap event into the {@link WebhookChange}s a site invalidates its
+ * cache by:
+ *
+ * - `zap.item.*`, `zap.document.*`, `zap.media.*`: one change per item,
+ *   document or file.
+ * - `zap.seo.updated`: one `item` or `document` change (action `updated`) per
+ *   entry or document whose SEO changed.
+ * - `zap.collection.*`: one `collection` change.
+ * - `zap.schema.field_changed` (action `field_changed`): one `collection`
+ *   change per collection whose fields changed, and one `document` change per
+ *   document whose fields changed, each named by its key. An older payload
+ *   without the keys names a collection by id (`resourceKey` is the id, no
+ *   `collectionKey`) and widens a document's fields to one `site` change.
+ * - `zap.site.updated`: one `site` change.
+ *
+ * Every other event yields an empty list: `ping`, drafts (`draft_updated`),
+ * assignments, comments, API keys, and sites created or deleted.
  */
 declare function webhookChanges(payload: WebhookPayload): WebhookChange[];
 
-export { type ApiErrorDetail, type ApiErrorPayload, type CacheAdapter, type CacheStrategy, type CachedFetchOptions, type ClientConfig, type ClientDefaults, type CollectionDetail, type CollectionFieldListResponse, CollectionFieldsResource, type CollectionListResponse, type CollectionSectionListResponse, CollectionSectionsResource, type CollectionSummary, CollectionsResource, type CommentAnchor, type CommentAnchorInput, type CommentAnchorKind, type CommentDomAnchor, type CommentDraftAnswer, type CommentFieldAnchorInput, type CommentListOptions, type CommentListResponse, type CommentPersonRef, type CommentProposedValue, type CommentProposedValueInput, type CommentRecord, type CommentRect, type CommentReplyAnswer, type CommentResolution, type CommentSource, type CommentSpotAnchor, type CommentStatus, type CommentTarget, type CommentThread, type CommentThreadAnswer, type CommentVersionRef, type CommentViewport, CommentsResource, type CommonRequestOptions, type ConfirmUploadInput, type CreateCollectionInput, type CreateCommentInput, type CreateDocumentFieldInput, type CreateDocumentInput, type CreateDraftInput, type CreateFieldInput, type CreateItemInput, type CreateSectionInput, type CreateUploadUrlInput, type CurrencyValue, type DeleteDocumentOptions, type DeleteItemOptions, type DeleteOptions, type DeliveryStatus, type DocumentDeleteResponse, type DocumentDetail, type DocumentFieldListResponse, DocumentFieldsResource, type DocumentGetOptions, type DocumentListEntry, type DocumentListOptions, type DocumentListResponse, type DocumentMeta, type DocumentMutationResponse, type DocumentSectionListResponse, DocumentSectionsResource, type DocumentSeo, DocumentSeoResource, type DocumentSeoResponse, DocumentValuesResource, type DocumentValuesResponse, type DocumentVersionDetail, type DocumentVersionSeo, type DocumentVersionSummary, type DocumentVersionValue, DocumentVersionsResource, DocumentsResource, EelZapClient, EelZapError, type EelZapErrorCode, EelZapNetworkError, type EnumValue, type FieldConstraints, type FieldInfo, type FieldOptionInput, type FieldType, type FilterOperatorMap, type FilterValue, type GalleryItemValue, type IdempotencyOptions, type ItemDeleteResponse, type ItemDetail, type ItemFilters, type ItemGetOptions, type ItemListOptions, type ItemListResponse, type ItemMeta, type ItemMutationResponse, ItemQueryBuilder, type ItemSeo, ItemSeoResource, type ItemSeoResponse, type ItemVersionDetail, type ItemVersionSeo, type ItemVersionSlug, type ItemVersionSummary, type ItemVersionValue, ItemVersionsResource, ItemsResource, type JsonObject, type MediaAccess, type MediaDetail, type MediaDetailResponse, type MediaFromUrlInput, type MediaListParams, type MediaListResponse, MediaResource, type MediaSort, type MediaType, type MediaUploadInput, type MediaUsage, type MediaValue, MemoryCacheAdapter, type OnPageComment, type OnPageCommentAnchor, type OnPageComments, type OnPageField, type Pagination, type PreviewOption, type PreviewTokenValidation, PreviewTokensResource, type QueryPrimitive, type ReplyCommentInput, type RetryEvent, type RetryOptions, type SaveCommentToDraftInput, type SectionInfo, type SectionMeta, type Seo, type SeoImage, type SeoInput, type SiteInfo, type SiteListEntry, SiteResource, SitesResource, type ThreadComment, type UpdateCollectionInput, type UpdateCommentInput, type UpdateDocumentDraftInput, type UpdateDocumentFieldInput, type UpdateDocumentInput, type UpdateFieldInput, type UpdateItemDraftInput, type UpdateItemInput, type UpdateMediaInput, type UpdateSectionInput, type UpdateSiteInput, type UploadFile, type UploadUrlResponse, type VerifyWebhookOptions, type VersionDetail, type VersionGalleryItem, type VersionListResponse, type VersionSeo, type VersionStatus, type VersionSummary, type VersionValue, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TIMESTAMP_HEADER, WEBHOOK_TOLERANCE_SECONDS, type WebhookAction, type WebhookActor, type WebhookChange, type WebhookCollectionRef, type WebhookCommentCreatedData, type WebhookCommentData, type WebhookCommentRef, type WebhookCommentReopenedData, type WebhookCommentRepliedData, type WebhookCommentResolvedData, type WebhookCommentSource, type WebhookCommentTarget, type WebhookCommentUpdatedData, type WebhookDocumentEventData, type WebhookEventName, type WebhookEventType, type WebhookHeaders, type WebhookItemEventData, type WebhookMediaEventData, type WebhookPayload, type WebhookSiteRef, type WebhookSubject, cachedFetch, cleanStega, createClient, getMediaUrl, hasStega, isEelZapError, verifyWebhookSignature, webhookChanges };
+export { type ApiErrorDetail, type ApiErrorPayload, type CacheAdapter, type CacheStrategy, type CachedFetchOptions, type ClientConfig, type ClientDefaults, type CollectionDetail, type CollectionFieldListResponse, CollectionFieldsResource, type CollectionListResponse, type CollectionSectionListResponse, CollectionSectionsResource, type CollectionSummary, CollectionsResource, type CommentAnchor, type CommentAnchorInput, type CommentAnchorKind, type CommentDomAnchor, type CommentDraftAnswer, type CommentFieldAnchorInput, type CommentListOptions, type CommentListResponse, type CommentPersonRef, type CommentProposedValue, type CommentProposedValueInput, type CommentRecord, type CommentRect, type CommentReplyAnswer, type CommentResolution, type CommentSource, type CommentSpotAnchor, type CommentStatus, type CommentTarget, type CommentThread, type CommentThreadAnswer, type CommentVersionRef, type CommentViewport, CommentsResource, type CommonRequestOptions, type ConfirmUploadInput, type CreateCollectionInput, type CreateCommentInput, type CreateDocumentFieldInput, type CreateDocumentInput, type CreateDraftInput, type CreateFieldInput, type CreateItemInput, type CreateSectionInput, type CreateUploadUrlInput, type CurrencyValue, type DeleteDocumentOptions, type DeleteItemOptions, type DeleteOptions, type DeliveryStatus, type DocumentDeleteResponse, type DocumentDetail, type DocumentFieldListResponse, DocumentFieldsResource, type DocumentGetOptions, type DocumentListEntry, type DocumentListOptions, type DocumentListResponse, type DocumentMeta, type DocumentMutationResponse, type DocumentSectionListResponse, DocumentSectionsResource, type DocumentSeo, DocumentSeoResource, type DocumentSeoResponse, DocumentValuesResource, type DocumentValuesResponse, type DocumentVersionDetail, type DocumentVersionSeo, type DocumentVersionSummary, type DocumentVersionValue, DocumentVersionsResource, DocumentsResource, EelZapClient, EelZapError, type EelZapErrorCode, EelZapNetworkError, type EnumValue, type FieldConstraints, type FieldInfo, type FieldOptionInput, type FieldType, type FilterOperatorMap, type FilterValue, type GalleryItemValue, type IdempotencyOptions, type ItemDeleteResponse, type ItemDetail, type ItemFilters, type ItemGetOptions, type ItemListOptions, type ItemListResponse, type ItemMeta, type ItemMutationResponse, ItemQueryBuilder, type ItemSeo, ItemSeoResource, type ItemSeoResponse, type ItemVersionDetail, type ItemVersionSeo, type ItemVersionSlug, type ItemVersionSummary, type ItemVersionValue, ItemVersionsResource, ItemsResource, type JsonObject, type MediaAccess, type MediaDetail, type MediaDetailResponse, type MediaFromUrlInput, type MediaListParams, type MediaListResponse, MediaResource, type MediaSort, type MediaType, type MediaUploadInput, type MediaUsage, type MediaValue, MemoryCacheAdapter, type OnPageComment, type OnPageCommentAnchor, type OnPageComments, type OnPageField, type Pagination, type PreviewOption, type PreviewTokenValidation, PreviewTokensResource, type QueryPrimitive, type ReplyCommentInput, type RetryEvent, type RetryOptions, type SaveCommentToDraftInput, type SectionInfo, type SectionMeta, type Seo, type SeoImage, type SeoInput, type SiteInfo, type SiteListEntry, SiteResource, SitesResource, type ThreadComment, type UpdateCollectionInput, type UpdateCommentInput, type UpdateDocumentDraftInput, type UpdateDocumentFieldInput, type UpdateDocumentInput, type UpdateFieldInput, type UpdateItemDraftInput, type UpdateItemInput, type UpdateMediaInput, type UpdateSectionInput, type UpdateSiteInput, type UploadFile, type UploadUrlResponse, type VerifyWebhookOptions, type VersionDetail, type VersionGalleryItem, type VersionListResponse, type VersionSeo, type VersionStatus, type VersionSummary, type VersionValue, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TIMESTAMP_HEADER, WEBHOOK_TOLERANCE_SECONDS, type WebhookAction, type WebhookActor, type WebhookChange, type WebhookCollectionEventData, type WebhookCollectionRef, type WebhookCommentCreatedData, type WebhookCommentData, type WebhookCommentRef, type WebhookCommentReopenedData, type WebhookCommentRepliedData, type WebhookCommentResolvedData, type WebhookCommentSource, type WebhookCommentTarget, type WebhookCommentUpdatedData, type WebhookDocumentEventData, type WebhookEventName, type WebhookEventType, type WebhookHeaders, type WebhookItemEventData, type WebhookMediaEventData, type WebhookPayload, type WebhookSchemaEventData, type WebhookSeoEventData, type WebhookSiteEventData, type WebhookSiteRef, type WebhookSubject, cachedFetch, cleanStega, createClient, getMediaUrl, hasStega, isEelZapError, verifyWebhookSignature, webhookChanges };

package/dist/index.d.ts

@@ -154,6 +154,14 @@ interface SeoImage {
 interface Seo {
     metaTitle: string | null;
     metaDescription: string | null;
+    /**
+     * Always an absolute URL, or null when the site has no URL or the record has
+     * no page (a document without a preview path is site-wide, such as a header
+     * and footer document). The record's own URL (the site URL plus its preview
+     * path, else `/{collectionKey}/{slug}` for an entry) unless an editor set
+     * one: a path set in Zap arrives resolved against the site URL, a full URL
+     * as typed.
+     */
     canonicalUrl: string | null;
     ogUrl: string | null;
     ogType: string | null;
@@ -307,6 +315,13 @@ interface SeoInput {
     ogType?: string | null;
     ogImageId?: string | null;
     ogImageAlt?: string | null;
+    /**
+     * Optional, SEO only. A path starting with `/` (stored as sent and resolved
+     * against the site URL on delivery, so it follows a change of address) or a
+     * full https URL (http only on localhost), kept as sent. `null` or `''`
+     * clears it, and delivery falls back to the record's own URL. Never changes
+     * the page Zap's preview opens.
+     */
     canonicalUrl?: string | null;
     twitterCard?: 'SUMMARY' | 'SUMMARY_LARGE_IMAGE';
     noIndex?: boolean;
@@ -992,8 +1007,15 @@ interface OnPageComment {
 }
 /** `onPage`: what the site's suggestion client needs on one page. */
 interface OnPageComments {
+    /**
+     * The signed-in person: their own name and email, and `editorUrl`, the
+     * absolute Zap editor URL of the entry or document this page is (an entry
+     * first when several are), or null.
+     */
     viewer: {
         name: string | null;
+        email: string | null;
+        editorUrl: string | null;
     };
     /** Whether the site lets people save straight to the draft. */
     liveEditing: boolean;
@@ -1177,6 +1199,7 @@ interface VersionSeo {
     ogType: string | null;
     ogImageId: string | null;
     ogImageAlt: string | null;
+    /** As stored: a path (`/blog/x`) or a full URL; null when unset. */
     canonicalUrl: string | null;
     twitterCard: string;
     noIndex: boolean;
@@ -2285,21 +2308,92 @@ interface WebhookMediaEventData {
         filename?: string;
     }>;
 }
-/** The kind of content a {@link WebhookChange} is about. */
-type WebhookEventType = 'item' | 'document' | 'media';
+/**
+ * `data` of `zap.seo.updated`. Entry targets hang off their collection
+ * (`collection` set, `key` the slug); document targets off the site
+ * (`collection` null, `key` the document key). Never the SEO text.
+ */
+interface WebhookSeoEventData {
+    site: WebhookSiteRef;
+    collection: WebhookCollectionRef | null;
+    targets: Array<{
+        kind: 'item' | 'document';
+        id: string;
+        key: string;
+        url: ZapLink;
+    }>;
+}
+/** `data` of the `zap.collection.*` events. */
+interface WebhookCollectionEventData {
+    site: WebhookSiteRef;
+    collection: WebhookCollectionRef & {
+        name?: string;
+        url: ZapLink;
+    };
+    /** On `zap.collection.updated`: the names of what changed. */
+    changed?: string[];
+}
+/**
+ * `data` of `zap.schema.field_changed`: one entry per field or section
+ * change, on a collection (`collection_id`, `collection_key`) or a document
+ * (`document_id`, `document_key`). The keys are the owner's key when the event
+ * was emitted; payloads from before they were added carry the ids only.
+ */
+interface WebhookSchemaEventData {
+    site: WebhookSiteRef;
+    changes: Array<{
+        action: 'created' | 'updated' | 'deleted' | 'restored' | 'reordered';
+        kind: 'field' | 'section';
+        id: string | null;
+        /** The field or section key. */
+        key?: string | null;
+        collection_id: string | null;
+        /** The collection's key. Absent on older payloads. */
+        collection_key?: string | null;
+        document_id: string | null;
+        /** The document's key. Absent on older payloads. */
+        document_key?: string | null;
+    }>;
+}
+/** `data` of the `zap.site.*` events (not the API-key ones). */
+interface WebhookSiteEventData {
+    site: WebhookSiteRef & {
+        name?: string;
+    };
+    /** On `zap.site.updated`: the names of the settings that changed. */
+    changed?: string[];
+}
+/**
+ * What a {@link WebhookChange} is about: an item, a document or a file, a
+ * whole collection (its settings or its fields), or the whole site.
+ */
+type WebhookEventType = 'item' | 'document' | 'media' | 'collection' | 'site';
 /** What happened to it: the verb of the event name. */
-type WebhookAction = 'created' | 'updated' | 'draft_updated' | 'published' | 'unpublished' | 'deleted' | 'rolled_back' | 'uploaded';
+type WebhookAction = 'created' | 'updated' | 'draft_updated' | 'published' | 'unpublished' | 'deleted' | 'rolled_back' | 'uploaded' | 'field_changed';
 /**
- * One changed item, document or file, flattened out of a payload by
- * `webhookChanges` — the unit a site invalidates its cache by.
+ * One changed item, document, file, collection or site, flattened out of a
+ * payload by `webhookChanges`: the unit a site invalidates its cache by.
+ *
+ * - `item`: an entry; `resourceKey` is its slug, `collectionKey` its collection.
+ * - `document`: `resourceKey` is the document key. Also from
+ *   `zap.schema.field_changed` on a document's fields (action `field_changed`).
+ * - `media`: `resourceKey` is the file id.
+ * - `collection`: everything in one collection; `resourceKey` and
+ *   `collectionKey` are the collection key. From `zap.collection.*`, and from
+ *   `zap.schema.field_changed` on a collection's fields (action
+ *   `field_changed`). An older schema payload without the key names the
+ *   collection by id: `resourceKey` is its id and `collectionKey` is absent.
+ * - `site`: everything on the site; `id` and `resourceKey` are the site's id
+ *   and key. From `zap.site.updated`, and from an older
+ *   `zap.schema.field_changed` on a document's fields that has no document key.
  */
 interface WebhookChange {
     type: WebhookEventType;
     action: WebhookAction;
     id: string;
-    /** The item's slug, the document's key, or the file's id. */
+    /** The item's slug, the document's key, the file's id, the collection's key (its id on an older schema payload), or the site's key. */
     resourceKey: string;
-    /** The item's collection. Items only. */
+    /** The item's collection, or the collection itself. Items and collections only. */
     collectionKey?: string;
     siteKey: string;
 }
@@ -2399,11 +2493,24 @@ interface VerifyWebhookOptions {
  */
 declare function verifyWebhookSignature(payload: string, headers: WebhookHeaders, secret: string, options?: VerifyWebhookOptions): Promise<boolean>;
 /**
- * Flattens a Zap content event into one {@link WebhookChange} per item,
- * document or file it names — what a site walks to invalidate its cache.
- * Every other event (`ping`, schema, site, SEO, assignment, comment
- * events) yields an empty list.
+ * Flattens a Zap event into the {@link WebhookChange}s a site invalidates its
+ * cache by:
+ *
+ * - `zap.item.*`, `zap.document.*`, `zap.media.*`: one change per item,
+ *   document or file.
+ * - `zap.seo.updated`: one `item` or `document` change (action `updated`) per
+ *   entry or document whose SEO changed.
+ * - `zap.collection.*`: one `collection` change.
+ * - `zap.schema.field_changed` (action `field_changed`): one `collection`
+ *   change per collection whose fields changed, and one `document` change per
+ *   document whose fields changed, each named by its key. An older payload
+ *   without the keys names a collection by id (`resourceKey` is the id, no
+ *   `collectionKey`) and widens a document's fields to one `site` change.
+ * - `zap.site.updated`: one `site` change.
+ *
+ * Every other event yields an empty list: `ping`, drafts (`draft_updated`),
+ * assignments, comments, API keys, and sites created or deleted.
  */
 declare function webhookChanges(payload: WebhookPayload): WebhookChange[];
 
-export { type ApiErrorDetail, type ApiErrorPayload, type CacheAdapter, type CacheStrategy, type CachedFetchOptions, type ClientConfig, type ClientDefaults, type CollectionDetail, type CollectionFieldListResponse, CollectionFieldsResource, type CollectionListResponse, type CollectionSectionListResponse, CollectionSectionsResource, type CollectionSummary, CollectionsResource, type CommentAnchor, type CommentAnchorInput, type CommentAnchorKind, type CommentDomAnchor, type CommentDraftAnswer, type CommentFieldAnchorInput, type CommentListOptions, type CommentListResponse, type CommentPersonRef, type CommentProposedValue, type CommentProposedValueInput, type CommentRecord, type CommentRect, type CommentReplyAnswer, type CommentResolution, type CommentSource, type CommentSpotAnchor, type CommentStatus, type CommentTarget, type CommentThread, type CommentThreadAnswer, type CommentVersionRef, type CommentViewport, CommentsResource, type CommonRequestOptions, type ConfirmUploadInput, type CreateCollectionInput, type CreateCommentInput, type CreateDocumentFieldInput, type CreateDocumentInput, type CreateDraftInput, type CreateFieldInput, type CreateItemInput, type CreateSectionInput, type CreateUploadUrlInput, type CurrencyValue, type DeleteDocumentOptions, type DeleteItemOptions, type DeleteOptions, type DeliveryStatus, type DocumentDeleteResponse, type DocumentDetail, type DocumentFieldListResponse, DocumentFieldsResource, type DocumentGetOptions, type DocumentListEntry, type DocumentListOptions, type DocumentListResponse, type DocumentMeta, type DocumentMutationResponse, type DocumentSectionListResponse, DocumentSectionsResource, type DocumentSeo, DocumentSeoResource, type DocumentSeoResponse, DocumentValuesResource, type DocumentValuesResponse, type DocumentVersionDetail, type DocumentVersionSeo, type DocumentVersionSummary, type DocumentVersionValue, DocumentVersionsResource, DocumentsResource, EelZapClient, EelZapError, type EelZapErrorCode, EelZapNetworkError, type EnumValue, type FieldConstraints, type FieldInfo, type FieldOptionInput, type FieldType, type FilterOperatorMap, type FilterValue, type GalleryItemValue, type IdempotencyOptions, type ItemDeleteResponse, type ItemDetail, type ItemFilters, type ItemGetOptions, type ItemListOptions, type ItemListResponse, type ItemMeta, type ItemMutationResponse, ItemQueryBuilder, type ItemSeo, ItemSeoResource, type ItemSeoResponse, type ItemVersionDetail, type ItemVersionSeo, type ItemVersionSlug, type ItemVersionSummary, type ItemVersionValue, ItemVersionsResource, ItemsResource, type JsonObject, type MediaAccess, type MediaDetail, type MediaDetailResponse, type MediaFromUrlInput, type MediaListParams, type MediaListResponse, MediaResource, type MediaSort, type MediaType, type MediaUploadInput, type MediaUsage, type MediaValue, MemoryCacheAdapter, type OnPageComment, type OnPageCommentAnchor, type OnPageComments, type OnPageField, type Pagination, type PreviewOption, type PreviewTokenValidation, PreviewTokensResource, type QueryPrimitive, type ReplyCommentInput, type RetryEvent, type RetryOptions, type SaveCommentToDraftInput, type SectionInfo, type SectionMeta, type Seo, type SeoImage, type SeoInput, type SiteInfo, type SiteListEntry, SiteResource, SitesResource, type ThreadComment, type UpdateCollectionInput, type UpdateCommentInput, type UpdateDocumentDraftInput, type UpdateDocumentFieldInput, type UpdateDocumentInput, type UpdateFieldInput, type UpdateItemDraftInput, type UpdateItemInput, type UpdateMediaInput, type UpdateSectionInput, type UpdateSiteInput, type UploadFile, type UploadUrlResponse, type VerifyWebhookOptions, type VersionDetail, type VersionGalleryItem, type VersionListResponse, type VersionSeo, type VersionStatus, type VersionSummary, type VersionValue, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TIMESTAMP_HEADER, WEBHOOK_TOLERANCE_SECONDS, type WebhookAction, type WebhookActor, type WebhookChange, type WebhookCollectionRef, type WebhookCommentCreatedData, type WebhookCommentData, type WebhookCommentRef, type WebhookCommentReopenedData, type WebhookCommentRepliedData, type WebhookCommentResolvedData, type WebhookCommentSource, type WebhookCommentTarget, type WebhookCommentUpdatedData, type WebhookDocumentEventData, type WebhookEventName, type WebhookEventType, type WebhookHeaders, type WebhookItemEventData, type WebhookMediaEventData, type WebhookPayload, type WebhookSiteRef, type WebhookSubject, cachedFetch, cleanStega, createClient, getMediaUrl, hasStega, isEelZapError, verifyWebhookSignature, webhookChanges };
+export { type ApiErrorDetail, type ApiErrorPayload, type CacheAdapter, type CacheStrategy, type CachedFetchOptions, type ClientConfig, type ClientDefaults, type CollectionDetail, type CollectionFieldListResponse, CollectionFieldsResource, type CollectionListResponse, type CollectionSectionListResponse, CollectionSectionsResource, type CollectionSummary, CollectionsResource, type CommentAnchor, type CommentAnchorInput, type CommentAnchorKind, type CommentDomAnchor, type CommentDraftAnswer, type CommentFieldAnchorInput, type CommentListOptions, type CommentListResponse, type CommentPersonRef, type CommentProposedValue, type CommentProposedValueInput, type CommentRecord, type CommentRect, type CommentReplyAnswer, type CommentResolution, type CommentSource, type CommentSpotAnchor, type CommentStatus, type CommentTarget, type CommentThread, type CommentThreadAnswer, type CommentVersionRef, type CommentViewport, CommentsResource, type CommonRequestOptions, type ConfirmUploadInput, type CreateCollectionInput, type CreateCommentInput, type CreateDocumentFieldInput, type CreateDocumentInput, type CreateDraftInput, type CreateFieldInput, type CreateItemInput, type CreateSectionInput, type CreateUploadUrlInput, type CurrencyValue, type DeleteDocumentOptions, type DeleteItemOptions, type DeleteOptions, type DeliveryStatus, type DocumentDeleteResponse, type DocumentDetail, type DocumentFieldListResponse, DocumentFieldsResource, type DocumentGetOptions, type DocumentListEntry, type DocumentListOptions, type DocumentListResponse, type DocumentMeta, type DocumentMutationResponse, type DocumentSectionListResponse, DocumentSectionsResource, type DocumentSeo, DocumentSeoResource, type DocumentSeoResponse, DocumentValuesResource, type DocumentValuesResponse, type DocumentVersionDetail, type DocumentVersionSeo, type DocumentVersionSummary, type DocumentVersionValue, DocumentVersionsResource, DocumentsResource, EelZapClient, EelZapError, type EelZapErrorCode, EelZapNetworkError, type EnumValue, type FieldConstraints, type FieldInfo, type FieldOptionInput, type FieldType, type FilterOperatorMap, type FilterValue, type GalleryItemValue, type IdempotencyOptions, type ItemDeleteResponse, type ItemDetail, type ItemFilters, type ItemGetOptions, type ItemListOptions, type ItemListResponse, type ItemMeta, type ItemMutationResponse, ItemQueryBuilder, type ItemSeo, ItemSeoResource, type ItemSeoResponse, type ItemVersionDetail, type ItemVersionSeo, type ItemVersionSlug, type ItemVersionSummary, type ItemVersionValue, ItemVersionsResource, ItemsResource, type JsonObject, type MediaAccess, type MediaDetail, type MediaDetailResponse, type MediaFromUrlInput, type MediaListParams, type MediaListResponse, MediaResource, type MediaSort, type MediaType, type MediaUploadInput, type MediaUsage, type MediaValue, MemoryCacheAdapter, type OnPageComment, type OnPageCommentAnchor, type OnPageComments, type OnPageField, type Pagination, type PreviewOption, type PreviewTokenValidation, PreviewTokensResource, type QueryPrimitive, type ReplyCommentInput, type RetryEvent, type RetryOptions, type SaveCommentToDraftInput, type SectionInfo, type SectionMeta, type Seo, type SeoImage, type SeoInput, type SiteInfo, type SiteListEntry, SiteResource, SitesResource, type ThreadComment, type UpdateCollectionInput, type UpdateCommentInput, type UpdateDocumentDraftInput, type UpdateDocumentFieldInput, type UpdateDocumentInput, type UpdateFieldInput, type UpdateItemDraftInput, type UpdateItemInput, type UpdateMediaInput, type UpdateSectionInput, type UpdateSiteInput, type UploadFile, type UploadUrlResponse, type VerifyWebhookOptions, type VersionDetail, type VersionGalleryItem, type VersionListResponse, type VersionSeo, type VersionStatus, type VersionSummary, type VersionValue, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TIMESTAMP_HEADER, WEBHOOK_TOLERANCE_SECONDS, type WebhookAction, type WebhookActor, type WebhookChange, type WebhookCollectionEventData, type WebhookCollectionRef, type WebhookCommentCreatedData, type WebhookCommentData, type WebhookCommentRef, type WebhookCommentReopenedData, type WebhookCommentRepliedData, type WebhookCommentResolvedData, type WebhookCommentSource, type WebhookCommentTarget, type WebhookCommentUpdatedData, type WebhookDocumentEventData, type WebhookEventName, type WebhookEventType, type WebhookHeaders, type WebhookItemEventData, type WebhookMediaEventData, type WebhookPayload, type WebhookSchemaEventData, type WebhookSeoEventData, type WebhookSiteEventData, type WebhookSiteRef, type WebhookSubject, cachedFetch, cleanStega, createClient, getMediaUrl, hasStega, isEelZapError, verifyWebhookSignature, webhookChanges };

package/dist/index.js

@@ -1916,7 +1916,6 @@ async function verifyWebhookSignature(payload, headers, secret, options = {}) {
 var CHANGE_ACTIONS = /* @__PURE__ */ new Set([
   "created",
   "updated",
-  "draft_updated",
   "published",
   "unpublished",
   "deleted",
@@ -1924,6 +1923,21 @@ var CHANGE_ACTIONS = /* @__PURE__ */ new Set([
   "uploaded"
 ]);
 function webhookChanges(payload) {
+  switch (payload.type) {
+    case "zap.seo.updated":
+      return seoChanges(payload.data);
+    case "zap.collection.created":
+    case "zap.collection.updated":
+    case "zap.collection.deleted":
+      return collectionChanges(
+        payload.type.slice("zap.collection.".length),
+        payload.data
+      );
+    case "zap.schema.field_changed":
+      return schemaChanges(payload.data);
+    case "zap.site.updated":
+      return siteChanges("updated", payload.data);
+  }
   const match = /^zap\.(item|document|media)\.([a-z_]+)$/.exec(payload.type);
   if (!match || !CHANGE_ACTIONS.has(match[2])) {
     return [];
@@ -1960,6 +1974,85 @@ function webhookChanges(payload) {
     siteKey: data.site.key
   }));
 }
+function seoChanges(data) {
+  return (data.targets ?? []).map((target) => {
+    if (target.kind === "item") {
+      return {
+        type: "item",
+        action: "updated",
+        id: target.id,
+        resourceKey: target.key,
+        ...data.collection ? { collectionKey: data.collection.key } : {},
+        siteKey: data.site.key
+      };
+    }
+    return {
+      type: "document",
+      action: "updated",
+      id: target.id,
+      resourceKey: target.key,
+      siteKey: data.site.key
+    };
+  });
+}
+function collectionChanges(action, data) {
+  if (!data.collection || !data.site) return [];
+  return [
+    {
+      type: "collection",
+      action,
+      id: data.collection.id,
+      resourceKey: data.collection.key,
+      collectionKey: data.collection.key,
+      siteKey: data.site.key
+    }
+  ];
+}
+function schemaChanges(data) {
+  const changes = [];
+  const seen = /* @__PURE__ */ new Set();
+  for (const change of data.changes ?? []) {
+    if (change.collection_id) {
+      if (seen.has(`collection:${change.collection_id}`)) continue;
+      seen.add(`collection:${change.collection_id}`);
+      const key = change.collection_key;
+      changes.push({
+        type: "collection",
+        action: "field_changed",
+        id: change.collection_id,
+        resourceKey: key ?? change.collection_id,
+        ...key ? { collectionKey: key } : {},
+        siteKey: data.site.key
+      });
+    } else if (change.document_id && change.document_key) {
+      if (seen.has(`document:${change.document_id}`)) continue;
+      seen.add(`document:${change.document_id}`);
+      changes.push({
+        type: "document",
+        action: "field_changed",
+        id: change.document_id,
+        resourceKey: change.document_key,
+        siteKey: data.site.key
+      });
+    } else if (change.document_id && !seen.has("site")) {
+      seen.add("site");
+      changes.push(...siteChanges("field_changed", data));
+    }
+  }
+  return changes;
+}
+function siteChanges(action, data) {
+  if (!data.site) return [];
+  return [
+    {
+      type: "site",
+      action,
+      id: data.site.id,
+      resourceKey: data.site.key,
+      siteKey: data.site.key
+    }
+  ];
+}
 export {
   CollectionFieldsResource,
   CollectionSectionsResource,