@wix/editor 1.686.0 → 1.688.0

package/dist/types/index.d.ts

@@ -5,7 +5,7 @@ import * as _wix_sdk_types from '@wix/sdk-types';
 import { Host } from '@wix/sdk-types';
 import * as _wix_sdk_runtime_host_modules from '@wix/sdk-runtime/host-modules';
 import * as _wix_editor_platform_transport from '@wix/editor-platform-transport';
-import { IElement, SiteLocale, ComponentRef, IElementSDK, ElementStyleDefinitions, ElementStyles, ElementStylesUpdate, ElementStylesRemoval, ElementDataDefinitions, ElementData, ElementDataInput, ElementPresetDefinitions, ElementStateDefinitions, SelectFontParams, SelectFontFamilyParams, SelectMediaParams, SelectLinkParams, ElementLink, SelectSortParams, ElementSort, SelectFilterParams, ElementFilter, SelectColorParams, BackgroundPickerOptions, SelectFontWeightParams, IFontWeight, SelectTextThemeParams, DsItem, BuilderStyle, StyleRef, OpenLinkPanelFn, OpenColorPickerFn, ListProvidersOptions, Provider, BindingProperties, BindingDetailsMap, UnbindAll, ListBindingsOptions, BindingTargetDetails, findBindingCandidatesOptions, BindingCandidate, SelectBindingOptions, GetContextActionsOptions, ContextActionCommand, IRouter, IPage, AddTemplateOptions, AddExtensionOptions } from '@wix/public-editor-platform-interfaces';
+import { IElement, SiteLocale, ComponentRef, IElementSDK, ElementStyleDefinitions, ElementStyles, ElementStylesUpdate, ElementStylesRemoval, ElementDataDefinitions, ElementData, ElementDataInput, ElementPresetDefinitions, ElementStateDefinitions, SelectFontParams, SelectFontFamilyParams, SelectMediaParams, SelectLinkParams, ElementLink, SelectSortParams, ElementSort, SelectFilterParams, ElementFilter, SelectColorParams, BackgroundPickerOptions, SelectFontWeightParams, IFontWeight, SelectTextThemeParams, DsItem, BuilderStyle, StyleRef, OpenLinkPanelFn, OpenColorPickerFn, ListProvidersOptions, Provider, BindingProperties, BindingDetailsMap, UnbindAll, ListBindingsOptions, BindingTargetDetails, findBindingCandidatesOptions, BindingCandidate, SelectBindingOptions, GetContextActionsOptions, ContextActionCommand, IRouter, IReadOnlyPage, AddTemplateOptions, IPage, AddExtensionOptions } from '@wix/public-editor-platform-interfaces';
 export { ContextActionCommand, ContextActionName, DataType, ElementA11y, ElementAddressLink, ElementAnchorLink, ElementAudio, ElementData, ElementDataDefinition, ElementDataDefinitions, ElementDataInput, ElementDataObject, ElementDataValue, ElementDirection, ElementDocumentLink, ElementDynamicPageLink, ElementEmailLink, ElementExternalLink, ElementFilter, ElementImage, ElementLink, ElementLoginToWixLink, ElementMenuItems, ElementPageLink, ElementPhoneLink, ElementPresetDefinition, ElementPresetDefinitions, ElementRichText, ElementSort, ElementStateDefinition, ElementStateDefinitions, ElementStyleDefinition, ElementStyleDefinitions, ElementStyles, ElementStylesRemoval, ElementStylesUpdate, ElementTextLink, ElementTpaPageLink, ElementVectorArt, ElementVideo, ElementWhatsAppLink, GetContextActionsOptions, NativeStateType, SiteLocale } from '@wix/public-editor-platform-interfaces';
 
 declare class Workspace implements NonNullable<WorkspaceHost$1['workspace']> {
@@ -41,18 +41,18 @@ declare class ApplicationSDKShape extends BaseSDKShape {
     getPublicAPI<T>(appDefinitionId: string): Promise<T>;
     getAppInstance(): Promise<any>;
 }
-declare const _default$g: ApplicationSDKShape & _wix_sdk_runtime_host_modules.HostModule<ApplicationSDKShape, _wix_sdk_types.Host>;
+declare const _default$h: ApplicationSDKShape & _wix_sdk_runtime_host_modules.HostModule<ApplicationSDKShape, _wix_sdk_types.Host>;
 
 declare class ElementsSDKShape extends BaseSDKShape {
     getSelection(): Promise<IElement[]>;
     onSelectionChange(cb: (elements: IElement[]) => void): Promise<void>;
 }
-declare const _default$f: ElementsSDKShape & _wix_sdk_runtime_host_modules.HostModule<ElementsSDKShape, _wix_sdk_types.Host>;
+declare const _default$g: ElementsSDKShape & _wix_sdk_runtime_host_modules.HostModule<ElementsSDKShape, _wix_sdk_types.Host>;
 
 declare class EventsSDKShape extends BaseSDKShape {
     addEventListener(name: any, cb: (payload: AppEventPayload<AllowedEvents>) => void): Promise<() => void>;
 }
-declare const _default$e: EventsSDKShape & _wix_sdk_runtime_host_modules.HostModule<EventsSDKShape, _wix_sdk_types.Host>;
+declare const _default$f: EventsSDKShape & _wix_sdk_runtime_host_modules.HostModule<EventsSDKShape, _wix_sdk_types.Host>;
 
 type ThemeCustomProperty = {
     type: string;
@@ -86,7 +86,7 @@ declare class InfoSDKShape extends BaseSDKShape {
     getFontFamilyDisplayName(fontFamily: string): Promise<string | undefined>;
     getMetaSiteId(): Promise<string>;
 }
-declare const _default$d: InfoSDKShape & _wix_sdk_runtime_host_modules.HostModule<InfoSDKShape, _wix_sdk_types.Host>;
+declare const _default$e: InfoSDKShape & _wix_sdk_runtime_host_modules.HostModule<InfoSDKShape, _wix_sdk_types.Host>;
 
 declare class WidgetScopedSDK {
     private compRef;
@@ -107,7 +107,7 @@ declare class WidgetSDKShape extends BaseSDKShape {
     setDesignPreset(designPresetName: string): Promise<void>;
     getNestedWidget(selector: `#${string}`): Promise<WidgetScopedSDK | null>;
 }
-declare const _default$c: WidgetSDKShape & _wix_sdk_runtime_host_modules.HostModule<WidgetSDKShape, _wix_sdk_types.Host>;
+declare const _default$d: WidgetSDKShape & _wix_sdk_runtime_host_modules.HostModule<WidgetSDKShape, _wix_sdk_types.Host>;
 
 interface FontPickerValue {
     font: string;
@@ -123,13 +123,13 @@ declare class InputsSDKShape extends BaseSDKShape {
         onChange?: (value: FontPickerValue) => void;
     }): Promise<FontPickerValue | undefined>;
 }
-declare const _default$b: InputsSDKShape & _wix_sdk_runtime_host_modules.HostModule<InputsSDKShape, _wix_sdk_types.Host>;
+declare const _default$c: InputsSDKShape & _wix_sdk_runtime_host_modules.HostModule<InputsSDKShape, _wix_sdk_types.Host>;
 
 declare class PanelsSDKShape extends BaseSDKShape {
     openLanguageSupportPanel(): Promise<any>;
     openFontsUploadPanel(): Promise<any>;
 }
-declare const _default$a: PanelsSDKShape & _wix_sdk_runtime_host_modules.HostModule<PanelsSDKShape, _wix_sdk_types.Host>;
+declare const _default$b: PanelsSDKShape & _wix_sdk_runtime_host_modules.HostModule<PanelsSDKShape, _wix_sdk_types.Host>;
 
 declare class ModalsSDKShape extends BaseSDKShape {
     openDashboardModal(options: {
@@ -137,7 +137,7 @@ declare class ModalsSDKShape extends BaseSDKShape {
         closeOtherPanels?: boolean;
     }): Promise<any>;
 }
-declare const _default$9: ModalsSDKShape & _wix_sdk_runtime_host_modules.HostModule<ModalsSDKShape, _wix_sdk_types.Host>;
+declare const _default$a: ModalsSDKShape & _wix_sdk_runtime_host_modules.HostModule<ModalsSDKShape, _wix_sdk_types.Host>;
 
 /**
  * Methods for interacting with a component from a custom panel.
@@ -684,13 +684,13 @@ declare class ElementSDKShape extends BaseSDKShape implements IElementSDK {
     getBiToken(): Promise<string>;
 }
 
-declare const _default$8: ElementSDKShape & _wix_sdk_runtime_host_modules.HostModule<ElementSDKShape, _wix_sdk_types.Host>;
+declare const _default$9: ElementSDKShape & _wix_sdk_runtime_host_modules.HostModule<ElementSDKShape, _wix_sdk_types.Host>;
 
 declare class PreferencesSDKShape extends BaseSDKShape {
     get(keys: string[]): Promise<any>;
     set(preferences: Record<string, any>): Promise<any>;
 }
-declare const _default$7: PreferencesSDKShape & _wix_sdk_runtime_host_modules.HostModule<PreferencesSDKShape, _wix_sdk_types.Host>;
+declare const _default$8: PreferencesSDKShape & _wix_sdk_runtime_host_modules.HostModule<PreferencesSDKShape, _wix_sdk_types.Host>;
 
 declare class ExternalPanelsSDKShape extends BaseSDKShape {
     getData(): Promise<any>;
@@ -703,7 +703,7 @@ declare class ExternalPanelsSDKShape extends BaseSDKShape {
     selectColor(...options: any): Promise<OpenColorPickerFn>;
     translate(key: string | string[], values?: Record<string, any>): Promise<any>;
 }
-declare const _default$6: ExternalPanelsSDKShape & _wix_sdk_runtime_host_modules.HostModule<ExternalPanelsSDKShape, _wix_sdk_types.Host>;
+declare const _default$7: ExternalPanelsSDKShape & _wix_sdk_runtime_host_modules.HostModule<ExternalPanelsSDKShape, _wix_sdk_types.Host>;
 
 interface AppController {
     type: string;
@@ -714,7 +714,7 @@ declare class ControllersSDKShape extends BaseSDKShape {
     #private;
     get(): Promise<AppController[]>;
 }
-declare const _default$5: ControllersSDKShape & _wix_sdk_runtime_host_modules.HostModule<ControllersSDKShape, _wix_sdk_types.Host>;
+declare const _default$6: ControllersSDKShape & _wix_sdk_runtime_host_modules.HostModule<ControllersSDKShape, _wix_sdk_types.Host>;
 
 /**
  * Binding target for public SDK
@@ -737,12 +737,12 @@ interface IBindingConnectionItem<T = unknown> {
 declare class CmsBindingsSDKShape extends BaseSDKShape {
     get(target: BindingTarget): Promise<IBindingConnectionItem | null>;
 }
-declare const _default$4: CmsBindingsSDKShape & _wix_sdk_runtime_host_modules.HostModule<CmsBindingsSDKShape, _wix_sdk_types.Host>;
+declare const _default$5: CmsBindingsSDKShape & _wix_sdk_runtime_host_modules.HostModule<CmsBindingsSDKShape, _wix_sdk_types.Host>;
 
 declare class BindingsProvidersSDKShape extends BaseSDKShape {
     list(bindingTarget: BindingTarget): Promise<any>;
 }
-declare const _default$3: BindingsProvidersSDKShape & _wix_sdk_runtime_host_modules.HostModule<BindingsProvidersSDKShape, _wix_sdk_types.Host>;
+declare const _default$4: BindingsProvidersSDKShape & _wix_sdk_runtime_host_modules.HostModule<BindingsProvidersSDKShape, _wix_sdk_types.Host>;
 
 declare class ProvidersPublicSDKShape extends BaseSDKShape {
     protected overriddenApplicationContext: Promise<ApplicationContext> | null;
@@ -787,7 +787,7 @@ declare class ContextActionsSDKShape extends BaseSDKShape {
      */
     getContextActions(options: GetContextActionsOptions): Promise<ContextActionCommand[]>;
 }
-declare const _default$2: ContextActionsSDKShape & _wix_sdk_runtime_host_modules.HostModule<ContextActionsSDKShape, _wix_sdk_types.Host>;
+declare const _default$3: ContextActionsSDKShape & _wix_sdk_runtime_host_modules.HostModule<ContextActionsSDKShape, _wix_sdk_types.Host>;
 
 type MethodNames<T> = Extract<{
     [K in keyof T]: T[K] extends (...args: any[]) => any ? K : never;
@@ -807,16 +807,49 @@ declare class RoutersSDKShape extends BaseSDKShape {
     list(): Promise<IRouter[]>;
     add(extensionId: string): Promise<IRouter>;
 }
-declare const _default$1: RoutersSDKShape & _wix_sdk_runtime_host_modules.HostModule<RoutersSDKShape, _wix_sdk_types.Host>;
+declare const _default$2: RoutersSDKShape & _wix_sdk_runtime_host_modules.HostModule<RoutersSDKShape, _wix_sdk_types.Host>;
 
 declare class PagesSDKShape extends BaseSDKShape {
     protected overriddenApplicationContext: Promise<ApplicationContext> | null;
     constructor(overriddenApplicationContext?: Promise<ApplicationContext> | null);
-    list(): Promise<IPage[]>;
+    list(): Promise<IReadOnlyPage[]>;
     addTemplate(templateId: string, options: AddTemplateOptions): Promise<IPage>;
     addExtension(extensionId: string, options?: AddExtensionOptions): Promise<IPage>;
 }
-declare const _default: PagesSDKShape & _wix_sdk_runtime_host_modules.HostModule<PagesSDKShape, _wix_sdk_types.Host>;
+declare const _default$1: PagesSDKShape & _wix_sdk_runtime_host_modules.HostModule<PagesSDKShape, _wix_sdk_types.Host>;
+
+/**
+ * Read-only SDK surface for the page the host initialized the client for. The
+ * page is bound through the host context, so it is already "the page in scope" —
+ * there is no page id to pass and no mutation surface.
+ *
+ * @example
+ * ```ts
+ * import { page } from '@wix/editor';
+ *
+ * const title = await page.getTitle();
+ * const router = await page.getRouter();
+ * const role = await page.getPageRole();
+ * ```
+ */
+declare class PageSDKShape extends BaseSDKShape {
+    #private;
+    protected overriddenApplicationContext: Promise<ApplicationContext> | null;
+    constructor(overriddenApplicationContext?: Promise<ApplicationContext> | null);
+    getTitle(): Promise<string>;
+    getExtensionId(): Promise<string | undefined>;
+    /**
+     * The page's role within its router, or `undefined` when the page is not
+     * connected to a router owned by the calling app.
+     */
+    getPageRole(): Promise<string | undefined>;
+    /**
+     * Read-only access to the page's router, or `undefined` when the page is not
+     * connected to a router owned by the calling app.
+     */
+    getRouter(): Promise<IRouter | undefined>;
+}
+declare const _default: PageSDKShape & _wix_sdk_runtime_host_modules.HostModule<PageSDKShape, _wix_sdk_types.Host>;
 
 declare const editor: {
     host: () => _wix_sdk_types.Host & {
@@ -832,4 +865,4 @@ declare const editor: {
     };
 };
 
-export { BaseSDKShape, ContextActionsSDKShape, ElementSDKShape, PagesSDKShape, PlatformSDKShape, ElementSDKShape as ReactElementsSDKShape, RoutersSDKShape, Workspace, WorkspaceHost, _default$g as application, bindingsPublicSDKShape as bindings, _default$3 as bindingsProviders, _default$4 as cmsBindings, _default$2 as contextActions, _default$5 as controllers, editor, _default$8 as element, _default$f as elements, _default$e as events, _default$6 as externalPanels, _default$d as info, _default$b as inputs, _default$9 as modals, _default as pages, _default$a as panels, _default$7 as preferences, providersPublicSDKShape as providers, _default$8 as reactElements, _default$1 as routers, _default$c as widget };
+export { BaseSDKShape, ContextActionsSDKShape, ElementSDKShape, PageSDKShape, PagesSDKShape, PlatformSDKShape, ElementSDKShape as ReactElementsSDKShape, RoutersSDKShape, Workspace, WorkspaceHost, _default$h as application, bindingsPublicSDKShape as bindings, _default$4 as bindingsProviders, _default$5 as cmsBindings, _default$3 as contextActions, _default$6 as controllers, editor, _default$9 as element, _default$g as elements, _default$f as events, _default$7 as externalPanels, _default$e as info, _default$c as inputs, _default$a as modals, _default as page, _default$1 as pages, _default$b as panels, _default$8 as preferences, providersPublicSDKShape as providers, _default$9 as reactElements, _default$2 as routers, _default$d as widget };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/editor",
-  "version": "1.686.0",
+  "version": "1.688.0",
   "license": "UNLICENSED",
   "author": {
     "name": "Editor Platform <editor-platform-dev@wix.com>",
@@ -31,11 +31,11 @@
     "*.{js,ts}": "yarn lint"
   },
   "dependencies": {
-    "@wix/editor-platform-contexts": "1.144.0",
-    "@wix/editor-platform-environment-api": "1.145.0",
+    "@wix/editor-platform-contexts": "1.145.0",
+    "@wix/editor-platform-environment-api": "1.146.0",
     "@wix/monitoring-browser-sdk-host": "^0.1.25",
     "@wix/public-editor-platform-errors": "1.9.0",
-    "@wix/public-editor-platform-interfaces": "1.87.0",
+    "@wix/public-editor-platform-interfaces": "1.88.0",
     "@wix/sdk-runtime": "^0.7.0",
     "@wix/sdk-types": "^1.17.9",
     "@wix/workspace": "^1.3.13"
@@ -69,5 +69,5 @@
       ]
     }
   },
-  "falconPackageHash": "e0087df1f4fc65221d4a93141b8ab31308a937e167032ad8c7f7f0aa"
+  "falconPackageHash": "17f4fe152bf947a9750887cfc6891990178fea8cf341e2ea69f771c9"
 }