@wix/viewer 1.0.0

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

@@ -0,0 +1,596 @@
+interface SiteStructureItem$1 {
+    /**
+     * The end goal: this field should contain a unique identifier for this site-structure item.\
+     * Currently it contains:
+     * - For site-structure integrated TPAs - the unique identifier provided by the TPA.
+     * - For all other item types - empty string.
+     */
+    itemId?: string;
+    /**
+     * An identifier for the type of the item. One of:
+     * - For the site's static pages - "static_page".
+     * - For legacy integration TPAs - the TPA's app-def-id.
+     * - For TPAs with new site-structure integration - the item type identifier provided by the TPA. Commonly one of that TPA's supported sub-pages.
+     * - For items that are the result of a dynamic router - "dynamic-page".
+     */
+    itemTypeIdentifier?: string;
+    /**
+     * An identifier for the source of the item. One of:
+     * - For the site's static pages - "editor".
+     * - For legacy integration TPAs - the TPA's app-def-id.
+     * - For TPAs with new site-structure integration - the TPA's app-def-id.
+     * - For items that are the result of a dynamic router - Wix-Code's app-def-id: '675bbcef-18d8-41f5-800e-131ec9e08762'.
+     */
+    sourceId?: string;
+    /**
+     * An identifier for the configuration of the item. Used currently as some sort of a placeholder for further filtering.
+     * - For items of type "dynamic-page" - The 'prefix' field that is part of the router-config object of the router that is related to this item (see WixCodeDynamicRouterResolver).
+     * - For all other items types - empty string.
+     */
+    configId?: string;
+    /**
+     * A human readable name string associated with the item.\
+     * Currently exists only for new TPA site-structure integration items, and contains the 'name' field provided by the TPA for that item.\
+     * This field is not guaranteed to be unique across the item list.
+     */
+    name?: string | null;
+    /**
+     * Deprecated. Previously used for media content that is associated with an item.\
+     * See 'image' and 'video' fields of this message.
+     * @deprecated
+     */
+    media?: MediaItem$1[];
+    /** A relative url path that can be used, with the site's base-url, to reach the page represented by this item. */
+    path?: string | null;
+    /**
+     * A timestamp representing the moment that this item was last changed.
+     * - For static pages - the site's last publish time.
+     * - For all kinds of TPAs - the last-modified field in the respective response item from the TPA.
+     * - For items that are the result of a dynamic router - the content of the 'lastModified' optional field in the response item from Wix-Code's RPC endpoint, or, if missing, the site's last publish time. (see WixCodeDynamicRouterResolver).
+     */
+    updatedDate?: Date | null;
+    /**
+     * A value indicating whether the item is inactive or not. E.g. hidden product/finished event etc.\
+     * Currently exists only for new TPA site-structure integration items, and contains the 'inactive' field provided by the TPA for that item.
+     */
+    inactive?: boolean | null;
+    /**
+     * A general free schema field to include further metadata related to this item.\
+     * Currently exists only for:\
+     * Static pages - a JSON that is the merge of:
+     * 1. The advancedSeoData JSON string that exists for the page in the master-page.
+     * 2. A JSON of the form:
+     * ```javascript
+     * {
+     * "seo_legacy": {
+     * "hidden_from_seo": true / false
+     * },
+     * "password_protected": true / false
+     * }
+     * ```
+     * New TPA site-structure integration items - the 'metadata' field provided by the TPA for that item.
+     */
+    metadata?: Record<string, any> | null;
+    /**
+     * An image media metadata the is related to this item.\
+     * Currently exists only for new TPA site-structure integration items, and contains the 'image' field provided by the TPA for that item.
+     */
+    image?: Image[];
+    /**
+     * A video media metadata the is related to this item.\
+     * Currently exists only for new TPA site-structure integration items, and contains the 'video' field provided by the TPA for that item.
+     */
+    video?: VideoV2[];
+    /** A value indicating whether the item is protected or not, by password or login. */
+    protected?: boolean | null;
+    /**
+     * ID of the translations of the item. As same item can have multiple instances, one for each language, we can match them by this ID.\
+     * For example:
+     * Blog has one post, translated to 2 languages (EN, FR):
+     * - EN item path is `/amazing-post`
+     * - FR item path is `/poste-incroyable
+     * Both of them might have different `item_id`, but will share the same `translation_id`, to be easily match together
+     * Currently only relevant for Blog
+     */
+    translationId?: string;
+    /** A value indicating whether the item is a custom error page or not. */
+    isCustomErrorPage?: boolean | null;
+}
+/** Deprecated - Copy this message into your service, do not reference it */
+interface MediaItem$1 extends MediaItemMediaOneOf$1 {
+    /** WixMedia image */
+    image?: Image;
+    /** WixMedia video */
+    video?: Video;
+    /** WixMedia document */
+    document?: Document;
+}
+/** @oneof */
+interface MediaItemMediaOneOf$1 {
+    /** WixMedia image */
+    image?: Image;
+    /** WixMedia video */
+    video?: Video;
+    /** WixMedia document */
+    document?: Document;
+}
+interface Image {
+    /** WixMedia image ID. */
+    id?: string;
+    /** Image URL. */
+    url?: string;
+    /**
+     * Original image height.
+     * @readonly
+     */
+    height?: number;
+    /**
+     * Original image width.
+     * @readonly
+     */
+    width?: number;
+    /** Image alt text. */
+    altText?: string | null;
+    /**
+     * Image filename.
+     * @readonly
+     */
+    filename?: string | null;
+}
+/** Deprecated - use VideoV2 */
+interface Video {
+    /** WixMedia ID */
+    id?: string;
+    /** URL of video */
+    url?: string;
+    /**
+     * Original image height
+     * @readonly
+     */
+    height?: number;
+    /**
+     * Original image width
+     * @readonly
+     */
+    width?: number;
+    /** Video poster */
+    thumbnail?: Image;
+}
+interface Document {
+    /** WixMedia ID. */
+    id?: string;
+    /** Document URL. */
+    url?: string;
+    /** Document filename. */
+    filename?: string | null;
+}
+interface VideoV2 {
+    /** WixMedia ID. */
+    id?: string;
+    /**
+     * Available resolutions for the video, starting with the optimal resolution.
+     * @readonly
+     */
+    resolutions?: VideoResolution[];
+    /**
+     * Video filename.
+     * @readonly
+     */
+    filename?: string | null;
+}
+interface VideoResolution {
+    /** Video URL. */
+    url?: string;
+    /** Video height. */
+    height?: number;
+    /** Video width. */
+    width?: number;
+    /** Video format for example, mp4, hls. */
+    format?: string;
+}
+interface SiteStructureRequest$1 {
+    /** An enum indicating whether the request is for the latest published version (0) or the latest saved version (1) of the site */
+    pageVersion?: PageSegment$1;
+    /**
+     * Pagination request metadata, currently applicable for:\
+     * - Queries filtered for items from a TPA that is part of the new-integration (TpaSiteStructureService)
+     * - Queries filtered for dynamic router items from the new dynamic-pages-router integration (DynamicSiteStructureService)
+     */
+    paging?: CursorPaging$1;
+    /** Filtering metadata. Only items allowed by the filter will be returned. */
+    filter?: SiteStructureRequestFilter$1;
+    /** General sorting metadata. Currently not supported. */
+    sorting?: Sorting$1;
+    /** General field mask metadata. Currently not supported. */
+    fieldSet?: string[];
+    /** Language metadata. Contains 2 chars language code and/or 4 chars language tag. */
+    languageMetadata?: LanguageMetadata$1;
+}
+declare enum PageSegment$1 {
+    PUBLISHED = "PUBLISHED",
+    SAVED = "SAVED"
+}
+interface CursorPaging$1 {
+    /** Maximum number of items to return in the results. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+/** A filter metadata type. The filter forces an 'and' logic between all of its comprising parts. */
+interface SiteStructureRequestFilter$1 {
+    /** In accordance to SiteStructureItem.item_type_identifier */
+    itemTypeIdentifier?: string;
+    /** In accordance to SiteStructureItem.source_id */
+    sourceId?: string;
+    /** In accordance to SiteStructureItem.config_id */
+    configId?: string;
+}
+interface Sorting$1 {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder$1;
+}
+declare enum SortOrder$1 {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface LanguageMetadata$1 {
+    /** 2 chars language code (e.g. 'en') */
+    code?: string;
+    /** 4 chars language tag (e.g. 'en-us') */
+    tag?: string | null;
+}
+interface SiteStructureResponse$1 {
+    /** The total number of items to be returned, combining all paginated responses. */
+    totalResults?: number;
+    /** A cursor based paging response metadata, including the item count in the current page and a cursor string to be used for querying of the next page. */
+    pageData?: CursorPagingMetaData$1;
+    /** A list of all the result items. */
+    results?: SiteStructureItem$1[];
+}
+interface CursorPagingMetaData$1 {
+    /** The item count in the current page */
+    count?: number | null;
+    /** The cursor which will be used to query the next page */
+    cursor?: string | null;
+}
+interface GetSiteStructureMetadataRequest$1 {
+    /** Page's version */
+    pageVersion?: PageSegment$1;
+}
+interface GetSiteStructureMetadataResponse$1 {
+    /** A list of pages types */
+    pageTypes?: SitePageType$1[];
+}
+interface SitePageType$1 {
+    /** Type identifier */
+    itemTypeIdentifier?: string;
+    /** Site's page-type sourceId */
+    sourceId?: string;
+    /** Site's page-type configId */
+    configId?: string;
+}
+interface FocalPointNonNullableFields {
+    x: number;
+    y: number;
+}
+interface ImageNonNullableFields {
+    id: string;
+    url: string;
+    height: number;
+    width: number;
+    focalPoint?: FocalPointNonNullableFields;
+}
+interface VideoNonNullableFields {
+    id: string;
+    url: string;
+    height: number;
+    width: number;
+    thumbnail?: ImageNonNullableFields;
+}
+interface DocumentNonNullableFields {
+    id: string;
+    url: string;
+}
+interface MediaItemNonNullableFields$1 {
+    image?: ImageNonNullableFields;
+    video?: VideoNonNullableFields;
+    document?: DocumentNonNullableFields;
+}
+interface VideoResolutionNonNullableFields {
+    url: string;
+    height: number;
+    width: number;
+    poster?: ImageNonNullableFields;
+    format: string;
+}
+interface VideoV2NonNullableFields {
+    id: string;
+    url: string;
+    resolutions: VideoResolutionNonNullableFields[];
+    posters: ImageNonNullableFields[];
+}
+interface SiteStructureItemNonNullableFields$1 {
+    itemId: string;
+    itemTypeIdentifier: string;
+    sourceId: string;
+    configId: string;
+    media: MediaItemNonNullableFields$1[];
+    image: ImageNonNullableFields[];
+    video: VideoV2NonNullableFields[];
+    translationId: string;
+}
+interface SiteStructureResponseNonNullableFields$1 {
+    totalResults: number;
+    results: SiteStructureItemNonNullableFields$1[];
+}
+interface SitePageTypeNonNullableFields$1 {
+    itemTypeIdentifier: string;
+    sourceId: string;
+    configId: string;
+    pageIdentifiers: string[];
+}
+interface GetSiteStructureMetadataResponseNonNullableFields$1 {
+    pageTypes: SitePageTypeNonNullableFields$1[];
+}
+
+interface SiteStructureItem {
+    /**
+     * The end goal: this field should contain a unique identifier for this site-structure item.\
+     * Currently it contains:
+     * - For site-structure integrated TPAs - the unique identifier provided by the TPA.
+     * - For all other item types - empty string.
+     */
+    itemId?: string;
+    /**
+     * An identifier for the type of the item. One of:
+     * - For the site's static pages - "static_page".
+     * - For legacy integration TPAs - the TPA's app-def-id.
+     * - For TPAs with new site-structure integration - the item type identifier provided by the TPA. Commonly one of that TPA's supported sub-pages.
+     * - For items that are the result of a dynamic router - "dynamic-page".
+     */
+    itemTypeIdentifier?: string;
+    /**
+     * An identifier for the source of the item. One of:
+     * - For the site's static pages - "editor".
+     * - For legacy integration TPAs - the TPA's app-def-id.
+     * - For TPAs with new site-structure integration - the TPA's app-def-id.
+     * - For items that are the result of a dynamic router - Wix-Code's app-def-id: '675bbcef-18d8-41f5-800e-131ec9e08762'.
+     */
+    sourceId?: string;
+    /**
+     * An identifier for the configuration of the item. Used currently as some sort of a placeholder for further filtering.
+     * - For items of type "dynamic-page" - The 'prefix' field that is part of the router-config object of the router that is related to this item (see WixCodeDynamicRouterResolver).
+     * - For all other items types - empty string.
+     */
+    configId?: string;
+    /**
+     * A human readable name string associated with the item.\
+     * Currently exists only for new TPA site-structure integration items, and contains the 'name' field provided by the TPA for that item.\
+     * This field is not guaranteed to be unique across the item list.
+     */
+    name?: string | null;
+    /**
+     * Deprecated. Previously used for media content that is associated with an item.\
+     * See 'image' and 'video' fields of this message.
+     * @deprecated
+     */
+    media?: MediaItem[];
+    /** A relative url path that can be used, with the site's base-url, to reach the page represented by this item. */
+    path?: string | null;
+    /**
+     * A timestamp representing the moment that this item was last changed.
+     * - For static pages - the site's last publish time.
+     * - For all kinds of TPAs - the last-modified field in the respective response item from the TPA.
+     * - For items that are the result of a dynamic router - the content of the 'lastModified' optional field in the response item from Wix-Code's RPC endpoint, or, if missing, the site's last publish time. (see WixCodeDynamicRouterResolver).
+     */
+    _updatedDate?: Date | null;
+    /**
+     * A value indicating whether the item is inactive or not. E.g. hidden product/finished event etc.\
+     * Currently exists only for new TPA site-structure integration items, and contains the 'inactive' field provided by the TPA for that item.
+     */
+    inactive?: boolean | null;
+    /**
+     * A general free schema field to include further metadata related to this item.\
+     * Currently exists only for:\
+     * Static pages - a JSON that is the merge of:
+     * 1. The advancedSeoData JSON string that exists for the page in the master-page.
+     * 2. A JSON of the form:
+     * ```javascript
+     * {
+     * "seo_legacy": {
+     * "hidden_from_seo": true / false
+     * },
+     * "password_protected": true / false
+     * }
+     * ```
+     * New TPA site-structure integration items - the 'metadata' field provided by the TPA for that item.
+     */
+    metadata?: Record<string, any> | null;
+    /**
+     * An image media metadata the is related to this item.\
+     * Currently exists only for new TPA site-structure integration items, and contains the 'image' field provided by the TPA for that item.
+     */
+    image?: string[];
+    /**
+     * A video media metadata the is related to this item.\
+     * Currently exists only for new TPA site-structure integration items, and contains the 'video' field provided by the TPA for that item.
+     */
+    video?: string[];
+    /** A value indicating whether the item is protected or not, by password or login. */
+    protected?: boolean | null;
+    /**
+     * ID of the translations of the item. As same item can have multiple instances, one for each language, we can match them by this ID.\
+     * For example:
+     * Blog has one post, translated to 2 languages (EN, FR):
+     * - EN item path is `/amazing-post`
+     * - FR item path is `/poste-incroyable
+     * Both of them might have different `item_id`, but will share the same `translation_id`, to be easily match together
+     * Currently only relevant for Blog
+     */
+    translationId?: string;
+    /** A value indicating whether the item is a custom error page or not. */
+    isCustomErrorPage?: boolean | null;
+}
+/** Deprecated - Copy this message into your service, do not reference it */
+interface MediaItem extends MediaItemMediaOneOf {
+    /** WixMedia image */
+    image?: string;
+    /** WixMedia video */
+    video?: string;
+    /** WixMedia document */
+    document?: string;
+}
+/** @oneof */
+interface MediaItemMediaOneOf {
+    /** WixMedia image */
+    image?: string;
+    /** WixMedia video */
+    video?: string;
+    /** WixMedia document */
+    document?: string;
+}
+interface SiteStructureRequest {
+    /** An enum indicating whether the request is for the latest published version (0) or the latest saved version (1) of the site */
+    pageVersion?: PageSegment;
+    /**
+     * Pagination request metadata, currently applicable for:\
+     * - Queries filtered for items from a TPA that is part of the new-integration (TpaSiteStructureService)
+     * - Queries filtered for dynamic router items from the new dynamic-pages-router integration (DynamicSiteStructureService)
+     */
+    paging?: CursorPaging;
+    /** Filtering metadata. Only items allowed by the filter will be returned. */
+    filter?: SiteStructureRequestFilter;
+    /** General sorting metadata. Currently not supported. */
+    sorting?: Sorting;
+    /** General field mask metadata. Currently not supported. */
+    fieldSet?: string[];
+    /** Language metadata. Contains 2 chars language code and/or 4 chars language tag. */
+    languageMetadata?: LanguageMetadata;
+}
+declare enum PageSegment {
+    PUBLISHED = "PUBLISHED",
+    SAVED = "SAVED"
+}
+interface CursorPaging {
+    /** Maximum number of items to return in the results. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+/** A filter metadata type. The filter forces an 'and' logic between all of its comprising parts. */
+interface SiteStructureRequestFilter {
+    /** In accordance to SiteStructureItem.item_type_identifier */
+    itemTypeIdentifier?: string;
+    /** In accordance to SiteStructureItem.source_id */
+    sourceId?: string;
+    /** In accordance to SiteStructureItem.config_id */
+    configId?: string;
+}
+interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface LanguageMetadata {
+    /** 2 chars language code (e.g. 'en') */
+    code?: string;
+    /** 4 chars language tag (e.g. 'en-us') */
+    tag?: string | null;
+}
+interface SiteStructureResponse {
+    /** The total number of items to be returned, combining all paginated responses. */
+    totalResults?: number;
+    /** A cursor based paging response metadata, including the item count in the current page and a cursor string to be used for querying of the next page. */
+    pageData?: CursorPagingMetaData;
+    /** A list of all the result items. */
+    results?: SiteStructureItem[];
+}
+interface CursorPagingMetaData {
+    /** The item count in the current page */
+    count?: number | null;
+    /** The cursor which will be used to query the next page */
+    cursor?: string | null;
+}
+interface GetSiteStructureMetadataRequest {
+    /** Page's version */
+    pageVersion?: PageSegment;
+}
+interface GetSiteStructureMetadataResponse {
+    /** A list of pages types */
+    pageTypes?: SitePageType[];
+}
+interface SitePageType {
+    /** Type identifier */
+    itemTypeIdentifier?: string;
+    /** Site's page-type sourceId */
+    sourceId?: string;
+    /** Site's page-type configId */
+    configId?: string;
+}
+interface MediaItemNonNullableFields {
+    image: string;
+    video: string;
+    document: string;
+}
+interface SiteStructureItemNonNullableFields {
+    itemId: string;
+    itemTypeIdentifier: string;
+    sourceId: string;
+    configId: string;
+    media: MediaItemNonNullableFields[];
+    image: string[];
+    video: string[];
+    translationId: string;
+}
+interface SiteStructureResponseNonNullableFields {
+    totalResults: number;
+    results: SiteStructureItemNonNullableFields[];
+}
+interface SitePageTypeNonNullableFields {
+    itemTypeIdentifier: string;
+    sourceId: string;
+    configId: string;
+    pageIdentifiers: string[];
+}
+interface GetSiteStructureMetadataResponseNonNullableFields {
+    pageTypes: SitePageTypeNonNullableFields[];
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function getSiteStructure(): __PublicMethodMetaInfo<'POST', {}, SiteStructureRequest, SiteStructureRequest$1, SiteStructureResponse & SiteStructureResponseNonNullableFields, SiteStructureResponse$1 & SiteStructureResponseNonNullableFields$1>;
+declare function getSiteStructureMetadata(): __PublicMethodMetaInfo<'POST', {}, GetSiteStructureMetadataRequest, GetSiteStructureMetadataRequest$1, GetSiteStructureMetadataResponse & GetSiteStructureMetadataResponseNonNullableFields, GetSiteStructureMetadataResponse$1 & GetSiteStructureMetadataResponseNonNullableFields$1>;
+
+type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
+declare const meta_getSiteStructure: typeof getSiteStructure;
+declare const meta_getSiteStructureMetadata: typeof getSiteStructureMetadata;
+declare namespace meta {
+  export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_getSiteStructure as getSiteStructure, meta_getSiteStructureMetadata as getSiteStructureMetadata };
+}
+
+export { meta as siteStructureService };