@wix/site-service-site-info 1.0.6 → 1.0.8

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.
package/README.md CHANGED
@@ -29,7 +29,7 @@ Declare `'@wix/site-service-site-info'` in your component's `serviceDependencies
29
29
  | Member | Type | Throws when | Description |
30
30
  |---|---|---|---|
31
31
  | `name` | `string` | never | Display name of the site, as set in the site's settings. `''` when the site has none. Same value as [`site.getSiteDisplayName()`](https://dev.wix.com/docs/sdk/frontend-modules/site/get-site-display-name). |
32
- | `revision` | `number` | never | Revision of the site that is being rendered. `0` when there is no revision. |
32
+ | `revision` | `number` | never | Revision of the site that is being rendered. `1` when there is no revision. |
33
33
  | `siteId` | `string` | never | ID of the site (its meta site ID). `''` when the site has none yet, for example an unsaved template in the editor. Replaces `getMetaSiteId()` from `@wix/viewer-service-environment`. |
34
34
  | `_updateConfig` | `(Partial<ISiteInfoServiceConfig>) => void` | never | Private replace-on-write updater for provided fields. |
35
35
 
@@ -45,7 +45,7 @@ type ISiteInfoServiceConfig = {
45
45
  }
46
46
  ```
47
47
 
48
- Injected by the host. `name` comes from the site's properties, and `revision` from the published site. The host passes `0` when it has no revision, and `''` when the site has no site ID yet.
48
+ Injected by the host. `name` comes from the site's properties, and `revision` from the published site. The host passes `1` when it has no revision, and `''` when the site has no site ID yet.
49
49
 
50
50
  ## Reactivity
51
51
 
@@ -8,7 +8,7 @@ export type ISiteInfoServiceConfig = {
8
8
  */
9
9
  name: string;
10
10
  /**
11
- * Revision of the site that is being rendered. `0` when the host has no revision.
11
+ * Revision of the site that is being rendered. `1` when the host has no revision.
12
12
  *
13
13
  * @exampleValue 42
14
14
  */
@@ -20,7 +20,7 @@ export type ISiteInfoServiceConfig = {
20
20
  */
21
21
  siteId: string;
22
22
  };
23
- /** Reports the display name, revision number and ID of the site your code runs on. */
23
+ /** Reports the display name, revision number, and ID of the site your code runs on. */
24
24
  export interface ISiteInfoService {
25
25
  /**
26
26
  * Site's display name.
@@ -43,7 +43,7 @@ export interface ISiteInfoService {
43
43
  * This value can change while the page is open. It changes when the site gets a new revision while a Wix
44
44
  * user is editing it. Read it while a component renders, so the component updates when it changes.
45
45
  *
46
- * `0` when no revision is available.
46
+ * `1` when no revision is available.
47
47
  *
48
48
  * @exampleValue 42
49
49
  */
@@ -52,8 +52,7 @@ export interface ISiteInfoService {
52
52
  * Site's ID: the ID that Wix APIs and analytics use to identify the site.
53
53
  *
54
54
  * This value can change while the page is open. It changes when a Wix user saves an unsaved template
55
- * while editing it. Read it while a component renders, or inside an `effect` or `computed`, to react to
56
- * changes.
55
+ * while editing it. Read it while a component renders, so the component updates when it changes.
57
56
  *
58
57
  * `''` when the site has no ID yet, for example an unsaved template in the editor.
59
58
  *
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/definition/index.ts"],"names":[],"mappings":";;;AAAA,oEAAyD;AAwEzD,yEAAyE;AAC5D,QAAA,kBAAkB,GAAG,IAAA,oCAAa,EAA2C,6BAA6B,CAAC,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/definition/index.ts"],"names":[],"mappings":";;;AAAA,oEAAyD;AAuEzD,yEAAyE;AAC5D,QAAA,kBAAkB,GAAG,IAAA,oCAAa,EAA2C,6BAA6B,CAAC,CAAA"}
@@ -8,7 +8,7 @@ export type ISiteInfoServiceConfig = {
8
8
  */
9
9
  name: string;
10
10
  /**
11
- * Revision of the site that is being rendered. `0` when the host has no revision.
11
+ * Revision of the site that is being rendered. `1` when the host has no revision.
12
12
  *
13
13
  * @exampleValue 42
14
14
  */
@@ -20,7 +20,7 @@ export type ISiteInfoServiceConfig = {
20
20
  */
21
21
  siteId: string;
22
22
  };
23
- /** Reports the display name, revision number and ID of the site your code runs on. */
23
+ /** Reports the display name, revision number, and ID of the site your code runs on. */
24
24
  export interface ISiteInfoService {
25
25
  /**
26
26
  * Site's display name.
@@ -43,7 +43,7 @@ export interface ISiteInfoService {
43
43
  * This value can change while the page is open. It changes when the site gets a new revision while a Wix
44
44
  * user is editing it. Read it while a component renders, so the component updates when it changes.
45
45
  *
46
- * `0` when no revision is available.
46
+ * `1` when no revision is available.
47
47
  *
48
48
  * @exampleValue 42
49
49
  */
@@ -52,8 +52,7 @@ export interface ISiteInfoService {
52
52
  * Site's ID: the ID that Wix APIs and analytics use to identify the site.
53
53
  *
54
54
  * This value can change while the page is open. It changes when a Wix user saves an unsaved template
55
- * while editing it. Read it while a component renders, or inside an `effect` or `computed`, to react to
56
- * changes.
55
+ * while editing it. Read it while a component renders, so the component updates when it changes.
57
56
  *
58
57
  * `''` when the site has no ID yet, for example an unsaved template in the editor.
59
58
  *
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/definition/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAwEzD,yEAAyE;AACzE,MAAM,CAAC,MAAM,kBAAkB,GAAG,aAAa,CAA2C,6BAA6B,CAAC,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/definition/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAuEzD,yEAAyE;AACzE,MAAM,CAAC,MAAM,kBAAkB,GAAG,aAAa,CAA2C,6BAA6B,CAAC,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/site-service-site-info",
3
- "version": "1.0.6",
3
+ "version": "1.0.8",
4
4
  "license": "UNLICENSED",
5
5
  "files": [
6
6
  "dist",
@@ -77,5 +77,5 @@
77
77
  ]
78
78
  }
79
79
  },
80
- "falconPackageHash": "19dc63e9d20d5a46566d8e41fa11959e7eb862d95fe6bff8a1b9fcaf"
80
+ "falconPackageHash": "c8b9947eebe039d1c05b08a7dab7d5a61fa3a290586bd97c789ed009"
81
81
  }
@@ -10,7 +10,7 @@ export type ISiteInfoServiceConfig = {
10
10
  */
11
11
  name: string
12
12
  /**
13
- * Revision of the site that is being rendered. `0` when the host has no revision.
13
+ * Revision of the site that is being rendered. `1` when the host has no revision.
14
14
  *
15
15
  * @exampleValue 42
16
16
  */
@@ -23,7 +23,7 @@ export type ISiteInfoServiceConfig = {
23
23
  siteId: string
24
24
  }
25
25
 
26
- /** Reports the display name, revision number and ID of the site your code runs on. */
26
+ /** Reports the display name, revision number, and ID of the site your code runs on. */
27
27
  export interface ISiteInfoService {
28
28
  /**
29
29
  * Site's display name.
@@ -46,7 +46,7 @@ export interface ISiteInfoService {
46
46
  * This value can change while the page is open. It changes when the site gets a new revision while a Wix
47
47
  * user is editing it. Read it while a component renders, so the component updates when it changes.
48
48
  *
49
- * `0` when no revision is available.
49
+ * `1` when no revision is available.
50
50
  *
51
51
  * @exampleValue 42
52
52
  */
@@ -55,8 +55,7 @@ export interface ISiteInfoService {
55
55
  * Site's ID: the ID that Wix APIs and analytics use to identify the site.
56
56
  *
57
57
  * This value can change while the page is open. It changes when a Wix user saves an unsaved template
58
- * while editing it. Read it while a component renders, or inside an `effect` or `computed`, to react to
59
- * changes.
58
+ * while editing it. Read it while a component renders, so the component updates when it changes.
60
59
  *
61
60
  * `''` when the site has no ID yet, for example an unsaved template in the editor.
62
61
  *