@content-island/api-client 0.10.0 → 0.11.0

package/dist/index.d.ts

@@ -1,9 +1,14 @@
+declare type AllowedModelFields<M extends Model, ValueType> = Partial<Omit<{
+    [K in keyof M as M[K] extends string | number | boolean ? `fields.${string & K}` : never]?: ValueType;
+}, 'fields.id' | 'fields.language'>>;
+
 export declare interface ApiClient {
     getProject: () => Promise<Project>;
-    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>;
+    getContentList: <M extends Model = Model & Record<string, any>>(queryParam?: ContentListQueryParams<M>) => Promise<M[]>;
+    getContent: <M extends Model = Model & Record<string, any>>(queryParam: ContentQueryParams<M>) => Promise<M>;
+    getRawContentList: <M extends Model = Model & Record<string, any>>(queryParam?: ContentListQueryParams<M>) => Promise<Content[]>;
+    getRawContent: <M extends Model = Model & Record<string, any>>(queryParam: ContentQueryParams<M>) => Promise<Content>;
+    getContentListSize: <M extends Model = Model & Record<string, any>>(queryParam?: ContentListSizeQueryParams<M>) => Promise<number>;
 }
 
 export declare type ClientFilter<Type = string | boolean> = Type | {
@@ -17,6 +22,12 @@ export declare interface Content {
     fields: Field[];
 }
 
+export declare type ContentListQueryParams<M extends Model = Model & Record<string, any>> = QueryParams<M>;
+
+export declare type ContentListSizeQueryParams<M extends Model = Model & Record<string, any>> = Omit<QueryParams<M>, 'sort' | 'pagination' | 'includeRelatedContent'>;
+
+export declare type ContentQueryParams<M extends Model = Model & Record<string, any>> = Omit<QueryParams<M>, 'sort' | 'pagination'>;
+
 declare interface ContentType extends Lookup {
     fields: ContentTypeField[];
 }
@@ -52,6 +63,200 @@ export declare type FieldType =
 | 'color'
 | FieldEntityType;
 
+declare type FilterableFields<M extends Model = Model> = {
+    id?: ClientFilter;
+    lastUpdate?: ClientFilter;
+    language?: ClientFilter<M['language'] extends undefined ? string : M['language']>;
+    contentType?: ClientFilter;
+    includeRelatedContent?: boolean;
+} & AllowedModelFields<M, ClientFilter>;
+
+declare type LanguageCode =
+| 'aa'
+| 'ab'
+| 'ae'
+| 'af'
+| 'ak'
+| 'am'
+| 'an'
+| 'ar'
+| 'as'
+| 'av'
+| 'ay'
+| 'az'
+| 'ba'
+| 'be'
+| 'bg'
+| 'bh'
+| 'bi'
+| 'bm'
+| 'bn'
+| 'bo'
+| 'br'
+| 'bs'
+| 'ca'
+| 'ce'
+| 'ch'
+| 'co'
+| 'cr'
+| 'cs'
+| 'cu'
+| 'cv'
+| 'cy'
+| 'da'
+| 'de'
+| 'dv'
+| 'dz'
+| 'ee'
+| 'el'
+| 'en'
+| 'eo'
+| 'es'
+| 'et'
+| 'eu'
+| 'fa'
+| 'ff'
+| 'fi'
+| 'fj'
+| 'fo'
+| 'fr'
+| 'fy'
+| 'ga'
+| 'gd'
+| 'gl'
+| 'gn'
+| 'gu'
+| 'gv'
+| 'ha'
+| 'he'
+| 'hi'
+| 'ho'
+| 'hr'
+| 'ht'
+| 'hu'
+| 'hy'
+| 'hz'
+| 'ia'
+| 'id'
+| 'ie'
+| 'ig'
+| 'ii'
+| 'ik'
+| 'io'
+| 'is'
+| 'it'
+| 'iu'
+| 'ja'
+| 'jv'
+| 'ka'
+| 'kg'
+| 'ki'
+| 'kj'
+| 'kk'
+| 'kl'
+| 'km'
+| 'kn'
+| 'ko'
+| 'kr'
+| 'ks'
+| 'ku'
+| 'kv'
+| 'kw'
+| 'ky'
+| 'la'
+| 'lb'
+| 'lg'
+| 'li'
+| 'ln'
+| 'lo'
+| 'lt'
+| 'lu'
+| 'lv'
+| 'mg'
+| 'mh'
+| 'mi'
+| 'mk'
+| 'ml'
+| 'mn'
+| 'mr'
+| 'ms'
+| 'mt'
+| 'my'
+| 'na'
+| 'nb'
+| 'nd'
+| 'ne'
+| 'ng'
+| 'nl'
+| 'nn'
+| 'no'
+| 'nr'
+| 'nv'
+| 'ny'
+| 'oc'
+| 'oj'
+| 'om'
+| 'or'
+| 'os'
+| 'pa'
+| 'pi'
+| 'pl'
+| 'ps'
+| 'pt'
+| 'qu'
+| 'rm'
+| 'rn'
+| 'ro'
+| 'ru'
+| 'rw'
+| 'sa'
+| 'sc'
+| 'sd'
+| 'se'
+| 'sg'
+| 'si'
+| 'sk'
+| 'sl'
+| 'sm'
+| 'sn'
+| 'so'
+| 'sq'
+| 'sr'
+| 'ss'
+| 'st'
+| 'su'
+| 'sv'
+| 'sw'
+| 'ta'
+| 'te'
+| 'tg'
+| 'th'
+| 'ti'
+| 'tk'
+| 'tl'
+| 'tn'
+| 'to'
+| 'tr'
+| 'ts'
+| 'tt'
+| 'tw'
+| 'ty'
+| 'ug'
+| 'uk'
+| 'ur'
+| 'uz'
+| 've'
+| 'vi'
+| 'vo'
+| 'wa'
+| 'wo'
+| 'xh'
+| 'yi'
+| 'yo'
+| 'za'
+| 'zh'
+| 'zu';
+
 export declare interface Lookup<ID = string> {
     id: ID;
     name: string;
@@ -76,23 +281,28 @@ export declare interface Options {
     apiVersion?: string;
 }
 
+declare type Pagination = {
+    take?: number;
+    skip?: number;
+};
+
 export declare interface Project {
     id: string;
     name: string;
-    languages: string[];
+    languages: LanguageCode[];
     contentTypes?: ContentType[];
 }
 
-declare type Query<M extends Model = Model> = {
-    id?: ClientFilter;
-    lastUpdate?: ClientFilter;
-    language?: ClientFilter<M['language'] extends undefined ? string : M['language']>;
-    contentType?: ClientFilter;
-    includeRelatedContent?: boolean;
-} & Partial<Omit<{
-    [K in keyof M as `fields.${string & K}`]: ClientFilter;
-}, 'fields.id' | 'fields.language'>>;
+declare type QueryParams<M extends Model = Model & Record<string, any>> = FilterableFields<M> & {
+    sort?: SortableFields<M>;
+    pagination?: Pagination;
+};
+
+declare type SortableFields<M extends Model> = {
+    contentType?: SortOrder;
+    lastUpdate?: SortOrder;
+} & AllowedModelFields<M, SortOrder>;
 
-export declare type QueryParams<M extends Model = Model & Record<string, any>> = Query<M>;
+declare type SortOrder = 'asc' | 'desc';
 
 export { }

package/dist/index.js

@@ -1,42 +1,55 @@
-const a = {
+const N = {
   IS_PRODUCTION: !0,
   DEFAULT_API_CLIENT_DOMAIN: "api.contentisland.net",
   DEFAULT_API_CLIENT_VERSION: "1.0"
-}, u = {
+}, $ = {
   SESSION_KEY: "authorization",
   SESSION_TYPE: "Bearer"
-}, O = (t) => t == null ? void 0 : t.includes("|"), S = (t, e) => Array.isArray(t) ? t.map(e) : [], C = (t, e) => t.isArray ? S(t.value, (o) => c(o, e)) : c(t.value, e), I = (t) => O(t.type) && (t.isArray ? t.value.every((e) => typeof e == "object" && "contentType" in e) : typeof t.value == "object" && "contentType" in t.value), _ = (t, e) => t.reduce(
+}, g = (t) => t == null ? void 0 : t.includes("|"), l = (t, e) => Array.isArray(t) ? t.map(e) : [], I = (t, e) => t.isArray ? l(t.value, (o) => T(o, e)) : T(t.value, e), O = (t) => g(t.type) && (t.isArray ? t.value.every((e) => typeof e == "object" && "contentType" in e) : typeof t.value == "object" && "contentType" in t.value), _ = (t, e) => t.reduce(
   (o, n) => ({
     ...o,
-    [n.name]: I(n) ? C(n, e) : n.value
+    [n.name]: O(n) ? I(n, e) : n.value
   }),
   {}
-), A = (t, e, o) => {
-  var l;
-  const n = o ?? ((l = t[0]) == null ? void 0 : l.language), r = t.filter((g) => g.language === n), s = _(r, n);
-  return Object.keys(s).length === 0 && console.warn(`No fields found for language "${n}" and content id "${e}"`), {
+), C = (t, e, o) => {
+  var s;
+  const n = o ?? ((s = t[0]) == null ? void 0 : s.language), r = t.filter((E) => E.language === n), c = _(r, n);
+  return Object.keys(c).length === 0 && console.warn(`No fields found for language "${n}" and content id "${e}"`), {
     id: e,
     language: n,
-    ...s
+    ...c
   };
-}, c = (t, e) => Array.isArray(t == null ? void 0 : t.fields) ? A(t.fields, t.id, e) : {}, N = (t, e) => {
+}, T = (t, e) => Array.isArray(t == null ? void 0 : t.fields) ? C(t.fields, t.id, e) : {}, u = (t, e) => {
   if (typeof e == "string" || typeof e == "boolean")
     return `${t}=${e}`;
   if (e.in)
     return `${t}[in]=${e.in.join(",")}`;
-}, $ = (t, e) => Object.entries(t).reduce(
-  (o, [n, r], s) => s === 0 ? N(n, r) : `${o}${e}${N(n, r)}`,
-  ""
-), E = (t) => t && Object.keys(t).length > 0 ? `?${$(t, "&")}` : "", T = {
+}, p = (t) => Object.entries(t).map(([e, o]) => `${e}:${o}`).join(","), A = (t, e) => {
+  let o = "";
+  return t.take !== void 0 && (o += `take=${t.take}`), t.skip !== void 0 && (o += o ? `${e}skip=${t.skip}` : `skip=${t.skip}`), o;
+}, L = (t, e) => Object.entries(t).reduce((o, [n, r], c) => {
+  if (n === "sort" && typeof r == "object" && r !== null && !Array.isArray(r)) {
+    const s = p(r);
+    return c === 0 ? `sort=${s}` : `${o}${e}sort=${s}`;
+  } else if (n === "pagination" && typeof r == "object" && r !== null) {
+    const s = A(r, e);
+    return c === 0 ? s : `${o}${e}${s}`;
+  } else if (r !== void 0 && n !== "sort" && n !== "pagination") {
+    const s = r;
+    return c === 0 ? u(n, s) : `${o}${e}${u(n, s)}`;
+  }
+  return o;
+}, ""), S = (t) => t && Object.keys(t).length > 0 ? `?${L(t, "&")}` : "", i = {
   PROJECT: "/project",
-  CONTENT_LIST: (t) => `/contents${E(t)}`,
-  CONTENT: (t) => `/content${E(t)}`
+  CONTENT_LIST: (t) => `/contents${S(t)}`,
+  CONTENT: (t) => `/content${S(t)}`,
+  CONTENT_LIST_SIZE: (t) => t ? `/contents/size${S(t)}` : "/contents/size"
 }, d = (t) => {
-  const o = (t.secureProtocol === void 0 ? a.IS_PRODUCTION : t.secureProtocol) ? "https" : "http", n = t.domain ? t.domain : a.DEFAULT_API_CLIENT_DOMAIN, r = t.apiVersion ? t.apiVersion : a.DEFAULT_API_CLIENT_VERSION;
+  const o = (t.secureProtocol === void 0 ? N.IS_PRODUCTION : t.secureProtocol) ? "https" : "http", n = t.domain ? t.domain : N.DEFAULT_API_CLIENT_DOMAIN, r = t.apiVersion ? t.apiVersion : N.DEFAULT_API_CLIENT_VERSION;
   return `${o}://${n}/api/${r}`;
-}, i = async (t, e) => fetch(`${d(e)}${t}`, {
+}, a = async (t, e) => fetch(`${d(e)}${t}`, {
   headers: {
-    [u.SESSION_KEY]: `${u.SESSION_TYPE} ${e.accessToken}`
+    [$.SESSION_KEY]: `${$.SESSION_TYPE} ${e.accessToken}`
   }
 }).then((o) => {
   if (o.ok)
@@ -47,23 +60,24 @@ const a = {
       statusText: o.statusText
     })
   );
-}), p = (t) => {
-  const e = (n) => i(T.CONTENT_LIST(n), t), o = (n) => i(T.CONTENT(n), t);
+}), f = (t) => {
+  const e = (n) => a(i.CONTENT_LIST(n), t), o = (n) => a(i.CONTENT(n), t);
   return {
-    getProject: () => i(T.PROJECT, t),
+    getProject: () => a(i.PROJECT, t),
     getContentList: (n) => e(n).then(
       (r) => Array.isArray(r) ? r.map(
-        (s) => c(s, n == null ? void 0 : n.language)
+        (c) => T(c, n == null ? void 0 : n.language)
       ) : []
     ),
     getContent: (n) => o(n).then(
-      (r) => c(r, n == null ? void 0 : n.language)
+      (r) => T(r, n == null ? void 0 : n.language)
     ),
     getRawContentList: e,
-    getRawContent: o
+    getRawContent: o,
+    getContentListSize: (n) => a(i.CONTENT_LIST_SIZE(n), t)
   };
 };
 export {
-  p as createClient,
-  c as mapContentToModel
+  f as createClient,
+  T as mapContentToModel
 };

package/dist/index.umd.cjs

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

package/package.json

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