@ccci/micro-server 1.0.126 → 1.0.127

package/dist/types/BaseControllerTypes.d.ts

@@ -5,11 +5,13 @@ export type RequestQuery = {
     page?: number;
     includes?: string;
     fields?: string;
+    paranoid?: string;
     sort?: string;
     paginate?: string;
     date_range?: string;
     others?: any;
     scan?: string;
+    groupBy?: string;
 };
 export type QueryOptions = {
     where?: WhereOptions<any>;
@@ -17,6 +19,7 @@ export type QueryOptions = {
     offset?: number;
     attributes?: Array<string>;
     order?: Order;
+    paranoid?: boolean;
     includes?: Array<string | IncludeType>;
 };
 export type ResponseType = {

package/dist/utils/BaseController.d.ts

@@ -69,6 +69,16 @@ export default class BaseController {
     count(req: Request, res: Response, next?: NextFunction): Promise<{
         count: number;
     }>;
+    /**
+     * Return a basic statistics based on the query and group provided.
+     * ```js
+     * Controller.find(req, res, next)
+     * ```
+     * @param req
+     * @param res
+     * @param next
+     */
+    stats(req: Request, res: Response, next?: NextFunction): Promise<any>;
     /**
      * ###############################################################
      * ###################### LIFE CYCLE HOOKS #######################

package/dist/utils/BaseControllerHelper.d.ts

@@ -1,7 +1,27 @@
 import { BaseError, UniqueConstraintError } from "sequelize";
 import { RequestQuery, QueryOptions, ResponseType } from "../types/BaseControllerTypes";
+/**
+ * Constructs a Sequelize query object based on the provided request query.
+ * This function dynamically builds the `where` clause, allows for sorting,
+ * pagination, field selection, and includes related models.
+ *
+ * @param {RequestQuery} query - The incoming request query parameters.
+ * @returns {QueryOptions} - Returns a Sequelize query options object to be used for querying the database.
+ */
 export declare function ConstructQuery(query: RequestQuery): QueryOptions;
+/**
+ * A helper function to structure a successful response.
+ *
+ * @param {any} response - Data to include in the response.
+ * @returns {ResponseType} - An object with success status and response data.
+ */
 export declare function ResponseHelper(response?: any): ResponseType;
+/**
+ * Handles errors and constructs an error response based on the type of error (Sequelize, database, or validation).
+ *
+ * @param {UniqueConstraintError | BaseError | Error | any} error - The error encountered during execution.
+ * @returns {ResponseType} - Returns a structured error response with error codes and messages.
+ */
 export declare function ErrorResponseHandler(error: UniqueConstraintError | BaseError | Error | any): ResponseType;
 export { ResponseType };
 //# sourceMappingURL=BaseControllerHelper.d.ts.map

package/dist/utils/BaseRouter.d.ts

@@ -65,6 +65,13 @@ export default class BaseRouter<T extends BaseController> {
      * @param next
      */
     count(req: Request, res: Response, next: NextFunction): Promise<void>;
+    /**
+     * /stats get count by group
+     * @param req
+     * @param res
+     * @param next
+     */
+    stats(req: Request, res: Response, next: NextFunction): Promise<void>;
     /**
      * @description default mappings that will be inherited across all router class
      * @returns {Array} mappings

package/dist/utils/{WebSocketServer.d.ts → WebsocketServer.d.ts}

@@ -26,4 +26,4 @@ export default class WebSocketServer {
      */
     static getHandler(path: string): ServerWebSocket | null;
 }
-//# sourceMappingURL=WebsocketServer.d.ts.map
+//# sourceMappingURL=WebSocketServer.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ccci/micro-server",
-  "version": "1.0.126",
+  "version": "1.0.127",
   "module": "index.ts",
   "type": "module",
   "main": "dist/index.js",