@content-island/api-client 0.2.1 → 0.3.0

package/README.md

@@ -0,0 +1,105 @@
+# @content-island/api-client
+
+## Installation
+
+```bash
+npm install @content-island/api-client
+```
+
+## Usage
+
+```typescript
+import { createClient } from '@content-island/api-client';
+
+const client = createClient({ accessToken: <your-token>});
+
+const project = client.getProject(); // Retrieve the project by access token
+
+const contents = client.getContentList(); // Retrieve the list of contents in the project
+
+const postContents = client.getContentList({ contentType: 'post'}); // Retrieve the list of contents in the project filtered by content type, for example 'post'
+
+const content = client.getContent('content-id'); // Retrieve a content by id
+
+const content = client.getContent('content-id', { contentType: 'post'}); // Retrieve a content by id filtered by content type, for example 'post'
+
+```
+
+## 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 by access token.
+
+##### `getContentList(queryParams)`
+
+Retrieves the list of contents in the project.
+
+##### `getContent(contentId, queryParams)`
+
+Retrieves a content by id.
+
+#### `queryParams`
+
+The query parameters to filter the list of contents.
+
+| param         | Description                                                          |
+| ------------- | -------------------------------------------------------------------- |
+| `contentType` | The content type to filter the list of contents. For example: `post` |
+
+### `mapFieldListToModel(fieldList)`
+
+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',
+  },
+];
+
+interface Post {
+  title: string;
+  body: string;
+  order: number;
+}
+
+const post = mapFieldListToModel<Post>(fields);
+
+console.log(post); // { title: 'My title', body: '# My body', order: 1 }
+```

package/dist/api-client.js

@@ -1,33 +1,42 @@
-const r = {
-  sessionKey: "authorization",
-  sessionType: "Bearer"
-}, i = {
-  DEFAULT_B2B_BASE_URL: "https://dev-content-island-b2b.azurewebsites.net/api/1.0"
-}, l = (e) => {
-  const { accessToken: t, baseUrl: n = i.DEFAULT_B2B_BASE_URL } = e;
-  return {
-    get: async (s) => fetch(`${n}/${s}`, {
-      headers: {
-        [r.sessionKey]: `${r.sessionType} ${t}`
-      }
-    }).then((o) => o.json())
-  };
-}, u = (e, t) => {
-  var n;
-  return (n = e.find((s) => s.name === t)) == null ? void 0 : n.value;
-}, a = (e) => Array.isArray(e.filterList) ? `?${y(e.filterList, "&")}` : "", y = (e, t) => Array.isArray(e) ? e.reduce(
-  (n, s, o, c) => c.length - 1 === o ? n += s : n += `${s}${t} `,
+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}`,
   ""
-) : "", $ = {
-  project: "/project",
-  contentList: (e) => `/contents${a(e)}`,
-  content: (e) => {
-    const t = a(e);
-    return `/contents/${e.id}${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 {
-  $ as API_URLS,
-  l as createContentIslandClient,
-  u as mapFieldToValue
+  O as createClient,
+  i as mapFieldListToModel
 };

package/dist/api-client.umd.cjs

@@ -1 +1 @@
-(function(t,o){typeof exports=="object"&&typeof module<"u"?o(exports):typeof define=="function"&&define.amd?define(["exports"],o):(t=typeof globalThis<"u"?globalThis:t||self,o(t.ApiClient={}))})(this,function(t){"use strict";const o={sessionKey:"authorization",sessionType:"Bearer"},c={DEFAULT_B2B_BASE_URL:"https://dev-content-island-b2b.azurewebsites.net/api/1.0"},d=e=>{const{accessToken:n,baseUrl:s=c.DEFAULT_B2B_BASE_URL}=e;return{get:async i=>fetch(`${s}/${i}`,{headers:{[o.sessionKey]:`${o.sessionType} ${n}`}}).then(r=>r.json())}},l=(e,n)=>{var s;return(s=e.find(i=>i.name===n))==null?void 0:s.value},a=e=>Array.isArray(e.filterList)?`?${u(e.filterList,"&")}`:"",u=(e,n)=>Array.isArray(e)?e.reduce((s,i,r,f)=>f.length-1===r?s+=i:s+=`${i}${n} `,""):"",y={project:"/project",contentList:e=>`/contents${a(e)}`,content:e=>{const n=a(e);return`/contents/${e.id}${n}`}};t.API_URLS=y,t.createContentIslandClient=d,t.mapFieldToValue=l,Object.defineProperty(t,Symbol.toStringTag,{value:"Module"})});
+(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,9 +1,13 @@
-interface Options {
+import { Project, Content } from '@content-island/b2b-api-model';
+import { QueryParams } from './model';
+export interface Options {
     accessToken: string;
-    baseUrl?: string;
+    domain?: string;
+    apiVersion?: string;
 }
-export interface ContentIslandClient {
-    get: <Entity>(url: string) => Promise<Entity>;
+export interface ApiClient {
+    getProject: () => Promise<Project>;
+    getContentList: (queryParam?: QueryParams) => Promise<Content[]>;
+    getContent: (id: string, queryParam?: QueryParams) => Promise<Content>;
 }
-export declare const createContentIslandClient: (options: Options) => ContentIslandClient;
-export {};
+export declare const createClient: (options: Options) => ApiClient;

package/dist/client.spec.d.ts

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

package/dist/constants.d.ts

@@ -1,7 +1,12 @@
-export declare const authConstants: {
-    sessionKey: string;
-    sessionType: string;
+export declare const ENV_CONSTANTS: {
+    IS_PRODUCTION: boolean;
+    DEFAULT_API_CLIENT_DOMAIN: string;
+    DEFAULT_API_CLIENT_VERSION: string;
 };
-export declare const envConstants: {
-    DEFAULT_B2B_BASE_URL: string;
+export declare const AUTH_CONSTANTS: {
+    SESSION_KEY: string;
+    SESSION_TYPE: string;
+};
+export declare const ALLOWED_QUERIES: {
+    contentType: string;
 };

package/dist/helpers.d.ts

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

package/dist/helpers.spec.d.ts

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

package/dist/index.d.ts

@@ -1,4 +1,3 @@
 export type { Project, Content, Field, FieldType, Resource, ApiLookup } from '@content-island/b2b-api-model';
 export * from './client';
 export * from './mappers';
-export * from './urls';

package/dist/mappers.d.ts

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

package/dist/mappers.spec.d.ts

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

package/dist/model.d.ts

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

package/dist/urls.d.ts

@@ -1,12 +1,6 @@
-interface BaseParams {
-    filterList: string[];
-}
-interface ContentParams extends BaseParams {
-    id: string;
-}
+import { QueryParams } from './model';
 export declare const API_URLS: {
-    project: string;
-    contentList: (params: BaseParams) => string;
-    content: (params: ContentParams) => string;
+    PROYECT: string;
+    CONTENT_LIST: (queryParam: QueryParams) => string;
+    CONTENT: (id: string, querParams: QueryParams) => string;
 };
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@content-island/api-client",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Content Island - REST API Client",
   "private": false,
   "author": "Lemoncode",
@@ -23,7 +23,9 @@
     "prebuild": "if-env NODE_ENV=development && sh ./create-dev-env.sh || echo noop",
     "build": "vite build",
     "type-check": "tsc --noEmit",
-    "type-check:watch": "npm run type-check -- --watch --preserveWatchOutput"
+    "type-check:watch": "npm run type-check -- --watch --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.0"
@@ -33,6 +35,7 @@
     "if-env": "^1.0.4",
     "typescript": "^5.2.2",
     "vite": "^4.4.9",
-    "vite-plugin-dts": "^3.5.3"
+    "vite-plugin-dts": "^3.5.3",
+    "vitest": "^0.34.6"
   }
 }