@wix/pro-gallery 1.0.32 → 1.0.34

package/build/cjs/src/pro-gallery-v2-gallery.universal.d.ts

@@ -1,9 +1,4 @@
-export declare const __debug: {
-    verboseLogging: {
-        on: () => boolean;
-        off: () => boolean;
-    };
-};
+import { EventDefinition } from '@wix/sdk-types';
 export interface Gallery {
     /**
      * Gallery ID.
@@ -475,6 +470,82 @@ export interface HtmlSiteRCPublished {
     /** Optional branch Id */
     branchId?: string | null;
 }
+export interface DomainEvent<T = string> extends DomainEventBodyOneOf<T> {
+    /** Information about a newly-created gallery. */
+    createdEvent?: EntityCreatedEvent<T>;
+    updatedEvent?: EntityUpdatedEvent<T>;
+    deletedEvent?: EntityDeletedEvent<T>;
+    actionEvent?: ActionEvent<T>;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+export interface DomainCreatedEvent<T> extends Omit<DomainEvent<T>, 'deletedEvent' | 'updatedEvent' | 'actionEvent'> {
+}
+export interface DomainDeletedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'updatedEvent' | 'actionEvent'> {
+}
+export interface DomainUpdatedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'actionEvent'> {
+}
+export interface DomainActionEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'updatedEvent'> {
+}
+/** @oneof */
+export interface DomainEventBodyOneOf<T> {
+    createdEvent?: EntityCreatedEvent<T>;
+    updatedEvent?: EntityUpdatedEvent<T>;
+    deletedEvent?: EntityDeletedEvent<T>;
+    actionEvent?: ActionEvent<T>;
+}
+export interface EntityCreatedEvent<T> {
+    entity?: T;
+}
+export interface EntityUpdatedEvent<T> {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: T;
+}
+export interface EntityDeletedEvent<T> {
+    /** Entity that was deleted */
+    deletedEntity?: T | null;
+}
+export interface ActionEvent<T> {
+    body?: T;
+}
 export interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
     /** insert/update documents */
     update?: DocumentUpdateOperation;
@@ -523,6 +594,8 @@ export interface IndexDocument {
     permittedMemberGroups?: string[];
     /** if true SEO is disabled for this document */
     seoHidden?: boolean | null;
+    /** if true the page is a lightbox popup */
+    isPopup?: boolean | null;
 }
 export interface DocumentPayload {
     /** url of the page representing the document */
@@ -780,72 +853,6 @@ export interface PublishGalleryResponse {
     /** Published gallery. */
     gallery?: Gallery;
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
-    /** Information about a newly-created gallery. */
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-    /**
-     * Unique event ID.
-     * Allows clients to ignore duplicate webhooks.
-     */
-    _id?: string;
-    /**
-     * Assumes actions are also always typed to an entity_type
-     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
-     */
-    entityFqdn?: string;
-    /**
-     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
-     * This is although the created/updated/deleted notion is duplication of the oneof types
-     * Example: created/updated/deleted/started/completed/email_opened
-     */
-    slug?: string;
-    /** ID of the entity associated with the event. */
-    entityId?: string;
-    /** Event timestamp. */
-    eventTime?: Date;
-    /**
-     * Whether the event was triggered as a result of a privacy regulation application
-     * (for example, GDPR).
-     */
-    triggeredByAnonymizeRequest?: boolean | null;
-    /** If present, indicates the action that triggered the event. */
-    originatedFrom?: string | null;
-    /**
-     * A sequence number defining the order of updates to the underlying entity.
-     * For example, given that some entity was updated at 16:00 and than again at 16:01,
-     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
-     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
-     * To do so, you will need to persist this number on your end, and compare the sequence number from the
-     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
-     */
-    entityEventSequence?: string | null;
-}
-/** @oneof */
-export interface DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-}
-export interface EntityCreatedEvent {
-    entityAsJson?: string;
-}
-export interface EntityUpdatedEvent {
-    /**
-     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
-     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
-     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
-     */
-    currentEntityAsJson?: string;
-}
-export interface EntityDeletedEvent {
-}
-export interface ActionEvent {
-    bodyAsJson?: string;
-}
 export interface ListGalleriesResponseNonNullableFields {
     galleries: {
         items: {
@@ -1012,6 +1019,12 @@ export interface UpdateGalleryItemResponseNonNullableFields {
 export interface DeleteGalleryItemResponseNonNullableFields {
     itemId: string;
 }
+export declare const onGalleryCreated: EventDefinition<DomainCreatedEvent<Gallery>, "wix.pro_gallery.gallery_v2_created">;
+export declare const onGalleryUpdated: EventDefinition<DomainUpdatedEvent<Gallery>, "wix.pro_gallery.gallery_v2_updated">;
+export declare const onGalleryDeleted: EventDefinition<DomainDeletedEvent<Gallery>, "wix.pro_gallery.gallery_v2_deleted">;
+export declare const onGalleryItemCreated: EventDefinition<DomainActionEvent<GalleryItemCreated>, "wix.pro_gallery.gallery_v2_gallery_item_created">;
+export declare const onGalleryItemUpdated: EventDefinition<DomainActionEvent<GalleryItemUpdated>, "wix.pro_gallery.gallery_v2_gallery_item_updated">;
+export declare const onGalleryItemDeleted: EventDefinition<DomainActionEvent<GalleryItemDeleted>, "wix.pro_gallery.gallery_v2_gallery_item_deleted">;
 /**
  * Retrieves a list of galleries.
  *
@@ -1020,7 +1033,9 @@ export interface DeleteGalleryItemResponseNonNullableFields {
  * @documentationMaturity preview
  * @param options - Options to use when getting the list of galleries.
  * @permissionScope Manage Galleries
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
  * @permissionScope Read Galleries
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
  * @applicableIdentity APP
  * @applicableIdentity MEMBER
  * @applicableIdentity VISITOR
@@ -1044,7 +1059,9 @@ export interface ListGalleriesOptions {
  * @requiredField galleryId
  * @param options - Options to use when getting the gallery.
  * @permissionScope Manage Galleries
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
  * @permissionScope Read Galleries
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
  * @applicableIdentity APP
  * @applicableIdentity MEMBER
  * @applicableIdentity VISITOR
@@ -1073,7 +1090,9 @@ export interface GetGalleryOptions extends GetGalleryRequestVersionOneOf {
  * @requiredField galleryId
  * @param options - Options to use when getting the list of gallery items.
  * @permissionScope Manage Galleries
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
  * @permissionScope Read Galleries
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
  * @applicableIdentity APP
  * @applicableIdentity MEMBER
  * @applicableIdentity VISITOR
@@ -1102,7 +1121,9 @@ export interface ListGalleryItemsOptions {
  * @requiredField identifiers.itemId
  * @param identifiers - Gallery ID and Item ID.
  * @permissionScope Manage Galleries
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
  * @permissionScope Read Galleries
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
  * @applicableIdentity APP
  * @applicableIdentity MEMBER
  * @applicableIdentity VISITOR
@@ -1143,6 +1164,7 @@ export interface GetGalleryItemIdentifiers {
  * @requiredField options.gallery.items.video.videoInfo
  * @param options - Options to use when creating the gallery.
  * @permissionScope Manage Galleries
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
  * @applicableIdentity APP
  * @returns Created gallery.
  */
@@ -1180,6 +1202,7 @@ export interface CreateGalleryOptions {
  * @param _id - ID of the gallery to update.
  * @param gallery - The information for the gallery being updated.
  * @permissionScope Manage Galleries
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
  * @applicableIdentity APP
  * @returns Updated gallery.
  */
@@ -1226,6 +1249,7 @@ export interface UpdateGallery {
  * @documentationMaturity preview
  * @requiredField galleryId
  * @permissionScope Manage Galleries
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
  * @applicableIdentity APP
  */
 export declare function deleteGallery(galleryId: string): Promise<DeleteGalleryResponse & DeleteGalleryResponseNonNullableFields>;
@@ -1256,6 +1280,7 @@ export declare function deleteGallery(galleryId: string): Promise<DeleteGalleryR
  * @requiredField item.text.html
  * @requiredField item.video.videoInfo
  * @permissionScope Manage Galleries
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
  * @applicableIdentity APP
  * @returns Created media item.
  */
@@ -1289,6 +1314,7 @@ export declare function createGalleryItem(galleryId: string, item: Item): Promis
  * @param item - The information for the gallery item being updated.
  * @param identifiers - Gallery ID and Item ID.
  * @permissionScope Manage Galleries
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
  * @applicableIdentity APP
  * @returns Updated media item.
  */
@@ -1360,6 +1386,7 @@ export interface UpdateGalleryItem {
  * @requiredField identifiers.itemId
  * @param identifiers - Gallery ID and Item ID.
  * @permissionScope Manage Galleries
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
  * @applicableIdentity APP
  */
 export declare function deleteGalleryItem(identifiers: DeleteGalleryItemIdentifiers): Promise<DeleteGalleryItemResponse & DeleteGalleryItemResponseNonNullableFields>;