@content-island/api-client 0.14.1 → 0.16.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;
+    [K in keyof M as IsPrimitive<NonNullable<M[K]>> extends true ? `fields.${string & K}` : never]?: ValueType;
 }, 'fields.id' | 'fields.language'>>;
 
 export declare interface ApiClient {
@@ -12,8 +12,15 @@ export declare interface ApiClient {
     updateContentFieldValue: (contentId: string, fieldId: string, value: any) => Promise<boolean>;
 }
 
+declare interface BaseModel {
+    id: string;
+    name: string;
+    type: ModelType;
+}
+
 export declare type ClientFilter<Type = string | boolean> = Type | {
     in?: Type[];
+    ne?: Type;
 };
 
 export declare interface Content {
@@ -30,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;
@@ -43,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;
@@ -52,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'
@@ -63,16 +94,18 @@ export declare type FieldType =
 | 'media'
 | 'boolean'
 | 'color'
-| FieldEntityType;
+| RelatedModelType;
 
 declare type FilterableFields<M extends Model = Model> = {
     id?: ClientFilter;
     lastUpdate?: ClientFilter;
-    language?: ClientFilter<M['language'] extends undefined ? string : M['language']>;
+    language?: M['language'];
     contentType?: ClientFilter;
     includeRelatedContent?: boolean;
 } & AllowedModelFields<M, ClientFilter>;
 
+declare type IsPrimitive<T> = [T] extends [string | number | boolean] ? true : false;
+
 export declare type LanguageCode =
 | 'aa'
 | 'ab'
@@ -277,6 +310,8 @@ export declare type Model<Language = string> = {
     lastUpdate?: string;
 };
 
+declare type ModelType = 'entity' | 'enum';
+
 export declare interface Options {
     accessToken: string;
     domain?: string;
@@ -294,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> & {
@@ -302,6 +337,8 @@ 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;
@@ -309,4 +346,6 @@ declare type SortableFields<M extends Model> = {
 
 declare type SortOrder = 'asc' | 'desc';
 
+declare type Validation = { name: string; customArgs?: any };
+
 export { }

package/dist/index.js

@@ -1,8 +1,10 @@
-const $ = (t, e) => {
+const N = (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;
@@ -15,10 +17,10 @@ const $ = (t, e) => {
     return a === 0 ? r : `${n}${e}${r}`;
   } else if (s !== void 0 && o !== "sort" && o !== "pagination") {
     const r = s;
-    return a === 0 ? $(o, r) : `${n}${e}${$(o, r)}`;
+    return a === 0 ? N(o, r) : `${n}${e}${N(o, r)}`;
   }
   return n;
-}, ""), S = (t) => t && Object.keys(t).length > 0 ? `?${_(t, "&")}` : "", N = {
+}, ""), S = (t) => t && Object.keys(t).length > 0 ? `?${_(t, "&")}` : "", $ = {
   IS_PRODUCTION: !0,
   DEFAULT_API_CLIENT_DOMAIN: "api.contentisland.net",
   DEFAULT_API_CLIENT_VERSION: "1.0"
@@ -27,7 +29,7 @@ const $ = (t, e) => {
   SESSION_TYPE: "Bearer",
   METADATA_KEY: "x-metadata"
 }, l = (t) => {
-  const n = (t.secureProtocol === void 0 ? N.IS_PRODUCTION : t.secureProtocol) ? "https" : "http", o = t.domain ? t.domain : N.DEFAULT_API_CLIENT_DOMAIN, s = t.apiVersion ? t.apiVersion : N.DEFAULT_API_CLIENT_VERSION;
+  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}`, {
   headers: {
@@ -63,22 +65,22 @@ const $ = (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), y = (t, e) => t.reduce(
+}, 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(
   (n, o) => ({
     ...n,
     [o.name]: f(o) ? L(o, e) : o.value
   }),
   {}
-), h = (t, e, n, o) => {
+), y = (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 = y(a, s);
+  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}"`), {
     id: e,
     language: s,
     lastUpdate: o,
     ...r
   };
-}, E = (t, e) => Array.isArray(t == null ? void 0 : t.fields) ? h(t.fields, t.id, e, t.lastUpdate) : {}, u = {
+}, E = (t, e) => Array.isArray(t == null ? void 0 : t.fields) ? y(t.fields, t.id, e, t.lastUpdate) : {}, u = {
   PROJECT: "/project",
   CONTENT_LIST: (t) => `/contents${S(t)}`,
   CONTENT: (t) => `/content${S(t)}`,

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(",")}`},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,s],o)=>{if(a==="sort"&&typeof s=="object"&&s!==null&&!Array.isArray(s)){const r=A(s);return o===0?`sort=${r}`:`${n}${e}sort=${r}`}else if(a==="pagination"&&typeof s=="object"&&s!==null){const r=O(s,e);return o===0?r:`${n}${e}${r}`}else if(s!==void 0&&a!=="sort"&&a!=="pagination"){const r=s;return o===0?T(a,r):`${n}${e}${T(a,r)}`}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"},$=t=>{const n=(t.secureProtocol===void 0?d.IS_PRODUCTION:t.secureProtocol)?"https":"http",a=t.domain?t.domain:d.DEFAULT_API_CLIENT_DOMAIN,s=t.apiVersion?t.apiVersion:d.DEFAULT_API_CLIENT_VERSION;return`${n}://${a}/api/${s}`},g={get:async(t,e)=>fetch(`${$(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)}${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 s=n??((c=t[0])==null?void 0:c.language),o=t.filter(N=>N.language===s),r=y(o,s);return Object.keys(r).length===0&&console.warn(`No fields found for language "${s}" and content id "${e}"`),{id:e,language:s,lastUpdate:a,...r}},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),s=async()=>{var r;const o=await a();return(r=o==null?void 0:o.languages)==null?void 0:r[0]};return{getProject:a,getContentList:async o=>{const r=await e(o),c=(o==null?void 0:o.language)??await s();return Array.isArray(r)?r.map(N=>E(N,c)):[]},getContent:async o=>{const r=await n(o),c=(o==null?void 0:o.language)??await s();return E(r,c)},getRawContentList:e,getRawContent:n,getContentListSize:o=>g.get(l.CONTENT_LIST_SIZE(o),t),updateContentFieldValue:(o,r,c)=>g.put(`${l.CONTENT(null)}/${o}`,{id:r,value:c},t)}};i.createClient=h,i.mapContentToModel=E,Object.defineProperty(i,Symbol.toStringTag,{value:"Module"})});
+(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=>l(n,e)):l(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),L=(t,e)=>t.reduce((n,a)=>({...n,[a.name]:I(a)?f(a,e):a.value}),{}),h=(t,e,n,a)=>{var c;const r=n??((c=t[0])==null?void 0:c.language),o=t.filter($=>$.language===r),s=L(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}},l=(t,e)=>Array.isArray(t==null?void 0:t.fields)?h(t.fields,t.id,e,t.lastUpdate):{},E={PROJECT:"/project",CONTENT_LIST:t=>`/contents${S(t)}`,CONTENT:t=>`/content${S(t)}`,CONTENT_LIST_SIZE:t=>t?`/contents/size${S(t)}`:"/contents/size"},y=t=>{const e=o=>g.get(E.CONTENT_LIST(o),t),n=o=>g.get(E.CONTENT(o),t),a=()=>g.get(E.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($=>l($,c)):[]},getContent:async o=>{const s=await n(o),c=(o==null?void 0:o.language)??await r();return l(s,c)},getRawContentList:e,getRawContent:n,getContentListSize:o=>g.get(E.CONTENT_LIST_SIZE(o),t),updateContentFieldValue:(o,s,c)=>g.put(`${E.CONTENT(null)}/${o}`,{id:s,value:c},t)}};i.createClient=y,i.mapContentToModel=l,Object.defineProperty(i,Symbol.toStringTag,{value:"Module"})});

package/package.json

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