jourycms-sdk 1.0.1

package/typings/v1/events/payloads.d.ts

@@ -0,0 +1,339 @@
+declare class EventDispatcher {
+  private handlers;
+  remove(eventName: string): void;
+  remove(eventNames: string[]): void;
+  remove(callback: (data: any) => void): void;
+  detach(detachFrom: any, eventName?: string): void;
+  detach(detachFrom: any, eventNames?: string[]): void;
+  detach(detachFrom: any, callback?: (data: any) => void): void;
+  attach(attachTo: any, eventName: string, callback: (data: any) => void): void;
+  attach(
+    attachTo: any,
+    eventNames: string[],
+    callback: (data: any) => void
+  ): void;
+  on(eventName: string, callback: (data: any) => void): void;
+  on(eventNames: string[], callback: (data: any) => void): void;
+  dispatch<T = any>(eventName: string, data: T): void;
+  dispatch<T = any>(eventNames: string[], data: T): void;
+}
+
+/**
+ * @description project levelup
+ */
+declare module Levelup {
+  export namespace CMS {
+    export namespace V1 {
+      /**
+       * @description Service
+       */
+      export namespace Events {
+        export namespace Payloads {
+          
+          /* -------------------------------------------------------------------------- */
+          /*                                    AUTH                                    */
+          /* -------------------------------------------------------------------------- */
+
+          export namespace Users {
+            export namespace User {
+              export type created = {
+                data: Partial<Levelup.V2.Users.Entity.ExposedUser>;
+              };
+              export type updated = {
+                data: Partial<Levelup.V2.Users.Entity.ExposedUser>;
+              };
+              export type deleted = {
+                data: Partial<Levelup.V2.Users.Entity.ExposedUser>;
+              };
+              export type restored = {
+                data: Partial<Levelup.V2.Users.Entity.ExposedUser>;
+              };
+              export type roleChanged = {
+                data: Partial<Levelup.V2.Users.Entity.ExposedUser>;
+              };
+              export type permissionsChanged = {
+                data: Partial<Levelup.V2.Users.Entity.ExposedUser>;
+              };
+              export type attributeCompany = {
+                data: Partial<Levelup.V2.Users.Entity.ExposedUser>;
+                company: Levelup.V2.Accounts.Entity.Company;
+              };
+              export type attributeStore = {
+                data: Partial<Levelup.V2.Users.Entity.ExposedUser>;
+                store_id: Levelup.V2.Accounts.Entity.Store;
+              };
+              export type removeStore = {
+                data: Partial<Levelup.V2.Users.Entity.ExposedUser>;
+                store_id: string;
+              };
+              export type suspendStatusChanged = {
+                suspended: boolean;
+                data: Partial<Levelup.V2.Users.Entity.ExposedUser>;
+              };
+              export type loginInfoUpdated = {
+                data: Partial<Levelup.V2.Users.Entity.ExposedUser>;
+              };
+            }
+          }
+
+          export namespace Auth {
+            export type login = { data: Levelup.V2.Users.Entity.ExposedUser };
+            export type register = { data: Levelup.V2.Users.Entity.ExposedUser };
+            export type logout = { data: Levelup.V2.Users.Entity.ExposedUser };
+            export type restored = { data: Levelup.V2.Users.Entity.ExposedUser };
+
+            export namespace ApiKey {
+              export type created = {
+                data: Partial<Levelup.V2.Auth.Entity.ApiKey>;
+              };
+              export type updated = {
+                data: Partial<Levelup.V2.Auth.Entity.ApiKey>;
+              };
+              export type deleted = {
+                data: Partial<Levelup.V2.Auth.Entity.ApiKey>;
+              };
+              export type restored = {
+                data: Partial<Levelup.V2.Auth.Entity.ApiKey>;
+              };
+              export type enableStatusChanged = {
+                enabled: boolean;
+                data: Partial<Levelup.V2.Auth.Entity.ApiKey>;
+              };
+            }
+
+            export namespace Role {
+              export type created = {
+                data: Partial<Levelup.V2.Auth.Entity.Role>;
+              };
+              export type updated = {
+                data: Partial<Levelup.V2.Auth.Entity.Role>;
+              };
+              export type deleted = {
+                data: Partial<Levelup.V2.Auth.Entity.Role>;
+              };
+              export type restored = {
+                data: Partial<Levelup.V2.Auth.Entity.Role>;
+              };
+              export type permissionsChanged = {
+                data: Partial<Levelup.V2.Auth.Entity.Role>;
+              };
+              export type addUser = {
+                data: Partial<Levelup.V2.Auth.Entity.Role>;
+              };
+            }
+
+            export namespace Permission {
+              export type created = {
+                data: Partial<Levelup.V2.Auth.Entity.Permission>;
+              };
+              export type updated = {
+                data: Partial<Levelup.V2.Auth.Entity.Permission>;
+              };
+              export type deleted = {
+                data: Partial<Levelup.V2.Auth.Entity.Permission>;
+              };
+              export type restored = {
+                data: Partial<Levelup.V2.Auth.Entity.Permission>;
+              };
+              export type addRole = {
+                data: Partial<Levelup.V2.Auth.Entity.Permission>;
+              };
+              export type addUser = {
+                data: Partial<Levelup.V2.Auth.Entity.Permission>;
+              };
+              export type permissionListUpdated = {
+                data: Partial<Levelup.V2.Auth.Entity.Permission>[];
+              };
+            }
+            export namespace PermissionGroup {
+              export type created = {
+                data: Partial<Levelup.V2.Auth.Entity.PermissionGroup>;
+              };
+              export type updated = {
+                data: Partial<Levelup.V2.Auth.Entity.PermissionGroup>;
+              };
+              export type deleted = {
+                data: Partial<Levelup.V2.Auth.Entity.PermissionGroup>;
+              };
+              export type restored = {
+                data: Partial<Levelup.V2.Auth.Entity.PermissionGroup>;
+              };
+            }
+          }
+
+          /* -------------------------------------------------------------------------- */
+          /*                                     CM                                     */
+          /* -------------------------------------------------------------------------- */
+          export namespace Content {
+            export namespace Comment {
+              export type created = {
+                data: Partial<Levelup.V2.Cm.Entity.Comment>;
+              };
+              export type updated = {
+                data: Partial<Levelup.V2.Cm.Entity.Comment>;
+              };
+              export type deleted = {
+                data: Partial<Levelup.V2.Cm.Entity.Comment>;
+              };
+              export type restored = {
+                data: Partial<Levelup.V2.Cm.Entity.Comment>;
+              };
+            }
+            export namespace Review {
+              export type created = {
+                data: Partial<Levelup.V2.Cm.Entity.Review>;
+              };
+              export type updated = {
+                data: Partial<Levelup.V2.Cm.Entity.Review>;
+              };
+              export type deleted = {
+                data: Partial<Levelup.V2.Cm.Entity.Review>;
+              };
+              export type restored = {
+                data: Partial<Levelup.V2.Cm.Entity.Review>;
+              };
+            }
+            export namespace Article {
+              export type created = {
+                data: Partial<Levelup.V2.Cm.Entity.Article>;
+              };
+              export type updated = {
+                data: Partial<Levelup.V2.Cm.Entity.Article>;
+              };
+              export type deleted = {
+                data: Partial<Levelup.V2.Cm.Entity.Article>;
+              };
+              export type restored = {
+                data: Partial<Levelup.V2.Cm.Entity.Article>;
+              };
+            }
+            export namespace ArticleType {
+              export type created = {
+                data: Partial<Levelup.V2.Cm.Entity.ArticleType>;
+              };
+              export type updated = {
+                data: Partial<Levelup.V2.Cm.Entity.ArticleType>;
+              };
+              export type deleted = {
+                data: Partial<Levelup.V2.Cm.Entity.ArticleType>;
+              };
+              export type restored = {
+                data: Partial<Levelup.V2.Cm.Entity.ArticleType>;
+              };
+            }
+            export namespace Term {
+              export type created = { data: Partial<Levelup.V2.Cm.Entity.Term> };
+              export type updated = { data: Partial<Levelup.V2.Cm.Entity.Term> };
+              export type deleted = { data: Partial<Levelup.V2.Cm.Entity.Term> };
+              export type restored = { data: Partial<Levelup.V2.Cm.Entity.Term> };
+            }
+            export namespace Taxonomy {
+              export type created = {
+                data: Partial<Levelup.V2.Cm.Entity.Taxonomy>;
+              };
+              export type updated = {
+                data: Partial<Levelup.V2.Cm.Entity.Taxonomy>;
+              };
+              export type deleted = {
+                data: Partial<Levelup.V2.Cm.Entity.Taxonomy>;
+              };
+              export type restored = {
+                data: Partial<Levelup.V2.Cm.Entity.Taxonomy>;
+              };
+            }
+            export namespace Translation {
+              export namespace Item {
+                export type created = {
+                  data: Partial<Levelup.V2.Cm.Translation.Entity.Item>;
+                };
+                export type updated = {
+                  data: Partial<Levelup.V2.Cm.Translation.Entity.Item>;
+                };
+                export type deleted = {
+                  data: Partial<Levelup.V2.Cm.Translation.Entity.Item>;
+                };
+                export type restored = {
+                  data: Partial<Levelup.V2.Cm.Translation.Entity.Item>;
+                };
+              }
+              export namespace Project {
+                export type created = {
+                  data: Partial<Levelup.V2.Cm.Translation.Entity.Project>;
+                };
+                export type updated = {
+                  data: Partial<Levelup.V2.Cm.Translation.Entity.Project>;
+                };
+                export type deleted = {
+                  data: Partial<Levelup.V2.Cm.Translation.Entity.Project>;
+                };
+                export type restored = {
+                  data: Partial<Levelup.V2.Cm.Translation.Entity.Project>;
+                };
+              }
+              export namespace Namespace {
+                export type created = {
+                  data: Partial<Levelup.V2.Cm.Translation.Entity.Namespace>;
+                };
+                export type updated = {
+                  data: Partial<Levelup.V2.Cm.Translation.Entity.Namespace>;
+                };
+                export type deleted = {
+                  data: Partial<Levelup.V2.Cm.Translation.Entity.Namespace>;
+                };
+                export type restored = {
+                  data: Partial<Levelup.V2.Cm.Translation.Entity.Namespace>;
+                };
+              }
+            }
+          }
+
+          /* -------------------------------------------------------------------------- */
+          /*                                   STORAGE                                  */
+          /* -------------------------------------------------------------------------- */
+          export namespace Storage {
+            export namespace UploadedFile {
+              export type created = {
+                data: Partial<Levelup.V2.Storage.Entity.UploadedFile>;
+              };
+              export type updated = {
+                data: Partial<Levelup.V2.Storage.Entity.UploadedFile>;
+              };
+              export type deleted = {
+                data: Partial<Levelup.V2.Storage.Entity.UploadedFile>;
+              };
+              export type restored = {
+                data: Partial<Levelup.V2.Storage.Entity.UploadedFile>;
+              };
+            }
+          }
+
+          /* -------------------------------------------------------------------------- */
+          /*                                   SYSTEM                                   */
+          /* -------------------------------------------------------------------------- */
+          export namespace System {
+            export namespace App {
+              export type created = {
+                data: Partial<Levelup.V2.System.Entity.App>;
+              };
+              export type updated = {
+                data: Partial<Levelup.V2.System.Entity.App>;
+              };
+              export type deleted = {
+                data: Partial<Levelup.V2.System.Entity.App>;
+              };
+              export type restored = {
+                data: Partial<Levelup.V2.System.Entity.App>;
+              };
+              export type disabled = {
+                data: Partial<Levelup.V2.System.Entity.App>;
+              };
+              export type enabled = {
+                data: Partial<Levelup.V2.System.Entity.App>;
+              };
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./events/index.d.ts";
+export * from "./lib/index.d.ts";
+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 "./ui/index.d.ts";
+export * from "./utils/index.d.ts";

package/typings/v1/lib/execution-scenario/index.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @description project levelup
+ * @version 2.0.0
+ * @namespace Levelup
+ * @global
+ * @export Levelup
+ * @copyright drsalmi@icloud.com
+ * @name Salmi Ahmed
+ */
+declare module Levelup {
+
+  namespace CMS {
+    namespace V1 {
+      namespace Lib {
+        namespace ExecutionScenario {
+          export interface Scenario<T> {
+            method: string;
+            args: Record<string, any>;
+            authData: Levelup.V2.Security.AuthData;
+            execution: T
+          }
+        }
+      }
+    }
+  }
+}
+

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

@@ -0,0 +1,4 @@
+'generated by levelup';
+
+export * from "./logger/index.d.ts";
+export * from "./execution-scenario/index.d.ts";

package/typings/v1/lib/logger/index.d.ts

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

package/typings/v1/lib/logger/logger.d.ts

@@ -0,0 +1,53 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Lib {
+        namespace Logger {
+          /**
+           * Represents the context of a logger instance.
+           */
+          type InstanceContext =
+            | "APPLICATION"
+            | "MIDDLEWARE"
+            | "SUBSCRIBER"
+            | "BROKER"
+            | "MAPPER"
+            | "VALIDATOR"
+            | "SANITIZER"
+            | "COMPONENT"
+            | "UTILITY"
+            | "SEED"
+            | "SERVICE"
+            | "CONTROLLER"
+            | "LOADER"
+            | "MODEL"
+            | "REDUX"
+            | "HOOK"
+            | "PAGE"
+            | "MODAL"
+            | "GUARD"
+            | "FORM";
+
+          /**
+           * Represents the log type of a logger instance.
+           */
+          type LogType =
+            | "INFO"
+            | "WARN"
+            | "ERROR"
+            | "DEBUG"
+            | "SUCCESS"
+            | "SILLY"
+            | "HTTP"
+            | "EVENT"
+            | "VALUE";
+
+          /**
+           * Represents the configuration of a logger instance.
+           */
+          type InstanceConfig = unknown;
+        }
+      }
+    }
+  }
+}

package/typings/v1/modules/express/express.d.ts

@@ -0,0 +1,40 @@
+
+namespace Express {
+
+  export interface Request {
+    auth?: (
+      | Levelup.V2.Security.JWTPaymentAuthPayload
+      | Levelup.V2.Security.JWTUserAuthPayload
+    ) & {
+      iss?: string | undefined;
+      sub?: string | undefined;
+      aud?: string | string[] | undefined;
+      exp?: number | undefined;
+      nbf?: number | undefined;
+      iat?: number | undefined;
+      jti?: string | undefined;
+    };
+
+    current_token?: string | null;
+    jwt_expired?: boolean;
+
+    attached_entities: {
+      token?: string;
+      app?: Levelup.V2.System.Entity.App | null;
+      user?: Levelup.V2.Users.Entity.User | null;
+      api_key?: Levelup.V2.Auth.Entity.ExposedApiKey | null;
+      service?: {
+        name: string;
+        is_external: boolean;
+      };
+    };
+
+    has_access_if?: {
+      filters?: {
+        user?: Levelup.V2.Utils.Common.ID;
+      };
+      condition?: () => boolean;
+    } | null;
+  }
+}
+

package/typings/v1/modules/express/index.d.ts

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

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

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

package/typings/v1/modules/mongoose/index.d.ts

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

package/typings/v1/modules/mongoose/mongoose.d.ts

@@ -0,0 +1,48 @@
+declare module 'mongoose' {
+  type MongooseFuzzySearchingField<T = any> =
+    | keyof T
+    | {
+      name: keyof T;
+      minSize?: number;
+      weight?: number;
+      prefixOnly?: boolean;
+      escapeSpecialCharacters?: boolean;
+      keys?: (string | number)[];
+    };
+
+  interface MongooseFuzzySearchingOptions<T extends Record<string, unknown>> {
+    fields?: MongooseFuzzySearchingField<T>[];
+    middlewares?: any;
+  }
+
+  interface MongooseFuzzySearchingParams {
+    query: string;
+    minSize?: string;
+    prefixOnly?: boolean;
+    exact?: boolean;
+  }
+
+  /**
+   * @deprecated this makes Model type = any
+   * FIXME: this makes Model type = any
+   */
+  interface _Model<T extends Document> {
+    fuzzySearch(query: string | MongooseFuzzySearchingParams): Promise<T[]>;
+  }
+
+  type QueryWithFuzzySearch<Entity> = Query<(Entity & Document)[], Entity & Document, {}, Entity & Document> & {
+    // type QueryWithFuzzySearch<ResultType, DocType, THelpers = {}, RawDocType = DocType> = Query<ResultType, DocType, THelpers, RawDocType> & {
+    fuzzySearch?(query: string | MongooseFuzzySearchingParams): Query<(Entity & Document)[], Entity & Document, {}, Entity & Document>;
+  }
+}
+
+declare module 'mongoose-fuzzy-searching';
+
+declare module 'mongoose-fuzzy-searching/helpers' {
+  export function nGrams(
+    query: string,
+    escapeSpecialCharacters: boolean,
+    defaultNgamMinSize: number,
+    checkPrefixOnly: boolean
+  ): string[];
+}

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

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