cloud-ide-lms-model 1.0.67 → 1.0.68

package/README.md

@@ -1,93 +1,154 @@
-# cloud-ide-lms-model
+# Cloud IDE LMS Model
 
+[![Version](https://img.shields.io/badge/version-1.0.67-blue.svg)](https://gitlab.com/lms-schools/cloud-ide-lms-model)
+[![License](https://img.shields.io/badge/license-ISC-green.svg)](https://gitlab.com/lms-schools/cloud-ide-lms-model)
 
+## Description
+This package contains the data models, schemas, and utilities for the Cloud IDE Learning Management System (LMS). It provides a consistent interface for database operations, API routes, and type definitions used throughout the Cloud IDE LMS ecosystem.
 
-## Getting started
+## Installation
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+```bash
+npm install cloud-ide-lms-model
+```
 
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+## Project Structure
 
-## Add your files
+The project is organized into several main directories:
 
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+### Schema (`/src/schema`)
 
-```
-cd existing_repo
-git remote add origin https://gitlab.com/lms-schools/cloud-ide-lms-model.git
-git branch -M main
-git push -uf origin main
-```
+Contains database schema definitions for the application.
 
-## Integrate with your tools
+- `collection_names.ts`: Defines the collection names used in the database
+- `auth/`: Contains authentication-related schemas
+- `core/`: Contains core system schemas
+- `email/`: Contains email service related schemas
 
-- [ ] [Set up project integrations](https://gitlab.com/lms-schools/cloud-ide-lms-model/-/settings/integrations)
+[More details about Schema](./src/schema/README.md)
 
-## Collaborate with your team
+### Common Types (`/src/common-types`)
 
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
+Contains TypeScript type definitions used throughout the application.
 
-## Test and Deploy
+- `common.ts`: Basic common types used throughout the system
+- `coreControllerResponse.ts`: Response types for core controllers
+- `jwtPayload.ts`: Type definition for JWT authentication payload
+- `loginControllerResponse.ts`: Response types for login operations
+- `userPermissions.ts`: Types related to user permissions and authorization
 
-Use the built-in continuous integration in GitLab.
+[More details about Common Types](./src/common-types/README.md)
 
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+### Models (`/src/model`)
 
-***
+Contains the data models that implement business logic.
 
-# Editing this README
+- `auth/`: Authentication-related models
+- `core/`: Core system models
 
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
+[More details about Models](./src/model/README.md)
 
-## Suggestions for a good README
+### Routes (`/src/routes`)
 
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+Contains API route definitions.
 
-## Name
-Choose a self-explaining name for your project.
+- `authRoutes.ts`: Authentication-related routes
+- `controllerRoutes.ts`: General controller route utilities
+- `coreRoutes.ts`: Core application routes
+- `designConfigRoutes.ts`: Routes for design configuration
+- `hostManagerRoutes.ts`: Host management routes
+- `userRoutes.ts`: User management routes
 
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+[More details about Routes](./src/routes/README.md)
 
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+### Utilities (`/src/utilities`)
 
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+Contains utility functions and helper methods.
 
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+- `helpers/`: Helper functions grouped by functionality
 
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+[More details about Utilities](./src/utilities/README.md)
 
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+## Usage Examples
 
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+### Importing Types
 
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
+```typescript
+import { 
+  CoreControllerResponse, 
+  JwtPayload 
+} from 'cloud-ide-lms-model';
+
+// Use types in your code
+function processResponse(response: CoreControllerResponse) {
+  // Implementation
+}
+```
+
+### Using Schemas
+
+```typescript
+import { SomeSchema } from 'cloud-ide-lms-model';
+
+// Use schema for validation or type checking
+```
+
+### Using Models
+
+```typescript
+import { SomeModel } from 'cloud-ide-lms-model';
+
+// Example usage
+async function useModel() {
+  const result = await SomeModel.findById(id);
+  // Process result
+}
+```
+
+### Using Routes
+
+```typescript
+import { authRoutes, coreRoutes } from 'cloud-ide-lms-model';
+import express from 'express';
 
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+const app = express();
+
+// Register routes
+app.use('/auth', authRoutes);
+app.use('/core', coreRoutes);
+```
 
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+## Development
 
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
+### Building the Project
+
+```bash
+npm run build
+```
+
+### Testing
+
+```bash
+npm test
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feature/my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin feature/my-new-feature`
+5. Submit a pull request
 
 ## License
-For open source projects, say how it is licensed.
 
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+This project is licensed under the ISC License - see the LICENSE file for details.
+
+## Authors
+
+- Ankush Bhure - Initial work and maintenance
+
+## Repository
+
+The project is hosted on GitLab:
+https://gitlab.com/lms-schools/cloud-ide-lms-model.git

package/lib/utilities/helpers/string.helper.d.ts

@@ -4,3 +4,4 @@ export declare function stringInterpolation(variables: {
 export declare const cidePath: {
     join: (path: string[]) => string;
 };
+export declare const generateRandomAlphanumericString: (length: number) => string;

package/lib/utilities/helpers/string.helper.js

@@ -7,7 +7,7 @@ var __asyncValues = (this && this.__asyncValues) || function (o) {
     function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cidePath = exports.stringInterpolation = void 0;
+exports.generateRandomAlphanumericString = exports.cidePath = exports.stringInterpolation = void 0;
 async function stringInterpolation(variables, body, data) {
     /*
     const placeholders = {
@@ -172,3 +172,14 @@ exports.cidePath = {
         return path.join("/");
     }
 };
+// Function to generate a random alphanumeric string of a given length
+const generateRandomAlphanumericString = (length) => {
+    const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+    let result = '';
+    const charactersLength = characters.length;
+    for (let i = 0; i < length; i++) {
+        result += characters.charAt(Math.floor(Math.random() * charactersLength));
+    }
+    return result;
+};
+exports.generateRandomAlphanumericString = generateRandomAlphanumericString;

package/package.json

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