@wix/site-service-site-info 1.0.3 → 1.0.5
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/cjs/build/definition/index.d.ts +18 -6
- package/cjs/build/definition/index.js +1 -0
- package/cjs/build/definition/index.js.map +1 -1
- package/dist/definition/index.d.ts +18 -6
- package/dist/definition/index.js +1 -0
- package/dist/definition/index.js.map +1 -1
- package/package.json +2 -2
- package/src/definition/index.ts +18 -6
|
@@ -14,28 +14,40 @@ export type ISiteInfoServiceConfig = {
|
|
|
14
14
|
*/
|
|
15
15
|
revision: number;
|
|
16
16
|
};
|
|
17
|
-
/**
|
|
17
|
+
/** Reports the display name and revision number of the site your code runs on. */
|
|
18
18
|
export interface ISiteInfoService {
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* Site's display name.
|
|
21
|
+
*
|
|
22
|
+
* A Wix user sets it in the Website Settings section of the site's dashboard.
|
|
23
|
+
*
|
|
24
|
+
* This value can change while the page is open. It changes when a Wix user renames the site while editing
|
|
25
|
+
* it. Read it while a component renders, so the component updates when it changes.
|
|
21
26
|
*
|
|
22
27
|
* `''` when the site has no display name.
|
|
23
28
|
*
|
|
24
|
-
* @exampleValue '
|
|
29
|
+
* @exampleValue 'Example Outfitters'
|
|
25
30
|
*/
|
|
26
31
|
readonly name: string;
|
|
27
32
|
/**
|
|
28
|
-
*
|
|
33
|
+
* Site's revision number.
|
|
34
|
+
*
|
|
35
|
+
* The site gets a new revision each time a Wix user saves or publishes it after a change.
|
|
36
|
+
*
|
|
37
|
+
* This value can change while the page is open. It changes when the site gets a new revision while a Wix
|
|
38
|
+
* user is editing it. Read it while a component renders, so the component updates when it changes.
|
|
29
39
|
*
|
|
30
|
-
* `0` when
|
|
40
|
+
* `0` when no revision is available.
|
|
31
41
|
*
|
|
32
42
|
* @exampleValue 42
|
|
33
43
|
*/
|
|
34
44
|
readonly revision: number;
|
|
35
|
-
/**
|
|
45
|
+
/** @internal Host-only. Replaces config values when the host's state changes. */
|
|
36
46
|
_updateConfig: (config: Partial<ISiteInfoServiceConfig>) => void;
|
|
37
47
|
}
|
|
48
|
+
/** Definition of the Site Info service, used to resolve it from the services manager. */
|
|
38
49
|
export type ISiteInfoDefinition = ServiceDefinition<ISiteInfoService, ISiteInfoServiceConfig>;
|
|
50
|
+
/** Definition of the Site Info service. Specify it in `useService()`. */
|
|
39
51
|
export declare const SiteInfoDefinition: string & {
|
|
40
52
|
__api: ISiteInfoService;
|
|
41
53
|
__config: ISiteInfoServiceConfig;
|
|
@@ -2,5 +2,6 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.SiteInfoDefinition = void 0;
|
|
4
4
|
const services_definitions_1 = require("@wix/services-definitions");
|
|
5
|
+
/** Definition of the Site Info service. Specify it in `useService()`. */
|
|
5
6
|
exports.SiteInfoDefinition = (0, services_definitions_1.defineService)('@wix/site-service-site-info');
|
|
6
7
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/definition/index.ts"],"names":[],"mappings":";;;AAAA,oEAAyD;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/definition/index.ts"],"names":[],"mappings":";;;AAAA,oEAAyD;AAsDzD,yEAAyE;AAC5D,QAAA,kBAAkB,GAAG,IAAA,oCAAa,EAA2C,6BAA6B,CAAC,CAAA"}
|
|
@@ -14,28 +14,40 @@ export type ISiteInfoServiceConfig = {
|
|
|
14
14
|
*/
|
|
15
15
|
revision: number;
|
|
16
16
|
};
|
|
17
|
-
/**
|
|
17
|
+
/** Reports the display name and revision number of the site your code runs on. */
|
|
18
18
|
export interface ISiteInfoService {
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* Site's display name.
|
|
21
|
+
*
|
|
22
|
+
* A Wix user sets it in the Website Settings section of the site's dashboard.
|
|
23
|
+
*
|
|
24
|
+
* This value can change while the page is open. It changes when a Wix user renames the site while editing
|
|
25
|
+
* it. Read it while a component renders, so the component updates when it changes.
|
|
21
26
|
*
|
|
22
27
|
* `''` when the site has no display name.
|
|
23
28
|
*
|
|
24
|
-
* @exampleValue '
|
|
29
|
+
* @exampleValue 'Example Outfitters'
|
|
25
30
|
*/
|
|
26
31
|
readonly name: string;
|
|
27
32
|
/**
|
|
28
|
-
*
|
|
33
|
+
* Site's revision number.
|
|
34
|
+
*
|
|
35
|
+
* The site gets a new revision each time a Wix user saves or publishes it after a change.
|
|
36
|
+
*
|
|
37
|
+
* This value can change while the page is open. It changes when the site gets a new revision while a Wix
|
|
38
|
+
* user is editing it. Read it while a component renders, so the component updates when it changes.
|
|
29
39
|
*
|
|
30
|
-
* `0` when
|
|
40
|
+
* `0` when no revision is available.
|
|
31
41
|
*
|
|
32
42
|
* @exampleValue 42
|
|
33
43
|
*/
|
|
34
44
|
readonly revision: number;
|
|
35
|
-
/**
|
|
45
|
+
/** @internal Host-only. Replaces config values when the host's state changes. */
|
|
36
46
|
_updateConfig: (config: Partial<ISiteInfoServiceConfig>) => void;
|
|
37
47
|
}
|
|
48
|
+
/** Definition of the Site Info service, used to resolve it from the services manager. */
|
|
38
49
|
export type ISiteInfoDefinition = ServiceDefinition<ISiteInfoService, ISiteInfoServiceConfig>;
|
|
50
|
+
/** Definition of the Site Info service. Specify it in `useService()`. */
|
|
39
51
|
export declare const SiteInfoDefinition: string & {
|
|
40
52
|
__api: ISiteInfoService;
|
|
41
53
|
__config: ISiteInfoServiceConfig;
|
package/dist/definition/index.js
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;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/definition/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAsDzD,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.
|
|
3
|
+
"version": "1.0.5",
|
|
4
4
|
"license": "UNLICENSED",
|
|
5
5
|
"files": [
|
|
6
6
|
"dist",
|
|
@@ -77,5 +77,5 @@
|
|
|
77
77
|
]
|
|
78
78
|
}
|
|
79
79
|
},
|
|
80
|
-
"falconPackageHash": "
|
|
80
|
+
"falconPackageHash": "4eb1917f3c9bef8261190d04856fe9c7dc0c21f5f3ace9b9d8d8cb92"
|
|
81
81
|
}
|
package/src/definition/index.ts
CHANGED
|
@@ -17,28 +17,40 @@ export type ISiteInfoServiceConfig = {
|
|
|
17
17
|
revision: number
|
|
18
18
|
}
|
|
19
19
|
|
|
20
|
-
/**
|
|
20
|
+
/** Reports the display name and revision number of the site your code runs on. */
|
|
21
21
|
export interface ISiteInfoService {
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* Site's display name.
|
|
24
|
+
*
|
|
25
|
+
* A Wix user sets it in the Website Settings section of the site's dashboard.
|
|
26
|
+
*
|
|
27
|
+
* This value can change while the page is open. It changes when a Wix user renames the site while editing
|
|
28
|
+
* it. Read it while a component renders, so the component updates when it changes.
|
|
24
29
|
*
|
|
25
30
|
* `''` when the site has no display name.
|
|
26
31
|
*
|
|
27
|
-
* @exampleValue '
|
|
32
|
+
* @exampleValue 'Example Outfitters'
|
|
28
33
|
*/
|
|
29
34
|
readonly name: string
|
|
30
35
|
/**
|
|
31
|
-
*
|
|
36
|
+
* Site's revision number.
|
|
37
|
+
*
|
|
38
|
+
* The site gets a new revision each time a Wix user saves or publishes it after a change.
|
|
39
|
+
*
|
|
40
|
+
* This value can change while the page is open. It changes when the site gets a new revision while a Wix
|
|
41
|
+
* user is editing it. Read it while a component renders, so the component updates when it changes.
|
|
32
42
|
*
|
|
33
|
-
* `0` when
|
|
43
|
+
* `0` when no revision is available.
|
|
34
44
|
*
|
|
35
45
|
* @exampleValue 42
|
|
36
46
|
*/
|
|
37
47
|
readonly revision: number
|
|
38
|
-
/**
|
|
48
|
+
/** @internal Host-only. Replaces config values when the host's state changes. */
|
|
39
49
|
_updateConfig: (config: Partial<ISiteInfoServiceConfig>) => void
|
|
40
50
|
}
|
|
41
51
|
|
|
52
|
+
/** Definition of the Site Info service, used to resolve it from the services manager. */
|
|
42
53
|
export type ISiteInfoDefinition = ServiceDefinition<ISiteInfoService, ISiteInfoServiceConfig>
|
|
43
54
|
|
|
55
|
+
/** Definition of the Site Info service. Specify it in `useService()`. */
|
|
44
56
|
export const SiteInfoDefinition = defineService<ISiteInfoService, ISiteInfoServiceConfig>('@wix/site-service-site-info')
|