@content-island/api-client 0.15.0 → 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,6 +12,12 @@ 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;
@@ -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,7 +94,7 @@ export declare type FieldType =
 | 'media'
 | 'boolean'
 | 'color'
-| FieldEntityType;
+| RelatedModelType;
 
 declare type FilterableFields<M extends Model = Model> = {
     id?: ClientFilter;
@@ -74,6 +104,8 @@ declare type FilterableFields<M extends Model = Model> = {
     includeRelatedContent?: boolean;
 } & AllowedModelFields<M, ClientFilter>;
 
+declare type IsPrimitive<T> = [T] extends [string | number | boolean] ? true : false;
+
 export declare type LanguageCode =
 | 'aa'
 | 'ab'
@@ -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,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;
@@ -310,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.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,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.15.0",
+  "version": "0.16.0",
   "description": "Content Island - REST API Client",
   "private": false,
   "sideEffects": false,