@wix/site-service-site-info 1.0.2 → 1.0.3

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
@@ -15,8 +15,8 @@ import { SiteInfoDefinition } from '@wix/site-service-site-info/definition'
15
15
 
16
16
  const siteInfo = servicesManager.getService(SiteInfoDefinition)
17
17
 
18
- siteInfo.siteName // 'My Bakery'
19
- siteInfo.siteRevision // 42
18
+ siteInfo.name // 'My Bakery'
19
+ siteInfo.revision // 42
20
20
  ```
21
21
 
22
22
  Read through the service object, not a destructured copy: a destructured value doesn't see later updates.
@@ -27,8 +27,8 @@ Declare `'@wix/site-service-site-info'` in your component's `serviceDependencies
27
27
 
28
28
  | Member | Type | Throws when | Description |
29
29
  |---|---|---|---|
30
- | `siteName` | `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). |
31
- | `siteRevision` | `number` | never | Revision of the site that is being rendered. `0` when there is no revision. |
30
+ | `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). |
31
+ | `revision` | `number` | never | Revision of the site that is being rendered. `0` when there is no revision. |
32
32
  | `_updateConfig` | `(Partial<ISiteInfoServiceConfig>) => void` | never | Private replace-on-write updater for provided fields. |
33
33
 
34
34
  ## Configuration
@@ -37,12 +37,12 @@ Declare `'@wix/site-service-site-info'` in your component's `serviceDependencies
37
37
 
38
38
  ```ts
39
39
  type ISiteInfoServiceConfig = {
40
- siteName: string
41
- siteRevision: number
40
+ name: string
41
+ revision: number
42
42
  }
43
43
  ```
44
44
 
45
- Injected by the host. `siteName` comes from the site's properties, and `siteRevision` from the published site. The host passes `0` when it has no revision.
45
+ 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.
46
46
 
47
47
  ## Reactivity
48
48
 
@@ -6,13 +6,13 @@ export type ISiteInfoServiceConfig = {
6
6
  *
7
7
  * @exampleValue 'My Bakery'
8
8
  */
9
- siteName: string;
9
+ name: string;
10
10
  /**
11
11
  * Revision of the site that is being rendered. `0` when the host has no revision.
12
12
  *
13
13
  * @exampleValue 42
14
14
  */
15
- siteRevision: number;
15
+ revision: number;
16
16
  };
17
17
  /** Information about the site that is being rendered. Both values can change during an editor session. */
18
18
  export interface ISiteInfoService {
@@ -23,7 +23,7 @@ export interface ISiteInfoService {
23
23
  *
24
24
  * @exampleValue 'My Bakery'
25
25
  */
26
- readonly siteName: string;
26
+ readonly name: string;
27
27
  /**
28
28
  * Revision of the site that is being rendered.
29
29
  *
@@ -31,7 +31,7 @@ export interface ISiteInfoService {
31
31
  *
32
32
  * @exampleValue 42
33
33
  */
34
- readonly siteRevision: number;
34
+ readonly revision: number;
35
35
  /** Called by the host when the site is renamed or gets a new revision. Fields left out keep their value. */
36
36
  _updateConfig: (config: Partial<ISiteInfoServiceConfig>) => void;
37
37
  }
@@ -6,21 +6,21 @@ const signals_1 = require("@wix/services-definitions/core-services/signals");
6
6
  const definition_1 = require("../definition");
7
7
  exports.SiteInfoService = (0, services_definitions_1.implementService)(definition_1.SiteInfoDefinition, ({ config, getService }) => {
8
8
  const { signal } = getService(signals_1.SignalsServiceDefinition);
9
- const _siteName = signal(config.siteName);
10
- const _siteRevision = signal(config.siteRevision);
9
+ const _name = signal(config.name);
10
+ const _revision = signal(config.revision);
11
11
  return {
12
- get siteName() {
13
- return _siteName.get();
12
+ get name() {
13
+ return _name.get();
14
14
  },
15
- get siteRevision() {
16
- return _siteRevision.get();
15
+ get revision() {
16
+ return _revision.get();
17
17
  },
18
18
  _updateConfig(update) {
19
- if (typeof update.siteName !== 'undefined') {
20
- _siteName.set(update.siteName);
19
+ if (typeof update.name !== 'undefined') {
20
+ _name.set(update.name);
21
21
  }
22
- if (typeof update.siteRevision !== 'undefined') {
23
- _siteRevision.set(update.siteRevision);
22
+ if (typeof update.revision !== 'undefined') {
23
+ _revision.set(update.revision);
24
24
  }
25
25
  },
26
26
  };
@@ -1 +1 @@
1
- {"version":3,"file":"siteInfoService.js","sourceRoot":"","sources":["../../../src/implementations/siteInfoService.ts"],"names":[],"mappings":";;;AAAA,oEAA4D;AAE5D,6EAA0F;AAE1F,8CAAkD;AAErC,QAAA,eAAe,GAAG,IAAA,uCAAgB,EAC9C,+BAAkB,EAClB,CAAC,EAAE,MAAM,EAAE,UAAU,EAA8C,EAAoB,EAAE;IACxF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,kCAAwB,CAAC,CAAA;IACvD,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IACzC,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;IAEjD,OAAO;QACN,IAAI,QAAQ;YACX,OAAO,SAAS,CAAC,GAAG,EAAE,CAAA;QACvB,CAAC;QACD,IAAI,YAAY;YACf,OAAO,aAAa,CAAC,GAAG,EAAE,CAAA;QAC3B,CAAC;QACD,aAAa,CAAC,MAAuC;YACpD,IAAI,OAAO,MAAM,CAAC,QAAQ,KAAK,WAAW,EAAE,CAAC;gBAC5C,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;YAC/B,CAAC;YACD,IAAI,OAAO,MAAM,CAAC,YAAY,KAAK,WAAW,EAAE,CAAC;gBAChD,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;YACvC,CAAC;QACF,CAAC;KACD,CAAA;AACF,CAAC,CACD,CAAA"}
1
+ {"version":3,"file":"siteInfoService.js","sourceRoot":"","sources":["../../../src/implementations/siteInfoService.ts"],"names":[],"mappings":";;;AAAA,oEAA4D;AAE5D,6EAA0F;AAE1F,8CAAkD;AAErC,QAAA,eAAe,GAAG,IAAA,uCAAgB,EAC9C,+BAAkB,EAClB,CAAC,EAAE,MAAM,EAAE,UAAU,EAA8C,EAAoB,EAAE;IACxF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,kCAAwB,CAAC,CAAA;IACvD,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACjC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IAEzC,OAAO;QACN,IAAI,IAAI;YACP,OAAO,KAAK,CAAC,GAAG,EAAE,CAAA;QACnB,CAAC;QACD,IAAI,QAAQ;YACX,OAAO,SAAS,CAAC,GAAG,EAAE,CAAA;QACvB,CAAC;QACD,aAAa,CAAC,MAAuC;YACpD,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;gBACxC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YACvB,CAAC;YACD,IAAI,OAAO,MAAM,CAAC,QAAQ,KAAK,WAAW,EAAE,CAAC;gBAC5C,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;YAC/B,CAAC;QACF,CAAC;KACD,CAAA;AACF,CAAC,CACD,CAAA"}
@@ -6,13 +6,13 @@ export type ISiteInfoServiceConfig = {
6
6
  *
7
7
  * @exampleValue 'My Bakery'
8
8
  */
9
- siteName: string;
9
+ name: string;
10
10
  /**
11
11
  * Revision of the site that is being rendered. `0` when the host has no revision.
12
12
  *
13
13
  * @exampleValue 42
14
14
  */
15
- siteRevision: number;
15
+ revision: number;
16
16
  };
17
17
  /** Information about the site that is being rendered. Both values can change during an editor session. */
18
18
  export interface ISiteInfoService {
@@ -23,7 +23,7 @@ export interface ISiteInfoService {
23
23
  *
24
24
  * @exampleValue 'My Bakery'
25
25
  */
26
- readonly siteName: string;
26
+ readonly name: string;
27
27
  /**
28
28
  * Revision of the site that is being rendered.
29
29
  *
@@ -31,7 +31,7 @@ export interface ISiteInfoService {
31
31
  *
32
32
  * @exampleValue 42
33
33
  */
34
- readonly siteRevision: number;
34
+ readonly revision: number;
35
35
  /** Called by the host when the site is renamed or gets a new revision. Fields left out keep their value. */
36
36
  _updateConfig: (config: Partial<ISiteInfoServiceConfig>) => void;
37
37
  }
@@ -3,21 +3,21 @@ import { SignalsServiceDefinition } from '@wix/services-definitions/core-service
3
3
  import { SiteInfoDefinition } from '../definition';
4
4
  export const SiteInfoService = implementService(SiteInfoDefinition, ({ config, getService }) => {
5
5
  const { signal } = getService(SignalsServiceDefinition);
6
- const _siteName = signal(config.siteName);
7
- const _siteRevision = signal(config.siteRevision);
6
+ const _name = signal(config.name);
7
+ const _revision = signal(config.revision);
8
8
  return {
9
- get siteName() {
10
- return _siteName.get();
9
+ get name() {
10
+ return _name.get();
11
11
  },
12
- get siteRevision() {
13
- return _siteRevision.get();
12
+ get revision() {
13
+ return _revision.get();
14
14
  },
15
15
  _updateConfig(update) {
16
- if (typeof update.siteName !== 'undefined') {
17
- _siteName.set(update.siteName);
16
+ if (typeof update.name !== 'undefined') {
17
+ _name.set(update.name);
18
18
  }
19
- if (typeof update.siteRevision !== 'undefined') {
20
- _siteRevision.set(update.siteRevision);
19
+ if (typeof update.revision !== 'undefined') {
20
+ _revision.set(update.revision);
21
21
  }
22
22
  },
23
23
  };
@@ -1 +1 @@
1
- {"version":3,"file":"siteInfoService.js","sourceRoot":"","sources":["../../src/implementations/siteInfoService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAE5D,OAAO,EAAE,wBAAwB,EAAE,MAAM,iDAAiD,CAAA;AAE1F,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAElD,MAAM,CAAC,MAAM,eAAe,GAAG,gBAAgB,CAC9C,kBAAkB,EAClB,CAAC,EAAE,MAAM,EAAE,UAAU,EAA8C,EAAoB,EAAE;IACxF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAA;IACvD,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IACzC,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;IAEjD,OAAO;QACN,IAAI,QAAQ;YACX,OAAO,SAAS,CAAC,GAAG,EAAE,CAAA;QACvB,CAAC;QACD,IAAI,YAAY;YACf,OAAO,aAAa,CAAC,GAAG,EAAE,CAAA;QAC3B,CAAC;QACD,aAAa,CAAC,MAAuC;YACpD,IAAI,OAAO,MAAM,CAAC,QAAQ,KAAK,WAAW,EAAE,CAAC;gBAC5C,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;YAC/B,CAAC;YACD,IAAI,OAAO,MAAM,CAAC,YAAY,KAAK,WAAW,EAAE,CAAC;gBAChD,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;YACvC,CAAC;QACF,CAAC;KACD,CAAA;AACF,CAAC,CACD,CAAA"}
1
+ {"version":3,"file":"siteInfoService.js","sourceRoot":"","sources":["../../src/implementations/siteInfoService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAE5D,OAAO,EAAE,wBAAwB,EAAE,MAAM,iDAAiD,CAAA;AAE1F,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAElD,MAAM,CAAC,MAAM,eAAe,GAAG,gBAAgB,CAC9C,kBAAkB,EAClB,CAAC,EAAE,MAAM,EAAE,UAAU,EAA8C,EAAoB,EAAE;IACxF,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAA;IACvD,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACjC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IAEzC,OAAO;QACN,IAAI,IAAI;YACP,OAAO,KAAK,CAAC,GAAG,EAAE,CAAA;QACnB,CAAC;QACD,IAAI,QAAQ;YACX,OAAO,SAAS,CAAC,GAAG,EAAE,CAAA;QACvB,CAAC;QACD,aAAa,CAAC,MAAuC;YACpD,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;gBACxC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YACvB,CAAC;YACD,IAAI,OAAO,MAAM,CAAC,QAAQ,KAAK,WAAW,EAAE,CAAC;gBAC5C,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;YAC/B,CAAC;QACF,CAAC;KACD,CAAA;AACF,CAAC,CACD,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/site-service-site-info",
3
- "version": "1.0.2",
3
+ "version": "1.0.3",
4
4
  "license": "UNLICENSED",
5
5
  "files": [
6
6
  "dist",
@@ -77,5 +77,5 @@
77
77
  ]
78
78
  }
79
79
  },
80
- "falconPackageHash": "48da656d89bb31081498afeeedb5225feec1817ff4b51b5581773972"
80
+ "falconPackageHash": "002db8725b0ef087ace3a88ced03868bf4176dd60c8f070a7fc5b6c0"
81
81
  }
@@ -8,13 +8,13 @@ export type ISiteInfoServiceConfig = {
8
8
  *
9
9
  * @exampleValue 'My Bakery'
10
10
  */
11
- siteName: string
11
+ name: string
12
12
  /**
13
13
  * Revision of the site that is being rendered. `0` when the host has no revision.
14
14
  *
15
15
  * @exampleValue 42
16
16
  */
17
- siteRevision: number
17
+ revision: number
18
18
  }
19
19
 
20
20
  /** Information about the site that is being rendered. Both values can change during an editor session. */
@@ -26,7 +26,7 @@ export interface ISiteInfoService {
26
26
  *
27
27
  * @exampleValue 'My Bakery'
28
28
  */
29
- readonly siteName: string
29
+ readonly name: string
30
30
  /**
31
31
  * Revision of the site that is being rendered.
32
32
  *
@@ -34,7 +34,7 @@ export interface ISiteInfoService {
34
34
  *
35
35
  * @exampleValue 42
36
36
  */
37
- readonly siteRevision: number
37
+ readonly revision: number
38
38
  /** Called by the host when the site is renamed or gets a new revision. Fields left out keep their value. */
39
39
  _updateConfig: (config: Partial<ISiteInfoServiceConfig>) => void
40
40
  }
@@ -8,22 +8,22 @@ export const SiteInfoService = implementService(
8
8
  SiteInfoDefinition,
9
9
  ({ config, getService }: ServiceFactoryOpts<ISiteInfoServiceConfig>): ISiteInfoService => {
10
10
  const { signal } = getService(SignalsServiceDefinition)
11
- const _siteName = signal(config.siteName)
12
- const _siteRevision = signal(config.siteRevision)
11
+ const _name = signal(config.name)
12
+ const _revision = signal(config.revision)
13
13
 
14
14
  return {
15
- get siteName() {
16
- return _siteName.get()
15
+ get name() {
16
+ return _name.get()
17
17
  },
18
- get siteRevision() {
19
- return _siteRevision.get()
18
+ get revision() {
19
+ return _revision.get()
20
20
  },
21
21
  _updateConfig(update: Partial<ISiteInfoServiceConfig>) {
22
- if (typeof update.siteName !== 'undefined') {
23
- _siteName.set(update.siteName)
22
+ if (typeof update.name !== 'undefined') {
23
+ _name.set(update.name)
24
24
  }
25
- if (typeof update.siteRevision !== 'undefined') {
26
- _siteRevision.set(update.siteRevision)
25
+ if (typeof update.revision !== 'undefined') {
26
+ _revision.set(update.revision)
27
27
  }
28
28
  },
29
29
  }