@sleekcms/client 2.2.1 → 2.3.0

package/README.md

@@ -1,7 +1,9 @@
-# SleekCMS Client
+# @sleekcms/client
 
 Official JavaScript/TypeScript client for [SleekCMS](https://sleekcms.com) - a headless CMS that lets you manage content and deliver it via API.
 
+Sign in at [sleekcms.com](https://sleekcms.com), create your content models, add your content, then grab your site token and use this library to integrate content in your apps.
+
 ## Installation
 
 ```bash
@@ -211,12 +213,12 @@ const logo = client.getImage('logo');
 // { url: 'https://...', alt: '...', ... }
 ```
 
-### `getList(name)`
+### `getOptionSet(name)`
 
-Get a list (array of label/value pairs).
+Get a option set (array of label/value pairs).
 
 ```typescript
-const categories = client.getList('categories');
+const categories = client.getOptionSet('categories');
 // [{ label: 'Tech', value: 'tech' }, ...]
 ```
 
@@ -325,7 +327,7 @@ import type {
   Page,
   Entry,
   Image,
-  List 
+  Options 
 } from '@sleekcms/client';
 ```
 

package/index.cjs

@@ -209,11 +209,11 @@ async function createClient(options) {
     if (!name) return null;
     return data.images ? data.images[name] : null;
   }
-  function getList(name) {
+  function getOptionSet(name) {
     if (!name) return null;
-    const lists = data.lists ?? {};
-    const list = lists[name];
-    return Array.isArray(list) ? list : null;
+    const options2 = data.options ?? {};
+    const optionSet = options2[name];
+    return Array.isArray(optionSet) ? optionSet : null;
   }
   return {
     getContent,
@@ -222,7 +222,7 @@ async function createClient(options) {
     getEntry,
     getSlugs,
     getImage,
-    getList
+    getOptionSet
   };
 }
 function createAsyncClient(options) {
@@ -274,12 +274,12 @@ function createAsyncClient(options) {
     const images = await fetchSiteContent({ siteToken, env: tag ?? env, search: "images", lang, cache });
     return images ? images[name] : null;
   }
-  async function getList(name) {
+  async function getOptionSet(name) {
     if (cdn && !tag) tag = await fetchEnvTag({ siteToken, env });
-    if (syncClient) return syncClient.getList(name);
-    const lists = await fetchSiteContent({ siteToken, env: tag ?? env, search: "lists", lang, cache });
-    const list = lists[name];
-    return Array.isArray(list) ? list : null;
+    if (syncClient) return syncClient.getOptionSet(name);
+    const options2 = await fetchSiteContent({ siteToken, env: tag ?? env, search: "options", lang, cache });
+    const optionSet = options2[name];
+    return Array.isArray(optionSet) ? optionSet : null;
   }
   async function _getEnvTag() {
     let resp = await fetchEnvTag({ siteToken, env });
@@ -295,7 +295,7 @@ function createAsyncClient(options) {
     getEntry,
     getSlugs,
     getImage,
-    getList,
+    getOptionSet,
     _getFetchUrl,
     _getEnvTag
   };

package/index.d.cts

@@ -7,7 +7,7 @@ type Image = {
     url: string;
     [key: string]: unknown;
 };
-type List = Array<{
+type Options = Array<{
     label: string;
     value: string;
 }>;
@@ -17,7 +17,7 @@ interface SleekSiteContent {
     };
     pages?: Array<Page>;
     images?: Record<string, Image>;
-    lists?: Record<string, List>;
+    options?: Record<string, Options>;
     config?: {
         title?: string;
     };
@@ -45,7 +45,7 @@ interface SleekClient {
     getEntry(handle: string): Entry | Entry[] | null;
     getSlugs(path: string): string[];
     getImage(name: string): Image | null;
-    getList(name: string): List | null;
+    getOptionSet(name: string): Options | null;
 }
 interface SleekAsyncClient {
     getContent(query?: string): Promise<SleekSiteContent>;
@@ -54,7 +54,7 @@ interface SleekAsyncClient {
     getEntry(handle: string): Promise<Entry | Entry[] | null>;
     getSlugs(path: string): Promise<string[]>;
     getImage(name: string): Promise<Image | null>;
-    getList(name: string): Promise<List | null>;
+    getOptionSet(name: string): Promise<Options | null>;
     _getFetchUrl(): string;
     _getEnvTag(): Promise<string>;
 }
@@ -62,4 +62,4 @@ interface SleekAsyncClient {
 declare function createClient(options: ClientOptions): Promise<SleekClient>;
 declare function createAsyncClient(options: ClientOptions): SleekAsyncClient | any;
 
-export { type AsyncCacheAdapter, type ClientOptions, type Entry, type Image, type List, 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, createClient };

package/index.d.ts

@@ -7,7 +7,7 @@ type Image = {
     url: string;
     [key: string]: unknown;
 };
-type List = Array<{
+type Options = Array<{
     label: string;
     value: string;
 }>;
@@ -17,7 +17,7 @@ interface SleekSiteContent {
     };
     pages?: Array<Page>;
     images?: Record<string, Image>;
-    lists?: Record<string, List>;
+    options?: Record<string, Options>;
     config?: {
         title?: string;
     };
@@ -45,7 +45,7 @@ interface SleekClient {
     getEntry(handle: string): Entry | Entry[] | null;
     getSlugs(path: string): string[];
     getImage(name: string): Image | null;
-    getList(name: string): List | null;
+    getOptionSet(name: string): Options | null;
 }
 interface SleekAsyncClient {
     getContent(query?: string): Promise<SleekSiteContent>;
@@ -54,7 +54,7 @@ interface SleekAsyncClient {
     getEntry(handle: string): Promise<Entry | Entry[] | null>;
     getSlugs(path: string): Promise<string[]>;
     getImage(name: string): Promise<Image | null>;
-    getList(name: string): Promise<List | null>;
+    getOptionSet(name: string): Promise<Options | null>;
     _getFetchUrl(): string;
     _getEnvTag(): Promise<string>;
 }
@@ -62,4 +62,4 @@ interface SleekAsyncClient {
 declare function createClient(options: ClientOptions): Promise<SleekClient>;
 declare function createAsyncClient(options: ClientOptions): SleekAsyncClient | any;
 
-export { type AsyncCacheAdapter, type ClientOptions, type Entry, type Image, type List, 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, createClient };

package/index.mjs

@@ -173,11 +173,11 @@ async function createClient(options) {
     if (!name) return null;
     return data.images ? data.images[name] : null;
   }
-  function getList(name) {
+  function getOptionSet(name) {
     if (!name) return null;
-    const lists = data.lists ?? {};
-    const list = lists[name];
-    return Array.isArray(list) ? list : null;
+    const options2 = data.options ?? {};
+    const optionSet = options2[name];
+    return Array.isArray(optionSet) ? optionSet : null;
   }
   return {
     getContent,
@@ -186,7 +186,7 @@ async function createClient(options) {
     getEntry,
     getSlugs,
     getImage,
-    getList
+    getOptionSet
   };
 }
 function createAsyncClient(options) {
@@ -238,12 +238,12 @@ function createAsyncClient(options) {
     const images = await fetchSiteContent({ siteToken, env: tag ?? env, search: "images", lang, cache });
     return images ? images[name] : null;
   }
-  async function getList(name) {
+  async function getOptionSet(name) {
     if (cdn && !tag) tag = await fetchEnvTag({ siteToken, env });
-    if (syncClient) return syncClient.getList(name);
-    const lists = await fetchSiteContent({ siteToken, env: tag ?? env, search: "lists", lang, cache });
-    const list = lists[name];
-    return Array.isArray(list) ? list : null;
+    if (syncClient) return syncClient.getOptionSet(name);
+    const options2 = await fetchSiteContent({ siteToken, env: tag ?? env, search: "options", lang, cache });
+    const optionSet = options2[name];
+    return Array.isArray(optionSet) ? optionSet : null;
   }
   async function _getEnvTag() {
     let resp = await fetchEnvTag({ siteToken, env });
@@ -259,7 +259,7 @@ function createAsyncClient(options) {
     getEntry,
     getSlugs,
     getImage,
-    getList,
+    getOptionSet,
     _getFetchUrl,
     _getEnvTag
   };

package/package.json

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