@wix/site-service-pages 1.7.0 → 1.8.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.
Files changed (4) hide show
  1. package/cjs/build/definition/index.d.ts +7 -7
  2. package/dist/definition/index.d.ts +7 -7
  3. package/package.json +2 -2
  4. package/src/definition/index.ts +7 -7
package/cjs/build/definition/index.d.ts CHANGED
@@ -40,7 +40,7 @@ export type PageConfig = {
40
40
  */
41
41
  popup: boolean;
42
42
  /**
43
- * ID of the app section this page provides.
43
+ * App page ID of this page.
44
44
  *
45
45
  * The ID stays the same across sites, even though a Wix user can change the page's path. It's unique
46
46
  * only within its app, so another installed app can use the same ID.
@@ -83,8 +83,8 @@ export interface IPagesService {
83
83
  *
84
84
  * The values don't include an `id`. Use the key as the page's ID.
85
85
  *
86
- * Don't change the map or its pages. The property is read-only, but the map it returns isn't, and
87
- * every component on the page shares it.
86
+ * Don't change the map or its pages. Every component on the page reads the same map, so a change shows in
87
+ * all of them, and the site doesn't save it.
88
88
  *
89
89
  * @exampleValue `{ "m4rw8": { "title": "Home", "path": "home", "popup": false }, "c1dmp": { "title": "Shop", "path": "shop", "popup": false }, "i9xk2": { "title": "Collections", "path": "collections", "popup": false }, "t5nb6": { "title": "Spring Collection", "path": "collections/spring", "parentPageId": "i9xk2", "popup": false }, "q7hz3": { "title": "Side Cart", "path": "side-cart", "popup": true, "appPageId": "ecom_side_cart" } }`
90
90
  */
@@ -97,8 +97,8 @@ export interface IPagesService {
97
97
  * A Wix user chooses which page this is. To check whether the page that's currently displayed is the
98
98
  * main page, compare `currentPage.id` with `mainPage.id`.
99
99
  *
100
- * Don't change its fields. The property is read-only, but the object it returns isn't, and every
101
- * component on the page shares it.
100
+ * Don't change its fields. Every component on the page reads the same object, so a change shows in all of
101
+ * them, and the site doesn't save it.
102
102
  *
103
103
  * @exampleValue `{ "id": "m4rw8", "title": "Home", "path": "home", "popup": false }`
104
104
  */
@@ -106,8 +106,8 @@ export interface IPagesService {
106
106
  /**
107
107
  * Page that's currently displayed.
108
108
  *
109
- * Don't change its fields. The property is read-only, but the object it returns isn't, and every
110
- * component on the page shares it.
109
+ * Don't change its fields. Every component on the page reads the same object, so a change shows in all of
110
+ * them, and the site doesn't save it.
111
111
  *
112
112
  * @exampleValue `{ "id": "c1dmp", "title": "Shop", "path": "shop", "popup": false }`
113
113
  */
package/dist/definition/index.d.ts CHANGED
@@ -40,7 +40,7 @@ export type PageConfig = {
40
40
  */
41
41
  popup: boolean;
42
42
  /**
43
- * ID of the app section this page provides.
43
+ * App page ID of this page.
44
44
  *
45
45
  * The ID stays the same across sites, even though a Wix user can change the page's path. It's unique
46
46
  * only within its app, so another installed app can use the same ID.
@@ -83,8 +83,8 @@ export interface IPagesService {
83
83
  *
84
84
  * The values don't include an `id`. Use the key as the page's ID.
85
85
  *
86
- * Don't change the map or its pages. The property is read-only, but the map it returns isn't, and
87
- * every component on the page shares it.
86
+ * Don't change the map or its pages. Every component on the page reads the same map, so a change shows in
87
+ * all of them, and the site doesn't save it.
88
88
  *
89
89
  * @exampleValue `{ "m4rw8": { "title": "Home", "path": "home", "popup": false }, "c1dmp": { "title": "Shop", "path": "shop", "popup": false }, "i9xk2": { "title": "Collections", "path": "collections", "popup": false }, "t5nb6": { "title": "Spring Collection", "path": "collections/spring", "parentPageId": "i9xk2", "popup": false }, "q7hz3": { "title": "Side Cart", "path": "side-cart", "popup": true, "appPageId": "ecom_side_cart" } }`
90
90
  */
@@ -97,8 +97,8 @@ export interface IPagesService {
97
97
  * A Wix user chooses which page this is. To check whether the page that's currently displayed is the
98
98
  * main page, compare `currentPage.id` with `mainPage.id`.
99
99
  *
100
- * Don't change its fields. The property is read-only, but the object it returns isn't, and every
101
- * component on the page shares it.
100
+ * Don't change its fields. Every component on the page reads the same object, so a change shows in all of
101
+ * them, and the site doesn't save it.
102
102
  *
103
103
  * @exampleValue `{ "id": "m4rw8", "title": "Home", "path": "home", "popup": false }`
104
104
  */
@@ -106,8 +106,8 @@ export interface IPagesService {
106
106
  /**
107
107
  * Page that's currently displayed.
108
108
  *
109
- * Don't change its fields. The property is read-only, but the object it returns isn't, and every
110
- * component on the page shares it.
109
+ * Don't change its fields. Every component on the page reads the same object, so a change shows in all of
110
+ * them, and the site doesn't save it.
111
111
  *
112
112
  * @exampleValue `{ "id": "c1dmp", "title": "Shop", "path": "shop", "popup": false }`
113
113
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/site-service-pages",
3
- "version": "1.7.0",
3
+ "version": "1.8.0",
4
4
  "license": "UNLICENSED",
5
5
  "files": [
6
6
  "dist",
@@ -77,5 +77,5 @@
77
77
  ]
78
78
  }
79
79
  },
80
- "falconPackageHash": "824488b92b2bde49e25e9c1f378ddd32847adfd2b0da037d3d25865f"
80
+ "falconPackageHash": "47c5a308a9f2b3c14c84bb656f850ad2fdce5a5d4954ae26485d26fb"
81
81
  }
package/src/definition/index.ts CHANGED
@@ -42,7 +42,7 @@ export type PageConfig = {
42
42
  */
43
43
  popup: boolean
44
44
  /**
45
- * ID of the app section this page provides.
45
+ * App page ID of this page.
46
46
  *
47
47
  * The ID stays the same across sites, even though a Wix user can change the page's path. It's unique
48
48
  * only within its app, so another installed app can use the same ID.
@@ -86,8 +86,8 @@ export interface IPagesService {
86
86
  *
87
87
  * The values don't include an `id`. Use the key as the page's ID.
88
88
  *
89
- * Don't change the map or its pages. The property is read-only, but the map it returns isn't, and
90
- * every component on the page shares it.
89
+ * Don't change the map or its pages. Every component on the page reads the same map, so a change shows in
90
+ * all of them, and the site doesn't save it.
91
91
  *
92
92
  * @exampleValue `{ "m4rw8": { "title": "Home", "path": "home", "popup": false }, "c1dmp": { "title": "Shop", "path": "shop", "popup": false }, "i9xk2": { "title": "Collections", "path": "collections", "popup": false }, "t5nb6": { "title": "Spring Collection", "path": "collections/spring", "parentPageId": "i9xk2", "popup": false }, "q7hz3": { "title": "Side Cart", "path": "side-cart", "popup": true, "appPageId": "ecom_side_cart" } }`
93
93
  */
@@ -99,8 +99,8 @@ export interface IPagesService {
99
99
  * A Wix user chooses which page this is. To check whether the page that's currently displayed is the
100
100
  * main page, compare `currentPage.id` with `mainPage.id`.
101
101
  *
102
- * Don't change its fields. The property is read-only, but the object it returns isn't, and every
103
- * component on the page shares it.
102
+ * Don't change its fields. Every component on the page reads the same object, so a change shows in all of
103
+ * them, and the site doesn't save it.
104
104
  *
105
105
  * @exampleValue `{ "id": "m4rw8", "title": "Home", "path": "home", "popup": false }`
106
106
  */
@@ -109,8 +109,8 @@ export interface IPagesService {
109
109
  /**
110
110
  * Page that's currently displayed.
111
111
  *
112
- * Don't change its fields. The property is read-only, but the object it returns isn't, and every
113
- * component on the page shares it.
112
+ * Don't change its fields. Every component on the page reads the same object, so a change shows in all of
113
+ * them, and the site doesn't save it.
114
114
  *
115
115
  * @exampleValue `{ "id": "c1dmp", "title": "Shop", "path": "shop", "popup": false }`
116
116
  */