@wix/site-service-pages 1.8.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 +10 -3
  2. package/cjs/build/definition/index.js.map +1 -1
  3. package/dist/definition/index.d.ts +10 -3
  4. package/dist/definition/index.js.map +1 -1
  5. package/package.json +2 -2
  6. package/src/definition/index.ts +10 -3
package/cjs/build/definition/index.d.ts CHANGED
@@ -43,14 +43,21 @@ export type PageConfig = {
43
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. */
@@ -86,7 +93,7 @@ export interface IPagesService {
86
93
  * Don't change the map or its pages. Every component on the page reads the same map, so a change shows in
87
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;
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
@@ -43,14 +43,21 @@ export type PageConfig = {
43
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. */
@@ -86,7 +93,7 @@ export interface IPagesService {
86
93
  * Don't change the map or its pages. Every component on the page reads the same map, so a change shows in
87
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;
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.8.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": "47c5a308a9f2b3c14c84bb656f850ad2fdce5a5d4954ae26485d26fb"
80
+ "falconPackageHash": "c622db257aae8f54416d87dfce31ffc74820e291e115a6a9cce8b0c4"
81
81
  }
package/src/definition/index.ts CHANGED
@@ -45,14 +45,21 @@ export type PageConfig = {
45
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
 
@@ -89,7 +96,7 @@ export interface IPagesService {
89
96
  * Don't change the map or its pages. Every component on the page reads the same map, so a change shows in
90
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