@content-island/vscode-api-client 0.1.3 → 0.1.5

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as vscode from 'vscode';
 
-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'>>;
 
 declare interface ApiClient {
@@ -14,7 +14,13 @@ 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;
 };
@@ -33,10 +39,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;
@@ -46,6 +48,27 @@ declare interface ContentTypeField extends Lookup {
 
 export declare const createClient: (options?: VSCodeClientOptions) => VSCodeApiClient;
 
+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;
@@ -55,7 +78,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'
@@ -66,15 +96,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'
@@ -280,6 +312,8 @@ export declare type Model<Language = string> = {
     lastUpdate?: string;
 };
 
+declare type ModelType = 'entity' | 'enum';
+
 declare interface Options {
     accessToken: string;
     domain?: string;
@@ -297,7 +331,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> & {
@@ -305,13 +339,17 @@ 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 declare interface VSCodeApiClient extends ApiClient {
     setVSCodeExtensionContext: (context: vscode.ExtensionContext) => void;
     authorize: (authorizationCode: string, metadata: string) => Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@content-island/vscode-api-client",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Content Island - VSCode Extension API Client",
   "private": false,
   "sideEffects": false,
@@ -32,7 +32,7 @@
     "test:watch": "vitest -c ./config/test/config.ts"
   },
   "dependencies": {
-    "@content-island/api-client": "0.15.0"
+    "@content-island/api-client": "0.17.0"
   },
   "devDependencies": {
     "@content-island/common-backend": "*",