jourycms-sdk 1.0.1

package/typings/v1/services/system/api/app.d.ts

@@ -0,0 +1,130 @@
+
+/**
+ * @description project
+ */
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace System {
+
+        export namespace Api {
+
+          export namespace Apps {
+
+            /**
+             * -------------------------------------------------------------------------- 
+             *                            Create                           
+             * -------------------------------------------------------------------------- 
+             * @link
+             * @fires AppsService.Create
+             * @param {Levelup.V2.System.Api.Apps.Create.Request} query
+             * @returns {Levelup.V2.System.Api.Apps.Create.Response}
+             * @method POST
+             *
+             */
+            export namespace Create {
+              export type Request = Utils.Api.Request.BuildCreateRequest<Entity.App>;
+              export type Response = Utils.Api.Response.BuildSingleItemResponse<Entity.App>;
+            }
+
+
+            /**
+             * -------------------------------------------------------------------------- 
+             *                            Update                           
+             * -------------------------------------------------------------------------- 
+             * @link
+             * @fires AppsService.Update
+             * @param {Levelup.V2.System.Api.Apps.Update.Request} query
+             * @returns {Levelup.V2.System.Api.Apps.Update.Response}
+             * @method PUT
+             *
+             */
+            export namespace Update {
+              export type Request = Utils.Api.Request.BuildUpdateRequest<Entity.App>;
+              export type Response = Utils.Api.Response.BuildSingleItemResponse<Entity.App>;
+            }
+
+            /**
+             * -------------------------------------------------------------------------- 
+             *                            Delete                           
+             * -------------------------------------------------------------------------- 
+             * @link
+             * @fires AppsService.Delete
+             * @param {Levelup.V2.System.Api.Apps.Delete.Request} query
+             * @returns {Levelup.V2.System.Api.Apps.Delete.Response}
+             * @method DELETE
+             *
+             */
+            export namespace Delete {
+              export type Response = Utils.Api.Response.DefaultDeleteResponse;
+            }
+
+
+            /**
+             * -------------------------------------------------------------------------- 
+             *                            BulkDelete                           
+             * -------------------------------------------------------------------------- 
+             * @link
+             * @fires AppsService.BulkDelete
+             * @param {Levelup.V2.System.Api.Apps.BulkDelete.Request} query
+             * @returns {Levelup.V2.System.Api.Apps.BulkDelete.Response}
+             * @method DELETE
+             *
+             */
+            export namespace BulkDelete {
+              export type Request = Utils.Api.Request.Build<{
+                data: {
+                  id?: string[];
+                  tracking_id?: string[];
+                }
+              }>
+              export type Response = Utils.Api.Response.DefaultDeleteResponse;
+            }
+
+            /**
+             * -------------------------------------------------------------------------- 
+             *                            GetOne                           
+             * -------------------------------------------------------------------------- 
+             * @link
+             * @fires AppsService.GetOne
+             * @param {Levelup.V2.System.Api.Apps.GetOne.Request} query
+             * @returns {Levelup.V2.System.Api.Apps.GetOne.Response}
+             * @method GET
+             *
+             */
+            export namespace GetOne {
+              type Scope = '';
+              export type Request = Utils.Api.Request.Build<Record<string, unknown>>
+              export type Response = Utils.Api.Response.BuildSingleItemResponse<Entity.App>
+            }
+
+            /**
+             * -------------------------------------------------------------------------- 
+             *                            List                           
+             * -------------------------------------------------------------------------- 
+             * @link
+             * @fires AppsService.List
+             * @param {Levelup.V2.System.Api.Apps.List.Request} query
+             * @returns {Levelup.V2.System.Api.Apps.List.Response}
+             * @method GET
+             *
+             */
+            export namespace List {
+              type Scope = 'listing' | 'ids' | 'trackings';
+
+              export type Request = Utils.Api.Request.BuildSearchablePagedSortableFilterableProjectable<Entity.App> & {
+                scope?: Scope;
+                filters?: {
+                  /**
+                   * Here will be the custom filters
+                   */
+                };
+              }
+              export type Response = Utils.Api.Response.BuildListResponse<Entity.App>
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/system/api/index.d.ts

@@ -0,0 +1,3 @@
+'generated by levelup';
+
+export * from "./app.d.ts";

package/typings/v1/services/system/entities/app.d.ts

@@ -0,0 +1,97 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace System {
+
+        export namespace Entity {
+          /**
+           * Represents the settings for an app.
+           */
+          export interface IAppSettings {
+            /**
+             * The listing configuration.
+             */
+            listing?: {
+              /**
+               * The default listing count.
+               * - better value of table list is 25
+               * - better value of grid list is 24
+               */
+              default_count: number;
+            };
+            /**
+             * The locales configuration.
+             */
+            locales?: {
+              /**
+               * The default language for the app.
+               */
+              default_language: Levelup.V2.ContentManagement.Entity.TranslationManager.TLanguageCode;
+              /**
+               * The supported languages for the app.
+               */
+              supported_languages: Levelup.V2.ContentManagement.Entity.TranslationManager.TLanguageCode[];
+            };
+            /**
+             * The locations configuration.
+             */
+            locations?: {
+              /**
+               * The default country for the app.
+               * null if not related to a specific country.
+               */
+              default_country: string | null;
+              /**
+               * The supported countries for the app.
+               */
+              supported_countries: string[];
+              /**
+               * The default currency for the app.
+               * null if not related to a specific currency.
+               */
+              default_currency: string | null;
+              /**
+               * The supported currencies for the app.
+               */
+              supported_currencies: string[];
+            };
+          }
+
+          export interface IAppAttributes {
+            is_suspended?: boolean;
+          }
+
+          export interface IAppInsights {
+            company_count?: number;
+            store_count?: number;
+            user_count?: number;
+          }
+
+          export interface App extends Utils.Entity.General.IHasSearchMeta {
+            _id: Utils.Common.ID;
+            created_at?: Date;
+            updated_at?: Date;
+            is_deleted?: boolean;
+            deleted_at?: Date;
+            created_by: Utils.Common.ID;
+            owner: Utils.Common.ID;
+            name: string;
+            description: string;
+            logo: Utils.Common.FileAttribute;
+
+            enabled_services: TService[];
+            //
+            settings: IAppSettings;
+            attributes: IAppAttributes;
+            insights: IAppInsights;
+            //
+            token: string;
+            encryptedKey: string;
+            salt: string;
+          }
+        }
+      }
+    }
+  }
+}
+

package/typings/v1/services/system/entities/index.d.ts

@@ -0,0 +1,3 @@
+'generated by levelup';
+
+export * from "./app.d.ts";

package/typings/v1/services/system/index.d.ts

@@ -0,0 +1,5 @@
+'generated by levelup';
+
+export * from "./models/index.d.ts";
+export * from "./entities/index.d.ts";
+export * from "./api/index.d.ts";

package/typings/v1/services/system/models/app.d.ts

@@ -0,0 +1,19 @@
+import { Document, Model as MongooseModel } from 'mongoose';
+
+/**
+ * @description global here is very important because we have imported from another module
+ */
+declare global {
+  namespace Levelup {
+    namespace CMS {
+      namespace V1 {
+        namespace System {
+          export namespace Model {
+            export type AppDocument = Entity.App & Document;
+            export type App = MongooseModel<AppDocument>;
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/system/models/index.d.ts

@@ -0,0 +1,3 @@
+'generated by levelup';
+
+export * from "./app.d.ts";

package/typings/v1/ui/admin/index.d.ts

@@ -0,0 +1 @@
+export * from "../routes/routes.js";

package/typings/v1/ui/forms/article/custom-fieds/custom-field.d.ts

@@ -0,0 +1,189 @@
+declare module Levelup {
+
+	namespace CMS {
+		namespace V1 {
+			export namespace UI {
+				export namespace Forms {
+					export namespace CustomFields {
+
+						export type AnyField = keyof OptionTypes;
+						export type FieldType = keyof FilterMenu.OptionTypes;
+						export type OptionType<FieldType> = OptionTypes[FieldType];
+
+
+						export type OnChangeValue<
+							Option,
+							IsMulti extends boolean
+						> = IsMulti extends true ? MultiValue<Option> : SingleValue<Option>;
+
+						type ExtendFieldProps<T> = T &
+							Partial<{
+								role_group:
+								| Levelup.V2.Auth.Entity.TRoleGroup
+								| Levelup.V2.Auth.Entity.TRoleGroup[];
+							}>;
+
+						export type Field<
+							T extends keyof OptionTypes,
+							IsMulti extends boolean = false
+						> =
+							| ExtendFieldProps<{
+								label: string;
+								isMulti?: false;
+								value: SingleValue<OptionType<T>>;
+								type: T;
+								source?:
+								| "companies"
+								| "offices"
+								| "users"
+								| "deliverers"
+								| "roles"
+								| "permissions"
+								| "productCategories"
+								| "warehouses"
+								| "vehicleTypes"
+								| "stores"
+								| string[];
+							}>
+							| ExtendFieldProps<{
+								label: string;
+								isMulti?: true;
+								value: MultiValue<OptionType<T>>;
+								type: T;
+								source?:
+								| "companies"
+								| "offices"
+								| "users"
+								| "deliverers"
+								| "roles"
+								| "permissions"
+								| "productCategories"
+								| "warehouses"
+								| "vehicleTypes"
+								| "stores"
+								| 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>;
+						};
+
+
+
+
+
+						export type SingleValue<Option> = Option | null;
+						export type MultiValue<Option> = Option[];
+
+
+
+
+						type BaseFieldOption<Input, IsMulti extends boolean = false> = {
+							label?: string;
+							required?: boolean;
+							default_value?: IsMulti extends true ? MultiValue<Input> : SingleValue<Input>;
+						}
+
+						type CustomFieldType =
+							| 'article_object'
+							| 'boolean'
+							| 'checkbox'
+							| 'date_range'
+							| 'date'
+							| 'file'
+							| 'image'
+							| 'number'
+							| 'radiobox'
+							| 'select'
+							| '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 '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 '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 'text' ? TextField.Options :
+							T extends 'time' ? TimeField.Options :
+							never;
+						}
+
+						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>;
+						}
+					}
+				}
+			}
+		}
+	}
+}
+

package/typings/v1/ui/forms/article/custom-fieds/fields/article_object.custom-field.d.ts

@@ -0,0 +1,29 @@
+declare module Levelup {
+
+	namespace CMS {
+		namespace V1 {
+			export namespace UI {
+				export namespace Forms {
+					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/ui/forms/article/custom-fieds/fields/boolean.custom-field.d.ts

@@ -0,0 +1,24 @@
+declare module Levelup {
+
+	namespace CMS {
+		namespace V1 {
+			export namespace UI {
+				export namespace Forms {
+					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/ui/forms/article/custom-fieds/fields/checkbox.custom-field.d.ts

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

package/typings/v1/ui/forms/article/custom-fieds/fields/date.custom-field.d.ts

@@ -0,0 +1,23 @@
+declare module Levelup {
+
+  namespace CMS {
+    namespace V1 {
+      export namespace UI {
+        export namespace Forms {
+          export namespace CustomFields {
+            export namespace DateField {
+
+              export type Key = "date";
+
+              export type Input = Date | null;
+
+              export type Output = Input;
+
+              export type Options = BaseFieldOption<Input, false> & {};
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/ui/forms/article/custom-fieds/fields/date_range.custom-field.d.ts

@@ -0,0 +1,26 @@
+declare module Levelup {
+
+  namespace CMS {
+    namespace V1 {
+      export namespace UI {
+        export namespace Forms {
+          export namespace CustomFields {
+            export namespace DateRangeField {
+
+              export type Key = "date_range";
+
+              export type Input = {
+                start: Date | null;
+                end: Date | null;
+              } | null;
+
+              export type Output = Input;
+
+              export type Options = BaseFieldOption<Input, false> & {};
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/ui/forms/article/custom-fieds/fields/file.custom-field.d.ts

@@ -0,0 +1,26 @@
+
+declare module Levelup {
+
+  namespace CMS {
+    namespace V1 {
+      export namespace UI {
+        export namespace Forms {
+          export namespace CustomFields {
+            export namespace FileField {
+
+              export type Key = "file";
+
+              export type Input<IsMulti extends boolean = false> = IsMulti extends true ? Utils.Common.FileAttribute[] : Utils.Common.FileAttribute | null;
+
+              export type Output<IsMulti extends boolean = false> = IsMulti extends true ? Utils.Common.FileAttribute[] : Utils.Common.FileAttribute | null;
+
+              export type Options<IsMulti extends boolean = false> = BaseFieldOption<Input, IsMulti> & {
+                multiple: IsMulti;
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/ui/forms/article/custom-fieds/fields/image.custom-field.d.ts

@@ -0,0 +1,25 @@
+declare module Levelup {
+
+  namespace CMS {
+    namespace V1 {
+      export namespace UI {
+        export namespace Forms {
+          export namespace CustomFields {
+            export namespace ImageField {
+
+              export type Key = "image";
+
+              export type Input<IsMulti extends boolean = false> = IsMulti extends true ? Utils.Common.FileAttribute[] : Utils.Common.FileAttribute | null;
+
+              export type Output<IsMulti extends boolean = false> = IsMulti extends true ? Utils.Common.FileAttribute[] : Utils.Common.FileAttribute | null;
+
+              export type Options<IsMulti extends boolean = false> = BaseFieldOption<Input, IsMulti> & {
+                multiple: IsMulti;
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/ui/forms/article/custom-fieds/fields/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./article_object.custom-field.d.ts";
+export * from "./boolean.custom-field.d.ts";
+export * from "./checkbox.custom-field.d.ts";
+export * from "./date.custom-field.d.ts";
+export * from "./file.custom-field.d.ts";
+export * from "./image.custom-field.d.ts";
+export * from "./number.custom-field.d.ts";
+export * from "./select.custom-field.d.ts";
+export * from "./text.custom-field.d.ts";
+export * from "./time.custom-field.d.ts";
+export * from "./radiobox.custom-field.d.ts";

package/typings/v1/ui/forms/article/custom-fieds/fields/number.custom-field.d.ts

@@ -0,0 +1,26 @@
+declare module Levelup {
+
+  namespace CMS {
+    namespace V1 {
+      export namespace UI {
+        export namespace Forms {
+          export namespace CustomFields {
+            export namespace NumberField {
+
+              export type Key = "number";
+
+              export type Input = number | null;
+
+              export type Output = Input;
+
+              export type Options = BaseFieldOption<Input, false> & {
+                min: number;
+                max: number;
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}