@wix/auto_sdk_viewer_site-structure-service 1.0.17 → 1.0.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -1
- package/build/cjs/index.js +13 -3
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +12 -1
- package/build/cjs/index.typings.js +13 -3
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +12 -1
- package/build/cjs/meta.js +13 -3
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +1 -1
- package/build/es/index.mjs +12 -2
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +12 -1
- package/build/es/index.typings.mjs +12 -2
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +12 -1
- package/build/es/meta.mjs +12 -2
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +1 -1
- package/build/internal/cjs/index.typings.d.ts +102 -1
- package/build/internal/cjs/meta.d.ts +191 -1
- package/build/internal/es/index.d.mts +1 -1
- package/build/internal/es/index.typings.d.mts +102 -1
- package/build/internal/es/meta.d.mts +191 -1
- package/package.json +5 -12
- package/build/cjs/schemas.d.ts +0 -102
- package/build/cjs/schemas.js +0 -216
- package/build/cjs/schemas.js.map +0 -1
- package/build/es/schemas.d.mts +0 -102
- package/build/es/schemas.mjs +0 -176
- package/build/es/schemas.mjs.map +0 -1
- package/build/internal/cjs/index.js +0 -284
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.js +0 -263
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.js +0 -206
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/schemas.d.ts +0 -102
- package/build/internal/cjs/schemas.js +0 -216
- package/build/internal/cjs/schemas.js.map +0 -1
- package/build/internal/es/index.mjs +0 -257
- package/build/internal/es/index.mjs.map +0 -1
- package/build/internal/es/index.typings.mjs +0 -236
- package/build/internal/es/index.typings.mjs.map +0 -1
- package/build/internal/es/meta.mjs +0 -176
- package/build/internal/es/meta.mjs.map +0 -1
- package/build/internal/es/schemas.d.mts +0 -102
- package/build/internal/es/schemas.mjs +0 -176
- package/build/internal/es/schemas.mjs.map +0 -1
- package/schemas/package.json +0 -3
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
2
|
import { GetSiteStructureOptions, SiteStructureResponse, GetSiteStructureMetadataOptions, GetSiteStructureMetadataResponse } from './index.typings.mjs';
|
|
3
|
-
export { ChunkMetadata, CursorPaging, CursorPagingMetaData, FocalPoint, GetSiteStructureChunkRequest, GetSiteStructureChunkResponse, GetSiteStructureChunksRequest, GetSiteStructureChunksResponse, GetSiteStructureMetadataRequest, LanguageMetadata, MediaItem, MediaItemMediaOneOf, PageSegment, PageSegmentWithLiterals, SitePageType, SiteStructureFetchError, SiteStructureFetchErrorItemTypeOneOf, SiteStructureItem, SiteStructureRequest, SiteStructureRequestFilter, SortOrder, SortOrderWithLiterals, Sorting, VideoResolution } from './index.typings.mjs';
|
|
3
|
+
export { AddressLocation, ChunkMetadata, CursorPaging, CursorPagingMetaData, FocalPoint, GetSiteStructureChunkRequest, GetSiteStructureChunkResponse, GetSiteStructureChunksRequest, GetSiteStructureChunksResponse, GetSiteStructureMetadataRequest, LanguageMetadata, MediaItem, MediaItemMediaOneOf, PageSegment, PageSegmentWithLiterals, SitePageType, SiteStructureFetchError, SiteStructureFetchErrorItemTypeOneOf, SiteStructureItem, SiteStructureRequest, SiteStructureRequestFilter, SortOrder, SortOrderWithLiterals, Sorting, VideoResolution } from './index.typings.mjs';
|
|
4
4
|
|
|
5
5
|
declare function getSiteStructure$1(httpClient: HttpClient): GetSiteStructureSignature;
|
|
6
6
|
interface GetSiteStructureSignature {
|
|
@@ -98,6 +98,12 @@ interface SiteStructureItem {
|
|
|
98
98
|
translationId?: string;
|
|
99
99
|
/** A value indicating whether the item is a custom error page or not. */
|
|
100
100
|
isCustomErrorPage?: boolean | null;
|
|
101
|
+
/**
|
|
102
|
+
* An page identifier.
|
|
103
|
+
* For items that are the result of a dynamic router - page key
|
|
104
|
+
* @internal
|
|
105
|
+
*/
|
|
106
|
+
pageIdentifier?: string | null;
|
|
101
107
|
}
|
|
102
108
|
/** Deprecated - Copy this message into your service, do not reference it */
|
|
103
109
|
interface MediaItem extends MediaItemMediaOneOf {
|
|
@@ -134,8 +140,68 @@ interface VideoResolution {
|
|
|
134
140
|
height?: number;
|
|
135
141
|
/** Video width. */
|
|
136
142
|
width?: number;
|
|
143
|
+
/**
|
|
144
|
+
* Deprecated. Use the `posters` property in the parent entity instead.
|
|
145
|
+
* @internal
|
|
146
|
+
* @deprecated
|
|
147
|
+
*/
|
|
148
|
+
poster?: string;
|
|
137
149
|
/** Video format for example, mp4, hls. */
|
|
138
150
|
format?: string;
|
|
151
|
+
/**
|
|
152
|
+
* Deprecated. Use the `urlExpirationDate` property in the parent entity instead.
|
|
153
|
+
* @internal
|
|
154
|
+
* @deprecated
|
|
155
|
+
*/
|
|
156
|
+
urlExpirationDate?: Date | null;
|
|
157
|
+
/**
|
|
158
|
+
* Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.
|
|
159
|
+
* @internal
|
|
160
|
+
* @format DECIMAL_VALUE
|
|
161
|
+
* @deprecated
|
|
162
|
+
*/
|
|
163
|
+
sizeInBytes?: string | null;
|
|
164
|
+
/**
|
|
165
|
+
* Video quality. For example: 480p, 720p.
|
|
166
|
+
* @internal
|
|
167
|
+
*/
|
|
168
|
+
quality?: string | null;
|
|
169
|
+
/**
|
|
170
|
+
* Video filename.
|
|
171
|
+
* @internal
|
|
172
|
+
*/
|
|
173
|
+
filename?: string | null;
|
|
174
|
+
/**
|
|
175
|
+
* Video duration in seconds.
|
|
176
|
+
* @internal
|
|
177
|
+
* @readonly
|
|
178
|
+
* @deprecated Video duration in seconds.
|
|
179
|
+
* @replacedBy duration_in_milliseconds
|
|
180
|
+
* @targetRemovalDate 2024-08-01
|
|
181
|
+
*/
|
|
182
|
+
durationInSeconds?: number | null;
|
|
183
|
+
/**
|
|
184
|
+
* Video duration in milliseconds.
|
|
185
|
+
* @internal
|
|
186
|
+
* @readonly
|
|
187
|
+
*/
|
|
188
|
+
durationInMilliseconds?: number | null;
|
|
189
|
+
/**
|
|
190
|
+
* When true, this is a protected asset, and calling the URL will return a 403 error.
|
|
191
|
+
* In order to access private assets, make a request to:
|
|
192
|
+
* `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
|
|
193
|
+
* @internal
|
|
194
|
+
* @readonly
|
|
195
|
+
*/
|
|
196
|
+
private?: boolean | null;
|
|
197
|
+
/**
|
|
198
|
+
* Key to identify the video resolution's relationship to the original media in WixMedia.
|
|
199
|
+
* Can be used to request a download for the specific video resolution.
|
|
200
|
+
* For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4
|
|
201
|
+
* @internal
|
|
202
|
+
* @readonly
|
|
203
|
+
*/
|
|
204
|
+
assetKey?: string | null;
|
|
139
205
|
}
|
|
140
206
|
interface SiteStructureRequest {
|
|
141
207
|
/** 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 {
|
|
|
189
255
|
sourceId?: string;
|
|
190
256
|
/** In accordance to SiteStructureItem.config_id */
|
|
191
257
|
configId?: string;
|
|
258
|
+
/**
|
|
259
|
+
* In accordance to SiteStructureItem.page_identifier
|
|
260
|
+
* @internal
|
|
261
|
+
*/
|
|
262
|
+
pageIdentifier?: string | null;
|
|
192
263
|
}
|
|
193
264
|
interface Sorting {
|
|
194
265
|
/**
|
|
@@ -198,6 +269,25 @@ interface Sorting {
|
|
|
198
269
|
fieldName?: string;
|
|
199
270
|
/** Sort order. */
|
|
200
271
|
order?: SortOrderWithLiterals;
|
|
272
|
+
/**
|
|
273
|
+
* When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
|
|
274
|
+
* a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
|
|
275
|
+
*
|
|
276
|
+
* If multiple filters are provided, they are combined with AND operator.
|
|
277
|
+
*
|
|
278
|
+
* Example:
|
|
279
|
+
* Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
|
|
280
|
+
* and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
|
|
281
|
+
* { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
|
|
282
|
+
* @internal
|
|
283
|
+
* @maxSize 10
|
|
284
|
+
*/
|
|
285
|
+
selectItemsBy?: Record<string, any>[] | null;
|
|
286
|
+
/**
|
|
287
|
+
* Origin point for geo-distance sorting on a GEO field
|
|
288
|
+
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
289
|
+
*/
|
|
290
|
+
origin?: AddressLocation;
|
|
201
291
|
}
|
|
202
292
|
declare enum SortOrder {
|
|
203
293
|
ASC = "ASC",
|
|
@@ -205,6 +295,12 @@ declare enum SortOrder {
|
|
|
205
295
|
}
|
|
206
296
|
/** @enumType */
|
|
207
297
|
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
298
|
+
interface AddressLocation {
|
|
299
|
+
/** Address latitude. */
|
|
300
|
+
latitude?: number | null;
|
|
301
|
+
/** Address longitude. */
|
|
302
|
+
longitude?: number | null;
|
|
303
|
+
}
|
|
208
304
|
interface LanguageMetadata {
|
|
209
305
|
/**
|
|
210
306
|
* 2 chars language code (e.g. 'en')
|
|
@@ -293,6 +389,11 @@ interface SitePageType {
|
|
|
293
389
|
sourceId?: string;
|
|
294
390
|
/** Site's page-type configId */
|
|
295
391
|
configId?: string;
|
|
392
|
+
/**
|
|
393
|
+
* Site's pages identifiers
|
|
394
|
+
* @internal
|
|
395
|
+
*/
|
|
396
|
+
pageIdentifiers?: string[];
|
|
296
397
|
}
|
|
297
398
|
interface GetSiteStructureChunksRequest {
|
|
298
399
|
/** @maxLength 8192 */
|
|
@@ -398,4 +499,4 @@ interface GetSiteStructureMetadataOptions {
|
|
|
398
499
|
pageVersion?: PageSegmentWithLiterals;
|
|
399
500
|
}
|
|
400
501
|
|
|
401
|
-
export { type ChunkMetadata, type CursorPaging, type CursorPagingMetaData, type FocalPoint, type GetSiteStructureChunkRequest, type GetSiteStructureChunkResponse, type GetSiteStructureChunksRequest, type GetSiteStructureChunksResponse, type GetSiteStructureMetadataOptions, type GetSiteStructureMetadataRequest, type GetSiteStructureMetadataResponse, type GetSiteStructureOptions, type LanguageMetadata, type MediaItem, type MediaItemMediaOneOf, PageSegment, type PageSegmentWithLiterals, type SitePageType, type SiteStructureFetchError, type SiteStructureFetchErrorItemTypeOneOf, type SiteStructureItem, type SiteStructureRequest, type SiteStructureRequestFilter, type SiteStructureResponse, SortOrder, type SortOrderWithLiterals, type Sorting, type VideoResolution, getSiteStructure, getSiteStructureMetadata };
|
|
502
|
+
export { type AddressLocation, type ChunkMetadata, type CursorPaging, type CursorPagingMetaData, type FocalPoint, type GetSiteStructureChunkRequest, type GetSiteStructureChunkResponse, type GetSiteStructureChunksRequest, type GetSiteStructureChunksResponse, type GetSiteStructureMetadataOptions, type GetSiteStructureMetadataRequest, type GetSiteStructureMetadataResponse, type GetSiteStructureOptions, type LanguageMetadata, type MediaItem, type MediaItemMediaOneOf, PageSegment, type PageSegmentWithLiterals, type SitePageType, type SiteStructureFetchError, type SiteStructureFetchErrorItemTypeOneOf, type SiteStructureItem, type SiteStructureRequest, type SiteStructureRequestFilter, type SiteStructureResponse, SortOrder, type SortOrderWithLiterals, type Sorting, type VideoResolution, getSiteStructure, getSiteStructureMetadata };
|
|
@@ -99,6 +99,12 @@ interface SiteStructureItem {
|
|
|
99
99
|
translationId?: string;
|
|
100
100
|
/** A value indicating whether the item is a custom error page or not. */
|
|
101
101
|
isCustomErrorPage?: boolean | null;
|
|
102
|
+
/**
|
|
103
|
+
* An page identifier.
|
|
104
|
+
* For items that are the result of a dynamic router - page key
|
|
105
|
+
* @internal
|
|
106
|
+
*/
|
|
107
|
+
pageIdentifier?: string | null;
|
|
102
108
|
}
|
|
103
109
|
/** Deprecated - Copy this message into your service, do not reference it */
|
|
104
110
|
interface MediaItem extends MediaItemMediaOneOf {
|
|
@@ -135,11 +141,29 @@ interface Image {
|
|
|
135
141
|
width?: number;
|
|
136
142
|
/** Image alt text. */
|
|
137
143
|
altText?: string | null;
|
|
144
|
+
/**
|
|
145
|
+
* Image URL expiration date (when relevant).
|
|
146
|
+
* @internal
|
|
147
|
+
* @readonly
|
|
148
|
+
*/
|
|
149
|
+
urlExpirationDate?: Date | null;
|
|
138
150
|
/**
|
|
139
151
|
* Image filename.
|
|
140
152
|
* @readonly
|
|
141
153
|
*/
|
|
142
154
|
filename?: string | null;
|
|
155
|
+
/**
|
|
156
|
+
* Image size in bytes.
|
|
157
|
+
* @internal
|
|
158
|
+
* @readonly
|
|
159
|
+
* @format DECIMAL_VALUE
|
|
160
|
+
*/
|
|
161
|
+
sizeInBytes?: string | null;
|
|
162
|
+
/**
|
|
163
|
+
* Focal point of the image.
|
|
164
|
+
* @internal
|
|
165
|
+
*/
|
|
166
|
+
focalPoint?: FocalPoint;
|
|
143
167
|
}
|
|
144
168
|
interface FocalPoint {
|
|
145
169
|
/** X-coordinate of the focal point. */
|
|
@@ -175,12 +199,34 @@ interface Document {
|
|
|
175
199
|
id?: string;
|
|
176
200
|
/** Document URL. */
|
|
177
201
|
url?: string;
|
|
202
|
+
/**
|
|
203
|
+
* Document URL expiration date (when relevant).
|
|
204
|
+
* @internal
|
|
205
|
+
*/
|
|
206
|
+
urlExpirationDate?: Date | null;
|
|
207
|
+
/**
|
|
208
|
+
* Document size in bytes.
|
|
209
|
+
* @internal
|
|
210
|
+
* @format DECIMAL_VALUE
|
|
211
|
+
*/
|
|
212
|
+
sizeInBytes?: string | null;
|
|
178
213
|
/** Document filename. */
|
|
179
214
|
filename?: string | null;
|
|
215
|
+
/**
|
|
216
|
+
* Document thumbnail.
|
|
217
|
+
* @internal
|
|
218
|
+
* @readonly
|
|
219
|
+
*/
|
|
220
|
+
thumbnail?: Image;
|
|
180
221
|
}
|
|
181
222
|
interface VideoV2 {
|
|
182
223
|
/** WixMedia ID. */
|
|
183
224
|
id?: string;
|
|
225
|
+
/**
|
|
226
|
+
* Original video URL.
|
|
227
|
+
* @internal
|
|
228
|
+
*/
|
|
229
|
+
url?: string;
|
|
184
230
|
/**
|
|
185
231
|
* Available resolutions for the video, starting with the optimal resolution.
|
|
186
232
|
* @readonly
|
|
@@ -192,6 +238,55 @@ interface VideoV2 {
|
|
|
192
238
|
* @readonly
|
|
193
239
|
*/
|
|
194
240
|
filename?: string | null;
|
|
241
|
+
/**
|
|
242
|
+
* Video posters.
|
|
243
|
+
* @internal
|
|
244
|
+
* @readonly
|
|
245
|
+
*/
|
|
246
|
+
posters?: Image[];
|
|
247
|
+
/**
|
|
248
|
+
* Original video size in bytes.
|
|
249
|
+
* @internal
|
|
250
|
+
* @readonly
|
|
251
|
+
* @format DECIMAL_VALUE
|
|
252
|
+
*/
|
|
253
|
+
sizeInBytes?: string | null;
|
|
254
|
+
/**
|
|
255
|
+
* Video URL expiration date (when relevant).
|
|
256
|
+
* @internal
|
|
257
|
+
* @readonly
|
|
258
|
+
*/
|
|
259
|
+
urlExpirationDate?: Date | null;
|
|
260
|
+
/**
|
|
261
|
+
* Original video duration in milliseconds.
|
|
262
|
+
* @internal
|
|
263
|
+
* @readonly
|
|
264
|
+
*/
|
|
265
|
+
durationInMilliseconds?: number | null;
|
|
266
|
+
/**
|
|
267
|
+
* A short title for the video. will be used for SEO purposes.
|
|
268
|
+
* @internal
|
|
269
|
+
* @maxLength 300
|
|
270
|
+
*/
|
|
271
|
+
title?: string | null;
|
|
272
|
+
/**
|
|
273
|
+
* A long description for the video. will be used for SEO purposes.
|
|
274
|
+
* @internal
|
|
275
|
+
* @maxLength 2000
|
|
276
|
+
*/
|
|
277
|
+
description?: string | null;
|
|
278
|
+
/**
|
|
279
|
+
* Original video height.
|
|
280
|
+
* @internal
|
|
281
|
+
* @readonly
|
|
282
|
+
*/
|
|
283
|
+
height?: number | null;
|
|
284
|
+
/**
|
|
285
|
+
* Original video width.
|
|
286
|
+
* @internal
|
|
287
|
+
* @readonly
|
|
288
|
+
*/
|
|
289
|
+
width?: number | null;
|
|
195
290
|
}
|
|
196
291
|
interface VideoResolution {
|
|
197
292
|
/** Video URL. */
|
|
@@ -200,8 +295,68 @@ interface VideoResolution {
|
|
|
200
295
|
height?: number;
|
|
201
296
|
/** Video width. */
|
|
202
297
|
width?: number;
|
|
298
|
+
/**
|
|
299
|
+
* Deprecated. Use the `posters` property in the parent entity instead.
|
|
300
|
+
* @internal
|
|
301
|
+
* @deprecated
|
|
302
|
+
*/
|
|
303
|
+
poster?: Image;
|
|
203
304
|
/** Video format for example, mp4, hls. */
|
|
204
305
|
format?: string;
|
|
306
|
+
/**
|
|
307
|
+
* Deprecated. Use the `urlExpirationDate` property in the parent entity instead.
|
|
308
|
+
* @internal
|
|
309
|
+
* @deprecated
|
|
310
|
+
*/
|
|
311
|
+
urlExpirationDate?: Date | null;
|
|
312
|
+
/**
|
|
313
|
+
* Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.
|
|
314
|
+
* @internal
|
|
315
|
+
* @format DECIMAL_VALUE
|
|
316
|
+
* @deprecated
|
|
317
|
+
*/
|
|
318
|
+
sizeInBytes?: string | null;
|
|
319
|
+
/**
|
|
320
|
+
* Video quality. For example: 480p, 720p.
|
|
321
|
+
* @internal
|
|
322
|
+
*/
|
|
323
|
+
quality?: string | null;
|
|
324
|
+
/**
|
|
325
|
+
* Video filename.
|
|
326
|
+
* @internal
|
|
327
|
+
*/
|
|
328
|
+
filename?: string | null;
|
|
329
|
+
/**
|
|
330
|
+
* Video duration in seconds.
|
|
331
|
+
* @internal
|
|
332
|
+
* @readonly
|
|
333
|
+
* @deprecated Video duration in seconds.
|
|
334
|
+
* @replacedBy duration_in_milliseconds
|
|
335
|
+
* @targetRemovalDate 2024-08-01
|
|
336
|
+
*/
|
|
337
|
+
durationInSeconds?: number | null;
|
|
338
|
+
/**
|
|
339
|
+
* Video duration in milliseconds.
|
|
340
|
+
* @internal
|
|
341
|
+
* @readonly
|
|
342
|
+
*/
|
|
343
|
+
durationInMilliseconds?: number | null;
|
|
344
|
+
/**
|
|
345
|
+
* When true, this is a protected asset, and calling the URL will return a 403 error.
|
|
346
|
+
* In order to access private assets, make a request to:
|
|
347
|
+
* `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
|
|
348
|
+
* @internal
|
|
349
|
+
* @readonly
|
|
350
|
+
*/
|
|
351
|
+
private?: boolean | null;
|
|
352
|
+
/**
|
|
353
|
+
* Key to identify the video resolution's relationship to the original media in WixMedia.
|
|
354
|
+
* Can be used to request a download for the specific video resolution.
|
|
355
|
+
* For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4
|
|
356
|
+
* @internal
|
|
357
|
+
* @readonly
|
|
358
|
+
*/
|
|
359
|
+
assetKey?: string | null;
|
|
205
360
|
}
|
|
206
361
|
interface SiteStructureRequest {
|
|
207
362
|
/** 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 {
|
|
|
255
410
|
sourceId?: string;
|
|
256
411
|
/** In accordance to SiteStructureItem.config_id */
|
|
257
412
|
configId?: string;
|
|
413
|
+
/**
|
|
414
|
+
* In accordance to SiteStructureItem.page_identifier
|
|
415
|
+
* @internal
|
|
416
|
+
*/
|
|
417
|
+
pageIdentifier?: string | null;
|
|
258
418
|
}
|
|
259
419
|
interface Sorting {
|
|
260
420
|
/**
|
|
@@ -264,6 +424,25 @@ interface Sorting {
|
|
|
264
424
|
fieldName?: string;
|
|
265
425
|
/** Sort order. */
|
|
266
426
|
order?: SortOrderWithLiterals;
|
|
427
|
+
/**
|
|
428
|
+
* When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
|
|
429
|
+
* a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
|
|
430
|
+
*
|
|
431
|
+
* If multiple filters are provided, they are combined with AND operator.
|
|
432
|
+
*
|
|
433
|
+
* Example:
|
|
434
|
+
* Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
|
|
435
|
+
* and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
|
|
436
|
+
* { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
|
|
437
|
+
* @internal
|
|
438
|
+
* @maxSize 10
|
|
439
|
+
*/
|
|
440
|
+
selectItemsBy?: Record<string, any>[] | null;
|
|
441
|
+
/**
|
|
442
|
+
* Origin point for geo-distance sorting on a GEO field
|
|
443
|
+
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
444
|
+
*/
|
|
445
|
+
origin?: AddressLocation;
|
|
267
446
|
}
|
|
268
447
|
declare enum SortOrder {
|
|
269
448
|
ASC = "ASC",
|
|
@@ -271,6 +450,12 @@ declare enum SortOrder {
|
|
|
271
450
|
}
|
|
272
451
|
/** @enumType */
|
|
273
452
|
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
453
|
+
interface AddressLocation {
|
|
454
|
+
/** Address latitude. */
|
|
455
|
+
latitude?: number | null;
|
|
456
|
+
/** Address longitude. */
|
|
457
|
+
longitude?: number | null;
|
|
458
|
+
}
|
|
274
459
|
interface LanguageMetadata {
|
|
275
460
|
/**
|
|
276
461
|
* 2 chars language code (e.g. 'en')
|
|
@@ -359,6 +544,11 @@ interface SitePageType {
|
|
|
359
544
|
sourceId?: string;
|
|
360
545
|
/** Site's page-type configId */
|
|
361
546
|
configId?: string;
|
|
547
|
+
/**
|
|
548
|
+
* Site's pages identifiers
|
|
549
|
+
* @internal
|
|
550
|
+
*/
|
|
551
|
+
pageIdentifiers?: string[];
|
|
362
552
|
}
|
|
363
553
|
interface GetSiteStructureChunksRequest {
|
|
364
554
|
/** @maxLength 8192 */
|
|
@@ -438,4 +628,4 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
438
628
|
declare function getSiteStructure(): __PublicMethodMetaInfo<'POST', {}, SiteStructureRequest$1, SiteStructureRequest, SiteStructureResponse$1, SiteStructureResponse>;
|
|
439
629
|
declare function getSiteStructureMetadata(): __PublicMethodMetaInfo<'POST', {}, GetSiteStructureMetadataRequest$1, GetSiteStructureMetadataRequest, GetSiteStructureMetadataResponse$1, GetSiteStructureMetadataResponse>;
|
|
440
630
|
|
|
441
|
-
export { type ChunkMetadata as ChunkMetadataOriginal, type CursorPagingMetaData as CursorPagingMetaDataOriginal, type CursorPaging as CursorPagingOriginal, type Document as DocumentOriginal, type FocalPoint as FocalPointOriginal, type GetSiteStructureChunkRequest as GetSiteStructureChunkRequestOriginal, type GetSiteStructureChunkResponse as GetSiteStructureChunkResponseOriginal, type GetSiteStructureChunksRequest as GetSiteStructureChunksRequestOriginal, type GetSiteStructureChunksResponse as GetSiteStructureChunksResponseOriginal, type GetSiteStructureMetadataRequest as GetSiteStructureMetadataRequestOriginal, type GetSiteStructureMetadataResponse as GetSiteStructureMetadataResponseOriginal, type Image as ImageOriginal, type LanguageMetadata as LanguageMetadataOriginal, type MediaItemMediaOneOf as MediaItemMediaOneOfOriginal, type MediaItem as MediaItemOriginal, PageSegment as PageSegmentOriginal, type PageSegmentWithLiterals as PageSegmentWithLiteralsOriginal, type SitePageType as SitePageTypeOriginal, type SiteStructureFetchErrorItemTypeOneOf as SiteStructureFetchErrorItemTypeOneOfOriginal, type SiteStructureFetchError as SiteStructureFetchErrorOriginal, type SiteStructureItem as SiteStructureItemOriginal, type SiteStructureRequestFilter as SiteStructureRequestFilterOriginal, type SiteStructureRequest as SiteStructureRequestOriginal, type SiteStructureResponse as SiteStructureResponseOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type Video as VideoOriginal, type VideoResolution as VideoResolutionOriginal, type VideoV2 as VideoV2Original, type __PublicMethodMetaInfo, getSiteStructure, getSiteStructureMetadata };
|
|
631
|
+
export { type AddressLocation as AddressLocationOriginal, type ChunkMetadata as ChunkMetadataOriginal, type CursorPagingMetaData as CursorPagingMetaDataOriginal, type CursorPaging as CursorPagingOriginal, type Document as DocumentOriginal, type FocalPoint as FocalPointOriginal, type GetSiteStructureChunkRequest as GetSiteStructureChunkRequestOriginal, type GetSiteStructureChunkResponse as GetSiteStructureChunkResponseOriginal, type GetSiteStructureChunksRequest as GetSiteStructureChunksRequestOriginal, type GetSiteStructureChunksResponse as GetSiteStructureChunksResponseOriginal, type GetSiteStructureMetadataRequest as GetSiteStructureMetadataRequestOriginal, type GetSiteStructureMetadataResponse as GetSiteStructureMetadataResponseOriginal, type Image as ImageOriginal, type LanguageMetadata as LanguageMetadataOriginal, type MediaItemMediaOneOf as MediaItemMediaOneOfOriginal, type MediaItem as MediaItemOriginal, PageSegment as PageSegmentOriginal, type PageSegmentWithLiterals as PageSegmentWithLiteralsOriginal, type SitePageType as SitePageTypeOriginal, type SiteStructureFetchErrorItemTypeOneOf as SiteStructureFetchErrorItemTypeOneOfOriginal, type SiteStructureFetchError as SiteStructureFetchErrorOriginal, type SiteStructureItem as SiteStructureItemOriginal, type SiteStructureRequestFilter as SiteStructureRequestFilterOriginal, type SiteStructureRequest as SiteStructureRequestOriginal, type SiteStructureResponse as SiteStructureResponseOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type Video as VideoOriginal, type VideoResolution as VideoResolutionOriginal, type VideoV2 as VideoV2Original, type __PublicMethodMetaInfo, getSiteStructure, getSiteStructureMetadata };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/auto_sdk_viewer_site-structure-service",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.19",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/",
|
|
@@ -21,23 +21,16 @@
|
|
|
21
21
|
"import": "./build/es/meta.mjs",
|
|
22
22
|
"require": "./build/cjs/meta.js",
|
|
23
23
|
"types": "./build/es/meta.d.mts"
|
|
24
|
-
},
|
|
25
|
-
"./schemas": {
|
|
26
|
-
"import": "./build/es/schemas.mjs",
|
|
27
|
-
"require": "./build/cjs/schemas.js",
|
|
28
|
-
"types": "./build/es/schemas.d.mts"
|
|
29
24
|
}
|
|
30
25
|
},
|
|
31
26
|
"files": [
|
|
32
27
|
"build",
|
|
33
28
|
"meta",
|
|
34
|
-
"service-plugins"
|
|
35
|
-
"schemas"
|
|
29
|
+
"service-plugins"
|
|
36
30
|
],
|
|
37
31
|
"dependencies": {
|
|
38
|
-
"@wix/sdk-runtime": "^1.0.
|
|
39
|
-
"@wix/sdk-types": "^1.17.
|
|
40
|
-
"zod": "^4.3.6"
|
|
32
|
+
"@wix/sdk-runtime": "^1.0.24",
|
|
33
|
+
"@wix/sdk-types": "^1.17.11"
|
|
41
34
|
},
|
|
42
35
|
"devDependencies": {
|
|
43
36
|
"tsup": "^8.4.0",
|
|
@@ -57,5 +50,5 @@
|
|
|
57
50
|
"fqdn": "wix.viewer.structure.v1.site_structure_item"
|
|
58
51
|
}
|
|
59
52
|
},
|
|
60
|
-
"falconPackageHash": "
|
|
53
|
+
"falconPackageHash": "70ba1e7fb5f8815ed05ce70a6ce3c662ae4c31164efebf4513b6ef81"
|
|
61
54
|
}
|
package/build/cjs/schemas.d.ts
DELETED
|
@@ -1,102 +0,0 @@
|
|
|
1
|
-
import * as z from 'zod';
|
|
2
|
-
|
|
3
|
-
declare const GetSiteStructureRequest: z.ZodObject<{
|
|
4
|
-
options: z.ZodOptional<z.ZodObject<{
|
|
5
|
-
pageVersion: z.ZodOptional<z.ZodEnum<{
|
|
6
|
-
PUBLISHED: "PUBLISHED";
|
|
7
|
-
SAVED: "SAVED";
|
|
8
|
-
}>>;
|
|
9
|
-
paging: z.ZodOptional<z.ZodObject<{
|
|
10
|
-
limit: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
11
|
-
cursor: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
12
|
-
}, z.core.$strip>>;
|
|
13
|
-
filter: z.ZodOptional<z.ZodObject<{
|
|
14
|
-
itemTypeIdentifier: z.ZodOptional<z.ZodString>;
|
|
15
|
-
sourceId: z.ZodOptional<z.ZodString>;
|
|
16
|
-
configId: z.ZodOptional<z.ZodString>;
|
|
17
|
-
}, z.core.$strip>>;
|
|
18
|
-
sorting: z.ZodOptional<z.ZodObject<{
|
|
19
|
-
fieldName: z.ZodOptional<z.ZodString>;
|
|
20
|
-
order: z.ZodOptional<z.ZodEnum<{
|
|
21
|
-
ASC: "ASC";
|
|
22
|
-
DESC: "DESC";
|
|
23
|
-
}>>;
|
|
24
|
-
}, z.core.$strip>>;
|
|
25
|
-
fieldSet: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
26
|
-
languageMetadata: z.ZodOptional<z.ZodObject<{
|
|
27
|
-
code: z.ZodOptional<z.ZodString>;
|
|
28
|
-
tag: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
29
|
-
}, z.core.$strip>>;
|
|
30
|
-
branchId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
31
|
-
}, z.core.$strip>>;
|
|
32
|
-
}, z.core.$strip>;
|
|
33
|
-
declare const GetSiteStructureResponse: z.ZodObject<{
|
|
34
|
-
totalResults: z.ZodOptional<z.ZodNumber>;
|
|
35
|
-
pageData: z.ZodOptional<z.ZodObject<{
|
|
36
|
-
count: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
37
|
-
cursor: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
38
|
-
}, z.core.$strip>>;
|
|
39
|
-
results: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
40
|
-
itemId: z.ZodOptional<z.ZodString>;
|
|
41
|
-
itemTypeIdentifier: z.ZodOptional<z.ZodString>;
|
|
42
|
-
sourceId: z.ZodOptional<z.ZodString>;
|
|
43
|
-
configId: z.ZodOptional<z.ZodString>;
|
|
44
|
-
name: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
45
|
-
media: z.ZodOptional<z.ZodArray<z.ZodIntersection<z.ZodObject<{}, z.core.$strip>, z.ZodXor<readonly [z.ZodObject<{
|
|
46
|
-
image: z.ZodOptional<z.ZodNever>;
|
|
47
|
-
video: z.ZodOptional<z.ZodNever>;
|
|
48
|
-
document: z.ZodOptional<z.ZodNever>;
|
|
49
|
-
}, z.core.$strip>, z.ZodObject<{
|
|
50
|
-
video: z.ZodOptional<z.ZodNever>;
|
|
51
|
-
document: z.ZodOptional<z.ZodNever>;
|
|
52
|
-
image: z.ZodString;
|
|
53
|
-
}, z.core.$strip>, z.ZodObject<{
|
|
54
|
-
image: z.ZodOptional<z.ZodNever>;
|
|
55
|
-
document: z.ZodOptional<z.ZodNever>;
|
|
56
|
-
video: z.ZodString;
|
|
57
|
-
}, z.core.$strip>, z.ZodObject<{
|
|
58
|
-
image: z.ZodOptional<z.ZodNever>;
|
|
59
|
-
video: z.ZodOptional<z.ZodNever>;
|
|
60
|
-
document: z.ZodString;
|
|
61
|
-
}, z.core.$strip>]>>>>;
|
|
62
|
-
path: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
63
|
-
_updatedDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
|
|
64
|
-
inactive: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
65
|
-
metadata: z.ZodNullable<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
|
|
66
|
-
image: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
67
|
-
video: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
68
|
-
protected: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
69
|
-
translationId: z.ZodOptional<z.ZodString>;
|
|
70
|
-
isCustomErrorPage: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
71
|
-
}, z.core.$strip>>>;
|
|
72
|
-
errors: z.ZodOptional<z.ZodArray<z.ZodIntersection<z.ZodObject<{
|
|
73
|
-
errorMessage: z.ZodOptional<z.ZodString>;
|
|
74
|
-
appId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
75
|
-
}, z.core.$strip>, z.ZodXor<readonly [z.ZodObject<{
|
|
76
|
-
itemTypeId: z.ZodOptional<z.ZodNever>;
|
|
77
|
-
routerPrefix: z.ZodOptional<z.ZodNever>;
|
|
78
|
-
}, z.core.$strip>, z.ZodObject<{
|
|
79
|
-
routerPrefix: z.ZodOptional<z.ZodNever>;
|
|
80
|
-
itemTypeId: z.ZodString;
|
|
81
|
-
}, z.core.$strip>, z.ZodObject<{
|
|
82
|
-
itemTypeId: z.ZodOptional<z.ZodNever>;
|
|
83
|
-
routerPrefix: z.ZodString;
|
|
84
|
-
}, z.core.$strip>]>>>>;
|
|
85
|
-
}, z.core.$strip>;
|
|
86
|
-
declare const GetSiteStructureMetadataRequest: z.ZodObject<{
|
|
87
|
-
options: z.ZodOptional<z.ZodObject<{
|
|
88
|
-
pageVersion: z.ZodOptional<z.ZodEnum<{
|
|
89
|
-
PUBLISHED: "PUBLISHED";
|
|
90
|
-
SAVED: "SAVED";
|
|
91
|
-
}>>;
|
|
92
|
-
}, z.core.$strip>>;
|
|
93
|
-
}, z.core.$strip>;
|
|
94
|
-
declare const GetSiteStructureMetadataResponse: z.ZodObject<{
|
|
95
|
-
pageTypes: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
96
|
-
itemTypeIdentifier: z.ZodOptional<z.ZodString>;
|
|
97
|
-
sourceId: z.ZodOptional<z.ZodString>;
|
|
98
|
-
configId: z.ZodOptional<z.ZodString>;
|
|
99
|
-
}, z.core.$strip>>>;
|
|
100
|
-
}, z.core.$strip>;
|
|
101
|
-
|
|
102
|
-
export { GetSiteStructureMetadataRequest, GetSiteStructureMetadataResponse, GetSiteStructureRequest, GetSiteStructureResponse };
|