cloud-ide-model-schema 1.1.20 → 1.1.21

package/README.md

@@ -89,20 +89,38 @@ The project is organized into the following main directories:
 5. Test your changes
 6. Submit a pull request
 
-## Documentation
+## Documentation Structure
 
-Detailed documentation is available within the codebase:
+This project uses README.md files throughout the codebase to provide comprehensive documentation. Each directory has its own README that explains its purpose and contents.
 
-- [Main README](./README.md): Overview of the entire package
-- [Source Code Documentation](./src/README.md): Documentation for source code structure
-  - [Configuration Utilities](./src/config/README.md): Configuration utilities
-  - [Schema Structure Overview](./src/schema/README.md): Schema structure overview
-    - [Authentication Schemas](./src/schema/auth/README.md): Authentication schemas
-    - [Core System Schemas](./src/schema/core/README.md): Core system schemas
-    - [Email Service Schemas](./src/schema/email/README.md): Email service schemas
-- [Compiled Output Documentation](./lib/README.md): Documentation for compiled output
-  - [Common Type Definitions](./lib/common-types/README.md): Common type definitions
-  - [Model Interface Definitions](./lib/model/README.md): Model interface definitions
+### Navigation Guide
+
+#### Source Code Documentation
+
+- [Source Directory](./src/README.md): Overview of the TypeScript source code
+  - [Configuration](./src/config/README.md): Database connection and configuration utilities
+  - [Schema](./src/schema/README.md): Schema structure overview
+    - [Authentication Schemas](./src/schema/auth/README.md): User management schemas
+    - [Core System Schemas](./src/schema/core/README.md): Core functionality schemas
+    - [Email Service Schemas](./src/schema/email/README.md): Email management schemas
+
+#### Compiled Output Documentation
+
+- [Compiled Output Directory](./lib/README.md): Overview of the compiled JavaScript files
+  - [Common Types](./lib/common-types/README.md): Shared type definitions
+  - [Model Interfaces](./lib/model/README.md): Domain model interfaces
+  - [Schema](./lib/schema/README.md): Compiled schema models
+  - [Configuration](./lib/config/README.md): Compiled configuration utilities
+  - [Utilities](./lib/utilities/README.md): Helper functions and utilities
+  - [Types](./lib/@types/README.md): Internal type definitions
+
+### README Structure
+
+Each README file contains:
+1. An overview of the directory or component
+2. Navigation links to related documents
+3. Details about files or subdirectories
+4. Usage information where appropriate
 
 ## Table of Contents
 
@@ -112,7 +130,9 @@ Detailed documentation is available within the codebase:
 - [Project Structure](#project-structure)
 - [Dependencies](#dependencies)
 - [Development](#development)
-- [Documentation](#documentation)
+- [Documentation Structure](#documentation-structure)
+  - [Navigation Guide](#navigation-guide)
+  - [README Structure](#readme-structure)
 - [License](#license)
 - [Author](#author)
 

package/lib/@types/README.md

@@ -0,0 +1,21 @@
+# Types Directory
+
+This directory contains TypeScript types and interfaces that are used internally by the Cloud IDE Model Schema package.
+
+## Navigation
+
+- [Back to Compiled Output](../README.md)
+- [Back to Main README](../../README.md)
+
+## Files
+
+This directory contains various type definition files (.d.ts) for:
+- Common utility types
+- Controller response structures
+- Configuration interfaces
+- Authentication payloads
+- User permissions
+
+## Usage
+
+These type definitions help ensure type safety when working with the Cloud IDE LMS system. They are primarily for internal use but can be referenced by consumers of the package for advanced type integration.

package/lib/config/README.md

@@ -0,0 +1,25 @@
+# Configuration Components
+
+This directory contains the compiled JavaScript files and TypeScript declaration files for configuration utilities used in the Cloud IDE LMS system.
+
+## Navigation
+
+- [Back to Compiled Output](../README.md)
+- [Back to Main README](../../README.md)
+
+## Files
+
+### database.js / database.d.ts
+
+Provides MongoDB database connection functionality:
+- `connectDB()`: Asynchronous function to establish a connection to MongoDB
+- Uses environment variables for connection parameters
+- Implements connection timeout and error handling
+
+### index.js / index.d.ts
+
+Aggregates and exports all configuration utilities.
+
+## Usage
+
+These compiled configuration files provide the functionality to connect to MongoDB and manage environment-specific settings in the deployed application.

package/lib/schema/README.md

@@ -0,0 +1,40 @@
+# Schema Directory
+
+This directory contains the compiled JavaScript files and TypeScript declaration files for all MongoDB schema definitions used in the Cloud IDE LMS system.
+
+## Navigation
+
+- [Back to Compiled Output](../README.md)
+- [Back to Main README](../../README.md)
+- [Common Types Documentation](../common-types/README.md)
+- [Model Interfaces Documentation](../model/README.md)
+
+## Directory Structure
+
+### Authentication Schemas (`/auth`)
+
+Contains compiled schemas for user authentication, profiles, and sessions:
+- User management
+- Login sessions
+- Mobile PIN authentication
+
+### Core System Schemas (`/core`)
+
+Contains compiled schemas for core system functionality:
+- System pages and themes
+- Menu management
+- Entity management
+- General master data
+- File management
+
+### Email Service Schemas (`/email`)
+
+Contains compiled schemas for email management:
+- Email lists
+- Templates
+- Logging
+- Vendor management
+
+## Usage
+
+These compiled schema files are the actual Mongoose models used in MongoDB operations. They implement the interfaces defined in the model directory.

package/lib/schema/core/core_system_pages_theme.js

@@ -47,6 +47,8 @@ var CCoreSytmLayout = /** @class */ (function (_super) {
     };
     return CCoreSytmLayout;
 }(mongoose_1.default.SchemaType));
+// @ts-ignore: We need to ignore this because TypeScript doesn't know about custom types beforehand.
+mongoose_1.default.Schema.Types.CCoreSytmLayout = CCoreSytmLayout;
 /* SCHEMA START */
 var core_system_pages_theme = new mongoose_1.Schema({
     sytm_preview_id_fm: {

package/lib/utilities/README.md

@@ -0,0 +1,22 @@
+# Utilities
+
+This directory contains compiled utility functions and helper methods used throughout the Cloud IDE LMS system.
+
+## Navigation
+
+- [Back to Compiled Output](../README.md)
+- [Back to Main README](../../README.md)
+
+## Directory Structure
+
+### Helpers (`/helpers`)
+
+Contains compiled utility functions for common tasks:
+- Data formatting
+- Validation helpers
+- Date manipulation
+- String operations
+
+## Usage
+
+These compiled utility functions provide reusable operations that support the core functionality of the application. They can be imported directly from the package.

package/package.json

@@ -9,7 +9,7 @@
     "typescript": "^5.8.3"
   },
   "name": "cloud-ide-model-schema",
-  "version": "1.1.20",
+  "version": "1.1.21",
   "description": "Pachage for schema management of Cloud IDEsys LMS",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",