@sleekcms/client 3.1.0 → 3.2.0

package/README.md

@@ -6,10 +6,52 @@ Sign in at [sleekcms.com](https://sleekcms.com), create your content models, add
 
 ## Installation
 
+### From NPM
+
 ```bash
 npm install @sleekcms/client
 ```
 
+### From CDN (Browser)
+
+Include the library directly in your HTML from a CDN:
+
+```html
+<!-- From unpkg -->
+<script src="https://unpkg.com/@sleekcms/client"></script>
+
+<!-- From jsdelivr -->
+<script src="https://cdn.jsdelivr.net/npm/@sleekcms/client"></script>
+
+<!-- Specific version -->
+<script src="https://unpkg.com/@sleekcms/client@3.1.0"></script>
+```
+
+The library is available globally as `SleekCMS`:
+
+```html
+<script src="https://unpkg.com/@sleekcms/client"></script>
+<script>
+  // Use the sync client
+  SleekCMS.createSyncClient({
+    siteToken: 'your-site-token',
+    env: 'latest'
+  }).then(client => {
+    const page = client.getPage('/about');
+    console.log(page);
+  });
+
+  // Or use the async client
+  const client = SleekCMS.createAsyncClient({
+    siteToken: 'your-site-token'
+  });
+  
+  client.getPage('/pricing').then(page => {
+    console.log(page);
+  });
+</script>
+```
+
 ## Quick Start
 
 ```typescript
@@ -168,7 +210,7 @@ const pages = client.getContent('pages');
 const title = client.getContent('config.title');
 ```
 
-### `getPages(path)`
+### `getPages(path, options?)`
 
 Get all pages that start with a specific path.
 
@@ -177,6 +219,17 @@ const posts = client.getPages('/blog');
 const products = client.getPages('/shop/products');
 ```
 
+**Options:**
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `collection` | `boolean` | If `true`, only returns pages that are part of a collection / multiple records |
+
+```typescript
+// Get only collection pages / multiple records
+const posts = client.getPages('/blog', { collection: true });
+```
+
 ### `getPage(path)`
 
 Get a single page by exact path. Returns `null` if not found.

package/index.cjs

@@ -164,11 +164,13 @@ function extractSlugs(pages, path) {
   }
   return slugs;
 }
-function filterPagesByPath(pages, path) {
+function filterPagesByPath(pages, path, options) {
   const pagesList = pages ?? [];
   return pagesList.filter((p) => {
     const pth = typeof p._path === "string" ? p._path : "";
-    return pth.startsWith(path);
+    if (path && !pth.startsWith(path)) return false;
+    if ((options == null ? void 0 : options.collection) && !("_slug" in p)) return false;
+    return true;
   });
 }
 
@@ -188,11 +190,11 @@ async function createSyncClient(options) {
   function getContent(query) {
     return applyJmes(data, query);
   }
-  function getPages(path) {
+  function getPages(path, options2) {
     if (!path) {
       throw new Error("[SleekCMS] path is required for getPages");
     }
-    return filterPagesByPath(data.pages, path);
+    return filterPagesByPath(data.pages, path, options2);
   }
   function getPage(path) {
     if (!path) {
@@ -251,11 +253,10 @@ function createAsyncClient(options) {
     if (!search2) return null;
     return await fetchSiteContent({ siteToken, env, search: search2, lang, cache, resolveEnv });
   }
-  async function getPages(path) {
-    if (syncClient) return syncClient.getPages(path);
+  async function getPages(path, options2) {
+    if (syncClient) return syncClient.getPages(path, options2);
     const pages = await fetchSiteContent({ siteToken, env, search: "pages", lang, cache, resolveEnv });
-    if (!path) return pages;
-    else return filterPagesByPath(pages, path);
+    return filterPagesByPath(pages, path, options2);
   }
   async function getPage(path) {
     if (syncClient) return syncClient.getPage(path);

package/index.d.cts

@@ -11,6 +11,9 @@ type Options = Array<{
     label: string;
     value: string;
 }>;
+type GetPagesOptions = {
+    collection?: boolean;
+};
 interface SleekSiteContent {
     entries?: {
         [handle: string]: Entry | Entry[];
@@ -40,7 +43,7 @@ interface ClientOptions {
 }
 interface SleekClient {
     getContent(query?: string): SleekSiteContent;
-    getPages(path: string): SleekSiteContent["pages"];
+    getPages(path: string, options?: GetPagesOptions): SleekSiteContent["pages"];
     getPage(path: string): Page | null;
     getEntry(handle: string): Entry | Entry[] | null;
     getSlugs(path: string): string[];
@@ -49,7 +52,7 @@ interface SleekClient {
 }
 interface SleekAsyncClient {
     getContent(query?: string): Promise<SleekSiteContent>;
-    getPages(path: string): Promise<SleekSiteContent["pages"]>;
+    getPages(path: string, options?: GetPagesOptions): Promise<SleekSiteContent["pages"]>;
     getPage(path: string): Promise<Page | null>;
     getEntry(handle: string): Promise<Entry | Entry[] | null>;
     getSlugs(path: string): Promise<string[]>;
@@ -62,4 +65,4 @@ interface SleekAsyncClient {
 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, createSyncClient };
+export { type AsyncCacheAdapter, type ClientOptions, type Entry, type GetPagesOptions, type Image, type Options, type Page, type SleekAsyncClient, type SleekClient, type SleekSiteContent, type SyncCacheAdapter, createAsyncClient, createSyncClient };

package/index.d.ts

@@ -11,6 +11,9 @@ type Options = Array<{
     label: string;
     value: string;
 }>;
+type GetPagesOptions = {
+    collection?: boolean;
+};
 interface SleekSiteContent {
     entries?: {
         [handle: string]: Entry | Entry[];
@@ -40,7 +43,7 @@ interface ClientOptions {
 }
 interface SleekClient {
     getContent(query?: string): SleekSiteContent;
-    getPages(path: string): SleekSiteContent["pages"];
+    getPages(path: string, options?: GetPagesOptions): SleekSiteContent["pages"];
     getPage(path: string): Page | null;
     getEntry(handle: string): Entry | Entry[] | null;
     getSlugs(path: string): string[];
@@ -49,7 +52,7 @@ interface SleekClient {
 }
 interface SleekAsyncClient {
     getContent(query?: string): Promise<SleekSiteContent>;
-    getPages(path: string): Promise<SleekSiteContent["pages"]>;
+    getPages(path: string, options?: GetPagesOptions): Promise<SleekSiteContent["pages"]>;
     getPage(path: string): Promise<Page | null>;
     getEntry(handle: string): Promise<Entry | Entry[] | null>;
     getSlugs(path: string): Promise<string[]>;
@@ -62,4 +65,4 @@ interface SleekAsyncClient {
 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, createSyncClient };
+export { type AsyncCacheAdapter, type ClientOptions, type Entry, type GetPagesOptions, type Image, type Options, type Page, type SleekAsyncClient, type SleekClient, type SleekSiteContent, type SyncCacheAdapter, createAsyncClient, createSyncClient };