@sleekcms/client 3.0.0 → 3.1.1
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 +43 -1
- package/index.cjs +1 -1
- package/index.global.js +1823 -0
- package/index.global.js.map +1 -0
- package/index.global.min.js +2 -0
- package/index.global.min.js.map +1 -0
- package/index.mjs +1 -1
- package/package.json +8 -2
package/README.md
CHANGED
|
@@ -6,10 +6,52 @@ Sign in at [sleekcms.com](https://sleekcms.com), create your content models, add
|
|
|
6
6
|
|
|
7
7
|
## Installation
|
|
8
8
|
|
|
9
|
+
### From NPM
|
|
10
|
+
|
|
9
11
|
```bash
|
|
10
12
|
npm install @sleekcms/client
|
|
11
13
|
```
|
|
12
14
|
|
|
15
|
+
### From CDN (Browser)
|
|
16
|
+
|
|
17
|
+
Include the library directly in your HTML from a CDN:
|
|
18
|
+
|
|
19
|
+
```html
|
|
20
|
+
<!-- From unpkg -->
|
|
21
|
+
<script src="https://unpkg.com/@sleekcms/client"></script>
|
|
22
|
+
|
|
23
|
+
<!-- From jsdelivr -->
|
|
24
|
+
<script src="https://cdn.jsdelivr.net/npm/@sleekcms/client"></script>
|
|
25
|
+
|
|
26
|
+
<!-- Specific version -->
|
|
27
|
+
<script src="https://unpkg.com/@sleekcms/client@3.1.0"></script>
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
The library is available globally as `SleekCMS`:
|
|
31
|
+
|
|
32
|
+
```html
|
|
33
|
+
<script src="https://unpkg.com/@sleekcms/client"></script>
|
|
34
|
+
<script>
|
|
35
|
+
// Use the sync client
|
|
36
|
+
SleekCMS.createSyncClient({
|
|
37
|
+
siteToken: 'your-site-token',
|
|
38
|
+
env: 'latest'
|
|
39
|
+
}).then(client => {
|
|
40
|
+
const page = client.getPage('/about');
|
|
41
|
+
console.log(page);
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
// Or use the async client
|
|
45
|
+
const client = SleekCMS.createAsyncClient({
|
|
46
|
+
siteToken: 'your-site-token'
|
|
47
|
+
});
|
|
48
|
+
|
|
49
|
+
client.getPage('/pricing').then(page => {
|
|
50
|
+
console.log(page);
|
|
51
|
+
});
|
|
52
|
+
</script>
|
|
53
|
+
```
|
|
54
|
+
|
|
13
55
|
## Quick Start
|
|
14
56
|
|
|
15
57
|
```typescript
|
|
@@ -59,7 +101,7 @@ const slugs = client.getSlugs('/blog');
|
|
|
59
101
|
```typescript
|
|
60
102
|
const client = createAsyncClient({
|
|
61
103
|
siteToken: 'your-site-token',
|
|
62
|
-
resolveEnv: true // optional: cache
|
|
104
|
+
resolveEnv: true // optional: resolve env to version tag to invalidate CDN cache if required
|
|
63
105
|
});
|
|
64
106
|
|
|
65
107
|
// All methods are async
|
package/index.cjs
CHANGED
|
@@ -79,7 +79,7 @@ async function fetchEnvTag({ siteToken, env }) {
|
|
|
79
79
|
async function fetchSiteContent(options) {
|
|
80
80
|
const { siteToken, env = "latest", resolveEnv = false, search: search2, lang, cache, cacheMinutes } = options;
|
|
81
81
|
let url = getUrl({ siteToken, env, search: search2, lang });
|
|
82
|
-
if (
|
|
82
|
+
if (resolveEnv) {
|
|
83
83
|
const cacheKey2 = `${siteToken}:${env}`;
|
|
84
84
|
let tag = envTagCache.get(cacheKey2);
|
|
85
85
|
try {
|