@wix/site-service-pages 1.7.0 → 1.9.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 (6) hide show
  1. package/cjs/build/definition/index.d.ts +17 -10
  2. package/cjs/build/definition/index.js.map +1 -1
  3. package/dist/definition/index.d.ts +17 -10
  4. package/dist/definition/index.js.map +1 -1
  5. package/package.json +2 -2
  6. package/src/definition/index.ts +17 -10
package/cjs/build/definition/index.d.ts CHANGED
@@ -40,17 +40,24 @@ 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
- * only within its app, so another installed app can use the same ID.
46
+ * only within its app, so another installed app can use the same ID. To identify an app's page, check
47
+ * `appDefinitionId` too.
47
48
  *
48
49
  * Available only for a page that belongs to an installed app.
49
50
  *
50
51
  * @exampleValue 'ecom_side_cart'
51
52
  */
52
53
  appPageId?: string;
53
- /** @internal Not documented: the host doesn't populate it yet (host PR #48632 set only `appPageId`). */
54
+ /**
55
+ * ID of the app that this page belongs to. This is the app's `appDefinitionId`.
56
+ *
57
+ * Available only for a page that belongs to an installed app.
58
+ *
59
+ * @exampleValue '1380b703-ce81-ff05-f115-39571d94dfcd'
60
+ */
54
61
  appDefinitionId?: string;
55
62
  };
56
63
  /** A page on a site, including its ID. */
@@ -83,10 +90,10 @@ export interface IPagesService {
83
90
  *
84
91
  * The values don't include an `id`. Use the key as the page's ID.
85
92
  *
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.
93
+ * Don't change the map or its pages. Every component on the page reads the same map, so a change shows in
94
+ * all of them, and the site doesn't save it.
88
95
  *
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" } }`
96
+ * @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", "appDefinitionId": "1380b703-ce81-ff05-f115-39571d94dfcd" } }`
90
97
  */
91
98
  readonly pages: {
92
99
  [pageId: string]: PageConfig;
@@ -97,8 +104,8 @@ export interface IPagesService {
97
104
  * A Wix user chooses which page this is. To check whether the page that's currently displayed is the
98
105
  * main page, compare `currentPage.id` with `mainPage.id`.
99
106
  *
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.
107
+ * Don't change its fields. Every component on the page reads the same object, so a change shows in all of
108
+ * them, and the site doesn't save it.
102
109
  *
103
110
  * @exampleValue `{ "id": "m4rw8", "title": "Home", "path": "home", "popup": false }`
104
111
  */
@@ -106,8 +113,8 @@ export interface IPagesService {
106
113
  /**
107
114
  * Page that's currently displayed.
108
115
  *
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.
116
+ * Don't change its fields. Every component on the page reads the same object, so a change shows in all of
117
+ * them, and the site doesn't save it.
111
118
  *
112
119
  * @exampleValue `{ "id": "c1dmp", "title": "Shop", "path": "shop", "popup": false }`
113
120
  */
package/cjs/build/definition/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/definition/index.ts"],"names":[],"mappings":";;;AAAA,oEAAyD;AA4H5C,QAAA,eAAe,GAAG,IAAA,oCAAa,EAAqC,yBAAyB,CAAC,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/definition/index.ts"],"names":[],"mappings":";;;AAAA,oEAAyD;AAmI5C,QAAA,eAAe,GAAG,IAAA,oCAAa,EAAqC,yBAAyB,CAAC,CAAA"}
package/dist/definition/index.d.ts CHANGED
@@ -40,17 +40,24 @@ 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
- * only within its app, so another installed app can use the same ID.
46
+ * only within its app, so another installed app can use the same ID. To identify an app's page, check
47
+ * `appDefinitionId` too.
47
48
  *
48
49
  * Available only for a page that belongs to an installed app.
49
50
  *
50
51
  * @exampleValue 'ecom_side_cart'
51
52
  */
52
53
  appPageId?: string;
53
- /** @internal Not documented: the host doesn't populate it yet (host PR #48632 set only `appPageId`). */
54
+ /**
55
+ * ID of the app that this page belongs to. This is the app's `appDefinitionId`.
56
+ *
57
+ * Available only for a page that belongs to an installed app.
58
+ *
59
+ * @exampleValue '1380b703-ce81-ff05-f115-39571d94dfcd'
60
+ */
54
61
  appDefinitionId?: string;
55
62
  };
56
63
  /** A page on a site, including its ID. */
@@ -83,10 +90,10 @@ export interface IPagesService {
83
90
  *
84
91
  * The values don't include an `id`. Use the key as the page's ID.
85
92
  *
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.
93
+ * Don't change the map or its pages. Every component on the page reads the same map, so a change shows in
94
+ * all of them, and the site doesn't save it.
88
95
  *
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" } }`
96
+ * @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", "appDefinitionId": "1380b703-ce81-ff05-f115-39571d94dfcd" } }`
90
97
  */
91
98
  readonly pages: {
92
99
  [pageId: string]: PageConfig;
@@ -97,8 +104,8 @@ export interface IPagesService {
97
104
  * A Wix user chooses which page this is. To check whether the page that's currently displayed is the
98
105
  * main page, compare `currentPage.id` with `mainPage.id`.
99
106
  *
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.
107
+ * Don't change its fields. Every component on the page reads the same object, so a change shows in all of
108
+ * them, and the site doesn't save it.
102
109
  *
103
110
  * @exampleValue `{ "id": "m4rw8", "title": "Home", "path": "home", "popup": false }`
104
111
  */
@@ -106,8 +113,8 @@ export interface IPagesService {
106
113
  /**
107
114
  * Page that's currently displayed.
108
115
  *
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.
116
+ * Don't change its fields. Every component on the page reads the same object, so a change shows in all of
117
+ * them, and the site doesn't save it.
111
118
  *
112
119
  * @exampleValue `{ "id": "c1dmp", "title": "Shop", "path": "shop", "popup": false }`
113
120
  */
package/dist/definition/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/definition/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AA4HzD,MAAM,CAAC,MAAM,eAAe,GAAG,aAAa,CAAqC,yBAAyB,CAAC,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/definition/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAmIzD,MAAM,CAAC,MAAM,eAAe,GAAG,aAAa,CAAqC,yBAAyB,CAAC,CAAA"}
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.9.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": "c622db257aae8f54416d87dfce31ffc74820e291e115a6a9cce8b0c4"
81
81
  }
package/src/definition/index.ts CHANGED
@@ -42,17 +42,24 @@ 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
- * only within its app, so another installed app can use the same ID.
48
+ * only within its app, so another installed app can use the same ID. To identify an app's page, check
49
+ * `appDefinitionId` too.
49
50
  *
50
51
  * Available only for a page that belongs to an installed app.
51
52
  *
52
53
  * @exampleValue 'ecom_side_cart'
53
54
  */
54
55
  appPageId?: string
55
- /** @internal Not documented: the host doesn't populate it yet (host PR #48632 set only `appPageId`). */
56
+ /**
57
+ * ID of the app that this page belongs to. This is the app's `appDefinitionId`.
58
+ *
59
+ * Available only for a page that belongs to an installed app.
60
+ *
61
+ * @exampleValue '1380b703-ce81-ff05-f115-39571d94dfcd'
62
+ */
56
63
  appDefinitionId?: string
57
64
  }
58
65
 
@@ -86,10 +93,10 @@ export interface IPagesService {
86
93
  *
87
94
  * The values don't include an `id`. Use the key as the page's ID.
88
95
  *
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.
96
+ * Don't change the map or its pages. Every component on the page reads the same map, so a change shows in
97
+ * all of them, and the site doesn't save it.
91
98
  *
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" } }`
99
+ * @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", "appDefinitionId": "1380b703-ce81-ff05-f115-39571d94dfcd" } }`
93
100
  */
94
101
  readonly pages: { [pageId: string]: PageConfig }
95
102
 
@@ -99,8 +106,8 @@ export interface IPagesService {
99
106
  * A Wix user chooses which page this is. To check whether the page that's currently displayed is the
100
107
  * main page, compare `currentPage.id` with `mainPage.id`.
101
108
  *
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.
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.
104
111
  *
105
112
  * @exampleValue `{ "id": "m4rw8", "title": "Home", "path": "home", "popup": false }`
106
113
  */
@@ -109,8 +116,8 @@ export interface IPagesService {
109
116
  /**
110
117
  * Page that's currently displayed.
111
118
  *
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.
119
+ * Don't change its fields. Every component on the page reads the same object, so a change shows in all of
120
+ * them, and the site doesn't save it.
114
121
  *
115
122
  * @exampleValue `{ "id": "c1dmp", "title": "Shop", "path": "shop", "popup": false }`
116
123
  */