jourycms-sdk 1.0.1

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

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

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

@@ -0,0 +1,27 @@
+declare module Levelup {
+
+  namespace CMS {
+    namespace V1 {
+      export namespace UI {
+        export namespace Forms {
+          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: MultiValue<Utils.Common.TLabelValue>
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/ui/forms/article/custom-fieds/fields/text.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 TextField {
+
+              export type Key = "text";
+
+              export type Input = string | null;
+
+              export type Output = Input;
+
+              export type Options = BaseFieldOption<Input, false> & {
+                min: number;
+                max: number;
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/ui/forms/article/custom-fieds/fields/time.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 TimeField {
+
+              export type Key = "time";
+
+              export type Input = SingleValue<Utils.Common.Time>;
+
+              export type Output = Input;
+
+              export type Options = BaseFieldOption<Input> & {
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1 @@
+export * from "./fields/index..d.ts";

package/typings/v1/ui/forms/article/index.d.ts

@@ -0,0 +1 @@
+export * from "./custom-fields/index..d.ts";

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

@@ -0,0 +1 @@
+export * from "./article/index.d.ts";

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

@@ -0,0 +1,3 @@
+export * from "./admin/index.d.ts";
+export * from "./forms/index.d.ts";
+export * from "./routes/index.d.ts";

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

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

package/typings/v1/ui/routes/routes.d.ts

@@ -0,0 +1,73 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      export namespace UI {
+        export namespace Routes {
+          type IconType = (props: {
+            className?: string | undefined;
+            height?: number | string | undefined;
+            id?: string | undefined;
+            lang?: string | undefined;
+            max?: number | string | undefined;
+            media?: string | undefined;
+            method?: string | undefined;
+            min?: number | string | undefined;
+            name?: string | undefined;
+            style?: CSSProperties | undefined;
+            target?: string | undefined;
+            type?: string | undefined;
+            width?: number | string | undefined;
+            children?: React.ReactNode;
+            size?: string | number;
+            color?: string;
+            title?: string;
+          }) => JSX.Element;
+
+          type TACAction = "read" | "create" | "update" | "delete" | "manage";
+
+          type TMenuSlotName = "articleTypes";
+          type TMenuSlotResultReturnType = {
+            [id: string]: Levelup.CMS.V1.UI.Routes.RouteItem;
+          };
+          type TMenuSlotResultFunction<T extends TMenuSlotName> =
+            T extends "articleTypes"
+            ? (
+              types: Levelup.CMS.V1.Content.Entity.ArticleType[],
+            ) => Promise<TMenuSlotResultReturnType>
+            : () => Promise<TMenuSlotResultReturnType>;
+
+          type TMenuSlot<T extends TMenuSlotName> = () => {
+            slot: T;
+            result: TMenuSlotResultFunction<T>;
+          };
+
+          type RouteItem = {
+            path: `/${string}`;
+            title: string;
+            menuTitle?: string;
+            icon?: IconType;
+            ac: (
+              | `${string}.${TACAction}`
+              | ((config: { extensions: string[] }) => boolean)
+            )[];
+            tutorialLink?: string;
+            description?: string;
+            hideOnMenu?: boolean;
+            isNew?: boolean;
+            isUpdated?: boolean;
+            _?: {
+              [Key: string]: RouteItem;
+            };
+            // placeholder?: SubroutesPlaceholder;
+          };
+
+          // type RouteSlot = (entity: string) =>
+
+          type RouteItems = {
+            [id: string]: RouteItem | TMenuSlot<TMenuSlotName>;
+          };
+        }
+      }
+    }
+  }
+}

package/typings/v1/utils/api/index.d.ts

@@ -0,0 +1,4 @@
+'generated by levelup';
+
+export * from "./response.d.ts";
+export * from "./request.d.ts";

package/typings/v1/utils/api/request.d.ts

@@ -0,0 +1,215 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      export namespace Utils {
+
+        export namespace Api {
+          export namespace Request {
+            type Request<T> = T & {
+              cancelToken?: any;
+            };
+            type PagedRequestFields = {
+              count?: number;
+              page?: number;
+            };
+            type Paged = {
+              count?: number;
+              page?: number;
+            };
+            type SortableRequestFields<T extends object> = {
+              sort_by: Levelup.V2.Utils.DocumentProperties<T>;
+              sort: "desc" | "asc";
+            };
+            type Sortable<T extends object> = {
+              sort_by?: Levelup.V2.Utils.DocumentProperties<T>;
+              sort?: "desc" | "asc";
+            };
+            type Searchable = {
+              search?: string;
+            };
+
+            type FilterableDeliverable<T extends string> = {
+              [K in T]?: any;
+            } & {
+              city?: string | string[];
+              state?: string | string[];
+              country?: string | string[];
+              starting_city?: string | string[];
+              starting_state?: string | string[];
+              starting_country?: string | string[];
+              current_city?: string | string[];
+              current_state?: string | string[];
+              current_country?: string | string[];
+              intermediate_city?: string | string[];
+              intermediate_state?: string | string[];
+              intermediate_country?: string | string[];
+              destination_city?: string | string[];
+              destination_state?: string | string[];
+              destination_country?: string | string[];
+              office?: string | string[];
+              starting_office?: string | string[];
+              current_office?: string | string[];
+              intermediate_office?: string | string[];
+              destination_office?: string | string[];
+              office_tracking?: string | string[];
+              starting_office_tracking?: string | string[];
+              current_office_tracking?: string | string[];
+              intermediate_office_tracking?: string | string[];
+              destination_office_tracking?: string | string[];
+              not?: { [K in T]?: any } & {
+                city?: string | string[];
+                state?: string | string[];
+                country?: string | string[];
+                starting_city?: string | string[];
+                starting_state?: string | string[];
+                starting_country?: string | string[];
+                current_city?: string | string[];
+                current_state?: string | string[];
+                current_country?: string | string[];
+                intermediate_city?: string | string[];
+                intermediate_state?: string | string[];
+                intermediate_country?: string | string[];
+                destination_city?: string | string[];
+                destination_state?: string | string[];
+                destination_country?: string | string[];
+                office?: string | string[];
+                starting_office?: string | string[];
+                current_office?: string | string[];
+                intermediate_office?: string | string[];
+                destination_office?: string | string[];
+                office_tracking?: string | string[];
+                starting_office_tracking?: string | string[];
+                current_office_tracking?: string | string[];
+                intermediate_office_tracking?: string | string[];
+                destination_office_tracking?: string | string[];
+              };
+            };
+            type Filterable<T extends string> = {
+              [K in T]?: unknown;
+            } & {
+              load_deleted?: boolean;
+              not?: { [K in T]?: unknown };
+            } & {
+              filters?: { [K in T]?: unknown } & {
+                not?: {
+                  [K in T]?: unknown;
+                };
+              };
+            };
+
+            type Projectable<T extends object> = {
+              fields?: (
+                | Utils.DocumentProperties<T>
+                | Utils.ExcludeDocumentProperties<T>
+              )[];
+            };
+
+            type Build<T> = Request<T>;
+            type BuildSearchable = Request<Searchable>;
+            type BuildPaged = Request<Paged>;
+            type BuildSortable<T extends object> = Request<Sortable<T>>;
+            type BuildProjectable<T extends object> = Request<Projectable<T>>;
+            type BuildSearchablePaged = Request<Searchable & Paged>;
+            type BuildSearchablePagedProjectable<T extends object> = Request<
+              Searchable & Paged & Projectable<T>
+            >;
+            type BuildSearchablePagedSortable<T extends object> = Request<
+              Searchable & Paged & Sortable<T>
+            >;
+            type BuildSearchablePagedSortableProjectable<T extends object> =
+              Request<Searchable & Paged & Sortable<T> & Projectable<T>>;
+            type BuildSearchablePagedFilterable<T> = Request<
+              Searchable &
+                Paged &
+                Filterable<Levelup.V2.Utils.DocumentProperties<T>>
+            >;
+            type BuildSearchablePagedFilterableProjectable<T extends object> =
+              Request<
+                Searchable &
+                  Paged &
+                  Filterable<Levelup.V2.Utils.DocumentProperties<T>> &
+                  Projectable<T>
+              >;
+            type BuildSearchablePagedSortableFilterable<T extends object> =
+              Request<
+                Searchable &
+                  Paged &
+                  Filterable<Levelup.V2.Utils.DocumentProperties<T>> &
+                  Sortable<T>
+              >;
+            type BuildSearchablePagedSortableFilterableProjectable<
+              T extends object,
+            > = Request<
+              Searchable &
+                Paged &
+                Filterable<Levelup.V2.Utils.DocumentProperties<T>> &
+                Filterable<Levelup.V2.Utils.DocumentProperties<T>> &
+                Sortable<T> &
+                Projectable<T>
+            >;
+            type BuildSortableFilterable<T extends object> = Request<
+              Filterable<Levelup.V2.Utils.DocumentProperties<T>> & Sortable<T>
+            >;
+            type BuildSortableFilterableProjectable<T extends object> = Request<
+              Filterable<Levelup.V2.Utils.DocumentProperties<T>> &
+                Sortable<T> &
+                Projectable<T>
+            >;
+            type BuildSearchablePagedFilterableDeliverable<T extends object> =
+              Request<
+                Searchable &
+                  Paged &
+                  FilterableDeliverable<Levelup.V2.Utils.DocumentProperties<T>>
+              >;
+            type BuildSearchablePagedFilterableDeliverableProjectable<
+              T extends object,
+            > = Request<
+              Searchable &
+                Paged &
+                FilterableDeliverable<Levelup.V2.Utils.DocumentProperties<T>> &
+                Projectable<T>
+            >;
+            type BuildSearchablePagedSortableFilterableDeliverable<
+              T extends object,
+            > = Request<
+              Searchable &
+                Paged &
+                FilterableDeliverable<Levelup.V2.Utils.DocumentProperties<T>> &
+                Sortable<T>
+            >;
+            type BuildSearchablePagedSortableFilterableDeliverableProjectable<
+              T extends object,
+            > = Request<
+              Searchable &
+                Paged &
+                FilterableDeliverable<Levelup.V2.Utils.DocumentProperties<T>> &
+                Sortable<T> &
+                Projectable<T>
+            >;
+
+            // create
+
+            type TOmittedFieldsFromCreateRequestData =
+              | "_id"
+              | "createdAt"
+              | "updatedAt"
+              | "user"
+              | "tracking_id";
+            type BuildCreateRequest<T extends object> = Build<{
+              data: Partial<Omit<T, TOmittedFieldsFromCreateRequestData>>;
+            }>;
+
+            type TOmittedFieldsFromUpdateRequestData =
+              | "createdAt"
+              | "updatedAt"
+              | "user"
+              | "tracking_id";
+            type BuildUpdateRequest<T extends object> = Build<{
+              data: Partial<Omit<T, TOmittedFieldsFromUpdateRequestData>>;
+            }>;
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/utils/api/response.d.ts

@@ -0,0 +1,188 @@
+/**
+ * @description project levelup
+ */
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Utils {
+        
+        export namespace Api {
+          export namespace Response {
+            type ErrorObject = {
+              is_axios?: boolean;
+              is_joi?: boolean;
+              is_mongoose?: boolean;
+              is_celebrate?: boolean;
+              name: string;
+              message: string;
+              status: number | string;
+              code: number | string;
+              headers?: any;
+              params?: any;
+              body?: any;
+              data?: any;
+              baseURL?: string;
+              url?: string;
+              method?: string;
+              errors?: any;
+              fields?: any;
+              stack: string | string[];
+            };
+
+            type ErrorFields<F extends string | number | symbol = string> = {
+              [key in F]?: {
+                value: any;
+                message: string;
+                label?: string;
+                meta?: any;
+              };
+            };
+            type ErrorFieldsInObjectProperties<
+              Obj extends object,
+              F extends Levelup.V2.Utils.DocumentRootProperties<Obj>,
+            > = {
+              [key in F]?: {
+                value: any;
+                message: string;
+                label?: string;
+                meta?: any;
+              };
+            };
+
+            type Error = {
+              message: string;
+              name: string;
+              status: number;
+              fields?: ErrorFields;
+              stack?: string[];
+              isAxios?: boolean;
+            };
+
+            type DefaultResponse = {
+              error?: Error;
+              request?: any;
+              token?: string;
+            };
+            type PagedResponse = {
+              pagination?: {
+                total: number;
+                pages: number;
+              };
+              links?: {
+                self?: string;
+                before?: string;
+                next?: string;
+              };
+            };
+
+            type TEdge<K extends keyof TResponseEdge> = {
+              [P in K]-?: NonNullable<TResponseEdge[P]>;
+            };
+
+            type BuildSingleItemResponse<
+              T,
+              Edges extends keyof TResponseEdge = undefined,
+            > = {
+              data?: T;
+              edge?: {
+                [P in Edges]-?: NonNullable<TResponseEdge[P]>;
+              };
+            } & DefaultResponse;
+
+            /**
+             * @param T
+             * @param Edges
+             */
+            type BuildListResponse<
+              T,
+              Edges extends keyof TResponseEdge = undefined,
+            > = {
+              data?: T[];
+              edge?: {
+                [P in Edges]-?: TResponseEdge[P];
+              };
+            } & PagedResponse &
+              DefaultResponse;
+
+            type DefaultDeleteResponse = {
+              data?: {
+                deleted?: boolean;
+                restored?: boolean;
+              };
+            } & DefaultResponse;
+
+            type DefaultBulkDeleteResponse = {
+              data?: {
+                [_id: string]: boolean;
+              };
+            } & DefaultResponse;
+
+            type TResponseEdge = {
+              companies: {
+                [ID: string]: Utils.Entity.Snapshots.Accounts.Company | null;
+              };
+              company:
+                | Utils.Entity.Snapshots.Accounts.Company
+                | Accounts.Entity.Company
+                | null;
+              stores: {
+                [ID: string]: Utils.Entity.Snapshots.Accounts.Store | null;
+              };
+              store:
+                | Utils.Entity.Snapshots.Accounts.Store
+                | Accounts.Entity.Store
+                | null;
+              users: {
+                [ID: string]: Utils.Entity.Snapshots.Auth.User | null;
+              };
+              user: Utils.Entity.Snapshots.Auth.User | Users.Entity.User | null;
+              offices: {
+                [ID: string]: Utils.Entity.Snapshots.Logistics.Office | null;
+              };
+              office:
+                | Utils.Entity.Snapshots.Logistics.Office
+                | Logistics.Entity.Office
+                | null;
+              regional_managements: {
+                [
+                  ID: string
+                ]: Utils.Entity.Snapshots.Logistics.RegionalManagement | null;
+              };
+              warehouses: {
+                [ID: string]: Utils.Entity.Snapshots.Logistics.Warehouse | null;
+              };
+              product_categories: {
+                [
+                  ID: string
+                ]: Utils.Entity.Snapshots.Products.ProductCategory | null;
+              };
+              products: {
+                [ID: string]: Products.Entity.Product | null;
+              };
+              product_snapshots: {
+                [
+                  TrackingID: string
+                ]: Utils.Entity.Snapshots.Products.ProductCategory | null;
+              };
+              parcels: {
+                [ID: string]: Shipping.Entity.Parcel | null;
+              };
+
+              deposits: Payment.Entity.Deposit[];
+              payments: Payment.Entity.Payment[];
+            };
+
+            type BuildResponseEdge<K extends keyof TResponseEdge> = Pick<
+              TResponseEdge,
+              K
+            >;
+
+            type EdgedResponse<TRes, K extends keyof TResponseEdge> = TRes & {
+              edge?: Pick<TResponseEdge, K>;
+            };
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/utils/common/common.d.ts

@@ -0,0 +1,53 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Utils {
+        namespace Common {
+          type ID = string;
+          type TrackingID = string;
+          type Code = string;
+          type LetterCode = string;
+          type NumberCode = string;
+          type LocationAdministrativeCode = string;
+          type Slug = string;
+          type Name = string;
+          type Time = `${string}:${string}`;
+          /**
+           * @description Location [longitude, latitude]
+           */
+          type Location = [number, number];
+          type FileAttribute = {
+            id: string | null;
+            url: string | null;
+          } | null;
+
+          type TLabelValue<T = string> = {
+            value: T;
+            label: string;
+          }
+
+          type SocialNetworks =
+            | "facebook"
+            | "youtube"
+            | "linkedin"
+            | "instagram"
+            | "viber"
+            | "whatsapp"
+            | "twitter"
+            | "reddit"
+            | "tiktok"
+            | "snapchat";
+
+          export type TDay =
+            | "sunday"
+            | "monday"
+            | "tuesday"
+            | "wednesday"
+            | "thursday"
+            | "friday"
+            | "saturday";
+        }
+      }
+    }
+  }
+}

package/typings/v1/utils/common/index.d.ts

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