@wix/auto_sdk_viewer_site-structure-service 1.0.18 → 1.0.19

package/build/internal/cjs/meta.d.ts

@@ -99,6 +99,12 @@ interface SiteStructureItem {
     translationId?: string;
     /** A value indicating whether the item is a custom error page or not. */
     isCustomErrorPage?: boolean | null;
+    /**
+     * An page identifier.
+     * For items that are the result of a dynamic router - page key
+     * @internal
+     */
+    pageIdentifier?: string | null;
 }
 /** Deprecated - Copy this message into your service, do not reference it */
 interface MediaItem extends MediaItemMediaOneOf {
@@ -135,11 +141,29 @@ interface Image {
     width?: number;
     /** Image alt text. */
     altText?: string | null;
+    /**
+     * Image URL expiration date (when relevant).
+     * @internal
+     * @readonly
+     */
+    urlExpirationDate?: Date | null;
     /**
      * Image filename.
      * @readonly
      */
     filename?: string | null;
+    /**
+     * Image size in bytes.
+     * @internal
+     * @readonly
+     * @format DECIMAL_VALUE
+     */
+    sizeInBytes?: string | null;
+    /**
+     * Focal point of the image.
+     * @internal
+     */
+    focalPoint?: FocalPoint;
 }
 interface FocalPoint {
     /** X-coordinate of the focal point. */
@@ -175,12 +199,34 @@ interface Document {
     id?: string;
     /** Document URL. */
     url?: string;
+    /**
+     * Document URL expiration date (when relevant).
+     * @internal
+     */
+    urlExpirationDate?: Date | null;
+    /**
+     * Document size in bytes.
+     * @internal
+     * @format DECIMAL_VALUE
+     */
+    sizeInBytes?: string | null;
     /** Document filename. */
     filename?: string | null;
+    /**
+     * Document thumbnail.
+     * @internal
+     * @readonly
+     */
+    thumbnail?: Image;
 }
 interface VideoV2 {
     /** WixMedia ID. */
     id?: string;
+    /**
+     * Original video URL.
+     * @internal
+     */
+    url?: string;
     /**
      * Available resolutions for the video, starting with the optimal resolution.
      * @readonly
@@ -192,6 +238,55 @@ interface VideoV2 {
      * @readonly
      */
     filename?: string | null;
+    /**
+     * Video posters.
+     * @internal
+     * @readonly
+     */
+    posters?: Image[];
+    /**
+     * Original video size in bytes.
+     * @internal
+     * @readonly
+     * @format DECIMAL_VALUE
+     */
+    sizeInBytes?: string | null;
+    /**
+     * Video URL expiration date (when relevant).
+     * @internal
+     * @readonly
+     */
+    urlExpirationDate?: Date | null;
+    /**
+     * Original video duration in milliseconds.
+     * @internal
+     * @readonly
+     */
+    durationInMilliseconds?: number | null;
+    /**
+     * A short title for the video. will be used for SEO purposes.
+     * @internal
+     * @maxLength 300
+     */
+    title?: string | null;
+    /**
+     * A long description for the video. will be used for SEO purposes.
+     * @internal
+     * @maxLength 2000
+     */
+    description?: string | null;
+    /**
+     * Original video height.
+     * @internal
+     * @readonly
+     */
+    height?: number | null;
+    /**
+     * Original video width.
+     * @internal
+     * @readonly
+     */
+    width?: number | null;
 }
 interface VideoResolution {
     /** Video URL. */
@@ -200,8 +295,68 @@ interface VideoResolution {
     height?: number;
     /** Video width. */
     width?: number;
+    /**
+     * Deprecated. Use the `posters` property in the parent entity instead.
+     * @internal
+     * @deprecated
+     */
+    poster?: Image;
     /** Video format for example, mp4, hls. */
     format?: string;
+    /**
+     * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.
+     * @internal
+     * @deprecated
+     */
+    urlExpirationDate?: Date | null;
+    /**
+     * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.
+     * @internal
+     * @format DECIMAL_VALUE
+     * @deprecated
+     */
+    sizeInBytes?: string | null;
+    /**
+     * Video quality. For example: 480p, 720p.
+     * @internal
+     */
+    quality?: string | null;
+    /**
+     * Video filename.
+     * @internal
+     */
+    filename?: string | null;
+    /**
+     * Video duration in seconds.
+     * @internal
+     * @readonly
+     * @deprecated Video duration in seconds.
+     * @replacedBy duration_in_milliseconds
+     * @targetRemovalDate 2024-08-01
+     */
+    durationInSeconds?: number | null;
+    /**
+     * Video duration in milliseconds.
+     * @internal
+     * @readonly
+     */
+    durationInMilliseconds?: number | null;
+    /**
+     * When true, this is a protected asset, and calling the URL will return a 403 error.
+     * In order to access private assets, make a request to:
+     * `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
+     * @internal
+     * @readonly
+     */
+    private?: boolean | null;
+    /**
+     * Key to identify the video resolution's relationship to the original media in WixMedia.
+     * Can be used to request a download for the specific video resolution.
+     * For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4
+     * @internal
+     * @readonly
+     */
+    assetKey?: string | null;
 }
 interface SiteStructureRequest {
     /** An enum indicating whether the request is for the latest published version (0) or the latest saved version (1) of the site */
@@ -255,6 +410,11 @@ interface SiteStructureRequestFilter {
     sourceId?: string;
     /** In accordance to SiteStructureItem.config_id */
     configId?: string;
+    /**
+     * In accordance to SiteStructureItem.page_identifier
+     * @internal
+     */
+    pageIdentifier?: string | null;
 }
 interface Sorting {
     /**
@@ -264,6 +424,20 @@ interface Sorting {
     fieldName?: string;
     /** Sort order. */
     order?: SortOrderWithLiterals;
+    /**
+     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+     *
+     * If multiple filters are provided, they are combined with AND operator.
+     *
+     * Example:
+     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+     * @internal
+     * @maxSize 10
+     */
+    selectItemsBy?: Record<string, any>[] | null;
     /**
      * Origin point for geo-distance sorting on a GEO field
      * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
@@ -370,6 +544,11 @@ interface SitePageType {
     sourceId?: string;
     /** Site's page-type configId */
     configId?: string;
+    /**
+     * Site's pages identifiers
+     * @internal
+     */
+    pageIdentifiers?: string[];
 }
 interface GetSiteStructureChunksRequest {
     /** @maxLength 8192 */

package/build/internal/es/index.typings.d.mts

@@ -98,6 +98,12 @@ interface SiteStructureItem {
     translationId?: string;
     /** A value indicating whether the item is a custom error page or not. */
     isCustomErrorPage?: boolean | null;
+    /**
+     * An page identifier.
+     * For items that are the result of a dynamic router - page key
+     * @internal
+     */
+    pageIdentifier?: string | null;
 }
 /** Deprecated - Copy this message into your service, do not reference it */
 interface MediaItem extends MediaItemMediaOneOf {
@@ -134,8 +140,68 @@ interface VideoResolution {
     height?: number;
     /** Video width. */
     width?: number;
+    /**
+     * Deprecated. Use the `posters` property in the parent entity instead.
+     * @internal
+     * @deprecated
+     */
+    poster?: string;
     /** Video format for example, mp4, hls. */
     format?: string;
+    /**
+     * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.
+     * @internal
+     * @deprecated
+     */
+    urlExpirationDate?: Date | null;
+    /**
+     * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.
+     * @internal
+     * @format DECIMAL_VALUE
+     * @deprecated
+     */
+    sizeInBytes?: string | null;
+    /**
+     * Video quality. For example: 480p, 720p.
+     * @internal
+     */
+    quality?: string | null;
+    /**
+     * Video filename.
+     * @internal
+     */
+    filename?: string | null;
+    /**
+     * Video duration in seconds.
+     * @internal
+     * @readonly
+     * @deprecated Video duration in seconds.
+     * @replacedBy duration_in_milliseconds
+     * @targetRemovalDate 2024-08-01
+     */
+    durationInSeconds?: number | null;
+    /**
+     * Video duration in milliseconds.
+     * @internal
+     * @readonly
+     */
+    durationInMilliseconds?: number | null;
+    /**
+     * When true, this is a protected asset, and calling the URL will return a 403 error.
+     * In order to access private assets, make a request to:
+     * `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
+     * @internal
+     * @readonly
+     */
+    private?: boolean | null;
+    /**
+     * Key to identify the video resolution's relationship to the original media in WixMedia.
+     * Can be used to request a download for the specific video resolution.
+     * For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4
+     * @internal
+     * @readonly
+     */
+    assetKey?: string | null;
 }
 interface SiteStructureRequest {
     /** An enum indicating whether the request is for the latest published version (0) or the latest saved version (1) of the site */
@@ -189,6 +255,11 @@ interface SiteStructureRequestFilter {
     sourceId?: string;
     /** In accordance to SiteStructureItem.config_id */
     configId?: string;
+    /**
+     * In accordance to SiteStructureItem.page_identifier
+     * @internal
+     */
+    pageIdentifier?: string | null;
 }
 interface Sorting {
     /**
@@ -198,6 +269,20 @@ interface Sorting {
     fieldName?: string;
     /** Sort order. */
     order?: SortOrderWithLiterals;
+    /**
+     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+     *
+     * If multiple filters are provided, they are combined with AND operator.
+     *
+     * Example:
+     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+     * @internal
+     * @maxSize 10
+     */
+    selectItemsBy?: Record<string, any>[] | null;
     /**
      * Origin point for geo-distance sorting on a GEO field
      * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
@@ -304,6 +389,11 @@ interface SitePageType {
     sourceId?: string;
     /** Site's page-type configId */
     configId?: string;
+    /**
+     * Site's pages identifiers
+     * @internal
+     */
+    pageIdentifiers?: string[];
 }
 interface GetSiteStructureChunksRequest {
     /** @maxLength 8192 */

package/build/internal/es/meta.d.mts

@@ -99,6 +99,12 @@ interface SiteStructureItem {
     translationId?: string;
     /** A value indicating whether the item is a custom error page or not. */
     isCustomErrorPage?: boolean | null;
+    /**
+     * An page identifier.
+     * For items that are the result of a dynamic router - page key
+     * @internal
+     */
+    pageIdentifier?: string | null;
 }
 /** Deprecated - Copy this message into your service, do not reference it */
 interface MediaItem extends MediaItemMediaOneOf {
@@ -135,11 +141,29 @@ interface Image {
     width?: number;
     /** Image alt text. */
     altText?: string | null;
+    /**
+     * Image URL expiration date (when relevant).
+     * @internal
+     * @readonly
+     */
+    urlExpirationDate?: Date | null;
     /**
      * Image filename.
      * @readonly
      */
     filename?: string | null;
+    /**
+     * Image size in bytes.
+     * @internal
+     * @readonly
+     * @format DECIMAL_VALUE
+     */
+    sizeInBytes?: string | null;
+    /**
+     * Focal point of the image.
+     * @internal
+     */
+    focalPoint?: FocalPoint;
 }
 interface FocalPoint {
     /** X-coordinate of the focal point. */
@@ -175,12 +199,34 @@ interface Document {
     id?: string;
     /** Document URL. */
     url?: string;
+    /**
+     * Document URL expiration date (when relevant).
+     * @internal
+     */
+    urlExpirationDate?: Date | null;
+    /**
+     * Document size in bytes.
+     * @internal
+     * @format DECIMAL_VALUE
+     */
+    sizeInBytes?: string | null;
     /** Document filename. */
     filename?: string | null;
+    /**
+     * Document thumbnail.
+     * @internal
+     * @readonly
+     */
+    thumbnail?: Image;
 }
 interface VideoV2 {
     /** WixMedia ID. */
     id?: string;
+    /**
+     * Original video URL.
+     * @internal
+     */
+    url?: string;
     /**
      * Available resolutions for the video, starting with the optimal resolution.
      * @readonly
@@ -192,6 +238,55 @@ interface VideoV2 {
      * @readonly
      */
     filename?: string | null;
+    /**
+     * Video posters.
+     * @internal
+     * @readonly
+     */
+    posters?: Image[];
+    /**
+     * Original video size in bytes.
+     * @internal
+     * @readonly
+     * @format DECIMAL_VALUE
+     */
+    sizeInBytes?: string | null;
+    /**
+     * Video URL expiration date (when relevant).
+     * @internal
+     * @readonly
+     */
+    urlExpirationDate?: Date | null;
+    /**
+     * Original video duration in milliseconds.
+     * @internal
+     * @readonly
+     */
+    durationInMilliseconds?: number | null;
+    /**
+     * A short title for the video. will be used for SEO purposes.
+     * @internal
+     * @maxLength 300
+     */
+    title?: string | null;
+    /**
+     * A long description for the video. will be used for SEO purposes.
+     * @internal
+     * @maxLength 2000
+     */
+    description?: string | null;
+    /**
+     * Original video height.
+     * @internal
+     * @readonly
+     */
+    height?: number | null;
+    /**
+     * Original video width.
+     * @internal
+     * @readonly
+     */
+    width?: number | null;
 }
 interface VideoResolution {
     /** Video URL. */
@@ -200,8 +295,68 @@ interface VideoResolution {
     height?: number;
     /** Video width. */
     width?: number;
+    /**
+     * Deprecated. Use the `posters` property in the parent entity instead.
+     * @internal
+     * @deprecated
+     */
+    poster?: Image;
     /** Video format for example, mp4, hls. */
     format?: string;
+    /**
+     * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.
+     * @internal
+     * @deprecated
+     */
+    urlExpirationDate?: Date | null;
+    /**
+     * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.
+     * @internal
+     * @format DECIMAL_VALUE
+     * @deprecated
+     */
+    sizeInBytes?: string | null;
+    /**
+     * Video quality. For example: 480p, 720p.
+     * @internal
+     */
+    quality?: string | null;
+    /**
+     * Video filename.
+     * @internal
+     */
+    filename?: string | null;
+    /**
+     * Video duration in seconds.
+     * @internal
+     * @readonly
+     * @deprecated Video duration in seconds.
+     * @replacedBy duration_in_milliseconds
+     * @targetRemovalDate 2024-08-01
+     */
+    durationInSeconds?: number | null;
+    /**
+     * Video duration in milliseconds.
+     * @internal
+     * @readonly
+     */
+    durationInMilliseconds?: number | null;
+    /**
+     * When true, this is a protected asset, and calling the URL will return a 403 error.
+     * In order to access private assets, make a request to:
+     * `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
+     * @internal
+     * @readonly
+     */
+    private?: boolean | null;
+    /**
+     * Key to identify the video resolution's relationship to the original media in WixMedia.
+     * Can be used to request a download for the specific video resolution.
+     * For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4
+     * @internal
+     * @readonly
+     */
+    assetKey?: string | null;
 }
 interface SiteStructureRequest {
     /** An enum indicating whether the request is for the latest published version (0) or the latest saved version (1) of the site */
@@ -255,6 +410,11 @@ interface SiteStructureRequestFilter {
     sourceId?: string;
     /** In accordance to SiteStructureItem.config_id */
     configId?: string;
+    /**
+     * In accordance to SiteStructureItem.page_identifier
+     * @internal
+     */
+    pageIdentifier?: string | null;
 }
 interface Sorting {
     /**
@@ -264,6 +424,20 @@ interface Sorting {
     fieldName?: string;
     /** Sort order. */
     order?: SortOrderWithLiterals;
+    /**
+     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+     *
+     * If multiple filters are provided, they are combined with AND operator.
+     *
+     * Example:
+     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+     * @internal
+     * @maxSize 10
+     */
+    selectItemsBy?: Record<string, any>[] | null;
     /**
      * Origin point for geo-distance sorting on a GEO field
      * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
@@ -370,6 +544,11 @@ interface SitePageType {
     sourceId?: string;
     /** Site's page-type configId */
     configId?: string;
+    /**
+     * Site's pages identifiers
+     * @internal
+     */
+    pageIdentifiers?: string[];
 }
 interface GetSiteStructureChunksRequest {
     /** @maxLength 8192 */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_viewer_site-structure-service",
-  "version": "1.0.18",
+  "version": "1.0.19",
   "license": "MIT",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -21,23 +21,16 @@
       "import": "./build/es/meta.mjs",
       "require": "./build/cjs/meta.js",
       "types": "./build/es/meta.d.mts"
-    },
-    "./schemas": {
-      "import": "./build/es/schemas.mjs",
-      "require": "./build/cjs/schemas.js",
-      "types": "./build/es/schemas.d.mts"
     }
   },
   "files": [
     "build",
     "meta",
-    "service-plugins",
-    "schemas"
+    "service-plugins"
   ],
   "dependencies": {
-    "@wix/sdk-runtime": "^1.0.12",
-    "@wix/sdk-types": "^1.17.7",
-    "zod": "^4.3.6"
+    "@wix/sdk-runtime": "^1.0.24",
+    "@wix/sdk-types": "^1.17.11"
   },
   "devDependencies": {
     "tsup": "^8.4.0",
@@ -57,5 +50,5 @@
       "fqdn": "wix.viewer.structure.v1.site_structure_item"
     }
   },
-  "falconPackageHash": "1b0186bab77a8243656055924f5a60f3c6b58cb357567b827a7861dc"
+  "falconPackageHash": "70ba1e7fb5f8815ed05ce70a6ce3c662ae4c31164efebf4513b6ef81"
 }