jourycms-sdk 1.0.1

package/typings/v1/utils/dev/config.d.ts

@@ -0,0 +1,135 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Utils {
+        namespace Dev {
+          namespace Instrumentation {
+            type Instrumentation = {
+              concurrency: number;
+              /**
+               * Sleep time in milliseconds
+               */
+              sleep: {
+                min: number;
+                max: number;
+              };
+
+              accelerate?:
+                | {
+                    min: number;
+                    max: number;
+                  }
+                | (() => {
+                    min: number;
+                    max: number;
+                  });
+
+              store?: Common.TrackingID;
+              user?: Common.TrackingID;
+              disabled_tasks?: TTaskName[];
+            };
+
+            type Conditions = {
+              service?: System.Entity.TService;
+              disabled?: boolean;
+              auth?: {
+                company?: boolean;
+                office?: boolean;
+                store?: boolean;
+              };
+              compound?: {
+                operator: "AND" | "OR";
+                conditions: (Conditions & { compound: never })[];
+              };
+            };
+
+            type Weight = {
+              min: number;
+              max: number;
+            };
+
+            type Task<Extend extends object = Record<string, any>> = {
+              conditions?: Conditions;
+              weight: Weight;
+            } & Extend;
+
+            type UsersTasks =
+              | ({ name: "users.list" } & Task)
+              | ({ name: "users.create" } & Task<{
+                  role?: Auth.Entity.TDefaultUserRoles;
+                  name_from_role_and_office?: boolean;
+                }>);
+            type StoresTasks =
+              | ({ name: "stores.list" } & Task)
+              | ({ name: "stores.create" } & Task<{
+                  owner?: string;
+                }>);
+
+            type ProductsTasks =
+              | ({ name: "products.list" } & Task)
+              | ({ name: "products.create" } & Task);
+
+            type OrdersTasks =
+              | ({ name: "orders.list" } & Task)
+              | ({ name: "orders.create" } & Task)
+              | ({ name: "orders.changeStatus" } & Task<{
+                  status: Orders.Entity.TOrderStatus | "RANDOM";
+                }>);
+
+            type ParcelsTasks =
+              | ({ name: "parcels.list" } & Task)
+              | ({ name: "parcels.create" } & Task)
+              | ({ name: "parcels.changeStatus" } & Task<{
+                  status: Shipping.Entity.TParcelStatus | "RANDOM";
+                }>);
+
+            type SacsTasks =
+              | ({ name: "sacs.list" } & Task)
+              | ({ name: "sacs.create" } & Task)
+              | ({ name: "sacs.changeStatus" } & Task<{
+                  status: Shipping.Entity.TSacStatus | "RANDOM";
+                }>);
+
+            type TTaskName =
+              // users
+              | "users.list"
+              | "users.create"
+              // stores
+              | "stores.list"
+              | "stores.create"
+              // products
+              | "products.list"
+              | "products.create"
+              // orders
+              | "orders.list"
+              | "orders.create"
+              | "orders.changeStatus"
+              // parcels
+              | "parcels.list"
+              | "parcels.create"
+              | "parcels.changeStatus"
+              // sacs
+              | "sacs.list"
+              | "sacs.create"
+              | "sacs.changeStatus";
+
+            type AnyTask =
+              | UsersTasks
+              | StoresTasks
+              | ProductsTasks
+              | SacsTasks
+              | ParcelsTasks
+              | OrdersTasks;
+
+            type Tasks = AnyTask[];
+
+            type Config = {
+              instrumentation: Instrumentation;
+              tasks: Tasks;
+            };
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,4 @@
+"generated by levelup";
+
+export * from "./instrumentation.d.ts";
+export * from "./config.d.ts";

package/typings/v1/utils/dev/instrumentation.d.ts

@@ -0,0 +1,41 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Utils {
+        namespace Dev {
+          namespace Instrumentation {
+            type TEventName = "sleep" | "info" | "login" | TTaskName;
+            type TStatus = "info" | "success" | "error" | "warn";
+
+            interface IEvent {
+              auth: {
+                app: string; // name
+                company: Levelup.V2.Utils.Entity.Snapshots.Accounts.Company | null;
+                user: Levelup.V2.Utils.Entity.Snapshots.Auth.User | null;
+                store: Levelup.V2.Utils.Entity.Snapshots.Accounts.Store | null;
+                office: Levelup.V2.Utils.Entity.Snapshots.Logistics.Office | null;
+              };
+              date: Date;
+              status: TStatus;
+              event: TEventName;
+              name: string;
+              duration?: number; // in milliseconds
+              entity?: Levelup.V2.SystemStructure.Services.Models.LevelupModels;
+              description?: string;
+              error?: boolean;
+              /**
+               * @param {boolean} fatal
+               * - true: if the error is fatal and the scenario should stop
+               * - false: if the error is not fatal and the scenario should continue
+               */
+              fatal?: boolean;
+              meta?: {
+                [key: string]: any;
+              };
+            }
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,66 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Utils {
+        namespace Entity {
+          /* ------------------------ COMMON GENERAL INTERFACES ----------------------- */
+          namespace General {
+            type TImportStatus = "draft" | "imported" | "created";
+            type ICreatable = {
+              app?: Utils.Common.ID | null;
+              company?: Utils.Common.ID | null;
+              created_by?: Utils.Common.ID | null;
+              created_by_original_user?: Snapshots.Auth.User | null;
+              created_at?: Date;
+              updated_at?: Date;
+              is_deleted?: boolean;
+              deleted_at?: Date | null;
+              tags?: {
+                [name: string]: any;
+              };
+              updates?: Utils.Entity.General.IItemUpdate[];
+            };
+
+            type IHasSearchMeta = {
+              search_meta?: string;
+            };
+
+            interface IImported {
+              import_status?: TImportStatus;
+              import_id?: string;
+              import_tracking_id?: string;
+              import_index?: number;
+            }
+
+            interface IDeliverable {}
+
+            interface IAttachment {
+              _id: string;
+              url: string;
+              type: string;
+            }
+
+            interface IItemUpdate {
+              updated_by_system?: boolean;
+              updated_by: Snapshots.Auth.User | null;
+              date: Date;
+              action: string;
+              updates: {
+                field: string;
+                old_value: unknown;
+                new_value: unknown;
+              }[];
+            }
+
+            interface IDateRangObject {
+              start: string | Date;
+              end: string | Date;
+            }
+
+            export type HasStartEnd = IDateRangObject;
+          }
+        }
+      }
+    }
+  }
+}

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

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

package/typings/v1/utils/entities/snapshots.d.ts

@@ -0,0 +1,69 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Utils {
+        namespace Entity {
+          /* ------------------------ COMMON GENERAL INTERFACES ----------------------- */
+          namespace Snapshots {
+            /* ------------------------- COMMON AUTH INTERFACES ------------------------- */
+            namespace Auth {
+              interface User {
+                _id: string | null;
+                tracking_id: string | null;
+                first_name: string | null;
+                family_name: string | null;
+                phones: string[];
+                photo: Common.FileAttribute;
+                role: string;
+              }
+            }
+
+            /* ----------------------- COMMON LOCATIONS INTERFACES ---------------------- */
+            export namespace Locations {
+              interface Address {
+                country_id: string;
+                country_code: string;
+                country_name: string;
+                state_id: string;
+                state_code: string;
+                state_name: string;
+                state_zone?: number;
+                city_id: string;
+                city_code: string;
+                city_name: string;
+                city_zone?: number;
+                street_address?: string;
+              }
+              interface City {
+                _id: string;
+                code: string;
+                name: string;
+                country_id: string;
+                state_id: string;
+                country_code: string;
+                state_code: string;
+                country_name: string;
+                state_name: string;
+              }
+              interface State {
+                _id: string;
+                code: string;
+                name: string;
+                country_id: string;
+                country_code: string;
+                country_name: string;
+              }
+              interface Country {
+                _id: string;
+                code: string;
+                name: string;
+              }
+            }
+
+            
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,10 @@
+'generated by levelup';
+
+export * from "./utils.d.ts";
+export * from "./seed/index.d.ts";
+export * from "./models/index.d.ts";
+export * from "./insights/index.d.ts";
+export * from "./entities/index.d.ts";
+export * from "./dev/index.d.ts";
+export * from "./common/index.d.ts";
+export * from "./api/index.d.ts";

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

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

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

@@ -0,0 +1,50 @@
+import { SchemaDefinitionProperty } from "mongoose";
+
+declare global {
+  namespace Levelup {
+    namespace CMS {
+      namespace V1 {
+        namespace Utils {
+          namespace Mongodb {
+            export type StrictSchemaDefinition<
+              T = undefined,
+              EnforcedDocType = any,
+            > = T extends undefined
+              ? { [path: string]: SchemaDefinitionProperty }
+              : {
+                  [path in keyof Complete<T>]: SchemaDefinitionProperty<
+                    Complete<T>[path],
+                    EnforcedDocType
+                  >;
+                };
+
+            type DeepStrictSchemaDefinition<
+              T = undefined,
+              EnforcedDocType = any,
+            > = {
+              [K in keyof Required<T>]: T[K] extends Date
+                ? SchemaDefinitionProperty<T[K], EnforcedDocType>
+                : T[K] extends object & { push?: never; unshift?: never }
+                  ?
+                      | DeepStrictSchemaDefinition<T[K], EnforcedDocType>
+                      | {
+                          type: DeepStrictSchemaDefinition<
+                            T[K],
+                            EnforcedDocType
+                          >;
+                          default?: T[K] | undefined;
+                          required?: boolean;
+                          unique?: boolean;
+                          index?: boolean;
+                          ref?: string;
+                          _id?: false;
+                        }
+                  : // : SchemaDefinition;
+                    SchemaDefinitionProperty<T[K], EnforcedDocType>;
+            };
+          }
+        }
+      }
+    }
+  }
+}

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

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

package/typings/v1/utils/seed/locations.d.ts

@@ -0,0 +1,41 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Utils {
+        export namespace Seed {
+          export interface SeedData {
+            countries: Country[];
+            countryFlags: { [key: string]: string };
+            dzStatesShipmentFees: DzStatesShipmentFees;
+            dzStates: { [key: string]: string };
+            dzCities: { state: string; cities: DzCity[] }[];
+          }
+
+          export interface Country {
+            id: number;
+            name: string;
+            alpha2: string;
+            alpha3: string;
+          }
+
+          export interface DzCity {
+            id: number;
+            nom: string;
+            wilaya_id: number;
+            sac_wilaya_id: number;
+            hasHub: number;
+            hasdesk: number;
+            deliverable: number;
+            dureedeviecolis: number;
+            dureedeviepaiement: number;
+          }
+
+          export interface DzStatesShipmentFees {
+            home: { [key: string]: number };
+            desk: { [key: string]: number };
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/utils/system/microservice.d.ts

@@ -0,0 +1,11 @@
+declare module Levelup {
+	namespace CMS {
+		namespace V1 {
+			namespace Utils {
+				namespace SystemStructure {
+					export type TMicroService = 'DEFAULT' | 'auth' | 'content' | 'storage' | 'system';
+				}
+			}
+		}
+	}
+}

package/typings/v1/utils/system/models.d.ts

@@ -0,0 +1,21 @@
+declare module Levelup {
+	namespace CMS {
+		namespace V1 {
+			namespace Utils {
+				namespace SystemStructure {
+				namespace Models {
+          /**
+           * TODO: finish this
+           */
+          export type AllModels = string;
+          
+          /**
+           * TODO: finish this
+           */
+          export type EntityType<M extends AllModels> = any;
+				}
+				}
+			}
+		}
+	}
+}

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

@@ -0,0 +1,171 @@
+// import { Document, Model } from 'mongoose';
+
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Utils {
+        export type PropType<TObj, TProp extends keyof TObj> = TObj[TProp];
+        export type PropTypeNonNullable<
+          TObj,
+          TProp extends keyof TObj,
+        > = NonNullable<TObj[TProp]>;
+
+        export type Maybe<T> = T | null;
+        export type Exact<T extends { [key: string]: unknown }> = {
+          [K in keyof T]: T[K];
+        };
+        export type Complete<T> = {
+          [P in keyof Required<T>]: Pick<T, P> extends Required<Pick<T, P>>
+            ? T[P]
+            : T[P] | undefined;
+        };
+
+        // Type utility to extract string literals recursively
+        type RecursiveKeyUnion<T> = T extends object
+          ? { [K in keyof T]: RecursiveKeyUnion<T[K]> }[keyof T]
+          : T;
+
+        type DeepComplete<T = undefined> = {
+          [K in keyof Complete<T>]: T[K] extends Date
+            ? Date
+            : T[K] extends object & { push?: never; unshift?: never }
+              ? DeepComplete<T[K]>
+              : NonUndefined<T[K]>;
+        };
+
+        export type NonUndefined<T> = T extends undefined ? never : T;
+
+        type MergeTypes<A, B> = {
+          [key in keyof A]: key extends keyof B ? B[key] : A[key];
+        } & B;
+
+        export type Frequency =
+          | {
+              frequency: "everyMinute" | "everyHour" | "everyDay";
+            }
+          | {
+              frequency: "custom";
+              interval:
+                | `every ${number}s`
+                | `every ${number}m`
+                | `every ${number}h`
+                | `every ${number}h ${number}m`
+                | `every ${number}h ${number}m ${number}s`;
+            };
+
+        export type DocumentProperties<T> = T extends object & {
+          push?: never;
+          unshift?: never;
+        }
+          ? {
+              [K in keyof T]-?: K extends string | number
+                ?
+                    | `${K}`
+                    | `${K}.${DocumentProperties<T[K]>}`
+                    | (T extends { attributes?: object }
+                        ? DocumentRootProperties<T["attributes"]>
+                        : never)
+                    | (T[K] extends Array<any>
+                        ? `${K}.${DocumentProperties<T[K][number]>}`
+                        : never)
+                : never;
+            }[keyof T]
+          : never;
+
+        export type ExcludeDocumentProperties<T> = T extends object & {
+          push?: never;
+          unshift?: never;
+        }
+          ? {
+              [K in keyof T]-?: K extends string | number
+                ?
+                    | `-${K}`
+                    | `-${K}.${DocumentProperties<T[K]>}`
+                    | (T extends { attributes?: object }
+                        ? ExcludeDocumentRootProperties<T["attributes"]>
+                        : never)
+                    | (T[K] extends Array<any>
+                        ? `${K}.${DocumentProperties<T[K][number]>}`
+                        : never)
+                : never;
+            }[keyof T]
+          : never;
+
+        export type DocumentRootProperties<T> = T extends object
+          ? {
+              [K in keyof T]-?: K extends string | number ? `${K}` : never;
+            }[keyof T]
+          : never;
+
+        export type ExcludeDocumentRootProperties<T> = T extends object
+          ? {
+              [K in keyof T]-?: K extends string | number ? `-${K}` : never;
+            }[keyof T]
+          : never;
+
+        export type DeepKeys<T> = T extends object & {
+          push?: never;
+          unshift?: never;
+        }
+          ? {
+              [K in keyof T]-?: K extends string | number
+                ? `${K}` | `${K}.${DeepKeys<T[K]>}`
+                : never;
+            }[keyof T]
+          : never;
+
+        export type DeepStringKeys<T> = T extends object & {
+          push?: never;
+          unshift?: never;
+        }
+          ? {
+              [K in keyof T]-?: K extends string | number
+                ? `${K}.${DeepKeys<T[K]>}`
+                : never;
+            }[keyof T]
+          : never;
+
+        /**
+         * Update : LeafKeys excludes the keys of object values
+         * @author dr. Salmi <reevosolutions@gmail.com>
+         * @since 29-10-2024 19:18:23
+         */
+        type LeafKeys<T> = T extends object
+          ? {
+              [K in Extract<keyof T, string | number>]: T[K] extends object
+                ? `${K}.${LeafKeys<T[K]>}`
+                : `${K}`;
+            }[Extract<keyof T, string | number>]
+          : never;
+
+        export type WithRequiredProperty<
+          Type,
+          Key extends keyof Type = keyof Type,
+        > = Type & {
+          [Property in Key]-?: Type[Property];
+        };
+
+        export type WithSelfChildren<T, C extends string> = T & {
+          [Prop in C]?: WithSelfChildren<T, C>[];
+        };
+
+        export type CachedHeavyResult<T> = {
+          last_updated?: Date;
+          next_update?: Date;
+          found?: boolean;
+          expired?: boolean;
+          value?: T;
+        };
+
+        /**
+         * Update : Added
+         * @author dr. Salmi <reevosolutions@gmail.com>
+         * @since 24-10-2024 17:51:08
+         */
+        export type DeepPartial<T> = {
+          [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+        };
+      }
+    }
+  }
+}