jourycms-sdk 1.0.3 → 1.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jourycms-sdk",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Sdk for Joury CMS",
   "main": "dist/index.js",
   "files": [

package/typings/v1/cache-manager/entity.d.ts

@@ -59,13 +59,24 @@ declare module Levelup {
           : // system
           E extends "app"
           ? System.Api.Apps.List.Request
+          
+          : // content
+          E extends "article"
+          ? Content.Api.Articles.List.Request
+          : E extends "articleType"
+          ? Content.Api.ArticleTypes.List.Request
+          : E extends "taxonomy"
+          ? Content.Api.Taxonomies.List.Request
+          : E extends "term"
+          ? Content.Api.Terms.List.Request
+
           : never;
 
 
 
 
         export type TListQueryParams<E extends TEntity> =
-          E extends Levelup.CMS.V1.CacheManager.TLevelupEntity
+          E extends Levelup.CMS.V1.Utils.SystemStructure.Models.AllModels
           ? Levelup.CMS.V1.CacheManager.TLevelupListQueryParams<E>
           : never;
       }

package/typings/v1/index.d.ts

@@ -4,5 +4,6 @@ export * from "./modules/index.d.ts";
 export * from "./sdk/index.d.ts";
 export * from "./security/index.d.ts";
 export * from "./services/index.d.ts";
+export * from "./theme/index.d.ts";
 export * from "./ui/index.d.ts";
 export * from "./utils/index.d.ts";

package/typings/v1/services/auth/api/auth.d.ts

@@ -18,7 +18,13 @@ declare module Levelup {
             export namespace Signup {
               export type Request =
                 Levelup.CMS.V1.Utils.Api.Request.BuildCreateRequest<{
-                  name: string;
+                  account_type: 'agency' | 'doctor' | 'escort';
+                  address: Utils.Entity.Snapshots.Locations.Address;
+                  first_name: string;
+                  family_name: string;
+                  phones: string[];
+                  website: string;
+                  sex: Users.Entity.Sex | null;
                   email: string;
                   password: string;
                 }>;

package/typings/v1/services/auth/entities/role.d.ts

@@ -3,9 +3,15 @@ declare module Levelup {
     namespace V1 {
       namespace Auth {
         export namespace Entity {
+
+          export type TDefaultUserRoles =
+            | "admin"
+            | "agency"
+            | "escort"
+            | "doctor"
           export interface Role
             extends Utils.Entity.General.ICreatable,
-              Utils.Entity.General.IHasSearchMeta {
+            Utils.Entity.General.IHasSearchMeta {
             _id: Utils.Common.ID;
             is_system: boolean;
             is_company_related: boolean;

package/typings/v1/services/auth/entities/user.d.ts

@@ -14,8 +14,6 @@ declare module Levelup {
             phones: string[];
             website: string | null;
             address: Utils.Entity.Snapshots.Locations.Address;
-            has_work_address: boolean;
-            work_address: Utils.Entity.Snapshots.Locations.Address | null;
             social_links?: {
               network: Utils.Common.SocialNetworks;
               url: string;
@@ -45,15 +43,6 @@ declare module Levelup {
           export interface IUserInsights {
             last_updated: Date | null;
             rating: number;
-            parcel_count: number;
-            delivered_parcel_count: number;
-            returned_parcel_count: number;
-            delivered_parcel_percentage: number;
-            returned_parcel_percentage: number;
-            complaint_count: number;
-            resolved_complaint_count: number;
-            resolved_complaint_percentage: number;
-            balance: number;
           }
 
           export interface IUserAttributes {
@@ -63,54 +52,11 @@ declare module Levelup {
             inactive_since?: Date | null;
 
             nid?: string | null;
-            driving_license_id?: string | null;
             started_at?: Date | null;
-
-            multi_office_user?: {
-              is_related_to_offices?: boolean;
-              can_manage_all_offices?: boolean;
-              subscribed_at_office?: Utils.Common.ID | null;
-              managed_offices?: Utils.Common.ID[];
-              last_managed_office?: Utils.Common.ID | null;
-            } | null;
-
-            seller?: {
-              stores: Utils.Common.ID[];
-              last_managed_store?: Utils.Common.ID;
-            } | null;
-
-            deliverer?: {
-              countries?: Utils.Common.LocationAdministrativeCode[];
-              states?: Utils.Common.LocationAdministrativeCode[];
-              cities?: Utils.Common.LocationAdministrativeCode[];
-              is_freelancer?: boolean;
-              default_delivery_fees?: number;
-              delivery_fees?: {
-                city: {
-                  country: Utils.Common.LocationAdministrativeCode;
-                  state: Utils.Common.LocationAdministrativeCode;
-                  city: Utils.Common.LocationAdministrativeCode;
-                };
-                is_default: boolean;
-                fees: number;
-              }[];
-            } | null;
-
-            team?: {
-              has_team: boolean;
-              team?: {
-                leader: string;
-                members: string[];
-              };
-            };
+            related_article?: string | null;
           }
 
           export interface IUserSnapshots {
-            stores?: Utils.Entity.Snapshots.Accounts.Store[];
-            company?: Utils.Entity.Snapshots.Accounts.Company;
-            offices?: Utils.Entity.Snapshots.Logistics.Office[];
-            team_leader?: Utils.Entity.Snapshots.Auth.User;
-            team_members?: Utils.Entity.Snapshots.Auth.User[];
           }
 
           export interface User
@@ -128,7 +74,6 @@ declare module Levelup {
 
             profile: IUserProfile;
             preferences?: IUserPreferences;
-            deliverer_data?: IDelivererData;
             attributes: IUserAttributes;
             snapshots?: IUserSnapshots;
             insights?: IUserInsights;

package/typings/v1/services/content/api/article.d.ts

@@ -73,7 +73,7 @@ declare module Levelup {
             export namespace GetOne {
               export type Request = Utils.Api.Request.Build<{}>;
               export type Response<T extends Entity.Article = Entity.Article> =
-                Utils.Api.Response.BuildSingleItemResponse<T>;
+                Utils.Api.Response.BuildSingleItemResponse<T, 'users' | 'article_types' | 'linked_articles'>;
             }
 
             /**
@@ -95,10 +95,11 @@ declare module Levelup {
                   Entity.Article & {
                     tag: any;
                     tag_slug: any;
+                    populate_linked_articles: Utils.Api.Request.TProjectableFields<Entity.Article>[] | boolean;
                   }
                 >;
               export type Response<T extends Entity.Article = Entity.Article> =
-                Utils.Api.Response.BuildListResponse<T>;
+                Utils.Api.Response.BuildListResponse<T, 'users' | 'article_types' | 'linked_articles'>;
             }
           }
         }

package/typings/v1/services/content/entities/article-type.d.ts

@@ -6,10 +6,8 @@ declare module Levelup {
           type ICustomMetaField = {
             field_key: string;
             field_label: string;
-            field_type: UI.Forms.CustomFields.CustomFieldType;
-            field_options: {
-              [Key: string]: any;
-            };
+            field_type: CustomFields.CustomFieldType;
+            field_options: CustomFields.MetaField<CustomFields.CustomFieldType, boolean>['field_options'];
           };
 
           export interface IArticleTypeSnapshots {
@@ -22,7 +20,7 @@ declare module Levelup {
 
           export interface ArticleType
             extends Utils.Entity.General.ICreatable,
-              Utils.Entity.General.IHasSearchMeta {
+            Utils.Entity.General.IHasSearchMeta {
             _id: Utils.Common.ID;
             slug: string;
             name: string;
@@ -36,7 +34,7 @@ declare module Levelup {
             };
             description: string;
             description_unformatted: string;
-            description_structured: { [Key: string]: any };
+            description_structured: JSONContent;
 
             custom_meta_fields: ICustomMetaField[];
             related_taxonomies: Utils.Common.ID[];

package/typings/v1/services/content/entities/article.d.ts

@@ -18,7 +18,7 @@ declare module Levelup {
 
           export interface Article
             extends Utils.Entity.General.ICreatable,
-              Utils.Entity.General.IHasSearchMeta {
+            Utils.Entity.General.IHasSearchMeta {
             _type: Utils.Common.ID | null;
             _id: Utils.Common.ID;
             slug: string;
@@ -26,13 +26,11 @@ declare module Levelup {
             body: string;
             body_unformatted: string;
             body_structured: { [Key: string]: any };
-
+            is_published: boolean;
+            published_at: Date | null;
             is_featured: boolean;
-
             featured_image: Utils.Common.FileAttribute | null;
-
             article_type: Utils.Common.ID;
-
             related_tags: {
               _id: Utils.Common.ID;
               taxonomy: Utils.Common.ID;

package/typings/v1/services/content/entities/comment.d.ts

@@ -23,7 +23,7 @@ declare module Levelup {
 
             body: string;
             body_unformatted: string;
-            body_structured: { [Key: string]: any };
+            body_structured: JSONContent;
 
             snapshots: ICommentSnapshots;
           }

package/typings/v1/services/content/entities/custom-fieds/custom-field.d.ts

@@ -0,0 +1,194 @@
+declare module Levelup {
+
+	namespace CMS {
+		namespace V1 {
+			export namespace Content {
+				export namespace CustomFields {
+					export type AnyField = keyof OptionTypes;
+					export type FieldType = keyof FilterMenu.OptionTypes;
+					export type OptionType<FieldType> = OptionTypes[FieldType];
+					type ExtendFieldProps<T> = T &
+						Partial<{
+						}>;
+
+					type TOperator = 'eq' | 'ne' | 'gt' | 'lt' | 'gte' | 'lte' | 'in' | 'nin' | 'exists' | 'not_empty';
+					type TConstraint<Operator extends TOperator> =
+						Operator extends 'eq' | 'ne' | 'gt' | 'lt' | 'gte' | 'lte' ? {
+							field: string;
+							operator: Operator;
+							value: any;
+						} :
+						Operator extends 'in' | 'nin' ? {
+							field: string;
+							operator: Operator;
+							value: any[];
+						} :
+						Operator extends 'exists' | 'not_empty' ? {
+							field: string;
+							operator: Operator;
+						} :
+						never;
+
+					type BaseFieldOption<Input, IsMulti extends boolean = false> = {
+						label?: string;
+						required?: boolean;
+						default_value?: IsMulti extends true ? Utils.Common.MultiValue<Input> : Utils.Common.SingleValue<Input>;
+						constraints?: TConstraint<TOperator>[];
+					}
+
+					type CustomFieldType =
+						| 'article_object'
+						| 'boolean'
+						| 'checkbox'
+						| 'date_range'
+						| 'date'
+						| 'file'
+						| 'image'
+						| 'number'
+						| 'radiobox'
+						| 'select'
+						| 'algerian_state'
+						| 'algerian_city'
+						| 'ksa_city'
+						| 'text'
+						| 'time';
+
+
+
+					type MetaFieldInput<T extends CustomFieldType, IsMulti extends boolean = false> =
+						T extends 'article_object' ? ArticleObjectField.Input<IsMulti> :
+						T extends 'boolean' ? BooleanField.Input :
+						T extends 'checkbox' ? CheckboxField.Input :
+						T extends 'date_range' ? DateRangeField.Input :
+						T extends 'date' ? DateField.Input :
+						T extends 'file' ? FileField.Input<IsMulti> :
+						T extends 'image' ? ImageField.Input<IsMulti> :
+						T extends 'number' ? NumberField.Input :
+						T extends 'radiobox' ? RadioboxField.Input :
+						T extends 'select' ? SelectField.Input<IsMulti> :
+						T extends 'algerian_state' ? SelectField.Intput<IsMulti> :
+						T extends 'algerian_city' ? SelectField.Intput<IsMulti> :
+						T extends 'ksa_city' ? SelectField.Intput<IsMulti> :
+						T extends 'text' ? TextField.Input :
+						T extends 'time' ? TimeField.Input :
+						never;
+
+					type MetaFieldOutput<T extends CustomFieldType, IsMulti extends boolean = false> =
+						T extends 'article_object' ? ArticleObjectField.Output<IsMulti> :
+						T extends 'boolean' ? BooleanField.Output :
+						T extends 'checkbox' ? CheckboxField.Output :
+						T extends 'date_range' ? DateRangeField.Output :
+						T extends 'date' ? DateField.Output :
+						T extends 'file' ? FileField.Output<IsMulti> :
+						T extends 'image' ? ImageField.Output<IsMulti> :
+						T extends 'number' ? NumberField.Output :
+						T extends 'radiobox' ? RadioboxField.Output :
+						T extends 'select' ? SelectField.Output<IsMulti> :
+						T extends 'algerian_state' ? SelectField.Output<IsMulti> :
+						T extends 'algerian_city' ? SelectField.Output<IsMulti> :
+						T extends 'ksa_city' ? SelectField.Output<IsMulti> :
+						T extends 'text' ? TextField.Output :
+						T extends 'time' ? TimeField.Output :
+						never;
+
+					type MetaField<T extends CustomFieldType, IsMulti extends boolean = false> = {
+						field_key: string;
+						field_label: string;
+						field_type: T;
+						field_options: T extends 'article_object' ? ArticleObjectField.Options<IsMulti> :
+						T extends 'boolean' ? BooleanField.Options :
+						T extends 'checkbox' ? CheckboxField.Options :
+						T extends 'date_range' ? DateRangeField.Options :
+						T extends 'date' ? DateField.Options :
+						T extends 'file' ? FileField.Options<IsMulti> :
+						T extends 'image' ? ImageField.Options<IsMulti> :
+						T extends 'number' ? NumberField.Options :
+						T extends 'radiobox' ? RadioboxField.Options :
+						T extends 'select' ? SelectField.Options<IsMulti> :
+						T extends 'algerian_state' ? SelectField.Options<IsMulti> :
+						T extends 'algerian_city' ? SelectField.Options<IsMulti> :
+						T extends 'ksa_city' ? SelectField.Options<IsMulti> :
+						T extends 'text' ? TextField.Options :
+						T extends 'time' ? TimeField.Options :
+						never;
+					}
+
+
+
+					export namespace Forms {
+
+
+						export type OnChangeValue<
+							Option,
+							IsMulti extends boolean
+						> = IsMulti extends true ? Utils.Common.MultiValue<Option> : Utils.Common.SingleValue<Option>;
+
+
+						export type Field<
+							T extends keyof OptionTypes,
+							IsMulti extends boolean = false
+						> =
+							| ExtendFieldProps<{
+								label: string;
+								isMulti?: false;
+								value: Utils.Common.SingleValue<OptionType<T>>;
+								type: T;
+								source?:
+								| string[];
+							}>
+							| ExtendFieldProps<{
+								label: string;
+								isMulti?: true;
+								value: Utils.Common.MultiValue<OptionType<T>>;
+								type: T;
+								source?:
+								| string[];
+							}>;
+
+						export type Fields<
+							T extends { [field: string]: Field } = { [field: string]: Field }
+						> = { [field: string]: Field };
+
+						export type FilterValue<T> = {
+							[property in keyof T]: T[property]["value"];
+						};
+
+						export type ComponentProps<
+							T extends Fields = { [field: string]: Field }
+						> = {
+							filter: T;
+							onChange: (
+								value: FilterValue<T>,
+								label: {
+									[field: string]: {
+										label: string;
+										value: LabelType;
+									};
+								}
+							) => void;
+							type?: TComponentType;
+							controlsPosition?: "both" | "bottom" | "top";
+							className?: string;
+							clearField?: (field: string) => void;
+							clearAll?: () => void;
+							omitFields?: Array<keyof T>;
+						};
+
+						type MetaFieldInputProps<T extends CustomFieldType, IsMulti extends boolean = false> = {
+							label: string;
+							required: MetaField<T, IsMulti>['field_options']['required'];
+							default_value: MetaField<T, IsMulti>['field_options']['default_value'] | null;
+							options: MetaField<T, IsMulti>['field_options'];
+							value: MetaFieldInput<T, IsMulti>;
+							onChange: (value: MetaFieldInput<T, IsMulti>) => void | PromiseLike<void>;
+							metaData: {
+								[key: string]: any;
+							};
+						}
+					}
+				}
+			}
+		}
+	}
+}
+

package/typings/v1/services/content/entities/custom-fieds/fields/article_object.custom-field.d.ts

@@ -0,0 +1,27 @@
+declare module Levelup {
+
+	namespace CMS {
+		namespace V1 {
+			export namespace Content {
+				export namespace CustomFields {
+					export namespace ArticleObjectField {
+
+						export type Key = "article_object";
+
+						export type Input<IsMulti extends boolean = false> = IsMulti extends true ? Utils.Common.ID[] : Utils.Common.ID | null;
+
+						export type Output<IsMulti extends boolean = false> = IsMulti extends true
+							? Content.Entity.Article[]
+							: Content.Entity.Article | null;
+
+						export type Options<IsMulti extends boolean = false> = BaseFieldOption<Input, IsMulti> & {
+							multiple: IsMulti;
+							type: Utils.Common.Name;
+							filter: Content.Api.Articles.List.Request['filters'];
+						}
+					}
+				}
+			}
+		}
+	}
+}

package/typings/v1/services/content/entities/custom-fieds/fields/boolean.custom-field.d.ts

@@ -0,0 +1,22 @@
+declare module Levelup {
+
+	namespace CMS {
+		namespace V1 {
+			export namespace Content {
+				export namespace CustomFields {
+					export namespace BooleanField {
+
+						export type Key = "boolean";
+
+						export type Input = boolean;
+
+						export type Output = boolean;
+
+						export type Options = BaseFieldOption<Input, false> & {
+						}
+					}
+				}
+			}
+		}
+	}
+}

package/typings/v1/services/content/entities/custom-fieds/fields/checkbox.custom-field.d.ts

@@ -0,0 +1,24 @@
+declare module Levelup {
+
+  namespace CMS {
+    namespace V1 {
+      export namespace Content {
+        export namespace CustomFields {
+          export namespace CheckboxField {
+
+
+            export type Key = "checkbox";
+
+            export type Input = Utils.Common.MultiValue<string>;
+
+            export type Output = Utils.Common.MultiValue<Utils.Common.TLabelValue>;
+
+            export type Options = BaseFieldOption<Input, false> & {
+              choices: Utils.Common.MultiValue<Utils.Common.TLabelValue>
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/{ui/forms/article → services/content/entities}/custom-fieds/fields/date.custom-field.d.ts

@@ -2,8 +2,7 @@ declare module Levelup {
 
   namespace CMS {
     namespace V1 {
-      export namespace UI {
-        export namespace Forms {
+        export namespace Content {
           export namespace CustomFields {
             export namespace DateField {
 
@@ -19,5 +18,4 @@ declare module Levelup {
         }
       }
     }
-  }
-}
+  }

package/typings/v1/{ui/forms/article → services/content/entities}/custom-fieds/fields/date_range.custom-field.d.ts

@@ -2,8 +2,7 @@ declare module Levelup {
 
   namespace CMS {
     namespace V1 {
-      export namespace UI {
-        export namespace Forms {
+        export namespace Content {
           export namespace CustomFields {
             export namespace DateRangeField {
 
@@ -22,5 +21,4 @@ declare module Levelup {
         }
       }
     }
-  }
-}
+  }

package/typings/v1/{ui/forms/article → services/content/entities}/custom-fieds/fields/file.custom-field.d.ts

@@ -3,8 +3,7 @@ declare module Levelup {
 
   namespace CMS {
     namespace V1 {
-      export namespace UI {
-        export namespace Forms {
+        export namespace Content {
           export namespace CustomFields {
             export namespace FileField {
 
@@ -22,5 +21,4 @@ declare module Levelup {
         }
       }
     }
-  }
-}
+  }

package/typings/v1/{ui/forms/article → services/content/entities}/custom-fieds/fields/image.custom-field.d.ts

@@ -2,8 +2,7 @@ declare module Levelup {
 
   namespace CMS {
     namespace V1 {
-      export namespace UI {
-        export namespace Forms {
+        export namespace Content {
           export namespace CustomFields {
             export namespace ImageField {
 
@@ -21,5 +20,4 @@ declare module Levelup {
         }
       }
     }
-  }
-}
+  }

package/typings/v1/{ui/forms/article → services/content/entities}/custom-fieds/fields/number.custom-field.d.ts

@@ -2,8 +2,7 @@ declare module Levelup {
 
   namespace CMS {
     namespace V1 {
-      export namespace UI {
-        export namespace Forms {
+        export namespace Content {
           export namespace CustomFields {
             export namespace NumberField {
 
@@ -22,5 +21,4 @@ declare module Levelup {
         }
       }
     }
-  }
-}
+  }

package/typings/v1/{ui/forms/article → services/content/entities}/custom-fieds/fields/radiobox.custom-field.d.ts

@@ -2,20 +2,19 @@ declare module Levelup {
 
   namespace CMS {
     namespace V1 {
-      export namespace UI {
-        export namespace Forms {
+        export namespace Content {
           export namespace CustomFields {
             export namespace RadioboxField {
 
 
               export type Key = "radiobox";
 
-              export type Input =  SingleValue<string>;
+              export type Input =  Utils.Common.SingleValue<string>;
 
-              export type Output = SingleValue<Utils.Common.TLabelValue>;
+              export type Output = Utils.Common.SingleValue<Utils.Common.TLabelValue>;
 
               export type Options = BaseFieldOption<Input, false> & {
-                choices: MultiValue<Utils.Common.TLabelValue>
+                choices: Utils.Common.MultiValue<Utils.Common.TLabelValue>
 
               }
             }
@@ -23,5 +22,4 @@ declare module Levelup {
         }
       }
     }
-  }
-}
+  }

package/typings/v1/services/content/entities/custom-fieds/fields/select.custom-field.d.ts

@@ -0,0 +1,25 @@
+declare module Levelup {
+
+  namespace CMS {
+    namespace V1 {
+      export namespace Content {
+        export namespace CustomFields {
+          export namespace SelectField {
+
+
+            export type Key = "select";
+
+            export type Input<IsMulti extends boolean = false> = IsMulti extends true ? string[] : string | null;
+
+            export type Output<IsMulti extends boolean = false> = IsMulti extends true ? Utils.Common.TLabelValue[] : Utils.Common.TLabelValue | null;
+
+            export type Options<IsMulti extends boolean = false> = BaseFieldOption<Input<IsMulti>, IsMulti> & {
+              multiple?: IsMulti;
+              choices: Utils.Common.MultiValue<Utils.Common.TLabelValue>
+            }
+          }
+        }
+      }
+    }
+  }
+}