cloud-ide-lms-model 1.0.241 → 1.0.243

package/lib/model/core/core_user_role.d.ts

@@ -0,0 +1,101 @@
+import { MTableQueries } from "../../common-types/common";
+import { CoreUserRole, CoreUserRoleBase, CoreUserRoleRights, CoreUserRoleRightsBase } from "../../schema";
+import { controllerResponse } from "../../utilities";
+type IUserRoleErrorLogger = {
+    [key in keyof MUserRole]: string;
+};
+type IUserRoleGetByIdErrorLogger = {
+    [key in keyof MUserRoleGetByIdPayload]: string;
+};
+type IUserRoleDeleteErrorLogger = {
+    [key in keyof MUserRoleDeletePayload]: string;
+};
+type IUserRoleInsertUpdateErrorLogger = {
+    [key in keyof MUserRoleInsertUpdatePayload]: string;
+};
+type IUserRoleWithRightsErrorLogger = {
+    [key in keyof MUserRoleWithRightsPayload]: string;
+};
+type IUserRoleToggleStatusErrorLogger = {
+    [key in keyof MUserRoleToggleStatusPayload]: string;
+};
+declare class MUserRole extends MTableQueries {
+    constructor(init: MUserRole);
+    Validate?(): Partial<IUserRoleErrorLogger>;
+}
+declare class MUserRoleGetByIdPayload {
+    syusrol_id?: string;
+    constructor(init: MUserRoleGetByIdPayload);
+    Validate?(): Partial<IUserRoleGetByIdErrorLogger>;
+}
+declare class MUserRoleDeletePayload {
+    syusrol_id?: string;
+    constructor(init: MUserRoleDeletePayload);
+    Validate?(): Partial<IUserRoleDeleteErrorLogger>;
+}
+declare class MUserRoleToggleStatusPayload {
+    syusrol_id?: string;
+    constructor(init: MUserRoleToggleStatusPayload);
+    Validate?(): Partial<IUserRoleToggleStatusErrorLogger>;
+}
+declare class MUserRoleInsertUpdatePayload extends CoreUserRole {
+    constructor(init: CoreUserRole);
+    Validate?(): Partial<IUserRoleInsertUpdateErrorLogger>;
+}
+declare class MUserRoleWithRightsPayload {
+    core_user_role?: CoreUserRole;
+    core_user_role_rights?: Array<CoreUserRoleRights>;
+    core_user_role_rights_delete?: string[];
+    constructor(init: MUserRoleWithRightsPayload);
+    Validate?(): Partial<IUserRoleWithRightsErrorLogger>;
+}
+interface CoreUserRoleResponse extends CoreUserRoleBase {
+    syusrol_role_entity_id_syen?: {
+        _id?: string;
+        syen_name?: string;
+    };
+}
+interface CoreUserRoleRightsResponse extends CoreUserRoleRightsBase {
+    syusrgt_role_id_syusrol?: {
+        _id?: string;
+        syusrol_role_name?: string;
+    };
+    syusrgt_role_permissions_id_sygms?: {
+        _id?: string;
+        sygms_name?: string;
+    };
+    syusrgt_menu_id_syme?: {
+        _id?: string;
+        syme_name?: string;
+    };
+}
+interface userRoleControllerResponse extends controllerResponse {
+    data?: Array<CoreUserRoleResponse>;
+}
+interface userRoleByIdControllerResponse extends controllerResponse {
+    data?: CoreUserRoleResponse;
+}
+interface userRoleInsertUpdateControllerResponse extends controllerResponse {
+    data?: CoreUserRole;
+}
+interface userRoleDeleteControllerResponse extends controllerResponse {
+    data?: boolean;
+}
+interface userRoleToggleStatusControllerResponse extends controllerResponse {
+    data?: boolean;
+}
+interface userRoleWithRightsControllerResponse extends controllerResponse {
+    data?: {
+        role: CoreUserRoleResponse;
+        rights: Array<CoreUserRoleRightsResponse>;
+    };
+}
+interface userRoleWithRightsInsertUpdateControllerResponse extends controllerResponse {
+    data?: {
+        role: CoreUserRoleResponse;
+        rightsInserted: number;
+        rightsUpdated: number;
+        rightsDeleted: number;
+    };
+}
+export { IUserRoleErrorLogger, IUserRoleGetByIdErrorLogger, IUserRoleDeleteErrorLogger, IUserRoleInsertUpdateErrorLogger, IUserRoleWithRightsErrorLogger, IUserRoleToggleStatusErrorLogger, MUserRole, MUserRoleGetByIdPayload, MUserRoleDeletePayload, MUserRoleInsertUpdatePayload, MUserRoleWithRightsPayload, MUserRoleToggleStatusPayload, userRoleControllerResponse, userRoleByIdControllerResponse, userRoleInsertUpdateControllerResponse, userRoleDeleteControllerResponse, userRoleToggleStatusControllerResponse, userRoleWithRightsControllerResponse, userRoleWithRightsInsertUpdateControllerResponse };

package/lib/model/core/core_user_role.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MUserRoleToggleStatusPayload = exports.MUserRoleWithRightsPayload = exports.MUserRoleInsertUpdatePayload = exports.MUserRoleDeletePayload = exports.MUserRoleGetByIdPayload = exports.MUserRole = void 0;
+const common_1 = require("../../common-types/common");
+const schema_1 = require("../../schema");
+/* INTERFACE END */
+/* MODEL START */
+class MUserRole extends common_1.MTableQueries {
+    constructor(init) {
+        super(init);
+        Object.assign(this, init);
+    }
+    Validate() {
+        let errorLogger = {};
+        return errorLogger;
+    }
+}
+exports.MUserRole = MUserRole;
+class MUserRoleGetByIdPayload {
+    constructor(init) {
+        Object.assign(this, init);
+    }
+    Validate() {
+        let errorLogger = {};
+        if (!this.syusrol_id) {
+            errorLogger.syusrol_id = "User Role ID is Required!";
+        }
+        return errorLogger;
+    }
+}
+exports.MUserRoleGetByIdPayload = MUserRoleGetByIdPayload;
+class MUserRoleDeletePayload {
+    constructor(init) {
+        Object.assign(this, init);
+    }
+    Validate() {
+        let errorLogger = {};
+        if (!this.syusrol_id) {
+            errorLogger.syusrol_id = "User Role ID is Required!";
+        }
+        return errorLogger;
+    }
+}
+exports.MUserRoleDeletePayload = MUserRoleDeletePayload;
+class MUserRoleToggleStatusPayload {
+    constructor(init) {
+        Object.assign(this, init);
+    }
+    Validate() {
+        let errorLogger = {};
+        if (!this.syusrol_id) {
+            errorLogger.syusrol_id = "User Role ID is Required!";
+        }
+        return errorLogger;
+    }
+}
+exports.MUserRoleToggleStatusPayload = MUserRoleToggleStatusPayload;
+class MUserRoleInsertUpdatePayload extends schema_1.CoreUserRole {
+    constructor(init) {
+        super();
+        Object.assign(this, init);
+    }
+    Validate() {
+        let errorLogger = {};
+        if (!this.syusrol_role_name) {
+            errorLogger.syusrol_role_name = "Role name is required!";
+        }
+        if (!this.syusrol_role_description) {
+            errorLogger.syusrol_role_description = "Role description is required!";
+        }
+        if (!this.syusrol_role_entity_id_syen) {
+            errorLogger.syusrol_role_entity_id_syen = "Entity ID is required!";
+        }
+        return errorLogger;
+    }
+}
+exports.MUserRoleInsertUpdatePayload = MUserRoleInsertUpdatePayload;
+class MUserRoleWithRightsPayload {
+    constructor(init) {
+        Object.assign(this, init);
+    }
+    Validate() {
+        let errorLogger = {};
+        // Validate Core User Role
+        if (!this.core_user_role) {
+            errorLogger.core_user_role = "Role information is required!";
+        }
+        else {
+            if (!this.core_user_role.syusrol_role_name) {
+                errorLogger.core_user_role = "Role name is required!";
+            }
+            if (!this.core_user_role.syusrol_role_description) {
+                errorLogger.core_user_role = "Role description is required!";
+            }
+            if (!this.core_user_role.syusrol_role_entity_id_syen) {
+                errorLogger.core_user_role = "Entity ID is required!";
+            }
+        }
+        // Validate Core User Role Rights
+        if (this.core_user_role_rights && this.core_user_role_rights.length > 0) {
+            this.core_user_role_rights.forEach((right, index) => {
+                if (!right.syusrgt_menu_id_syme) {
+                    errorLogger[`core_user_role_rights[${index}].syusrgt_menu_id_syme`] = "Menu ID is required!";
+                }
+                if (!right.syusrgt_role_permissions_id_sygms) {
+                    errorLogger[`core_user_role_rights[${index}].syusrgt_role_permissions_id_sygms`] = "Permission ID is required!";
+                }
+            });
+        }
+        return errorLogger;
+    }
+}
+exports.MUserRoleWithRightsPayload = MUserRoleWithRightsPayload;

package/lib/model/core/index.d.ts

@@ -17,3 +17,4 @@ export * from "./core_designation";
 export * from "./core_designation_grade_level";
 export * from "./core_system_pages";
 export * from "./core_general_master_type";
+export * from "./core_user_role";

package/lib/model/core/index.js

@@ -33,3 +33,4 @@ __exportStar(require("./core_designation"), exports);
 __exportStar(require("./core_designation_grade_level"), exports);
 __exportStar(require("./core_system_pages"), exports);
 __exportStar(require("./core_general_master_type"), exports);
+__exportStar(require("./core_user_role"), exports);

package/lib/routes/academicsRoutes.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Object containing URLs for authentication-related endpoints.
+ * These URLs are used for various authentication operations such as sign-in, sign-out, etc.
+ */
+declare const academicsRoutesUrl: {
+    module: string;
+    /** Endpoint to get academic year (academic-year)
+     * for more details refer {@link https://docs.google.com/document/d/1CwB4evLsQuatG4jI0U1faRtmqtNmIfZOE4fDWiz9-sQ/edit?pli=1&tab=t.0#bookmark=id.sxfaxi4qxff3}
+     */
+    academicYear: string;
+    /**
+     * Endpoint to get academic year mapping (academic-year-mapping)
+     */
+    academicYearMapping: string;
+};
+export { academicsRoutesUrl };

package/lib/routes/academicsRoutes.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.academicsRoutesUrl = void 0;
+/**
+ * Object containing URLs for authentication-related endpoints.
+ * These URLs are used for various authentication operations such as sign-in, sign-out, etc.
+ */
+const academicsRoutesUrl = {
+    module: 'academics',
+    /** Endpoint to get academic year (academic-year)
+     * for more details refer {@link https://docs.google.com/document/d/1CwB4evLsQuatG4jI0U1faRtmqtNmIfZOE4fDWiz9-sQ/edit?pli=1&tab=t.0#bookmark=id.sxfaxi4qxff3}
+     */
+    academicYear: "academic-year",
+    /**
+     * Endpoint to get academic year mapping (academic-year-mapping)
+     */
+    academicYearMapping: "academic-year-mapping",
+};
+exports.academicsRoutesUrl = academicsRoutesUrl;
+// Freeze the authRoutesUrl object to prevent modifications
+Object.freeze(academicsRoutesUrl);

package/lib/routes/accountsRoutes.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Object containing URLs for authentication-related endpoints.
+ * These URLs are used for various authentication operations such as sign-in, sign-out, etc.
+ */
+declare const accountsRoutesUrl: {
+    module: string;
+    /** Endpoint to get accounts year (accounts-year)
+     * for more details refer {@link https://docs.google.com/document/d/1CwB4evLsQuatG4jI0U1faRtmqtNmIfZOE4fDWiz9-sQ/edit?pli=1&tab=t.0#bookmark=id.sxfaxi4qxff3}
+     */
+    financialYear: string;
+    /**
+     * Endpoint to get accounts year mapping (accounts-year-mapping)
+     */
+    financialYearMapping: string;
+};
+export { accountsRoutesUrl };

package/lib/routes/accountsRoutes.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.accountsRoutesUrl = void 0;
+/**
+ * Object containing URLs for authentication-related endpoints.
+ * These URLs are used for various authentication operations such as sign-in, sign-out, etc.
+ */
+const accountsRoutesUrl = {
+    module: 'accounts',
+    /** Endpoint to get accounts year (accounts-year)
+     * for more details refer {@link https://docs.google.com/document/d/1CwB4evLsQuatG4jI0U1faRtmqtNmIfZOE4fDWiz9-sQ/edit?pli=1&tab=t.0#bookmark=id.sxfaxi4qxff3}
+     */
+    financialYear: "financial-year",
+    /**
+     * Endpoint to get accounts year mapping (accounts-year-mapping)
+     */
+    financialYearMapping: "financial-year-mapping",
+};
+exports.accountsRoutesUrl = accountsRoutesUrl;
+// Freeze the accountsRoutesUrl object to prevent modifications
+Object.freeze(accountsRoutesUrl);

package/lib/routes/coreRoutes.d.ts

@@ -81,5 +81,9 @@ declare const coreRoutesUrl: {
      * @description Endpoint to get the general master type (general-master-type)
      */
     generalMasterType: string;
+    /**
+     * @description Endpoint to get the user role (user-role)
+     */
+    userRole: string;
 };
 export { coreRoutesUrl };

package/lib/routes/coreRoutes.js

@@ -83,7 +83,11 @@ const coreRoutesUrl = {
     /**
      * @description Endpoint to get the general master type (general-master-type)
      */
-    generalMasterType: "general-master-type"
+    generalMasterType: "general-master-type",
+    /**
+     * @description Endpoint to get the user role (user-role)
+     */
+    userRole: "user-role",
 };
 exports.coreRoutesUrl = coreRoutesUrl;
 Object.freeze(coreRoutesUrl);

package/lib/routes/index.d.ts

@@ -3,3 +3,5 @@ export * from './coreRoutes';
 export * from './designConfigRoutes';
 export * from './authRoutes';
 export * from './userRoutes';
+export * from './academicsRoutes';
+export * from './accountsRoutes';

package/lib/routes/index.js

@@ -19,3 +19,5 @@ __exportStar(require("./coreRoutes"), exports);
 __exportStar(require("./designConfigRoutes"), exports);
 __exportStar(require("./authRoutes"), exports);
 __exportStar(require("./userRoutes"), exports);
+__exportStar(require("./academicsRoutes"), exports);
+__exportStar(require("./accountsRoutes"), exports);

package/lib/schema/core/core_user_role.d.ts

@@ -0,0 +1,11 @@
+declare class CoreUserRoleBase {
+    _id?: string;
+    syusrol_role_name?: string;
+    syusrol_role_description?: string;
+    syusrol_isactive?: boolean;
+}
+declare class CoreUserRole extends CoreUserRoleBase {
+    syusrol_role_entity_id_syen?: string;
+}
+export { CoreUserRoleBase, // interface
+CoreUserRole };

package/lib/schema/core/core_user_role.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CoreUserRole = exports.CoreUserRoleBase = void 0;
+class CoreUserRoleBase {
+}
+exports.CoreUserRoleBase = CoreUserRoleBase;
+class CoreUserRole extends CoreUserRoleBase {
+}
+exports.CoreUserRole = CoreUserRole;

package/lib/schema/core/core_user_role_rights.d.ts

@@ -0,0 +1,11 @@
+declare class CoreUserRoleRightsBase {
+    _id?: string;
+    syusrgt_isactive?: boolean;
+}
+declare class CoreUserRoleRights extends CoreUserRoleRightsBase {
+    syusrgt_role_id_syusrol?: string;
+    syusrgt_role_permissions_id_sygms?: string;
+    syusrgt_menu_id_syme?: string;
+}
+export { CoreUserRoleRightsBase, // interface
+CoreUserRoleRights };

package/lib/schema/core/core_user_role_rights.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CoreUserRoleRights = exports.CoreUserRoleRightsBase = void 0;
+class CoreUserRoleRightsBase {
+}
+exports.CoreUserRoleRightsBase = CoreUserRoleRightsBase;
+class CoreUserRoleRights extends CoreUserRoleRightsBase {
+}
+exports.CoreUserRoleRights = CoreUserRoleRights;

package/lib/schema/core/index.d.ts

@@ -27,3 +27,5 @@ export * from './core_user_contact_addresses';
 export * from './core_user_documents';
 export * from './core_user_family_details';
 export * from './core_user_attributes';
+export * from './core_user_role';
+export * from './core_user_role_rights';

package/lib/schema/core/index.js

@@ -43,3 +43,5 @@ __exportStar(require("./core_user_contact_addresses"), exports);
 __exportStar(require("./core_user_documents"), exports);
 __exportStar(require("./core_user_family_details"), exports);
 __exportStar(require("./core_user_attributes"), exports);
+__exportStar(require("./core_user_role"), exports);
+__exportStar(require("./core_user_role_rights"), exports);

package/package.json

@@ -5,7 +5,7 @@
     "typescript": "^5.4.2"
   },
   "name": "cloud-ide-lms-model",
-  "version": "1.0.241",
+  "version": "1.0.243",
   "description": "Package for Model management of Cloud IDEsys LMS",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",