@content-island/api-client 0.7.0 → 0.8.1

package/README.md

@@ -22,159 +22,20 @@ interface Post {
 ```
 
 ```typescript
-import { createClient, mapContentToModel } from '@content-island/api-client';
+import { createClient } from '@content-island/api-client';
 
 const client = createClient({ accessToken: <your-token>});
 
-const postContents = client.getContentList({ contentType: 'post'}); // Retrieve the list of contents in the project filtered by content type, for example 'post'
-const englishPosts = postContents.map(content => mapContentToModel<Post>(content, 'en')); // Map the english content to your own model
-const spanishPosts = postContents.map(content => mapContentToModel<Post>(content, 'es')); // Map the spanish content to your own model
+const postsWithDefaultLanguage = client.getContentList<Post>({ contentType: 'post'}); // Retrieve the list of contents in the project filtered by content type, for example 'post' in the
+const englishPosts = client.getContentList<Post>({ contentType: 'post', language: 'en'}); // Get english posts
+const spanishPosts = client.getContentList<Post>({ contentType: 'post', language: 'es'}); // Get spanish posts
 
 // Or you can retrieve a content by id
-const content = client.getContent('content-id'); // Retrieve a content by id
-const englishPost = mapContentToModel<Post>(content, 'en'); // Map the english content to your own model
-const spanishPost = mapContentToModel<Post>(content, 'es'); // Map the spanish content to your own model
+const postById = client.getContent<Post>({ id: 'content-id', language: 'es' }); // Retrieve a content by id
+const postBySomeField = client.getContent<Post>({ 'fields.title': 'post-title', language: 'es' }); // Retrieve a content by field value
 
 ```
 
-### Filter by language
+### Documentation
 
-```typescript
-import { createClient, mapContentToModel } from '@content-island/api-client';
-
-const client = createClient({ accessToken: <your-token>});
-
-const englishPostContents = client.getContentList({ contentType: 'post', language: 'en'}); // Retrieve the english posts
-const englishPosts = englishPostContents.map(content => mapContentToModel<Post>(content)); // Map content to your own model using the first language available, in this case 'en'
-
-// Or you can retrieve contents by multiple languages
-const postContents = client.getContentList({ contentType: 'post', language: { in: ['en', 'es']}}); // Retrieve the english or spanish posts
-
-// Or you can retrieve a content by id
-const englishContent = client.getContent('content-id', { language: 'en'}); // Retrieve a content by id
-const englishPost = mapContentToModel<Post>(englishContent); // Map content to your own model using the first language available, in this case 'en'
-
-```
-
-> Check the [API/queryParams](#queryparams) section for more information about the query parameters.
-
-## API
-
-### `createClient(options): endpoints`
-
-Creates a client instance.
-
-#### `options`
-
-| name          | type     | required | description                                                 |
-| ------------- | -------- | -------- | ----------------------------------------------------------- |
-| `accessToken` | `string` | `true`   | The access token of the project                             |
-| `domain`      | `string` | `false`  | The domain of the project. Default: `api.contentisland.net` |
-| `apiVersion`  | `string` | `false`  | The version of the API. Default: `1.0`                      |
-
-#### `endpoints`
-
-##### `getProject()`
-
-Retrieves the project details by access token.
-
-##### `getContentList(queryParams?)`
-
-Retrieves the list of contents in the project.
-
-##### `getContent(id, queryParams?)`
-
-Retrieves a content by id.
-
-#### `queryParams`
-
-The query parameters to filter the list of contents.
-
-| Key           | Value    | Description                                                                                                                                                |
-| ------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id`          | `Filter` | The id of the content to retrieve. This is useful to retrieve a list of contents by id. For example: `client.getContentList({ id: { in: ['1', '2', '3']})` |
-| `contentType` | `Filter` | The content type to filter the list of contents. For example: `post`                                                                                       |
-| `language`    | `Filter` | The language to filter the list of contents. For example: `en`                                                                                             |
-
-| Filter type        | Description                                                        | Example                              |
-| ------------------ | ------------------------------------------------------------------ | ------------------------------------ |
-| `string`           | Filter the content where the param is `equal to` this value        | `{ contentType: 'post' }`            |
-| `{ in: string[] }` | Filter the content where the param `contains some` of these values | `{ language: { in: ['en', 'es'] } }` |
-
-### `mapContentToModel(content, language?)`
-
-Maps a list of fields to a model.
-
-```typescript
-const content: Content = {
-  id: '1',
-  contentType: { id: '10', name: 'post' },
-  lastUpdate: '2023-10-20T00:00:00.000Z',
-  fields: [
-    {
-      id: '100',
-      name: 'title',
-      value: 'My title',
-      type: 'short-text',
-      isArray: false,
-      language: 'en',
-    },
-    {
-      id: '200',
-      name: 'body',
-      value: '# My long text in markdown',
-      type: 'long-text',
-      isArray: false,
-      language: 'en',
-    },
-    {
-      id: '300',
-      name: 'order',
-      value: 1,
-      type: 'number',
-      isArray: false,
-      language: 'en',
-    },
-    {
-      id: '400',
-      name: 'title',
-      value: 'Mi titutlo',
-      type: 'short-text',
-      isArray: false,
-      language: 'es',
-    },
-    {
-      id: '500',
-      name: 'body',
-      value: '# Mi texto largo en markdown',
-      type: 'long-text',
-      isArray: false,
-      language: 'es',
-    },
-    {
-      id: '600',
-      name: 'order',
-      value: 1,
-      type: 'number',
-      isArray: false,
-      language: 'es',
-    },
-  ],
-};
-
-interface Post {
-  id: string;
-  title: string;
-  body: string;
-  order: number;
-}
-
-const post = mapContentToModel<Post>(fields); // Get the first language available, in this case 'en'
-console.log(post); // { id: '1', title: 'My title', body: '# My long text in markdown', order: 1 }
-
-const englishPost = mapContentToModel<Post>(fields, 'en');
-console.log(englishPost); // { id: '1', title: 'My title', body: '# My long text in markdown', order: 1 }
-
-const spanishPost = mapContentToModel<Post>(fields, 'es');
-console.log(spanishPost); // { id: '1', title: 'Mi titulo', body: '# Mi texto largo en markdown', order: 1 }
-```
+For more detailed documentation, please refer to the [Content Island API Client documentation](https://docs.contentisland.net/client-api/overview/).

package/dist/index.d.ts

@@ -1,9 +1,14 @@
-declare type AllowedQueryKeys = keyof Pick<Query, 'id' | 'contentType' | 'language'>;
+declare type AllowedQueryKeys<M extends Model = Model> = keyof Pick<
+Query<M>,
+'id' | 'contentType' | 'language' | Extract<keyof Query<M>, `fields.${string}`>
+>;
 
 export declare interface ApiClient {
     getProject: () => Promise<Project>;
-    getContentList: (queryParam?: QueryParams) => Promise<Content[]>;
-    getContent: (id: string, queryParam?: QueryParams) => Promise<Content>;
+    getContentList: <M extends Model = Model & Record<string, any>>(queryParam?: QueryParams<M>) => Promise<M[]>;
+    getContent: <M extends Model = Model & Record<string, any>>(queryParam: QueryParams<M>) => Promise<M>;
+    getRawContentList: <M extends Model = Model & Record<string, any>>(queryParam?: QueryParams<M>) => Promise<Content[]>;
+    getRawContent: <M extends Model = Model & Record<string, any>>(queryParam: QueryParams<M>) => Promise<Content>;
 }
 
 export declare interface ApiLookup {
@@ -11,12 +16,7 @@ export declare interface ApiLookup {
     name: string;
 }
 
-declare type BaseModel<Language> = {
-    id: string;
-    language?: Language;
-};
-
-export declare type ClientFilter = string | { in?: string[] };
+export declare type ClientFilter<Type = string> = Type | { in?: Type[] };
 
 export declare interface Content {
     id: string;
@@ -25,6 +25,17 @@ export declare interface Content {
     fields: Field[];
 }
 
+declare interface ContentType extends ApiLookup {
+    fields: ContentTypeField[];
+}
+
+declare interface ContentTypeField extends ApiLookup {
+    type: FieldType;
+    tsType: string;
+    isArray: boolean;
+    isRequired?: boolean;
+}
+
 export declare const createClient: (options: Options) => ApiClient;
 
 export declare interface Field {
@@ -36,31 +47,34 @@ export declare interface Field {
     language: string;
 }
 
-export declare type FieldType = 'short-text' | 'long-text' | 'number' | 'date' | 'date-time' | 'media' | 'boolean';
-
-declare type Filter =
-| string
-| {
-    ne?: string;
-    all?: string;
-    in?: string;
-    nin?: string;
-    lt?: string;
-    lte?: string;
-    gt?: string;
-    gte?: string;
-};
+declare type FieldEntityType = `${string}|${string}`;
+
+export declare type FieldType =
+| 'short-text'
+| 'long-text'
+| 'number'
+| 'date'
+| 'date-time'
+| 'media'
+| 'boolean'
+| FieldEntityType;
 
-export declare const mapContentToModel: <Model extends BaseModel<Language>, Language = Model["language"]>(content: Content, language?: Language) => Model;
+export declare const mapContentToModel: <M extends Model<Language> = Model<any> & Record<string, any>, Language = M["language"]>(content: Content, language?: Language) => M;
 
 export declare interface Media {
     name: string;
     url: string;
 }
 
+export declare type Model<Language = string> = {
+    id: string;
+    language?: Language;
+};
+
 export declare interface Options {
     accessToken: string;
     domain?: string;
+    secureProtocol?: boolean;
     apiVersion?: string;
 }
 
@@ -68,17 +82,23 @@ export declare interface Project {
     id: string;
     name: string;
     languages: string[];
-    contentTypes?: ApiLookup[];
+    contentTypes?: ContentType[];
 }
 
-declare type Query<F = Filter> = {
-    id?: F;
-    lastUpdate?: F;
-    language?: F;
-    contentType?: F;
-    [key: `fields.${string}`]: F;
-};
-
-export declare type QueryParams = Pick<Query<ClientFilter>, AllowedQueryKeys>;
+declare type Query<M extends Model = Model> = {
+    id?: ClientFilter;
+    lastUpdate?: ClientFilter;
+    language?: ClientFilter<M['language'] extends undefined ? string : M['language']>;
+    contentType?: ClientFilter;
+} & Partial<
+Omit<
+    {
+    [K in keyof M as `fields.${string & K}`]: ClientFilter;
+},
+'fields.id' | 'fields.language'
+>
+>;
+
+export declare type QueryParams<M extends Model = Model & Record<string, any>> = Pick<Query<M>, AllowedQueryKeys<M>>;
 
 export { }

package/dist/index.js

@@ -1,54 +1,63 @@
-const T = {
+const s = {
+  IS_PRODUCTION: !0,
   DEFAULT_API_CLIENT_DOMAIN: "api.contentisland.net",
   DEFAULT_API_CLIENT_VERSION: "1.0"
-}, E = {
+}, l = {
   SESSION_KEY: "authorization",
   SESSION_TYPE: "Bearer"
-}, N = (e, t) => {
-  if (typeof t == "string")
-    return `${e}=${t}`;
-  if (t.in)
-    return `${e}[in]=${t.in.join(",")}`;
-}, S = (e, t) => Object.entries(e).reduce(
-  (n, [r, s], a) => a === 0 ? N(r, s) : `${n}${t}${N(r, s)}`,
+}, O = (t) => t.reduce((e, o) => ({ ...e, [o.name]: o.value }), {}), S = (t, e, o) => {
+  var i;
+  const n = o ?? ((i = t[0]) == null ? void 0 : i.language), r = t.filter((u) => u.language === n), c = O(r);
+  return Object.keys(c).length === 0 && console.warn(`No fields found for language "${n}" and content id "${e}"`), {
+    id: e,
+    language: n,
+    ...c
+  };
+}, N = (t, e) => Array.isArray(t == null ? void 0 : t.fields) ? S(t.fields, t.id, e) : {}, E = (t, e) => {
+  if (typeof e == "string")
+    return `${t}=${e}`;
+  if (e.in)
+    return `${t}[in]=${e.in.join(",")}`;
+}, I = (t, e) => Object.entries(t).reduce(
+  (o, [n, r], c) => c === 0 ? E(n, r) : `${o}${e}${E(n, r)}`,
   ""
-), u = (e) => e && Object.keys(e).length > 0 ? `?${S(e, "&")}` : "", o = {
+), g = (t) => t && Object.keys(t).length > 0 ? `?${I(t, "&")}` : "", a = {
   PROJECT: "/project",
-  CONTENT_LIST: (e) => `/contents${u(e)}`,
-  CONTENT: (e, t) => {
-    const n = u(t);
-    return `/contents/${e}${n}`;
-  }
-}, _ = (e) => {
-  const t = "https", n = e.domain ? e.domain : T.DEFAULT_API_CLIENT_DOMAIN, r = e.apiVersion ? e.apiVersion : T.DEFAULT_API_CLIENT_VERSION;
-  return `${t}://${n}/api/${r}`;
-}, c = async (e, t) => fetch(`${_(t)}${e}`, {
+  CONTENT_LIST: (t) => `/contents${g(t)}`,
+  CONTENT: (t) => `/content${g(t)}`
+}, _ = (t) => {
+  const o = (t.secureProtocol === void 0 ? s.IS_PRODUCTION : t.secureProtocol) ? "https" : "http", n = t.domain ? t.domain : s.DEFAULT_API_CLIENT_DOMAIN, r = t.apiVersion ? t.apiVersion : s.DEFAULT_API_CLIENT_VERSION;
+  return `${o}://${n}/api/${r}`;
+}, T = async (t, e) => fetch(`${_(e)}${t}`, {
   headers: {
-    [E.SESSION_KEY]: `${E.SESSION_TYPE} ${t.accessToken}`
+    [l.SESSION_KEY]: `${l.SESSION_TYPE} ${e.accessToken}`
   }
-}).then((n) => {
-  if (n.ok)
-    return n.json();
+}).then((o) => {
+  if (o.ok)
+    return o.json();
   throw Error(
     JSON.stringify({
-      status: n.status,
-      statusText: n.statusText
+      status: o.status,
+      statusText: o.statusText
     })
   );
-}), $ = (e) => ({
-  getProject: () => c(o.PROJECT, e),
-  getContentList: (t) => c(o.CONTENT_LIST(t), e),
-  getContent: (t, n) => c(o.CONTENT(t, n), e)
-}), g = (e) => e.reduce((t, n) => ({ ...t, [n.name]: n.value }), {}), O = (e, t, n) => {
-  var i;
-  const r = n ?? ((i = e[0]) == null ? void 0 : i.language), s = e.filter((l) => l.language === r), a = g(s);
-  return Object.keys(a).length === 0 && console.warn(`No fields found for language "${r}" and content id "${t}"`), {
-    id: t,
-    language: r,
-    ...a
+}), d = (t) => {
+  const e = (n) => T(a.CONTENT_LIST(n), t), o = (n) => T(a.CONTENT(n), t);
+  return {
+    getProject: () => T(a.PROJECT, t),
+    getContentList: (n) => e(n).then(
+      (r) => Array.isArray(r) ? r.map(
+        (c) => N(c, n == null ? void 0 : n.language)
+      ) : []
+    ),
+    getContent: (n) => o(n).then(
+      (r) => N(r, n == null ? void 0 : n.language)
+    ),
+    getRawContentList: e,
+    getRawContent: o
   };
-}, d = (e, t) => Array.isArray(e == null ? void 0 : e.fields) ? O(e.fields, e.id, t) : {};
+};
 export {
-  $ as createClient,
-  d as mapContentToModel
+  d as createClient,
+  N as mapContentToModel
 };

package/dist/index.umd.cjs

@@ -1 +1 @@
-(function(s,r){typeof exports=="object"&&typeof module<"u"?r(exports):typeof define=="function"&&define.amd?define(["exports"],r):(s=typeof globalThis<"u"?globalThis:s||self,r(s.ApiClient={}))})(this,function(s){"use strict";const r={DEFAULT_API_CLIENT_DOMAIN:"api.contentisland.net",DEFAULT_API_CLIENT_VERSION:"1.0"},u={SESSION_KEY:"authorization",SESSION_TYPE:"Bearer"},l=(e,t)=>{if(typeof t=="string")return`${e}=${t}`;if(t.in)return`${e}[in]=${t.in.join(",")}`},N=(e,t)=>Object.entries(e).reduce((n,[o,a],i)=>i===0?l(o,a):`${n}${t}${l(o,a)}`,""),d=e=>e&&Object.keys(e).length>0?`?${N(e,"&")}`:"",c={PROJECT:"/project",CONTENT_LIST:e=>`/contents${d(e)}`,CONTENT:(e,t)=>{const n=d(t);return`/contents/${e}${n}`}},S=e=>{const t="https",n=e.domain?e.domain:r.DEFAULT_API_CLIENT_DOMAIN,o=e.apiVersion?e.apiVersion:r.DEFAULT_API_CLIENT_VERSION;return`${t}://${n}/api/${o}`},T=async(e,t)=>fetch(`${S(t)}${e}`,{headers:{[u.SESSION_KEY]:`${u.SESSION_TYPE} ${t.accessToken}`}}).then(n=>{if(n.ok)return n.json();throw Error(JSON.stringify({status:n.status,statusText:n.statusText}))}),f=e=>({getProject:()=>T(c.PROJECT,e),getContentList:t=>T(c.CONTENT_LIST(t),e),getContent:(t,n)=>T(c.CONTENT(t,n),e)}),g=e=>e.reduce((t,n)=>({...t,[n.name]:n.value}),{}),O=(e,t,n)=>{var E;const o=n??((E=e[0])==null?void 0:E.language),a=e.filter($=>$.language===o),i=g(a);return Object.keys(i).length===0&&console.warn(`No fields found for language "${o}" and content id "${t}"`),{id:t,language:o,...i}},_=(e,t)=>Array.isArray(e==null?void 0:e.fields)?O(e.fields,e.id,t):{};s.createClient=f,s.mapContentToModel=_,Object.defineProperty(s,Symbol.toStringTag,{value:"Module"})});
+(function(s,c){typeof exports=="object"&&typeof module<"u"?c(exports):typeof define=="function"&&define.amd?define(["exports"],c):(s=typeof globalThis<"u"?globalThis:s||self,c(s.ApiClient={}))})(this,function(s){"use strict";const c={IS_PRODUCTION:!0,DEFAULT_API_CLIENT_DOMAIN:"api.contentisland.net",DEFAULT_API_CLIENT_VERSION:"1.0"},u={SESSION_KEY:"authorization",SESSION_TYPE:"Bearer"},E=e=>e.reduce((t,o)=>({...t,[o.name]:o.value}),{}),S=(e,t,o)=>{var g;const n=o??((g=e[0])==null?void 0:g.language),i=e.filter(I=>I.language===n),r=E(i);return Object.keys(r).length===0&&console.warn(`No fields found for language "${n}" and content id "${t}"`),{id:t,language:n,...r}},l=(e,t)=>Array.isArray(e==null?void 0:e.fields)?S(e.fields,e.id,t):{},d=(e,t)=>{if(typeof t=="string")return`${e}=${t}`;if(t.in)return`${e}[in]=${t.in.join(",")}`},O=(e,t)=>Object.entries(e).reduce((o,[n,i],r)=>r===0?d(n,i):`${o}${t}${d(n,i)}`,""),N=e=>e&&Object.keys(e).length>0?`?${O(e,"&")}`:"",a={PROJECT:"/project",CONTENT_LIST:e=>`/contents${N(e)}`,CONTENT:e=>`/content${N(e)}`},f=e=>{const o=(e.secureProtocol===void 0?c.IS_PRODUCTION:e.secureProtocol)?"https":"http",n=e.domain?e.domain:c.DEFAULT_API_CLIENT_DOMAIN,i=e.apiVersion?e.apiVersion:c.DEFAULT_API_CLIENT_VERSION;return`${o}://${n}/api/${i}`},T=async(e,t)=>fetch(`${f(t)}${e}`,{headers:{[u.SESSION_KEY]:`${u.SESSION_TYPE} ${t.accessToken}`}}).then(o=>{if(o.ok)return o.json();throw Error(JSON.stringify({status:o.status,statusText:o.statusText}))}),C=e=>{const t=n=>T(a.CONTENT_LIST(n),e),o=n=>T(a.CONTENT(n),e);return{getProject:()=>T(a.PROJECT,e),getContentList:n=>t(n).then(i=>Array.isArray(i)?i.map(r=>l(r,n==null?void 0:n.language)):[]),getContent:n=>o(n).then(i=>l(i,n==null?void 0:n.language)),getRawContentList:t,getRawContent:o}};s.createClient=C,s.mapContentToModel=l,Object.defineProperty(s,Symbol.toStringTag,{value:"Module"})});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@content-island/api-client",
-  "version": "0.7.0",
+  "version": "0.8.1",
   "description": "Content Island - REST API Client",
   "private": false,
   "sideEffects": false,