@wix/pro-gallery 1.0.44 → 1.0.46

package/type-bundles/context.bundle.d.ts

@@ -0,0 +1,673 @@
+interface Gallery {
+    /**
+     * Gallery ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /** Gallery name. */
+    name?: string | null;
+    /**
+     * Total number of items in the gallery.
+     * @readonly
+     */
+    totalItems?: number | null;
+    /** Media items in the gallery. */
+    items?: Item[];
+    /**
+     * Index that determines which position a gallery is displayed on the site. <br />
+     *
+     * >**Note:** If you assign the same sort order index to more than one gallery, the function fails.
+     */
+    sortOrder?: number | null;
+    /**
+     * Date and time the gallery was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+}
+interface Item extends ItemMetadataOneOf {
+    /** Details about the image. */
+    image?: Image;
+    /** Details about the video. */
+    video?: Video;
+    /** Details about the text file. */
+    text?: Text;
+    /**
+     * Item ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Index that determines which position a media item is displayed in the gallery. <br />
+     *
+     * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
+     *
+     * >**Note:** If you assign the same sort order index to more than one media item in a gallery, the function fails.
+     */
+    sortOrder?: number | null;
+    /** Item title. */
+    title?: string | null;
+    /** Item description. */
+    description?: string | null;
+    /** Link from the item. You can link to Wix sites or external URLs. */
+    link?: Link;
+    /** @readonly */
+    type?: Type;
+    /**
+     * Date and time the item was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date and time the item was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /** Item tags. */
+    tags?: Tags;
+}
+/** @oneof */
+interface ItemMetadataOneOf {
+    /** Details about the image. */
+    image?: Image;
+    /** Details about the video. */
+    video?: Video;
+    /** Details about the text file. */
+    text?: Text;
+}
+interface Link {
+    /** Display text of the link. */
+    text?: string | null;
+    /** Target URL of the link. */
+    url?: string | null;
+}
+declare enum Type {
+    UNDEFINED = "UNDEFINED",
+    IMAGE = "IMAGE",
+    VIDEO = "VIDEO",
+    TEXT = "TEXT"
+}
+interface Image {
+    /** The image's Wix media URL in the following format: `'wix:image://v1/<uri>/<filename>#originWidth=<width>&originHeight=<height>[&watermark=<watermark_manifest_string>]'`. */
+    imageInfo?: string;
+    /** Focal point of the image. */
+    focalPoint?: Point;
+    /** Set of key-value pairs describing the media in [Exchangeable Image File format](https://en.wikipedia.org/wiki/Exif). */
+    exif?: Record<string, any> | null;
+    /**
+     * Image compression level. <br />
+     *
+     * Min: `30` <br />
+     * Max: `100`
+     */
+    quality?: number | null;
+    /** [Unsharp masking](https://en.wikipedia.org/wiki/Unsharp_masking) values of the image. */
+    unsharpMasking?: UnsharpMasking;
+}
+interface Point {
+    /** X-coordinate of the focal point. */
+    x?: number;
+    /** Y-coordinate of the focal point. */
+    y?: number;
+}
+interface UnsharpMasking {
+    /**
+     * Unsharp masking amount. Controls the sharpening strength. <br />
+     *
+     * Min: `0` <br />
+     * Max: `5`
+     */
+    amount?: number | null;
+    /** Unsharp masking radius in pixels. Controls the sharpening width. */
+    radius?: number | null;
+    /**
+     * Unsharp masking threshold. Controls how different neighboring pixels must be for shapening to apply. <br />
+     *
+     * Min: `0` <br />
+     * Max: `1`
+     */
+    threshold?: number | null;
+}
+interface Video {
+    type?: VideoType;
+    /**
+     * The video's URL. Either a Wix media URL, or a supported https external URL in the following formats:
+     *
+     *  Wix Media: `'wix:video://v1/6e6ea4_461425d7e7db4d5487a28e00c5ba6244/9e6ea4_461425d7e7db4d5487a28e00c5ba6277#posterUri=9e6ea4_461425d7e7db4d5487a28e00c5ba6277f000.jpg&posterWidth=960&posterHeight=540'`
+     *
+     * Vimeo: `'https://vimeo.com/378840916'`
+     *
+     * Youtube: `'https://www.youtube.com/results?search_query=uplifting+upbeat+music'`
+     */
+    videoInfo?: string;
+    /** Manually defined video duration in milliseconds. */
+    durationInMillis?: number | null;
+}
+declare enum VideoType {
+    UNDEFINED = "UNDEFINED",
+    WIX_MEDIA = "WIX_MEDIA",
+    YOUTUBE = "YOUTUBE",
+    VIMEO = "VIMEO"
+}
+interface Text {
+    /** Text in HTML format. */
+    html?: string | null;
+    /**
+     * Set of key-value pairs describing the [CSS style](https://en.wikipedia.org/wiki/CSS) of the text.
+     *
+     * __Note:__ The object structure is customizable. See the [List Gallery Items](https://dev.wix.com/api/rest/site-content/pro-gallery/list-gallery-items) code example for supported values.
+     */
+    css?: Record<string, any> | null;
+    /** Reserved for internal use. */
+    editorHtml?: string | null;
+    /** Reserved for internal use. */
+    editorFontId?: string | null;
+}
+interface Tags {
+    /** List of tags assigned to the media item. */
+    values?: string[];
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface GalleryItemCreated {
+    /** Created gallery item. */
+    item?: Item;
+}
+interface GalleryItemUpdated {
+    /** Updated gallery item. */
+    updatedItem?: Item;
+}
+interface GalleryItemDeleted {
+    /** ID of the deleted gallery item. */
+    itemId?: string;
+}
+interface ListGalleriesResponse {
+    /** Total number of galleries in the site. */
+    totalGalleries?: number | null;
+    /** List of galleries. Sorted by `_createdDate`. */
+    galleries?: Gallery[];
+}
+/** @oneof */
+interface GetGalleryRequestVersionOneOf {
+}
+interface ListGalleryItemsResponse {
+    /** List of media items in the gallery. */
+    items?: Item[];
+}
+interface DeleteGalleryResponse {
+    /**
+     * ID of the deleted gallery.
+     * @readonly
+     */
+    galleryId?: string;
+}
+interface DeleteGalleryItemResponse {
+    /**
+     * ID of the deleted media item.
+     * @readonly
+     */
+    itemId?: string;
+}
+interface ListGalleriesResponseNonNullableFields {
+    galleries: {
+        items: {
+            image?: {
+                imageInfo: string;
+                focalPoint?: {
+                    x: number;
+                    y: number;
+                };
+            };
+            video?: {
+                type: VideoType;
+                videoInfo: string;
+            };
+            type: Type;
+            tags?: {
+                values: string[];
+            };
+        }[];
+    }[];
+}
+interface ListGalleryItemsResponseNonNullableFields {
+    items: {
+        image?: {
+            imageInfo: string;
+            focalPoint?: {
+                x: number;
+                y: number;
+            };
+        };
+        video?: {
+            type: VideoType;
+            videoInfo: string;
+        };
+        type: Type;
+        tags?: {
+            values: string[];
+        };
+    }[];
+}
+interface DeleteGalleryResponseNonNullableFields {
+    galleryId: string;
+}
+interface DeleteGalleryItemResponseNonNullableFields {
+    itemId: string;
+}
+interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /**
+     * 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;
+}
+interface GalleryCreatedEnvelope {
+    entity: Gallery;
+    metadata: EventMetadata;
+}
+interface GalleryUpdatedEnvelope {
+    entity: Gallery;
+    metadata: EventMetadata;
+}
+interface GalleryDeletedEnvelope {
+    metadata: EventMetadata;
+}
+interface GalleryItemCreatedEnvelope {
+    data: GalleryItemCreated;
+    metadata: EventMetadata;
+}
+interface GalleryItemUpdatedEnvelope {
+    data: GalleryItemUpdated;
+    metadata: EventMetadata;
+}
+interface GalleryItemDeletedEnvelope {
+    data: GalleryItemDeleted;
+    metadata: EventMetadata;
+}
+interface ListGalleriesOptions {
+    /** Number of galleries to list. Defaults to 10. */
+    itemLimit?: number | null;
+    /** Number of galleries to skip in the returns. Defaults to 0. */
+    offset?: number | null;
+    /** Number of galleries to list. Defaults to 10. */
+    limit?: number | null;
+}
+interface GetGalleryOptions extends GetGalleryRequestVersionOneOf {
+    /** Number of media items to skip in the returns. Defaults to 0. */
+    itemOffset?: number | null;
+    /**
+     * Maximum number of media items to return. <br />
+     *
+     * Min: `1` <br />
+     * Max: `100` <br />
+     * Default: `50`
+     */
+    itemLimit?: number | null;
+}
+interface ListGalleryItemsOptions {
+    /** Number of media items to skip in the returns. Defaults to 0. */
+    itemOffset?: number | null;
+    /**
+     * Maximum number of media items to return. <br />
+     *
+     * Min: `1` <br />
+     * Max: `100` <br />
+     * Default: `50`
+     */
+    itemLimit?: number | null;
+}
+interface GetGalleryItemIdentifiers {
+    /** Gallery ID. */
+    galleryId: string;
+    /** Item ID. */
+    itemId: string;
+}
+interface CreateGalleryOptions {
+    /** Gallery to create. */
+    gallery?: Gallery;
+    /** Gallery ID to clone from. */
+    cloneFromGalleryId?: string | null;
+}
+interface UpdateGallery {
+    /**
+     * Gallery ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /** Gallery name. */
+    name?: string | null;
+    /**
+     * Total number of items in the gallery.
+     * @readonly
+     */
+    totalItems?: number | null;
+    /** Media items in the gallery. */
+    items?: Item[];
+    /**
+     * Index that determines which position a gallery is displayed on the site. <br />
+     *
+     * >**Note:** If you assign the same sort order index to more than one gallery, the function fails.
+     */
+    sortOrder?: number | null;
+    /**
+     * Date and time the gallery was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+}
+interface UpdateGalleryItemIdentifiers {
+    /** ID of the gallery containing the item to update.  */
+    galleryId: string;
+    /**
+     * ID of the item to update.
+     * @readonly
+     */
+    itemId?: string | null;
+}
+interface UpdateGalleryItem {
+    /** Details about the image. */
+    image?: Image;
+    /** Details about the video. */
+    video?: Video;
+    /** Details about the text file. */
+    text?: Text;
+    /**
+     * Item ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Index that determines which position a media item is displayed in the gallery. <br />
+     *
+     * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
+     *
+     * >**Note:** If you assign the same sort order index to more than one media item in a gallery, the function fails.
+     */
+    sortOrder?: number | null;
+    /** Item title. */
+    title?: string | null;
+    /** Item description. */
+    description?: string | null;
+    /** Link from the item. You can link to Wix sites or external URLs. */
+    link?: Link;
+    /** @readonly */
+    type?: Type;
+    /**
+     * Date and time the item was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date and time the item was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /** Item tags. */
+    tags?: Tags;
+}
+interface DeleteGalleryItemIdentifiers {
+    /** Gallery ID. */
+    galleryId: string;
+    /** ID of the media item to delete. */
+    itemId: string;
+}
+
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: unknown;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, _transformations?: unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+declare function listGalleries$1(httpClient: HttpClient): (options?: ListGalleriesOptions) => Promise<ListGalleriesResponse & ListGalleriesResponseNonNullableFields>;
+declare function getGallery$1(httpClient: HttpClient): (galleryId: string, options?: GetGalleryOptions) => Promise<Gallery & {
+    items: {
+        image?: {
+            imageInfo: string;
+            focalPoint?: {
+                x: number;
+                y: number;
+            } | undefined;
+        } | undefined;
+        video?: {
+            type: VideoType;
+            videoInfo: string;
+        } | undefined;
+        type: Type;
+        tags?: {
+            values: string[];
+        } | undefined;
+    }[];
+}>;
+declare function listGalleryItems$1(httpClient: HttpClient): (galleryId: string, options?: ListGalleryItemsOptions) => Promise<ListGalleryItemsResponse & ListGalleryItemsResponseNonNullableFields>;
+declare function getGalleryItem$1(httpClient: HttpClient): (identifiers: GetGalleryItemIdentifiers) => Promise<Item & {
+    image?: {
+        imageInfo: string;
+        focalPoint?: {
+            x: number;
+            y: number;
+        } | undefined;
+    } | undefined;
+    video?: {
+        type: VideoType;
+        videoInfo: string;
+    } | undefined;
+    type: Type;
+    tags?: {
+        values: string[];
+    } | undefined;
+}>;
+declare function createGallery$1(httpClient: HttpClient): (options?: CreateGalleryOptions) => Promise<Gallery & {
+    items: {
+        image?: {
+            imageInfo: string;
+            focalPoint?: {
+                x: number;
+                y: number;
+            } | undefined;
+        } | undefined;
+        video?: {
+            type: VideoType;
+            videoInfo: string;
+        } | undefined;
+        type: Type;
+        tags?: {
+            values: string[];
+        } | undefined;
+    }[];
+}>;
+declare function updateGallery$1(httpClient: HttpClient): (_id: string | null, gallery: UpdateGallery) => Promise<Gallery & {
+    items: {
+        image?: {
+            imageInfo: string;
+            focalPoint?: {
+                x: number;
+                y: number;
+            } | undefined;
+        } | undefined;
+        video?: {
+            type: VideoType;
+            videoInfo: string;
+        } | undefined;
+        type: Type;
+        tags?: {
+            values: string[];
+        } | undefined;
+    }[];
+}>;
+declare function deleteGallery$1(httpClient: HttpClient): (galleryId: string) => Promise<DeleteGalleryResponse & DeleteGalleryResponseNonNullableFields>;
+declare function createGalleryItem$1(httpClient: HttpClient): (galleryId: string, item: Item) => Promise<Item & {
+    image?: {
+        imageInfo: string;
+        focalPoint?: {
+            x: number;
+            y: number;
+        } | undefined;
+    } | undefined;
+    video?: {
+        type: VideoType;
+        videoInfo: string;
+    } | undefined;
+    type: Type;
+    tags?: {
+        values: string[];
+    } | undefined;
+}>;
+declare function updateGalleryItem$1(httpClient: HttpClient): (identifiers: UpdateGalleryItemIdentifiers, item: UpdateGalleryItem) => Promise<Item & {
+    image?: {
+        imageInfo: string;
+        focalPoint?: {
+            x: number;
+            y: number;
+        } | undefined;
+    } | undefined;
+    video?: {
+        type: VideoType;
+        videoInfo: string;
+    } | undefined;
+    type: Type;
+    tags?: {
+        values: string[];
+    } | undefined;
+}>;
+declare function deleteGalleryItem$1(httpClient: HttpClient): (identifiers: DeleteGalleryItemIdentifiers) => Promise<DeleteGalleryItemResponse & DeleteGalleryItemResponseNonNullableFields>;
+declare const onGalleryCreated$1: EventDefinition<GalleryCreatedEnvelope, "wix.pro_gallery.gallery_v2_created">;
+declare const onGalleryUpdated$1: EventDefinition<GalleryUpdatedEnvelope, "wix.pro_gallery.gallery_v2_updated">;
+declare const onGalleryDeleted$1: EventDefinition<GalleryDeletedEnvelope, "wix.pro_gallery.gallery_v2_deleted">;
+declare const onGalleryItemCreated$1: EventDefinition<GalleryItemCreatedEnvelope, "wix.pro_gallery.gallery_v2_gallery_item_created">;
+declare const onGalleryItemUpdated$1: EventDefinition<GalleryItemUpdatedEnvelope, "wix.pro_gallery.gallery_v2_gallery_item_updated">;
+declare const onGalleryItemDeleted$1: EventDefinition<GalleryItemDeletedEnvelope, "wix.pro_gallery.gallery_v2_gallery_item_deleted">;
+
+declare const listGalleries: BuildRESTFunction<typeof listGalleries$1>;
+declare const getGallery: BuildRESTFunction<typeof getGallery$1>;
+declare const listGalleryItems: BuildRESTFunction<typeof listGalleryItems$1>;
+declare const getGalleryItem: BuildRESTFunction<typeof getGalleryItem$1>;
+declare const createGallery: BuildRESTFunction<typeof createGallery$1>;
+declare const updateGallery: BuildRESTFunction<typeof updateGallery$1>;
+declare const deleteGallery: BuildRESTFunction<typeof deleteGallery$1>;
+declare const createGalleryItem: BuildRESTFunction<typeof createGalleryItem$1>;
+declare const updateGalleryItem: BuildRESTFunction<typeof updateGalleryItem$1>;
+declare const deleteGalleryItem: BuildRESTFunction<typeof deleteGalleryItem$1>;
+declare const onGalleryCreated: BuildEventDefinition<typeof onGalleryCreated$1>;
+declare const onGalleryUpdated: BuildEventDefinition<typeof onGalleryUpdated$1>;
+declare const onGalleryDeleted: BuildEventDefinition<typeof onGalleryDeleted$1>;
+declare const onGalleryItemCreated: BuildEventDefinition<typeof onGalleryItemCreated$1>;
+declare const onGalleryItemUpdated: BuildEventDefinition<typeof onGalleryItemUpdated$1>;
+declare const onGalleryItemDeleted: BuildEventDefinition<typeof onGalleryItemDeleted$1>;
+
+declare const context_createGallery: typeof createGallery;
+declare const context_createGalleryItem: typeof createGalleryItem;
+declare const context_deleteGallery: typeof deleteGallery;
+declare const context_deleteGalleryItem: typeof deleteGalleryItem;
+declare const context_getGallery: typeof getGallery;
+declare const context_getGalleryItem: typeof getGalleryItem;
+declare const context_listGalleries: typeof listGalleries;
+declare const context_listGalleryItems: typeof listGalleryItems;
+declare const context_onGalleryCreated: typeof onGalleryCreated;
+declare const context_onGalleryDeleted: typeof onGalleryDeleted;
+declare const context_onGalleryItemCreated: typeof onGalleryItemCreated;
+declare const context_onGalleryItemDeleted: typeof onGalleryItemDeleted;
+declare const context_onGalleryItemUpdated: typeof onGalleryItemUpdated;
+declare const context_onGalleryUpdated: typeof onGalleryUpdated;
+declare const context_updateGallery: typeof updateGallery;
+declare const context_updateGalleryItem: typeof updateGalleryItem;
+declare namespace context {
+  export { context_createGallery as createGallery, context_createGalleryItem as createGalleryItem, context_deleteGallery as deleteGallery, context_deleteGalleryItem as deleteGalleryItem, context_getGallery as getGallery, context_getGalleryItem as getGalleryItem, context_listGalleries as listGalleries, context_listGalleryItems as listGalleryItems, context_onGalleryCreated as onGalleryCreated, context_onGalleryDeleted as onGalleryDeleted, context_onGalleryItemCreated as onGalleryItemCreated, context_onGalleryItemDeleted as onGalleryItemDeleted, context_onGalleryItemUpdated as onGalleryItemUpdated, context_onGalleryUpdated as onGalleryUpdated, context_updateGallery as updateGallery, context_updateGalleryItem as updateGalleryItem };
+}
+
+export { context as proGallery };