@sleekcms/client 2.4.0 → 3.0.0

package/README.md

@@ -13,9 +13,9 @@ npm install @sleekcms/client
 ## Quick Start
 
 ```typescript
-import { createClient } from '@sleekcms/client';
+import { createSyncClient } from '@sleekcms/client';
 
-const client = await createClient({
+const client = await createSyncClient({
   siteToken: 'your-site-token',
   env: 'latest'
 });
@@ -34,11 +34,11 @@ const footer = client.getEntry('footer');
 
 ### Sync Client (Recommended for SSG)
 
-**`createClient()`** fetches all content upfront and returns a client with synchronous methods. Best for static site generation where you build once and want instant access to content.
+**`createSyncClient()`** fetches all content upfront and returns a client with synchronous methods. Best for static site generation where you build once and want instant access to content.
 
 ```typescript
 // Async initialization, sync usage
-const client = await createClient({
+const client = await createSyncClient({
   siteToken: 'your-site-token'
 });
 
@@ -59,7 +59,7 @@ const slugs = client.getSlugs('/blog');
 ```typescript
 const client = createAsyncClient({
   siteToken: 'your-site-token',
-  cdn: true  // optional: cache-friendly URLs
+  resolveEnv: true  // optional: cache-friendly URLs
 });
 
 // All methods are async
@@ -78,8 +78,8 @@ const posts = await client.getPages('/blog');
 |--------|------|---------|-------------|
 | `siteToken` | `string` | required | Your site token from SleekCMS |
 | `env` | `string` | `'latest'` | Environment/alias name |
-| `cdn` | `boolean` | `false` | Resolve env name to bypass CDN cache. Adds latency. |
-| `lang` | `string` | - | Language code for internationalized content (e.g., `'en'`, `'es'`, `'fr'`) |
+| `resolveEnv` | `boolean` | `false` | Env is an alias to version. This flag resolves env to version tag, so as to bypass CDN cache. Add's some latency.|
+| `lang` | `string` | - | Language code for internationalized content |
 | `cache` | `SyncCacheAdapter \| AsyncCacheAdapter` | In-memory cache | Custom cache adapter for storing fetched content |
 | `cacheMinutes` | `number` | - | Cache expiration time in minutes. If not set, cache never expires |
 
@@ -87,7 +87,7 @@ const posts = await client.getPages('/blog');
 
 ```typescript
 // Fetch Spanish content
-const client = await createClient({
+const client = await createSyncClient({
   siteToken: 'your-site-token',
   lang: 'es'
 });
@@ -103,7 +103,7 @@ The client includes built-in caching support to improve performance and reduce A
 ### Default In-Memory Cache
 
 ```typescript
-const client = await createClient({
+const client = await createSyncClient({
   siteToken: 'your-site-token'
 });
 // Uses built-in memory cache automatically
@@ -112,7 +112,7 @@ const client = await createClient({
 ### Using localStorage
 
 ```typescript
-const client = await createClient({
+const client = await createSyncClient({
   siteToken: 'your-site-token',
   cache: localStorage,  // Use browser's localStorage
   cacheMinutes: 60*24      // Cache expires after 1 day
@@ -142,7 +142,7 @@ interface AsyncCacheAdapter {
 Use `cacheMinutes` to set when cached content expires:
 
 ```typescript
-const client = await createClient({
+const client = await createSyncClient({
   siteToken: 'your-site-token',
   cache: localStorage,
   cacheMinutes: 60*24  // Cache expires after 1 day
@@ -228,10 +228,10 @@ const categories = client.getOptions('categories');
 
 ```typescript
 // app/blog/page.tsx
-import { createClient } from '@sleekcms/client';
+import { createSyncClient } from '@sleekcms/client';
 
 export default async function BlogPage() {
-  const client = await createClient({
+  const client = await createSyncClient({
     siteToken: process.env.SLEEKCMS_SITE_TOKEN!
   });
 
@@ -253,10 +253,10 @@ export default async function BlogPage() {
 
 ```typescript
 // app/blog/[slug]/page.tsx
-import { createClient } from '@sleekcms/client';
+import { createSyncClient } from '@sleekcms/client';
 
 export async function generateStaticParams() {
-  const client = await createClient({
+  const client = await createSyncClient({
     siteToken: process.env.SLEEKCMS_SITE_TOKEN!
   });
 
@@ -266,7 +266,7 @@ export async function generateStaticParams() {
 }
 
 export default async function Post({ params }: { params: { slug: string } }) {
-  const client = await createClient({
+  const client = await createSyncClient({
     siteToken: process.env.SLEEKCMS_SITE_TOKEN!
   });
 
@@ -284,7 +284,7 @@ import { createAsyncClient } from '@sleekcms/client';
 
 const client = createAsyncClient({
   siteToken: process.env.SLEEKCMS_SITE_TOKEN,
-  cdn: true
+  resolveEnv: true
 });
 
 export async function load() {
@@ -298,9 +298,9 @@ export async function load() {
 ```astro
 ---
 // src/pages/blog/index.astro
-import { createClient } from '@sleekcms/client';
+import { createSyncClient } from '@sleekcms/client';
 
-const client = await createClient({
+const client = await createSyncClient({
   siteToken: import.meta.env.SLEEKCMS_SITE_TOKEN
 });
 

package/index.cjs

@@ -30,7 +30,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   createAsyncClient: () => createAsyncClient,
-  createClient: () => createClient
+  createSyncClient: () => createSyncClient
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -77,16 +77,20 @@ async function fetchEnvTag({ siteToken, env }) {
   return env;
 }
 async function fetchSiteContent(options) {
-  const { siteToken, env = "latest", cdn = false, search: search2, lang, cache, cacheMinutes } = options;
+  const { siteToken, env = "latest", resolveEnv = false, search: search2, lang, cache, cacheMinutes } = options;
   let url = getUrl({ siteToken, env, search: search2, lang });
-  if (!cdn) {
+  if (!resolveEnv) {
     const cacheKey2 = `${siteToken}:${env}`;
     let tag = envTagCache.get(cacheKey2);
-    if (!tag) {
-      tag = await fetchEnvTag({ siteToken, env });
-      envTagCache.set(cacheKey2, tag);
+    try {
+      if (!tag) {
+        tag = await fetchEnvTag({ siteToken, env });
+        envTagCache.set(cacheKey2, tag);
+      }
+      url = getUrl({ siteToken, env: tag, search: search2, lang });
+    } catch (error) {
+      console.warn("[SleekCMS] Failed to resolve env tag, using cached content instead.");
     }
-    url = getUrl({ siteToken, env: tag, search: search2, lang });
   }
   const cacheKey = url;
   const fetchAndCache = async () => {
@@ -129,7 +133,11 @@ async function fetchSiteContent(options) {
               const expiryMs = cacheMinutes * 60 * 1e3;
               const age = now - cachedData._ts;
               if (age >= expiryMs) {
-                return await fetchAndCache();
+                try {
+                  return await fetchAndCache();
+                } catch (error) {
+                  console.warn("[SleekCMS] Fetch failed, using expired cache:", error);
+                }
               }
             }
             return cachedData.data;
@@ -174,7 +182,7 @@ var MemoryCache = class {
     this.cache.set(key, value);
   }
 };
-async function createClient(options) {
+async function createSyncClient(options) {
   const cache = options.cache ?? new MemoryCache();
   const data = await fetchSiteContent({ ...options, cache });
   function getContent(query) {
@@ -232,26 +240,26 @@ async function createClient(options) {
   };
 }
 function createAsyncClient(options) {
-  const { siteToken, env = "latest", cdn, lang } = options;
+  const { siteToken, env = "latest", resolveEnv, lang } = options;
   const cache = options.cache ?? new MemoryCache();
   let syncClient = null;
   async function getContent(search2) {
     if (!search2 && !syncClient) {
-      syncClient = await createClient({ siteToken, env, cdn, lang, cache });
+      syncClient = await createSyncClient({ siteToken, env, resolveEnv, lang, cache });
     }
     if (syncClient) return syncClient.getContent(search2);
     if (!search2) return null;
-    return await fetchSiteContent({ siteToken, env, search: search2, lang, cache, cdn });
+    return await fetchSiteContent({ siteToken, env, search: search2, lang, cache, resolveEnv });
   }
   async function getPages(path) {
     if (syncClient) return syncClient.getPages(path);
-    const pages = await fetchSiteContent({ siteToken, env, search: "pages", lang, cache, cdn });
+    const pages = await fetchSiteContent({ siteToken, env, search: "pages", lang, cache, resolveEnv });
     if (!path) return pages;
     else return filterPagesByPath(pages, path);
   }
   async function getPage(path) {
     if (syncClient) return syncClient.getPage(path);
-    const pages = await fetchSiteContent({ siteToken, env, search: "pages", lang, cache, cdn });
+    const pages = await fetchSiteContent({ siteToken, env, search: "pages", lang, cache, resolveEnv });
     const page = pages == null ? void 0 : pages.find((p) => {
       const pth = typeof p._path === "string" ? p._path : "";
       return pth === path;
@@ -261,21 +269,21 @@ function createAsyncClient(options) {
   async function getEntry(handle) {
     if (syncClient) return syncClient.getEntry(handle);
     let search2 = `entries.${handle}`;
-    return await fetchSiteContent({ siteToken, env, search: search2, lang, cache, cdn });
+    return await fetchSiteContent({ siteToken, env, search: search2, lang, cache, resolveEnv });
   }
   async function getSlugs(path) {
     if (syncClient) return syncClient.getSlugs(path);
-    const pages = await fetchSiteContent({ siteToken, env, search: "pages", lang, cache, cdn });
+    const pages = await fetchSiteContent({ siteToken, env, search: "pages", lang, cache, resolveEnv });
     return extractSlugs(pages, path);
   }
   async function getImage(name) {
     if (syncClient) return syncClient.getImage(name);
-    const images = await fetchSiteContent({ siteToken, env, search: "images", lang, cache, cdn });
+    const images = await fetchSiteContent({ siteToken, env, search: "images", lang, cache, resolveEnv });
     return images ? images[name] : null;
   }
   async function getOptions(name) {
     if (syncClient) return syncClient.getOptions(name);
-    const options2 = await fetchSiteContent({ siteToken, env, search: "options", lang, cache, cdn });
+    const options2 = await fetchSiteContent({ siteToken, env, search: "options", lang, cache, resolveEnv });
     const optionSet = options2[name];
     return Array.isArray(optionSet) ? optionSet : null;
   }
@@ -301,5 +309,5 @@ function createAsyncClient(options) {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   createAsyncClient,
-  createClient
+  createSyncClient
 });

package/index.d.cts

@@ -33,7 +33,7 @@ interface AsyncCacheAdapter {
 interface ClientOptions {
     siteToken: string;
     env?: string;
-    cdn?: boolean;
+    resolveEnv?: boolean;
     lang?: string;
     cache?: SyncCacheAdapter | AsyncCacheAdapter;
     cacheMinutes?: number;
@@ -59,7 +59,7 @@ interface SleekAsyncClient {
     _getEnvTag(): Promise<string>;
 }
 
-declare function createClient(options: ClientOptions): Promise<SleekClient>;
+declare function createSyncClient(options: ClientOptions): Promise<SleekClient>;
 declare function createAsyncClient(options: ClientOptions): SleekAsyncClient | any;
 
-export { type AsyncCacheAdapter, type ClientOptions, type Entry, type Image, type Options, type Page, type SleekAsyncClient, type SleekClient, type SleekSiteContent, type SyncCacheAdapter, createAsyncClient, createClient };
+export { type AsyncCacheAdapter, type ClientOptions, type Entry, type Image, type Options, type Page, type SleekAsyncClient, type SleekClient, type SleekSiteContent, type SyncCacheAdapter, createAsyncClient, createSyncClient };

package/index.d.ts

@@ -33,7 +33,7 @@ interface AsyncCacheAdapter {
 interface ClientOptions {
     siteToken: string;
     env?: string;
-    cdn?: boolean;
+    resolveEnv?: boolean;
     lang?: string;
     cache?: SyncCacheAdapter | AsyncCacheAdapter;
     cacheMinutes?: number;
@@ -59,7 +59,7 @@ interface SleekAsyncClient {
     _getEnvTag(): Promise<string>;
 }
 
-declare function createClient(options: ClientOptions): Promise<SleekClient>;
+declare function createSyncClient(options: ClientOptions): Promise<SleekClient>;
 declare function createAsyncClient(options: ClientOptions): SleekAsyncClient | any;
 
-export { type AsyncCacheAdapter, type ClientOptions, type Entry, type Image, type Options, type Page, type SleekAsyncClient, type SleekClient, type SleekSiteContent, type SyncCacheAdapter, createAsyncClient, createClient };
+export { type AsyncCacheAdapter, type ClientOptions, type Entry, type Image, type Options, type Page, type SleekAsyncClient, type SleekClient, type SleekSiteContent, type SyncCacheAdapter, createAsyncClient, createSyncClient };

package/index.mjs

@@ -41,16 +41,20 @@ async function fetchEnvTag({ siteToken, env }) {
   return env;
 }
 async function fetchSiteContent(options) {
-  const { siteToken, env = "latest", cdn = false, search: search2, lang, cache, cacheMinutes } = options;
+  const { siteToken, env = "latest", resolveEnv = false, search: search2, lang, cache, cacheMinutes } = options;
   let url = getUrl({ siteToken, env, search: search2, lang });
-  if (!cdn) {
+  if (!resolveEnv) {
     const cacheKey2 = `${siteToken}:${env}`;
     let tag = envTagCache.get(cacheKey2);
-    if (!tag) {
-      tag = await fetchEnvTag({ siteToken, env });
-      envTagCache.set(cacheKey2, tag);
+    try {
+      if (!tag) {
+        tag = await fetchEnvTag({ siteToken, env });
+        envTagCache.set(cacheKey2, tag);
+      }
+      url = getUrl({ siteToken, env: tag, search: search2, lang });
+    } catch (error) {
+      console.warn("[SleekCMS] Failed to resolve env tag, using cached content instead.");
     }
-    url = getUrl({ siteToken, env: tag, search: search2, lang });
   }
   const cacheKey = url;
   const fetchAndCache = async () => {
@@ -93,7 +97,11 @@ async function fetchSiteContent(options) {
               const expiryMs = cacheMinutes * 60 * 1e3;
               const age = now - cachedData._ts;
               if (age >= expiryMs) {
-                return await fetchAndCache();
+                try {
+                  return await fetchAndCache();
+                } catch (error) {
+                  console.warn("[SleekCMS] Fetch failed, using expired cache:", error);
+                }
               }
             }
             return cachedData.data;
@@ -138,7 +146,7 @@ var MemoryCache = class {
     this.cache.set(key, value);
   }
 };
-async function createClient(options) {
+async function createSyncClient(options) {
   const cache = options.cache ?? new MemoryCache();
   const data = await fetchSiteContent({ ...options, cache });
   function getContent(query) {
@@ -196,26 +204,26 @@ async function createClient(options) {
   };
 }
 function createAsyncClient(options) {
-  const { siteToken, env = "latest", cdn, lang } = options;
+  const { siteToken, env = "latest", resolveEnv, lang } = options;
   const cache = options.cache ?? new MemoryCache();
   let syncClient = null;
   async function getContent(search2) {
     if (!search2 && !syncClient) {
-      syncClient = await createClient({ siteToken, env, cdn, lang, cache });
+      syncClient = await createSyncClient({ siteToken, env, resolveEnv, lang, cache });
     }
     if (syncClient) return syncClient.getContent(search2);
     if (!search2) return null;
-    return await fetchSiteContent({ siteToken, env, search: search2, lang, cache, cdn });
+    return await fetchSiteContent({ siteToken, env, search: search2, lang, cache, resolveEnv });
   }
   async function getPages(path) {
     if (syncClient) return syncClient.getPages(path);
-    const pages = await fetchSiteContent({ siteToken, env, search: "pages", lang, cache, cdn });
+    const pages = await fetchSiteContent({ siteToken, env, search: "pages", lang, cache, resolveEnv });
     if (!path) return pages;
     else return filterPagesByPath(pages, path);
   }
   async function getPage(path) {
     if (syncClient) return syncClient.getPage(path);
-    const pages = await fetchSiteContent({ siteToken, env, search: "pages", lang, cache, cdn });
+    const pages = await fetchSiteContent({ siteToken, env, search: "pages", lang, cache, resolveEnv });
     const page = pages == null ? void 0 : pages.find((p) => {
       const pth = typeof p._path === "string" ? p._path : "";
       return pth === path;
@@ -225,21 +233,21 @@ function createAsyncClient(options) {
   async function getEntry(handle) {
     if (syncClient) return syncClient.getEntry(handle);
     let search2 = `entries.${handle}`;
-    return await fetchSiteContent({ siteToken, env, search: search2, lang, cache, cdn });
+    return await fetchSiteContent({ siteToken, env, search: search2, lang, cache, resolveEnv });
   }
   async function getSlugs(path) {
     if (syncClient) return syncClient.getSlugs(path);
-    const pages = await fetchSiteContent({ siteToken, env, search: "pages", lang, cache, cdn });
+    const pages = await fetchSiteContent({ siteToken, env, search: "pages", lang, cache, resolveEnv });
     return extractSlugs(pages, path);
   }
   async function getImage(name) {
     if (syncClient) return syncClient.getImage(name);
-    const images = await fetchSiteContent({ siteToken, env, search: "images", lang, cache, cdn });
+    const images = await fetchSiteContent({ siteToken, env, search: "images", lang, cache, resolveEnv });
     return images ? images[name] : null;
   }
   async function getOptions(name) {
     if (syncClient) return syncClient.getOptions(name);
-    const options2 = await fetchSiteContent({ siteToken, env, search: "options", lang, cache, cdn });
+    const options2 = await fetchSiteContent({ siteToken, env, search: "options", lang, cache, resolveEnv });
     const optionSet = options2[name];
     return Array.isArray(optionSet) ? optionSet : null;
   }
@@ -264,5 +272,5 @@ function createAsyncClient(options) {
 }
 export {
   createAsyncClient,
-  createClient
+  createSyncClient
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sleekcms/client",
-  "version": "2.4.0",
+  "version": "3.0.0",
   "description": "Official SleekCMS content client for Node 18+ and browser",
   "type": "module",
   "main": "index.cjs",