@content-island/api-client 0.15.0 → 0.17.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-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;
+declare type AllowedFields<M extends Model, Type extends 'sort' | 'filter'> = Partial<Omit<{
+    [K in keyof M as IsPrimitive<NonNullable<M[K]>> extends true ? `fields.${string & K}` : never]?: Type extends 'sort' ? SortOrder : ClientFilter<NonNullable<M[K]>>;
 }, 'fields.id' | 'fields.language'>>;
 
 export declare interface ApiClient {
@@ -12,7 +12,13 @@ export declare interface ApiClient {
     updateContentFieldValue: (contentId: string, fieldId: string, value: any) => Promise<boolean>;
 }
 
-export declare type ClientFilter<Type = string | boolean> = Type | {
+declare interface BaseModel {
+    id: string;
+    name: string;
+    type: ModelType;
+}
+
+export declare type ClientFilter<Type = string | boolean | number> = Type | {
     in?: Type[];
     ne?: Type;
 };
@@ -31,10 +37,6 @@ export declare type ContentListSizeQueryParams<M extends Model = Model & Record<
 
 export declare type ContentQueryParams<M extends Model = Model & Record<string, any>> = Omit<QueryParams<M>, 'sort' | 'pagination'>;
 
-declare interface ContentType extends Lookup {
-    fields: ContentTypeField[];
-}
-
 declare interface ContentTypeField extends Lookup {
     type: FieldType;
     tsType: string;
@@ -44,6 +46,27 @@ declare interface ContentTypeField extends Lookup {
 
 export declare const createClient: (options: Options) => ApiClient;
 
+declare interface Entity extends BaseModel {
+    type: 'entity';
+    fieldList?: Field_2[];
+}
+
+declare type EntityContentType = Omit<Entity, 'fieldList'> & {
+    fields: ContentTypeField[];
+};
+
+declare interface Enum extends BaseModel {
+    type: 'enum';
+    values: EnumValue[];
+}
+
+declare type EnumContentType = Enum;
+
+declare interface EnumValue {
+    id: string;
+    value: string;
+}
+
 export declare interface Field {
     id: string;
     name: string;
@@ -53,7 +76,14 @@ export declare interface Field {
     language: string;
 }
 
-declare type FieldEntityType = `${string}|${string}`;
+declare interface Field_2 {
+    id: string;
+    name: string;
+    type: FieldType;
+    isArray: boolean;
+    order: number;
+    validations?: Validation[];
+}
 
 export declare type FieldType =
 | 'short-text'
@@ -64,15 +94,17 @@ export declare type FieldType =
 | 'media'
 | 'boolean'
 | 'color'
-| FieldEntityType;
+| RelatedModelType;
 
 declare type FilterableFields<M extends Model = Model> = {
-    id?: ClientFilter;
-    lastUpdate?: ClientFilter;
+    id?: ClientFilter<string>;
+    lastUpdate?: ClientFilter<string>;
     language?: M['language'];
-    contentType?: ClientFilter;
+    contentType?: ClientFilter<string>;
     includeRelatedContent?: boolean;
-} & AllowedModelFields<M, ClientFilter>;
+} & AllowedFields<M, 'filter'>;
+
+declare type IsPrimitive<T> = [T] extends [string | number | boolean] ? true : false;
 
 export declare type LanguageCode =
 | 'aa'
@@ -278,6 +310,8 @@ export declare type Model<Language = string> = {
     lastUpdate?: string;
 };
 
+declare type ModelType = 'entity' | 'enum';
+
 export declare interface Options {
     accessToken: string;
     domain?: string;
@@ -295,7 +329,7 @@ export declare interface Project {
     id: string;
     name: string;
     languages: LanguageCode[];
-    contentTypes?: ContentType[];
+    contentTypes?: (EntityContentType | EnumContentType)[];
 }
 
 declare type QueryParams<M extends Model = Model & Record<string, any>> = FilterableFields<M> & {
@@ -303,11 +337,15 @@ declare type QueryParams<M extends Model = Model & Record<string, any>> = Filter
     pagination?: Pagination;
 };
 
+declare type RelatedModelType = `${string}|${string}`;
+
 declare type SortableFields<M extends Model> = {
     contentType?: SortOrder;
     lastUpdate?: SortOrder;
-} & AllowedModelFields<M, SortOrder>;
+} & AllowedFields<M, 'sort'>;
 
 declare type SortOrder = 'asc' | 'desc';
 
+declare type Validation = { name: string; customArgs?: any };
+
 export { }

package/dist/index.js

@@ -1,26 +1,27 @@
-const N = (t, e) => {
-  if (typeof e == "string" || typeof e == "boolean")
-    return `${t}=${e}`;
+const l = (t, e) => `&${t}.type=${typeof e}`, A = (t) => typeof t == "string" || typeof t == "number" || typeof t == "boolean", O = (t, e, n) => `${t}=${e}${n ? l(t, e) : ""}`, N = (t, e) => {
+  const n = t.startsWith("fields.");
+  if (A(e))
+    return O(t, e, n);
   if (e.in)
-    return `${t}[in]=${e.in.join(",")}`;
-  if (e.ne)
-    return `${t}[ne]=${e.ne}`;
-}, A = (t) => Object.entries(t).map(([e, n]) => `${e}:${n}`).join(","), O = (t, e) => {
+    return `${t}[in]=${e.in.join(",")}${n && e.in.length > 0 ? l(t, e.in[0]) : ""}`;
+  if (e.ne !== void 0)
+    return `${t}[ne]=${e.ne}${n ? l(t, e.ne) : ""}`;
+}, _ = (t) => Object.entries(t).map(([e, n]) => `${e}:${n}`).join(","), p = (t, e) => {
   let n = "";
   return t.take !== void 0 && (n += `take=${t.take}`), t.skip !== void 0 && (n += n ? `${e}skip=${t.skip}` : `skip=${t.skip}`), n;
-}, _ = (t, e) => Object.entries(t).reduce((n, [o, s], a) => {
-  if (o === "sort" && typeof s == "object" && s !== null && !Array.isArray(s)) {
-    const r = A(s);
-    return a === 0 ? `sort=${r}` : `${n}${e}sort=${r}`;
-  } else if (o === "pagination" && typeof s == "object" && s !== null) {
-    const r = O(s, e);
-    return a === 0 ? r : `${n}${e}${r}`;
-  } else if (s !== void 0 && o !== "sort" && o !== "pagination") {
-    const r = s;
-    return a === 0 ? N(o, r) : `${n}${e}${N(o, r)}`;
+}, C = (t, e) => Object.entries(t).reduce((n, [o, r], a) => {
+  if (o === "sort" && typeof r == "object" && r !== null && !Array.isArray(r)) {
+    const s = _(r);
+    return a === 0 ? `sort=${s}` : `${n}${e}sort=${s}`;
+  } else if (o === "pagination" && typeof r == "object" && r !== null) {
+    const s = p(r, e);
+    return a === 0 ? s : `${n}${e}${s}`;
+  } else if (r !== void 0 && o !== "sort" && o !== "pagination") {
+    const s = r;
+    return a === 0 ? N(o, s) : `${n}${e}${N(o, s)}`;
   }
   return n;
-}, ""), S = (t) => t && Object.keys(t).length > 0 ? `?${_(t, "&")}` : "", $ = {
+}, ""), g = (t) => t && Object.keys(t).length > 0 ? `?${C(t, "&")}` : "", S = {
   IS_PRODUCTION: !0,
   DEFAULT_API_CLIENT_DOMAIN: "api.contentisland.net",
   DEFAULT_API_CLIENT_VERSION: "1.0"
@@ -28,10 +29,10 @@ const N = (t, e) => {
   SESSION_KEY: "authorization",
   SESSION_TYPE: "Bearer",
   METADATA_KEY: "x-metadata"
-}, l = (t) => {
-  const n = (t.secureProtocol === void 0 ? $.IS_PRODUCTION : t.secureProtocol) ? "https" : "http", o = t.domain ? t.domain : $.DEFAULT_API_CLIENT_DOMAIN, s = t.apiVersion ? t.apiVersion : $.DEFAULT_API_CLIENT_VERSION;
-  return `${n}://${o}/api/${s}`;
-}, d = async (t, e) => fetch(`${l(e)}${t}`, {
+}, d = (t) => {
+  const n = (t.secureProtocol === void 0 ? S.IS_PRODUCTION : t.secureProtocol) ? "https" : "http", o = t.domain ? t.domain : S.DEFAULT_API_CLIENT_DOMAIN, r = t.apiVersion ? t.apiVersion : S.DEFAULT_API_CLIENT_VERSION;
+  return `${n}://${o}/api/${r}`;
+}, I = async (t, e) => fetch(`${d(e)}${t}`, {
   headers: {
     [i.SESSION_KEY]: `${i.SESSION_TYPE} ${e.accessToken}`,
     ...e.metadata ? { [i.METADATA_KEY]: e.metadata } : {}
@@ -45,7 +46,7 @@ const N = (t, e) => {
       statusText: n.statusText
     })
   );
-}), C = async (t, e, n) => fetch(`${l(n)}${t}`, {
+}), L = async (t, e, n) => fetch(`${d(n)}${t}`, {
   method: "PUT",
   headers: {
     "Content-Type": "application/json",
@@ -63,51 +64,51 @@ const N = (t, e) => {
     })
   );
 }), T = {
-  get: d,
-  put: C
-}, I = (t) => t == null ? void 0 : t.includes("|"), p = (t, e) => Array.isArray(t) ? t.map(e) : [], L = (t, e) => t.isArray ? p(t.value, (n) => E(n, e)) : E(t.value, e), f = (t) => I(t.type) && (t.isArray ? t.value.every((e) => typeof e == "object" && "contentType" in e) : typeof t.value == "object" && "contentType" in t.value), h = (t, e) => t.reduce(
+  get: I,
+  put: L
+}, h = (t) => t == null ? void 0 : t.includes("|"), f = (t, e) => Array.isArray(t) ? t.map(e) : [], y = (t, e) => t.isArray ? f(t.value, (n) => E(n, e)) : E(t.value, e), F = (t) => h(t.type) && (t.isArray ? t.value.every((e) => typeof e == "object" && "contentType" in e) : typeof t.value == "object" && "contentType" in t.value), j = (t, e) => t.reduce(
   (n, o) => ({
     ...n,
-    [o.name]: f(o) ? L(o, e) : o.value
+    [o.name]: F(o) ? y(o, e) : o.value
   }),
   {}
-), y = (t, e, n, o) => {
+), R = (t, e, n, o) => {
   var c;
-  const s = n ?? ((c = t[0]) == null ? void 0 : c.language), a = t.filter((g) => g.language === s), r = h(a, s);
-  return Object.keys(r).length === 0 && console.warn(`No fields found for language "${s}" and content id "${e}"`), {
+  const r = n ?? ((c = t[0]) == null ? void 0 : c.language), a = t.filter(($) => $.language === r), s = j(a, r);
+  return Object.keys(s).length === 0 && console.warn(`No fields found for language "${r}" and content id "${e}"`), {
     id: e,
-    language: s,
+    language: r,
     lastUpdate: o,
-    ...r
+    ...s
   };
-}, E = (t, e) => Array.isArray(t == null ? void 0 : t.fields) ? y(t.fields, t.id, e, t.lastUpdate) : {}, u = {
+}, E = (t, e) => Array.isArray(t == null ? void 0 : t.fields) ? R(t.fields, t.id, e, t.lastUpdate) : {}, 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"
-}, j = (t) => {
-  const e = (a) => T.get(u.CONTENT_LIST(a), t), n = (a) => T.get(u.CONTENT(a), t), o = () => T.get(u.PROJECT, t), s = async () => {
-    var r;
+  CONTENT_LIST: (t) => `/contents${g(t)}`,
+  CONTENT: (t) => `/content${g(t)}`,
+  CONTENT_LIST_SIZE: (t) => t ? `/contents/size${g(t)}` : "/contents/size"
+}, D = (t) => {
+  const e = (a) => T.get(u.CONTENT_LIST(a), t), n = (a) => T.get(u.CONTENT(a), t), o = () => T.get(u.PROJECT, t), r = async () => {
+    var s;
     const a = await o();
-    return (r = a == null ? void 0 : a.languages) == null ? void 0 : r[0];
+    return (s = a == null ? void 0 : a.languages) == null ? void 0 : s[0];
   };
   return {
     getProject: o,
     getContentList: async (a) => {
-      const r = await e(a), c = (a == null ? void 0 : a.language) ?? await s();
-      return Array.isArray(r) ? r.map((g) => E(g, c)) : [];
+      const s = await e(a), c = (a == null ? void 0 : a.language) ?? await r();
+      return Array.isArray(s) ? s.map(($) => E($, c)) : [];
     },
     getContent: async (a) => {
-      const r = await n(a), c = (a == null ? void 0 : a.language) ?? await s();
-      return E(r, c);
+      const s = await n(a), c = (a == null ? void 0 : a.language) ?? await r();
+      return E(s, c);
     },
     getRawContentList: e,
     getRawContent: n,
     getContentListSize: (a) => T.get(u.CONTENT_LIST_SIZE(a), t),
-    updateContentFieldValue: (a, r, c) => T.put(
+    updateContentFieldValue: (a, s, c) => T.put(
       `${u.CONTENT(null)}/${a}`,
       {
-        id: r,
+        id: s,
         value: c
       },
       t
@@ -115,6 +116,6 @@ const N = (t, e) => {
   };
 };
 export {
-  j as createClient,
+  D as createClient,
   E as mapContentToModel
 };

package/dist/index.umd.cjs

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

package/package.json

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