@localess/js-client 0.6.1-next.20250411-201151.0 → 0.7.1-next.20250423-213407.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.
- package/README.md +1 -1
- package/dist/index.d.mts +10 -10
- package/dist/index.d.ts +10 -10
- package/package.json +2 -5
package/README.md
CHANGED
|
@@ -52,7 +52,7 @@ llClient.getTranslations('en')
|
|
|
52
52
|
|
|
53
53
|
## Sync with Visual Editor
|
|
54
54
|
|
|
55
|
-
It will automatically inject Localess Sync Script in to HTML page.
|
|
55
|
+
It will automatically inject Localess Sync Script in to the HTML page.
|
|
56
56
|
|
|
57
57
|
````ts
|
|
58
58
|
import {loadLocalessSync} from "@localess/js-client";
|
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Content Asset
|
|
2
|
+
* Content Asset defines reference to an Asset.
|
|
3
3
|
*/
|
|
4
4
|
interface ContentAsset {
|
|
5
5
|
/**
|
|
@@ -21,7 +21,7 @@ interface ContentLink {
|
|
|
21
21
|
*/
|
|
22
22
|
kind: 'LINK';
|
|
23
23
|
/**
|
|
24
|
-
* Define the target of the link. _blank for new tab and _self for same tab.
|
|
24
|
+
* Define the target of the link. _blank for the new tab and _self for the same tab.
|
|
25
25
|
*/
|
|
26
26
|
target: '_blank' | '_self';
|
|
27
27
|
/**
|
|
@@ -29,7 +29,7 @@ interface ContentLink {
|
|
|
29
29
|
*/
|
|
30
30
|
type: 'url' | 'content';
|
|
31
31
|
/**
|
|
32
|
-
* If type is content, then it will be Content ID. Otherwise it will be URL.
|
|
32
|
+
* If the type is content, then it will be Content ID. Otherwise, it will be URL.
|
|
33
33
|
*/
|
|
34
34
|
uri: string;
|
|
35
35
|
}
|
|
@@ -49,7 +49,7 @@ interface ContentRichText {
|
|
|
49
49
|
}
|
|
50
50
|
|
|
51
51
|
/**
|
|
52
|
-
* Content Reference
|
|
52
|
+
* Content Reference defines reference to a Content.
|
|
53
53
|
*/
|
|
54
54
|
interface ContentReference {
|
|
55
55
|
/**
|
|
@@ -85,13 +85,13 @@ interface ContentDataSchema {
|
|
|
85
85
|
*/
|
|
86
86
|
interface ContentData extends ContentDataSchema {
|
|
87
87
|
/**
|
|
88
|
-
* Other Schema
|
|
88
|
+
* Other Schema-specific fields
|
|
89
89
|
*/
|
|
90
90
|
[field: string]: ContentDataField | undefined;
|
|
91
91
|
}
|
|
92
92
|
|
|
93
93
|
/**
|
|
94
|
-
* Content Metadata
|
|
94
|
+
* Content Metadata defines short information about a Content for navigation reason.
|
|
95
95
|
*/
|
|
96
96
|
interface ContentMetadata {
|
|
97
97
|
/**
|
|
@@ -133,14 +133,14 @@ interface ContentMetadata {
|
|
|
133
133
|
}
|
|
134
134
|
|
|
135
135
|
/**
|
|
136
|
-
* Key-Value Object. Where Key is Unique identifier for the Content object and Value is Content Metadata.
|
|
136
|
+
* Key-Value Object. Where Key is a Unique identifier for the Content object and Value is Content Metadata.
|
|
137
137
|
*/
|
|
138
138
|
interface Links {
|
|
139
139
|
[key: string]: ContentMetadata;
|
|
140
140
|
}
|
|
141
141
|
|
|
142
142
|
/**
|
|
143
|
-
* Content
|
|
143
|
+
* Content defines a shared object for all possible Content Types.
|
|
144
144
|
*/
|
|
145
145
|
interface Content<T extends ContentData = ContentData> extends ContentMetadata {
|
|
146
146
|
/**
|
|
@@ -168,11 +168,11 @@ type LocalessClientOptions = {
|
|
|
168
168
|
*/
|
|
169
169
|
origin: string;
|
|
170
170
|
/**
|
|
171
|
-
* Localess space ID
|
|
171
|
+
* Localess space ID can be found in the Localess Space settings
|
|
172
172
|
*/
|
|
173
173
|
spaceId: string;
|
|
174
174
|
/**
|
|
175
|
-
* Localess API token
|
|
175
|
+
* Localess API token can be found in the Localess Space settings
|
|
176
176
|
*/
|
|
177
177
|
token: string;
|
|
178
178
|
/**
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Content Asset
|
|
2
|
+
* Content Asset defines reference to an Asset.
|
|
3
3
|
*/
|
|
4
4
|
interface ContentAsset {
|
|
5
5
|
/**
|
|
@@ -21,7 +21,7 @@ interface ContentLink {
|
|
|
21
21
|
*/
|
|
22
22
|
kind: 'LINK';
|
|
23
23
|
/**
|
|
24
|
-
* Define the target of the link. _blank for new tab and _self for same tab.
|
|
24
|
+
* Define the target of the link. _blank for the new tab and _self for the same tab.
|
|
25
25
|
*/
|
|
26
26
|
target: '_blank' | '_self';
|
|
27
27
|
/**
|
|
@@ -29,7 +29,7 @@ interface ContentLink {
|
|
|
29
29
|
*/
|
|
30
30
|
type: 'url' | 'content';
|
|
31
31
|
/**
|
|
32
|
-
* If type is content, then it will be Content ID. Otherwise it will be URL.
|
|
32
|
+
* If the type is content, then it will be Content ID. Otherwise, it will be URL.
|
|
33
33
|
*/
|
|
34
34
|
uri: string;
|
|
35
35
|
}
|
|
@@ -49,7 +49,7 @@ interface ContentRichText {
|
|
|
49
49
|
}
|
|
50
50
|
|
|
51
51
|
/**
|
|
52
|
-
* Content Reference
|
|
52
|
+
* Content Reference defines reference to a Content.
|
|
53
53
|
*/
|
|
54
54
|
interface ContentReference {
|
|
55
55
|
/**
|
|
@@ -85,13 +85,13 @@ interface ContentDataSchema {
|
|
|
85
85
|
*/
|
|
86
86
|
interface ContentData extends ContentDataSchema {
|
|
87
87
|
/**
|
|
88
|
-
* Other Schema
|
|
88
|
+
* Other Schema-specific fields
|
|
89
89
|
*/
|
|
90
90
|
[field: string]: ContentDataField | undefined;
|
|
91
91
|
}
|
|
92
92
|
|
|
93
93
|
/**
|
|
94
|
-
* Content Metadata
|
|
94
|
+
* Content Metadata defines short information about a Content for navigation reason.
|
|
95
95
|
*/
|
|
96
96
|
interface ContentMetadata {
|
|
97
97
|
/**
|
|
@@ -133,14 +133,14 @@ interface ContentMetadata {
|
|
|
133
133
|
}
|
|
134
134
|
|
|
135
135
|
/**
|
|
136
|
-
* Key-Value Object. Where Key is Unique identifier for the Content object and Value is Content Metadata.
|
|
136
|
+
* Key-Value Object. Where Key is a Unique identifier for the Content object and Value is Content Metadata.
|
|
137
137
|
*/
|
|
138
138
|
interface Links {
|
|
139
139
|
[key: string]: ContentMetadata;
|
|
140
140
|
}
|
|
141
141
|
|
|
142
142
|
/**
|
|
143
|
-
* Content
|
|
143
|
+
* Content defines a shared object for all possible Content Types.
|
|
144
144
|
*/
|
|
145
145
|
interface Content<T extends ContentData = ContentData> extends ContentMetadata {
|
|
146
146
|
/**
|
|
@@ -168,11 +168,11 @@ type LocalessClientOptions = {
|
|
|
168
168
|
*/
|
|
169
169
|
origin: string;
|
|
170
170
|
/**
|
|
171
|
-
* Localess space ID
|
|
171
|
+
* Localess space ID can be found in the Localess Space settings
|
|
172
172
|
*/
|
|
173
173
|
spaceId: string;
|
|
174
174
|
/**
|
|
175
|
-
* Localess API token
|
|
175
|
+
* Localess API token can be found in the Localess Space settings
|
|
176
176
|
*/
|
|
177
177
|
token: string;
|
|
178
178
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@localess/js-client",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.7.1-next.20250423-213407.0",
|
|
4
4
|
"description": "Universal JavaScript/TypeScript SDK for Localess's API.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"localess",
|
|
@@ -34,10 +34,7 @@
|
|
|
34
34
|
"url": "https://github.com/Lessify/localess-js-client/issues"
|
|
35
35
|
},
|
|
36
36
|
"scripts": {
|
|
37
|
-
"build": "
|
|
38
|
-
"build:tsc": "tsc -p tsconfig.json",
|
|
39
|
-
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
40
|
-
"build:tsup": "tsup src/index.ts --format cjs,esm --dts"
|
|
37
|
+
"build": "tsup src/index.ts --format cjs,esm --dts"
|
|
41
38
|
},
|
|
42
39
|
"license": "MIT",
|
|
43
40
|
"devDependencies": {
|