@wix/public-editor-platform-interfaces 1.87.0 → 1.88.0

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.
@@ -1,14 +1,29 @@
1
- export interface IPage {
1
+ import type { IRouter } from './routers';
2
+ /**
3
+ * Read-only projection of a page: every read method of {@link IPage}, without the
4
+ * mutators. Returned by `pages.list()` and the base shape of `pages.getCurrent()`
5
+ * for pages that are not connected to a router owned by the calling app.
6
+ */
7
+ export interface IReadOnlyPage {
2
8
  getExtensionId(): Promise<string | undefined>;
3
9
  getTitle(): Promise<string>;
4
- updateTitle(title: string): Promise<void>;
5
10
  getSlug(): Promise<string>;
6
- updateSlug(slug: string): Promise<void>;
7
11
  getPageId(): Promise<string | undefined>;
8
- equals(other: IPage): boolean;
12
+ equals(other: IReadOnlyPage): boolean;
13
+ }
14
+ export interface IPage extends IReadOnlyPage {
15
+ updateTitle(title: string): Promise<void>;
16
+ updateSlug(slug: string): Promise<void>;
9
17
  }
10
- export interface IRouterPage extends IPage {
18
+ /**
19
+ * Read-only projection of a router-connected page: the read-only page surface plus
20
+ * the page's role within its router and read-only access to the router itself.
21
+ */
22
+ export interface IReadOnlyRouterPage extends IReadOnlyPage {
11
23
  getPageRole(): Promise<string>;
24
+ getRouter(): Promise<IRouter | undefined>;
25
+ }
26
+ export interface IRouterPage extends IReadOnlyRouterPage, IPage {
12
27
  updatePageRole(pageRole: string): Promise<void>;
13
28
  isConnected(): Promise<boolean>;
14
29
  connect(pageRole: string): Promise<void>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/public-editor-platform-interfaces",
3
- "version": "1.87.0",
3
+ "version": "1.88.0",
4
4
  "license": "UNLICENSED",
5
5
  "contributors": [
6
6
  {
@@ -52,5 +52,5 @@
52
52
  ]
53
53
  }
54
54
  },
55
- "falconPackageHash": "b3f3c6d949a8863bf4d130f70824a9de11a4fb41053d33c85cfe0889"
55
+ "falconPackageHash": "fd64cf47b63c95aab4d5b3b58ddf0cae520a49aaa988057f034c970e"
56
56
  }