jourycms-sdk 1.0.1

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

@@ -0,0 +1,158 @@
+import {
+  AxiosHeaderValue,
+  AxiosRequestConfig,
+  AxiosResponse,
+  AxiosInstance,
+} from "axios";
+
+
+declare global {
+  namespace Levelup {
+
+    namespace CMS {
+      namespace V1 {
+
+        namespace SDK {
+
+          interface ISdk {
+            generateHeadersFromRequestConfig(config?: TRequestConfig): { [key: string]: AxiosHeaderValue; }
+
+            handleError(err: any): IError;
+            // eslint-disable-next-line @typescript-eslint/ban-types
+            handleResponse<T extends SDK.IResponse>(response: AxiosResponse<T, any>, callback: Function, path: string, ...args: any[]): Promise<SDK.TResponseDatum<T>>;
+            reinitRequestCount(): void;
+            incrementRequestCount(): void;
+            getRequestCount(): number
+            readonly httpClient: IHttpClient;
+            readonly config: ISdkConfig;
+          }
+
+          interface ISdkConfig {
+            baseURL: string;
+            appId: string;
+            appSecret: string;
+            logResponses?: boolean;
+            env?: TEnvironment;
+            headers: () => { [key: string]: string } | PromiseLike<{ [key: string]: string }>;
+            refreshTokenHandler?: (sdk: ISdk) => Promise<void>;
+            debug: boolean;
+          }
+
+          type TRequestConfig = {
+            token?: string;
+            app?: string;
+            company?: string;
+            office?: string;
+            store?: string;
+          } & ({
+            serviceName: string;
+            serviceToken: string;
+          } | {
+            serviceName?: never;
+            serviceToken?: never;
+          }) & {
+            throw_not_found_error?: boolean;
+          };
+
+
+
+          interface IAppContainer {
+            readonly sdk: ISdk;
+          }
+
+          interface IServiceContainer {
+            readonly sdk: ISdk;
+            readonly prefix: string;
+          }
+
+          interface IClient {
+            // readonly prefix: string;
+          }
+
+          type TEnvironment = "production" | "development";
+          type PathPrefix = '' | `/${string}`;
+
+          type TResponseDatum<T extends { data?: object | Array<object>; } & Levelup.V2.Utils.Api.Response.DefaultResponse & Levelup.V2.Utils.Api.Response.PagedResponse> =
+            Levelup.V2.Utils.NonUndefined<T['data']> extends Array<any> ? {
+              data: Levelup.V2.Utils.NonUndefined<T['data']>;
+              edge: Levelup.V2.Utils.NonUndefined<T['edge']>;
+              pagination?: Levelup.V2.Utils.NonUndefined<Levelup.V2.Utils.Api.Response.PagedResponse['pagination']>;
+            } : {
+              data: Levelup.V2.Utils.NonUndefined<T['data']>;
+              edge: Levelup.V2.Utils.NonUndefined<T['edge']>;
+            };
+
+          type IResponse = {
+            data?: any;
+            edge?: any;
+            error?: Levelup.V2.Utils.Api.Response.Error;
+          } & Levelup.V2.Utils.Api.Response.PagedResponse;
+
+          type IError = Error & object;
+
+          interface IHttpClient {
+            get axios(): AxiosInstance;
+            request<T extends IResponse, D = any>(
+              config: AxiosRequestConfig<D>
+            ): Promise<SDK.TResponseDatum<T>>;
+            get<T extends IResponse, D = any>(
+              path: string,
+              query?: object,
+              config?: AxiosRequestConfig<D>
+            ): Promise<SDK.TResponseDatum<T>>;
+            delete<T extends SDK.IResponse, D = any>(
+              path: string,
+              query?: object,
+              config?: AxiosRequestConfig<D>
+            ): Promise<SDK.TResponseDatum<T>>;
+            head<T extends SDK.IResponse>(
+              path: string,
+              query: object
+            ): Promise<SDK.TResponseDatum<T>>;
+            options<T extends SDK.IResponse>(
+              path: string,
+              query: object
+            ): Promise<SDK.TResponseDatum<T>>;
+            post<T extends SDK.IResponse, D = any>(
+              path: string,
+              data?: D,
+              config?: AxiosRequestConfig<D>
+            ): Promise<SDK.TResponseDatum<T>>;
+            put<T extends SDK.IResponse, D = any>(
+              path: string,
+              data?: D,
+              config?: AxiosRequestConfig<D>
+            ): Promise<SDK.TResponseDatum<T>>;
+            patch<T extends SDK.IResponse, D = any>(
+              path: string,
+              data?: D,
+              config?: AxiosRequestConfig<D>
+            ): Promise<SDK.TResponseDatum<T>>;
+            postForm<T extends SDK.IResponse, D = any>(
+              path: string,
+              data?: D,
+              config?: AxiosRequestConfig<D>
+            ): Promise<SDK.TResponseDatum<T>>;
+            putForm<T extends SDK.IResponse, D = any>(
+              path: string,
+              data?: D,
+              config?: AxiosRequestConfig<D>
+            ): Promise<SDK.TResponseDatum<T>>;
+            patchForm<T extends SDK.IResponse, D = any>(
+              path: string,
+              data?: D,
+              config?: AxiosRequestConfig<D>
+            ): Promise<SDK.TResponseDatum<T>>;
+          }
+        }
+      }
+    }
+  }
+}
+
+type TResponseDatum<T extends { data?: object | Array<object>; }> = {
+  data: T['data'];
+  edge: T['edge'];
+  pagination: T['data'] extends Array ? boolean : never;
+
+};

package/typings/v1/security/auth-data.d.ts

@@ -0,0 +1,36 @@
+import { Request } from "express";
+
+declare global {
+  namespace Levelup {
+    namespace CMS {
+      namespace V1 {
+        namespace Security {
+          export type AuthData = {
+            /**
+             * @description the properties parsed from the request
+             */
+            current?: {
+              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;
+              };
+            };
+            /**
+             * @description the properties collected from the current item
+             */
+            attributed?: {
+              user: Utils.Entity.Snapshots.Auth.User | null;
+            };
+
+            req?: () => Request;
+            isServiceRequest?: () => boolean;
+          } | null;
+        }
+      }
+    }
+  }
+}

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

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

package/typings/v1/security/jwt.d.ts

@@ -0,0 +1,36 @@
+
+/**
+ * @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 Security {
+
+        export type JWTPaymentAuthPayload = {
+          _id: string;
+          tracking_id: string;
+          role: string;
+          space: Levelup.V2.Auth.Entity.TJWTTokenSpace;
+        }
+
+        export type JWTUserAuthPayload = {
+          _id: string;
+          tracking_id: string;
+          role: string;
+          space: Levelup.V2.Auth.Entity.TJWTTokenSpace;
+        }
+
+      }
+    }
+  }
+}

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

@@ -0,0 +1,144 @@
+declare module Levelup {
+  namespace CMS {
+  namespace V1 {
+    namespace Auth {
+      
+      export namespace Api {
+
+        export namespace ApiKeys {
+
+          /**
+           * -------------------------------------------------------------------------- 
+           *                            Create                           
+           * -------------------------------------------------------------------------- 
+           * @link
+           * @fires ApiKeysService.Create
+           * @param {Levelup.V2.Auth.Api.ApiKeys.Create.Request} query
+           * @returns {Levelup.V2.Auth.Api.ApiKeys.Create.Response}
+           * @method POST
+           *
+           */
+          export namespace Create {
+            export type Request = Utils.Api.Request.BuildCreateRequest<Entity.ApiKey>;
+            export type Response = Utils.Api.Response.BuildSingleItemResponse<Entity.ApiKey>;
+          }
+
+
+          /**
+           * -------------------------------------------------------------------------- 
+           *                            Update                           
+           * -------------------------------------------------------------------------- 
+           * @link
+           * @fires ApiKeysService.Update
+           * @param {Levelup.V2.Auth.Api.ApiKeys.Update.Request} query
+           * @returns {Levelup.V2.Auth.Api.ApiKeys.Update.Response}
+           * @method PUT
+           *
+           */
+          export namespace Update {
+            export type Request = Utils.Api.Request.BuildUpdateRequest<Entity.ApiKey>;
+            export type Response = Utils.Api.Response.BuildSingleItemResponse<Entity.ApiKey>;
+          }
+
+          /**
+           * -------------------------------------------------------------------------- 
+           *                            Delete                           
+           * -------------------------------------------------------------------------- 
+           * @link
+           * @fires ApiKeysService.Delete
+           * @param {Levelup.V2.Auth.Api.ApiKeys.Delete.Request} query
+           * @returns {Levelup.V2.Auth.Api.ApiKeys.Delete.Response}
+           * @method DELETE
+           *
+           */
+          export namespace Delete {
+            export type Response = Utils.Api.Response.DefaultDeleteResponse;
+          }
+
+
+          /**
+           * -------------------------------------------------------------------------- 
+           *                            BulkDelete                           
+           * -------------------------------------------------------------------------- 
+           * @link
+           * @fires ApiKeysService.BulkDelete
+           * @param {Levelup.V2.Auth.Api.ApiKeys.BulkDelete.Request} query
+           * @returns {Levelup.V2.Auth.Api.ApiKeys.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 ApiKeysService.GetOne
+           * @param {Levelup.V2.Auth.Api.ApiKeys.GetOne.Request} query
+           * @returns {Levelup.V2.Auth.Api.ApiKeys.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.ApiKey>
+          }
+
+          /**
+           * -------------------------------------------------------------------------- 
+           *                            List                           
+           * -------------------------------------------------------------------------- 
+           * @link
+           * @fires ApiKeysService.List
+           * @param {Levelup.V2.Auth.Api.ApiKeys.List.Request} query
+           * @returns {Levelup.V2.Auth.Api.ApiKeys.List.Response}
+           * @method GET
+           *
+           */
+          export namespace List {
+            type Scope = 'listing' | 'ids' | 'trackings';
+
+            export type Request = Utils.Api.Request.BuildSearchablePagedSortableFilterableProjectable<Entity.ApiKey> & {
+              scope?: Scope;
+              filters?: {
+                /**
+                 * Here will be the custom filters
+                 */
+              };
+            }
+            export type Response = Utils.Api.Response.BuildListResponse<Entity.ApiKey>
+          }
+
+          /**
+           * -------------------------------------------------------------------------- 
+           *                            GetByToken                           
+           * -------------------------------------------------------------------------- 
+           * @link
+           * @fires ApiKeysService.GetByToken
+           * @param {Levelup.V2.Auth.Api.ApiKeys.GetByToken.Request} query
+           * @returns {Levelup.V2.Auth.Api.ApiKeys.GetByToken.Response}
+           * @method GET
+           *
+           */
+          export namespace GetByToken {
+            export type Response = Utils.Api.Response.BuildSingleItemResponse<Entity.ExposedApiKey>
+          }
+
+        }
+      }
+    }
+
+  }
+}
+}
+

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

@@ -0,0 +1,168 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Auth {
+        export namespace Api {
+          export namespace Auth {
+            /**
+             * --------------------------------------------------------------------------
+             *                            Signup
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires AuthService.Signup
+             * @param {Levelup.V2.Auth.Api.Auth.Signup.Request} query
+             * @returns {Levelup.V2.Auth.Api.Auth.Signup.Response}
+             * @method POST
+             *
+             */
+            export namespace Signup {
+              export type Request =
+                Levelup.V2.Utils.Api.Request.BuildCreateRequest<{
+                  name: string;
+                  email: string;
+                  password: string;
+                }>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<{
+                  user: Users.Entity.User;
+                  token: string;
+                  refresh_token: string;
+                }>;
+            }
+            /**
+             * --------------------------------------------------------------------------
+             *                            Signin
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires AuthService.Signin
+             * @param {Levelup.V2.Auth.Api.Auth.Signin.Request} query
+             * @returns {Levelup.V2.Auth.Api.Auth.Signin.Response}
+             * @method POST
+             *
+             */
+            export namespace Signin {
+              export type Request =
+                Levelup.V2.Utils.Api.Request.BuildCreateRequest<{
+                  email: string;
+                  password: string;
+                }>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<{
+                  user: Users.Entity.User;
+                  token: string;
+                  refresh_token: string;
+                }>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            RefreshToken
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires AuthService.RefreshToken
+             * @param {Levelup.V2.Auth.Api.Auth.RefreshToken.Request}
+             * @returns {Levelup.V2.Auth.Api.Auth.RefreshToken.Response}
+             * @method POST
+             */
+            export namespace RefreshToken {
+              export type Request =
+                Levelup.V2.Utils.Api.Request.BuildCreateRequest<{
+                  refresh_token?: string;
+                }>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<{
+                  user: Users.Entity.User;
+                  token: string;
+                  refresh_token: string;
+                }>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            SigninWithID
+             * --------------------------------------------------------------------------
+             * @method POST
+             * @link /api/v2/auth/login-with-id
+             * @fires AuthService.SigninWithId
+             * @param {Levelup.V2.Auth.Api.Auth.SigninWithId.Request} query
+             * @returns {Levelup.V2.Auth.Api.Auth.SigninWithId.Response}
+             *
+             */
+            export namespace SigninWithId {
+              export type Request = Levelup.V2.Utils.Api.Request.Build<{
+                user_id: Utils.Common.ID;
+              }>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<{
+                  user?: Users.Entity.User;
+                  token?: string;
+                  refresh_token: string;
+                }>;
+            }
+            /**
+             * --------------------------------------------------------------------------
+             *                            SigninForPayment
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires AuthService.SigninForPayment
+             * @param {Levelup.V2.Auth.Api.Auth.SigninForPayment.Request} query
+             * @returns {Levelup.V2.Auth.Api.Auth.SigninForPayment.Response}
+             * @method POST
+             *
+             */
+            export namespace SigninForPayment {
+              export type Request = Levelup.V2.Utils.Api.Request.Build<{
+                password: string;
+              }>;
+              export type Response = Utils.Api.Response.DefaultResponse & {
+                payment_token?: string;
+              };
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            UpdatePaymentPassword
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires AuthService.UpdatePaymentPassword
+             * @param {Levelup.V2.Auth.Api.Auth.UpdatePaymentPassword.Request} query
+             * @returns {Levelup.V2.Auth.Api.Auth.UpdatePaymentPassword.Response}
+             * @method PUT
+             *
+             */
+            export namespace UpdatePaymentPassword {
+              export type Request = Levelup.V2.Utils.Api.Request.Build<{
+                old_password: string;
+                password: string;
+              }>;
+              export type Response = Utils.Api.Response.DefaultResponse & {
+                payment_token?: string;
+              };
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            ChangeSellerPaymentPassword
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires AuthService.ChangeSellerPaymentPassword
+             * @param {Levelup.V2.Auth.Api.Auth.ChangeSellerPaymentPassword.Request} query
+             * @returns {Levelup.V2.Auth.Api.Auth.ChangeSellerPaymentPassword.Response}
+             * @method PUT
+             *
+             */
+            export namespace ChangeSellerPaymentPassword {
+              export type Request = Levelup.V2.Utils.Api.Request.Build<{
+                password: string;
+              }>;
+              export type Response = Utils.Api.Response.DefaultResponse & {
+                data: Users.Entity.User;
+              };
+            }
+            // end of request
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,9 @@
+'generated by levelup';
+
+export * from "./user.d.ts";
+export * from "./tools.d.ts";
+export * from "./role.d.ts";
+export * from "./permission.d.ts";
+export * from "./permission-group.d.ts";
+export * from "./auth.d.ts";
+export * from "./api-key.d.ts";

package/typings/v1/services/auth/api/permission-group.d.ts

@@ -0,0 +1,95 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Auth {
+        export namespace Api {
+          export namespace PermissionGroups {
+            /**
+             * --------------------------------------------------------------------------
+             *                            Create
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires PermissionGroupsService.Create
+             * @param {Levelup.V2.Auth.Api.PermissionGroups.Create.Request} query
+             * @returns {Levelup.V2.Auth.Api.PermissionGroups.Create.Response}
+             * @method POST
+             *
+             */
+            export namespace Create {
+              export type Request =
+                Levelup.V2.Utils.Api.Request.BuildCreateRequest<Entity.PermissionGroup>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.PermissionGroup>;
+            }
+            /**
+             * --------------------------------------------------------------------------
+             *                            Update
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires PermissionGroupsService.Update
+             * @param {Levelup.V2.Auth.Api.PermissionGroups.Update.Request} query
+             * @returns {Levelup.V2.Auth.Api.PermissionGroups.Update.Response}
+             * @method PUT
+             *
+             */
+            export namespace Update {
+              export type Request =
+                Levelup.V2.Utils.Api.Request.BuildUpdateRequest<Entity.PermissionGroup>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.PermissionGroup>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            Delete
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires PermissionGroupsService.Delete
+             * @param {Levelup.V2.Auth.Api.PermissionGroups.Delete.Request} query
+             * @returns {Levelup.V2.Auth.Api.PermissionGroups.Delete.Response}
+             * @method DELETE
+             *
+             */
+            export namespace Delete {
+              export type Response = Utils.Api.Response.DefaultDeleteResponse;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            Get
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires PermissionGroupsService.Get
+             * @param {Levelup.V2.Auth.Api.PermissionGroups.GetOne.Request} query
+             * @returns {Levelup.V2.Auth.Api.PermissionGroups.GetOne.Response}
+             * @method GET
+             *
+             */
+            export namespace GetOne {
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.PermissionGroup>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            List
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires PermissionGroupsService.List
+             * @param {Levelup.V2.Auth.Api.PermissionGroups.List.Request} query
+             * @returns {Levelup.V2.Auth.Api.PermissionGroups.List.Response}
+             * @method GET
+             *
+             */
+            export namespace List {
+              export type Request =
+                Levelup.V2.Utils.Api.Request.BuildSearchablePagedSortableFilterableProjectable<Entity.PermissionGroup>;
+              export type Response =
+                Utils.Api.Response.BuildListResponse<Entity.PermissionGroup>;
+            }
+          }
+        }
+      }
+    }
+  }
+}