@content-island/api-client 0.3.1 → 0.5.0

package/README.md

@@ -6,25 +6,58 @@
 npm install @content-island/api-client
 ```
 
-## Usage
+## Examples
 
-```typescript
-import { createClient } from '@content-island/api-client';
+### Basic Usage
 
-const client = createClient({ accessToken: <your-token>});
+```typescript
+// Your model
+interface Post {
+  id: string;
+  title: string;
+  body: string;
+  order: number;
+  language: 'es' | 'en';
+}
+```
 
-const project = client.getProject(); // Retrieve the project by access token
+```typescript
+import { createClient, mapContentToModel } from '@content-island/api-client';
 
-const contents = client.getContentList(); // Retrieve the list of contents in the project
+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
 
+// 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 content = client.getContent('content-id', { contentType: 'post'}); // Retrieve a content by id filtered by content type, for example 'post'
+```
+
+### Filter by language
+
+```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`
@@ -43,13 +76,13 @@ Creates a client instance.
 
 ##### `getProject()`
 
-Retrieves the project by access token.
+Retrieves the project details by access token.
 
-##### `getContentList(queryParams)`
+##### `getContentList(queryParams?)`
 
 Retrieves the list of contents in the project.
 
-##### `getContent(contentId, queryParams)`
+##### `getContent(id, queryParams?)`
 
 Retrieves a content by id.
 
@@ -57,49 +90,91 @@ Retrieves a content by id.
 
 The query parameters to filter the list of contents.
 
-| param         | Description                                                          |
-| ------------- | -------------------------------------------------------------------- |
-| `contentType` | The content type to filter the list of contents. For example: `post` |
+| 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({ ids: { 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`                                                                                              |
 
-### `mapFieldListToModel(fieldList)`
+| 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 fields: Field[] = [
-  {
-    id: '1',
-    name: 'title',
-    value: 'My title',
-    type: 'short-text',
-    isArray: false,
-    language: 'en',
-  },
-  {
-    id: '2',
-    name: 'body',
-    value: '# My body',
-    type: 'long-text',
-    isArray: false,
-    language: 'en',
-  },
-  {
-    id: '3',
-    name: 'order',
-    value: 1,
-    type: 'number',
-    isArray: false,
-    language: 'en',
-  },
-];
+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 = mapFieldListToModel<Post>(fields);
+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 }
 
-console.log(post); // { title: 'My title', body: '# My body', order: 1 }
+const spanishPost = mapContentToModel<Post>(fields, 'es');
+console.log(spanishPost); // { id: '1', title: 'Mi titulo', body: '# Mi texto largo en markdown', order: 1 }
 ```

package/dist/index.d.ts

@@ -1,4 +1,84 @@
-export type { Project, Content, Field, FieldType, Resource, ApiLookup } from '@content-island/b2b-api-model';
-export { createClient } from './client.js';
-export type { ApiClient, Options } from './client.js';
-export { mapFieldListToModel } from './mappers.js';
+declare type AllowedQueryKeys = keyof Pick<Query, 'id' | 'contentType' | 'language'>;
+
+export declare interface ApiClient {
+    getProject: () => Promise<Project>;
+    getContentList: (queryParam?: QueryParams) => Promise<Content[]>;
+    getContent: (id: string, queryParam?: QueryParams) => Promise<Content>;
+}
+
+export declare interface ApiLookup {
+    id: string;
+    name: string;
+}
+
+declare type BaseModel<Language> = {
+    id: string;
+    language?: Language;
+};
+
+export declare type ClientFilter = string | { in?: string[] };
+
+export declare interface Content {
+    id: string;
+    contentType: ApiLookup;
+    lastUpdate: Date;
+    fields: Field[];
+}
+
+export declare const createClient: (options: Options) => ApiClient;
+
+export declare interface Field {
+    id: string;
+    name: string;
+    value: any;
+    type: FieldType;
+    isArray: boolean;
+    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;
+};
+
+export declare const mapContentToModel: <Model extends BaseModel<Language>, Language = Model["language"]>(content: Content, language?: Language) => Model;
+
+export declare interface Options {
+    accessToken: string;
+    domain?: string;
+    apiVersion?: string;
+}
+
+export declare interface Project {
+    id: string;
+    name: string;
+    languages: string[];
+    entities?: ApiLookup[];
+}
+
+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>;
+
+export declare interface Resource {
+    name: string;
+    link: string;
+}
+
+export { }

package/dist/index.js

@@ -0,0 +1,54 @@
+const T = {
+  DEFAULT_API_CLIENT_DOMAIN: "api.contentisland.net",
+  DEFAULT_API_CLIENT_VERSION: "1.0"
+}, E = {
+  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)}`,
+  ""
+), u = (e) => e && Object.keys(e).length > 0 ? `?${S(e, "&")}` : "", o = {
+  PROYECT: "/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}`, {
+  headers: {
+    [E.SESSION_KEY]: `${E.SESSION_TYPE} ${t.accessToken}`
+  }
+}).then((n) => {
+  if (n.ok)
+    return n.json();
+  throw Error(
+    JSON.stringify({
+      status: n.status,
+      statusText: n.statusText
+    })
+  );
+}), $ = (e) => ({
+  getProject: () => c(o.PROYECT, 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 = (e, t) => Array.isArray(e == null ? void 0 : e.fields) ? O(e.fields, e.id, t) : {};
+export {
+  $ as createClient,
+  d as mapContentToModel
+};

package/dist/index.umd.cjs

@@ -0,0 +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={PROYECT:"/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.PROYECT,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"})});

package/package.json

@@ -1,41 +1,34 @@
 {
   "name": "@content-island/api-client",
-  "version": "0.3.1",
+  "version": "0.5.0",
   "description": "Content Island - REST API Client",
   "private": false,
+  "sideEffects": false,
   "author": "Lemoncode",
   "license": "MIT",
   "files": [
     "dist"
   ],
   "type": "module",
-  "module": "./dist/api-client.js",
-  "main": "./dist/api-client.umd.cjs",
+  "module": "./dist/index.js",
+  "main": "./dist/index.umd.cjs",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/api-client.js",
-      "require": "./dist/api-client.umd.cjs",
-      "types": "./dist/index.d.ts"
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.umd.cjs"
     }
   },
   "scripts": {
-    "prebuild": "if-env NODE_ENV=development && sh ./create-dev-env.sh || echo noop",
+    "prebuild:dev": "sh ./create-dev-env.sh",
+    "build:dev": "vite build --mode development",
     "build": "vite build",
-    "type-check": "tsc --noEmit",
-    "type-check:watch": "npm run type-check -- --watch --preserveWatchOutput",
+    "type-check": "tsc --noEmit --preserveWatchOutput",
     "test": "vitest run -c ./config/test/config.ts",
     "test:watch": "vitest -c ./config/test/config.ts"
   },
-  "dependencies": {
-    "@content-island/b2b-api-model": "^0.2.1"
-  },
   "devDependencies": {
-    "dotenv": "^16.3.1",
-    "if-env": "^1.0.4",
-    "typescript": "^5.2.2",
-    "vite": "^4.4.9",
-    "vite-plugin-dts": "^3.5.3",
-    "vitest": "^0.34.6"
+    "@content-island/b2b-api-model": "*"
   }
 }

package/dist/api-client.js

@@ -1,42 +0,0 @@
-const a = {
-  IS_PRODUCTION: !0,
-  DEFAULT_API_CLIENT_DOMAIN: "api.contentisland.net",
-  DEFAULT_API_CLIENT_VERSION: "1.0"
-}, s = {
-  SESSION_KEY: "authorization",
-  SESSION_TYPE: "Bearer"
-}, S = (t, e) => Object.entries(t).reduce(
-  (n, [o, T], E) => E === 0 ? `${o}=${T}` : `${n}${e}${o}=${T}`,
-  ""
-), N = (t) => t && Object.keys(t).length > 0 ? `?${S(t, "&")}` : "", r = {
-  PROYECT: "/project",
-  CONTENT_LIST: (t) => `/contents${N(t)}`,
-  CONTENT: (t, e) => {
-    const n = N(e);
-    return `/contents/${t}${n}`;
-  }
-}, _ = (t) => {
-  const e = "https", n = t.domain ? t.domain : a.DEFAULT_API_CLIENT_DOMAIN, o = t.apiVersion ? t.apiVersion : a.DEFAULT_API_CLIENT_VERSION;
-  return `${e}://${n}/api/${o}`;
-}, c = async (t, e) => fetch(`${_(e)}${t}`, {
-  headers: {
-    [s.SESSION_KEY]: `${s.SESSION_TYPE} ${e.accessToken}`
-  }
-}).then((n) => {
-  if (n.ok)
-    return n.json();
-  throw Error(
-    JSON.stringify({
-      status: n.status,
-      statusText: n.statusText
-    })
-  );
-}), O = (t) => ({
-  getProject: () => c(r.PROYECT, t),
-  getContentList: (e) => c(r.CONTENT_LIST(e), t),
-  getContent: (e, n) => c(r.CONTENT(e, n), t)
-}), I = (t) => t.reduce((e, n) => ({ ...e, [n.name]: n.value }), {}), i = (t) => Array.isArray(t) ? I(t) : {};
-export {
-  O as createClient,
-  i as mapFieldListToModel
-};

package/dist/api-client.umd.cjs

@@ -1 +0,0 @@
-(function(o,r){typeof exports=="object"&&typeof module<"u"?r(exports):typeof define=="function"&&define.amd?define(["exports"],r):(o=typeof globalThis<"u"?globalThis:o||self,r(o.ApiClient={}))})(this,function(o){"use strict";const r={IS_PRODUCTION:!0,DEFAULT_API_CLIENT_DOMAIN:"api.contentisland.net",DEFAULT_API_CLIENT_VERSION:"1.0"},T={SESSION_KEY:"authorization",SESSION_TYPE:"Bearer"},S=(t,e)=>Object.entries(t).reduce((n,[i,N],_)=>_===0?`${i}=${N}`:`${n}${e}${i}=${N}`,""),a=t=>t&&Object.keys(t).length>0?`?${S(t,"&")}`:"",c={PROYECT:"/project",CONTENT_LIST:t=>`/contents${a(t)}`,CONTENT:(t,e)=>{const n=a(e);return`/contents/${t}${n}`}},u=t=>{const e="https",n=t.domain?t.domain:r.DEFAULT_API_CLIENT_DOMAIN,i=t.apiVersion?t.apiVersion:r.DEFAULT_API_CLIENT_VERSION;return`${e}://${n}/api/${i}`},s=async(t,e)=>fetch(`${u(e)}${t}`,{headers:{[T.SESSION_KEY]:`${T.SESSION_TYPE} ${e.accessToken}`}}).then(n=>{if(n.ok)return n.json();throw Error(JSON.stringify({status:n.status,statusText:n.statusText}))}),E=t=>({getProject:()=>s(c.PROYECT,t),getContentList:e=>s(c.CONTENT_LIST(e),t),getContent:(e,n)=>s(c.CONTENT(e,n),t)}),d=t=>t.reduce((e,n)=>({...e,[n.name]:n.value}),{}),O=t=>Array.isArray(t)?d(t):{};o.createClient=E,o.mapFieldListToModel=O,Object.defineProperty(o,Symbol.toStringTag,{value:"Module"})});

package/dist/client.d.ts

@@ -1,13 +0,0 @@
-import { Project, Content } from '@content-island/b2b-api-model';
-import { QueryParams } from './model.js';
-export interface Options {
-    accessToken: string;
-    domain?: string;
-    apiVersion?: string;
-}
-export interface ApiClient {
-    getProject: () => Promise<Project>;
-    getContentList: (queryParam?: QueryParams) => Promise<Content[]>;
-    getContent: (id: string, queryParam?: QueryParams) => Promise<Content>;
-}
-export declare const createClient: (options: Options) => ApiClient;

package/dist/client.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/constants.d.ts

@@ -1,12 +0,0 @@
-export declare const ENV_CONSTANTS: {
-    IS_PRODUCTION: boolean;
-    DEFAULT_API_CLIENT_DOMAIN: string;
-    DEFAULT_API_CLIENT_VERSION: string;
-};
-export declare const AUTH_CONSTANTS: {
-    SESSION_KEY: string;
-    SESSION_TYPE: string;
-};
-export declare const ALLOWED_QUERIES: {
-    contentType: string;
-};

package/dist/helpers.d.ts

@@ -1,2 +0,0 @@
-import { QueryParams } from './model.js';
-export declare const formatQuery: (queryParams: QueryParams) => string;

package/dist/helpers.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/mappers.d.ts

@@ -1,2 +0,0 @@
-import { Field } from '@content-island/b2b-api-model';
-export declare const mapFieldListToModel: <Model>(fields: Field[]) => Model;

package/dist/mappers.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/model.d.ts

@@ -1,2 +0,0 @@
-import { ALLOWED_QUERIES } from './constants.js';
-export type QueryParams = Partial<typeof ALLOWED_QUERIES>;

package/dist/urls.d.ts

@@ -1,6 +0,0 @@
-import { QueryParams } from './model.js';
-export declare const API_URLS: {
-    PROYECT: string;
-    CONTENT_LIST: (queryParam: QueryParams) => string;
-    CONTENT: (id: string, querParams: QueryParams) => string;
-};