@wix/viewer 1.0.0 → 1.0.2

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

@@ -1,801 +0,0 @@
-type HostModule<T, H extends Host> = {
-    __type: 'host';
-    create(host: H): T;
-};
-type HostModuleAPI<T extends HostModule<any, any>> = T extends HostModule<infer U, any> ? U : never;
-type Host<Environment = unknown> = {
-    channel: {
-        observeState(callback: (props: unknown, environment: Environment) => unknown): {
-            disconnect: () => void;
-        } | Promise<{
-            disconnect: () => void;
-        }>;
-    };
-    environment?: Environment;
-    /**
-     * Optional name of the environment, use for logging
-     */
-    name?: string;
-    /**
-     * Optional bast url to use for API requests, for example `www.wixapis.com`
-     */
-    apiBaseUrl?: string;
-    /**
-     * Possible data to be provided by every host, for cross cutting concerns
-     * like internationalization, billing, etc.
-     */
-    essentials?: {
-        /**
-         * The language of the currently viewed session
-         */
-        language?: string;
-        /**
-         * The locale of the currently viewed session
-         */
-        locale?: string;
-        /**
-         * Any headers that should be passed through to the API requests
-         */
-        passThroughHeaders?: Record<string, 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>>;
-    fetchWithAuth: typeof fetch;
-    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
-    getActiveToken?: () => string | undefined;
-}
-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?: (envelope: unknown) => Payload;
-    __payload: Payload;
-};
-declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => 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;
-
-type ServicePluginMethodInput = {
-    request: any;
-    metadata: any;
-};
-type ServicePluginContract = Record<string, (payload: ServicePluginMethodInput) => unknown | Promise<unknown>>;
-type ServicePluginMethodMetadata = {
-    name: string;
-    primaryHttpMappingPath: string;
-    transformations: {
-        fromREST: (...args: unknown[]) => ServicePluginMethodInput;
-        toREST: (...args: unknown[]) => unknown;
-    };
-};
-type ServicePluginDefinition<Contract extends ServicePluginContract> = {
-    __type: 'service-plugin-definition';
-    componentType: string;
-    methods: ServicePluginMethodMetadata[];
-    __contract: Contract;
-};
-declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
-type BuildServicePluginDefinition<T extends ServicePluginDefinition<any>> = (implementation: T['__contract']) => void;
-declare const SERVICE_PLUGIN_ERROR_TYPE = "wix_spi_error";
-
-type RequestContext = {
-    isSSR: boolean;
-    host: string;
-    protocol?: string;
-};
-type ResponseTransformer = (data: any, headers?: any) => any;
-/**
- * Ambassador request options types are copied mostly from AxiosRequestConfig.
- * They are copied and not imported to reduce the amount of dependencies (to reduce install time).
- * https://github.com/axios/axios/blob/3f53eb6960f05a1f88409c4b731a40de595cb825/index.d.ts#L307-L315
- */
-type Method = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'purge' | 'PURGE' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
-type AmbassadorRequestOptions<T = any> = {
-    _?: T;
-    url?: string;
-    method?: Method;
-    params?: any;
-    data?: any;
-    transformResponse?: ResponseTransformer | ResponseTransformer[];
-};
-type AmbassadorFactory<Request, Response> = (payload: Request) => ((context: RequestContext) => AmbassadorRequestOptions<Response>) & {
-    __isAmbassador: boolean;
-};
-type AmbassadorFunctionDescriptor<Request = any, Response = any> = AmbassadorFactory<Request, Response>;
-type BuildAmbassadorFunction<T extends AmbassadorFunctionDescriptor> = T extends AmbassadorFunctionDescriptor<infer Request, infer Response> ? (req: Request) => Promise<Response> : never;
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
-}
-
-declare const emptyObjectSymbol: unique symbol;
-
-/**
-Represents a strictly empty plain object, the `{}` value.
-
-When you annotate something as the type `{}`, it can be anything except `null` and `undefined`. This means that you cannot use `{}` to represent an empty plain object ([read more](https://stackoverflow.com/questions/47339869/typescript-empty-object-and-any-difference/52193484#52193484)).
-
-@example
-```
-import type {EmptyObject} from 'type-fest';
-
-// The following illustrates the problem with `{}`.
-const foo1: {} = {}; // Pass
-const foo2: {} = []; // Pass
-const foo3: {} = 42; // Pass
-const foo4: {} = {a: 1}; // Pass
-
-// With `EmptyObject` only the first case is valid.
-const bar1: EmptyObject = {}; // Pass
-const bar2: EmptyObject = 42; // Fail
-const bar3: EmptyObject = []; // Fail
-const bar4: EmptyObject = {a: 1}; // Fail
-```
-
-Unfortunately, `Record<string, never>`, `Record<keyof any, never>` and `Record<never, never>` do not work. See {@link https://github.com/sindresorhus/type-fest/issues/395 #395}.
-
-@category Object
-*/
-type EmptyObject = {[emptyObjectSymbol]?: never};
-
-/**
-Returns a boolean for whether the two given types are equal.
-
-@link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
-@link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
-
-Use-cases:
-- If you want to make a conditional branch based on the result of a comparison of two types.
-
-@example
-```
-import type {IsEqual} from 'type-fest';
-
-// This type returns a boolean for whether the given array includes the given item.
-// `IsEqual` is used to compare the given array at position 0 and the given item and then return true if they are equal.
-type Includes<Value extends readonly any[], Item> =
-	Value extends readonly [Value[0], ...infer rest]
-		? IsEqual<Value[0], Item> extends true
-			? true
-			: Includes<rest, Item>
-		: false;
-```
-
-@category Type Guard
-@category Utilities
-*/
-type IsEqual<A, B> =
-	(<G>() => G extends A ? 1 : 2) extends
-	(<G>() => G extends B ? 1 : 2)
-		? true
-		: false;
-
-/**
-Filter out keys from an object.
-
-Returns `never` if `Exclude` is strictly equal to `Key`.
-Returns `never` if `Key` extends `Exclude`.
-Returns `Key` otherwise.
-
-@example
-```
-type Filtered = Filter<'foo', 'foo'>;
-//=> never
-```
-
-@example
-```
-type Filtered = Filter<'bar', string>;
-//=> never
-```
-
-@example
-```
-type Filtered = Filter<'bar', 'foo'>;
-//=> 'bar'
-```
-
-@see {Except}
-*/
-type Filter<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true ? never : (KeyType extends ExcludeType ? never : KeyType);
-
-type ExceptOptions = {
-	/**
-	Disallow assigning non-specified properties.
-
-	Note that any omitted properties in the resulting type will be present in autocomplete as `undefined`.
-
-	@default false
-	*/
-	requireExactProps?: boolean;
-};
-
-/**
-Create a type from an object type without certain keys.
-
-We recommend setting the `requireExactProps` option to `true`.
-
-This type is a stricter version of [`Omit`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-5.html#the-omit-helper-type). The `Omit` type does not restrict the omitted keys to be keys present on the given type, while `Except` does. The benefits of a stricter type are avoiding typos and allowing the compiler to pick up on rename refactors automatically.
-
-This type was proposed to the TypeScript team, which declined it, saying they prefer that libraries implement stricter versions of the built-in types ([microsoft/TypeScript#30825](https://github.com/microsoft/TypeScript/issues/30825#issuecomment-523668235)).
-
-@example
-```
-import type {Except} from 'type-fest';
-
-type Foo = {
-	a: number;
-	b: string;
-};
-
-type FooWithoutA = Except<Foo, 'a'>;
-//=> {b: string}
-
-const fooWithoutA: FooWithoutA = {a: 1, b: '2'};
-//=> errors: 'a' does not exist in type '{ b: string; }'
-
-type FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;
-//=> {a: number} & Partial<Record<"b", never>>
-
-const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
-//=> errors at 'b': Type 'string' is not assignable to type 'undefined'.
-```
-
-@category Object
-*/
-type Except<ObjectType, KeysType extends keyof ObjectType, Options extends ExceptOptions = {requireExactProps: false}> = {
-	[KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType];
-} & (Options['requireExactProps'] extends true
-	? Partial<Record<KeysType, never>>
-	: {});
-
-/**
-Returns a boolean for whether the given type is `never`.
-
-@link https://github.com/microsoft/TypeScript/issues/31751#issuecomment-498526919
-@link https://stackoverflow.com/a/53984913/10292952
-@link https://www.zhenghao.io/posts/ts-never
-
-Useful in type utilities, such as checking if something does not occur.
-
-@example
-```
-import type {IsNever, And} from 'type-fest';
-
-// https://github.com/andnp/SimplyTyped/blob/master/src/types/strings.ts
-type AreStringsEqual<A extends string, B extends string> =
-	And<
-		IsNever<Exclude<A, B>> extends true ? true : false,
-		IsNever<Exclude<B, A>> extends true ? true : false
-	>;
-
-type EndIfEqual<I extends string, O extends string> =
-	AreStringsEqual<I, O> extends true
-		? never
-		: void;
-
-function endIfEqual<I extends string, O extends string>(input: I, output: O): EndIfEqual<I, O> {
-	if (input === output) {
-		process.exit(0);
-	}
-}
-
-endIfEqual('abc', 'abc');
-//=> never
-
-endIfEqual('abc', '123');
-//=> void
-```
-
-@category Type Guard
-@category Utilities
-*/
-type IsNever<T> = [T] extends [never] ? true : false;
-
-/**
-An if-else-like type that resolves depending on whether the given type is `never`.
-
-@see {@link IsNever}
-
-@example
-```
-import type {IfNever} from 'type-fest';
-
-type ShouldBeTrue = IfNever<never>;
-//=> true
-
-type ShouldBeBar = IfNever<'not never', 'foo', 'bar'>;
-//=> 'bar'
-```
-
-@category Type Guard
-@category Utilities
-*/
-type IfNever<T, TypeIfNever = true, TypeIfNotNever = false> = (
-	IsNever<T> extends true ? TypeIfNever : TypeIfNotNever
-);
-
-/**
-Extract the keys from a type where the value type of the key extends the given `Condition`.
-
-Internally this is used for the `ConditionalPick` and `ConditionalExcept` types.
-
-@example
-```
-import type {ConditionalKeys} from 'type-fest';
-
-interface Example {
-	a: string;
-	b: string | number;
-	c?: string;
-	d: {};
-}
-
-type StringKeysOnly = ConditionalKeys<Example, string>;
-//=> 'a'
-```
-
-To support partial types, make sure your `Condition` is a union of undefined (for example, `string | undefined`) as demonstrated below.
-
-@example
-```
-import type {ConditionalKeys} from 'type-fest';
-
-type StringKeysAndUndefined = ConditionalKeys<Example, string | undefined>;
-//=> 'a' | 'c'
-```
-
-@category Object
-*/
-type ConditionalKeys<Base, Condition> =
-{
-	// Map through all the keys of the given base type.
-	[Key in keyof Base]-?:
-	// Pick only keys with types extending the given `Condition` type.
-	Base[Key] extends Condition
-	// Retain this key
-	// If the value for the key extends never, only include it if `Condition` also extends never
-		? IfNever<Base[Key], IfNever<Condition, Key, never>, Key>
-	// Discard this key since the condition fails.
-		: never;
-	// Convert the produced object into a union type of the keys which passed the conditional test.
-}[keyof Base];
-
-/**
-Exclude keys from a shape that matches the given `Condition`.
-
-This is useful when you want to create a new type with a specific set of keys from a shape. For example, you might want to exclude all the primitive properties from a class and form a new shape containing everything but the primitive properties.
-
-@example
-```
-import type {Primitive, ConditionalExcept} from 'type-fest';
-
-class Awesome {
-	name: string;
-	successes: number;
-	failures: bigint;
-
-	run() {}
-}
-
-type ExceptPrimitivesFromAwesome = ConditionalExcept<Awesome, Primitive>;
-//=> {run: () => void}
-```
-
-@example
-```
-import type {ConditionalExcept} from 'type-fest';
-
-interface Example {
-	a: string;
-	b: string | number;
-	c: () => void;
-	d: {};
-}
-
-type NonStringKeysOnly = ConditionalExcept<Example, string>;
-//=> {b: string | number; c: () => void; d: {}}
-```
-
-@category Object
-*/
-type ConditionalExcept<Base, Condition> = Except<
-Base,
-ConditionalKeys<Base, Condition>
->;
-
-/**
- * Descriptors are objects that describe the API of a module, and the module
- * can either be a REST module or a host module.
- * This type is recursive, so it can describe nested modules.
- */
-type Descriptors = RESTFunctionDescriptor | AmbassadorFunctionDescriptor | HostModule<any, any> | EventDefinition<any> | ServicePluginDefinition<any> | {
-    [key: string]: Descriptors | PublicMetadata | any;
-};
-/**
- * This type takes in a descriptors object of a certain Host (including an `unknown` host)
- * and returns an object with the same structure, but with all descriptors replaced with their API.
- * Any non-descriptor properties are removed from the returned object, including descriptors that
- * do not match the given host (as they will not work with the given host).
- */
-type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined, Depth extends number = 5> = {
-    done: T;
-    recurse: T extends {
-        __type: typeof SERVICE_PLUGIN_ERROR_TYPE;
-    } ? never : T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : T extends EventDefinition<any> ? BuildEventDefinition<T> : T extends ServicePluginDefinition<any> ? BuildServicePluginDefinition<T> : T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
-        [Key in keyof T]: T[Key] extends Descriptors ? BuildDescriptors<T[Key], H, [
-            -1,
-            0,
-            1,
-            2,
-            3,
-            4,
-            5
-        ][Depth]> : never;
-    }, EmptyObject>;
-}[Depth extends -1 ? 'done' : 'recurse'];
-type PublicMetadata = {
-    PACKAGE_NAME?: string;
-};
-
-declare global {
-    interface ContextualClient {
-    }
-}
-/**
- * A type used to create concerete types from SDK descriptors in
- * case a contextual client is available.
- */
-type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
-    host: Host;
-} ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
-
-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 FocalPoint {
-    /** X-coordinate of the focal point. */
-    x?: number;
-    /** Y-coordinate of the focal point. */
-    y?: number;
-    /** crop by height */
-    height?: number | null;
-    /** crop by width */
-    width?: number | 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 {
-    /** 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[];
-}
-interface GetSiteStructureOptions {
-    /** 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;
-}
-interface GetSiteStructureMetadataOptions {
-    /** Page's version */
-    pageVersion?: PageSegment;
-}
-
-declare function getSiteStructure$1(httpClient: HttpClient): GetSiteStructureSignature;
-interface GetSiteStructureSignature {
-    /**
-     * Get Site's structure
-     */
-    (options?: GetSiteStructureOptions | undefined): Promise<SiteStructureResponse & SiteStructureResponseNonNullableFields>;
-}
-declare function getSiteStructureMetadata$1(httpClient: HttpClient): GetSiteStructureMetadataSignature;
-interface GetSiteStructureMetadataSignature {
-    /**
-     * Get Site's structure meta-data
-     */
-    (options?: GetSiteStructureMetadataOptions | undefined): Promise<GetSiteStructureMetadataResponse & GetSiteStructureMetadataResponseNonNullableFields>;
-}
-
-declare const getSiteStructure: MaybeContext<BuildRESTFunction<typeof getSiteStructure$1> & typeof getSiteStructure$1>;
-declare const getSiteStructureMetadata: MaybeContext<BuildRESTFunction<typeof getSiteStructureMetadata$1> & typeof getSiteStructureMetadata$1>;
-
-type context_CursorPaging = CursorPaging;
-type context_CursorPagingMetaData = CursorPagingMetaData;
-type context_FocalPoint = FocalPoint;
-type context_GetSiteStructureMetadataOptions = GetSiteStructureMetadataOptions;
-type context_GetSiteStructureMetadataRequest = GetSiteStructureMetadataRequest;
-type context_GetSiteStructureMetadataResponse = GetSiteStructureMetadataResponse;
-type context_GetSiteStructureMetadataResponseNonNullableFields = GetSiteStructureMetadataResponseNonNullableFields;
-type context_GetSiteStructureOptions = GetSiteStructureOptions;
-type context_LanguageMetadata = LanguageMetadata;
-type context_MediaItem = MediaItem;
-type context_MediaItemMediaOneOf = MediaItemMediaOneOf;
-type context_PageSegment = PageSegment;
-declare const context_PageSegment: typeof PageSegment;
-type context_SitePageType = SitePageType;
-type context_SiteStructureItem = SiteStructureItem;
-type context_SiteStructureRequest = SiteStructureRequest;
-type context_SiteStructureRequestFilter = SiteStructureRequestFilter;
-type context_SiteStructureResponse = SiteStructureResponse;
-type context_SiteStructureResponseNonNullableFields = SiteStructureResponseNonNullableFields;
-type context_SortOrder = SortOrder;
-declare const context_SortOrder: typeof SortOrder;
-type context_Sorting = Sorting;
-type context_VideoResolution = VideoResolution;
-declare const context_getSiteStructure: typeof getSiteStructure;
-declare const context_getSiteStructureMetadata: typeof getSiteStructureMetadata;
-declare namespace context {
-  export { type context_CursorPaging as CursorPaging, type context_CursorPagingMetaData as CursorPagingMetaData, type context_FocalPoint as FocalPoint, type context_GetSiteStructureMetadataOptions as GetSiteStructureMetadataOptions, type context_GetSiteStructureMetadataRequest as GetSiteStructureMetadataRequest, type context_GetSiteStructureMetadataResponse as GetSiteStructureMetadataResponse, type context_GetSiteStructureMetadataResponseNonNullableFields as GetSiteStructureMetadataResponseNonNullableFields, type context_GetSiteStructureOptions as GetSiteStructureOptions, type context_LanguageMetadata as LanguageMetadata, type context_MediaItem as MediaItem, type context_MediaItemMediaOneOf as MediaItemMediaOneOf, context_PageSegment as PageSegment, type context_SitePageType as SitePageType, type context_SiteStructureItem as SiteStructureItem, type context_SiteStructureRequest as SiteStructureRequest, type context_SiteStructureRequestFilter as SiteStructureRequestFilter, type context_SiteStructureResponse as SiteStructureResponse, type context_SiteStructureResponseNonNullableFields as SiteStructureResponseNonNullableFields, context_SortOrder as SortOrder, type context_Sorting as Sorting, type context_VideoResolution as VideoResolution, context_getSiteStructure as getSiteStructure, context_getSiteStructureMetadata as getSiteStructureMetadata };
-}
-
-export { context as siteStructureService };