@point-hub/papi 0.5.24 → 0.5.26

package/lib/index.js

@@ -73411,7 +73411,13 @@ class BaseUseCase {
     return { status: "success", data };
   }
   fail(error) {
-    return { status: "failed", error };
+    return {
+      status: "failed",
+      error: {
+        name: "ApiError",
+        ...error
+      }
+    };
   }
 }
 // src/database/mongodb/mongodb-compose.ts

package/lib/src/base-usecase.d.ts

@@ -2,13 +2,15 @@
  * Interface for a standard successful output structure.
  * T is the type of the successful data payload.
  */
-export interface IOutputSuccess<T> {
+export interface IUseCaseOutputSuccess<T> {
     status: 'success';
     data: T;
 }
-export interface IError {
-    message: string;
+export interface IUseCaseError {
     code: number;
+    message: string;
+    name?: string;
+    status?: string;
     errors?: {
         [key: string]: string[];
     };
@@ -17,9 +19,9 @@ export interface IError {
  * Interface for a standard failed output structure.
  * E is the type of the error details payload.
  */
-export interface IOutputFailed {
+export interface IUseCaseOutputFailed {
     status: 'failed';
-    error: IError;
+    error: IUseCaseError;
 }
 /**
  * Abstract Base Class for a Use Case.
@@ -28,9 +30,8 @@ export interface IOutputFailed {
  * making it reusable for any business logic operation.
  *
  * @param IInput - The type of the data passed to the handle method.
- * @param ISuccessData - The type of data returned on success.
- * @param IErrorData - The type of error object returned on failure (defaults to IIErrorData).
  * @param IDependencies - The type of the injected dependencies.
+ * @param ISuccessData - The type of data returned on success.
  */
 export declare abstract class BaseUseCase<IInput, IDependencies, ISuccessData> {
     protected readonly deps: IDependencies;
@@ -38,15 +39,15 @@ export declare abstract class BaseUseCase<IInput, IDependencies, ISuccessData> {
     /**
      * Generates a standardized success output object.
      * @param data - The successful payload data (type ISuccessData).
-     * @returns An IOutputSuccess object.
+     * @returns An IUseCaseOutputSuccess object.
      */
-    protected success(data: ISuccessData): IOutputSuccess<ISuccessData>;
+    protected success(data: ISuccessData): IUseCaseOutputSuccess<ISuccessData>;
     /**
      * Generates a standardized failure output object.
-     * @param error - The error details (type IErrorData).
-     * @returns An IOutputFailed object.
+     * @param error - The error details (type IUseCaseError).
+     * @returns An IUseCaseOutputFailed object.
      */
-    protected fail(error: IError): IOutputFailed;
+    protected fail(error: IUseCaseError): IUseCaseOutputFailed;
     /**
      * The core method that defines the use case's business logic.
      * Subclasses must implement this method.
@@ -54,6 +55,6 @@ export declare abstract class BaseUseCase<IInput, IDependencies, ISuccessData> {
      * @param input - The data required to execute the use case (type IInput).
      * @returns A promise resolving to the use case's result.
      */
-    abstract handle(input: IInput): Promise<IOutputSuccess<ISuccessData> | IOutputFailed>;
+    abstract handle(input: IInput): Promise<IUseCaseOutputSuccess<ISuccessData> | IUseCaseOutputFailed>;
 }
 //# sourceMappingURL=base-usecase.d.ts.map

package/lib/src/base-usecase.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base-usecase.d.ts","sourceRoot":"","sources":["../../src/base-usecase.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC;IAC/B,MAAM,EAAE,SAAS,CAAA;IACjB,IAAI,EAAE,CAAC,CAAA;CACR;AAGD,MAAM,WAAW,MAAM;IACrB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE;QACP,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KACxB,CAAA;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,QAAQ,CAAC;IACjB,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;;;;;;;;GAUG;AACH,8BAAsB,WAAW,CAC/B,MAAM,EACN,aAAa,EACb,YAAY;IAEZ,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAA;gBAE1B,IAAI,EAAE,aAAa;IAI/B;;;;OAIG;IACH,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,YAAY,GAAG,cAAc,CAAC,YAAY,CAAC;IAInE;;;;OAIG;IACH,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa;IAI5C;;;;;;OAMG;aACa,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,YAAY,CAAC,GAAG,aAAa,CAAC;CAC7F"}
+{"version":3,"file":"base-usecase.d.ts","sourceRoot":"","sources":["../../src/base-usecase.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,MAAM,EAAE,SAAS,CAAA;IACjB,IAAI,EAAE,CAAC,CAAA;CACR;AAGD,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE;QACP,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KACxB,CAAA;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,QAAQ,CAAC;IACjB,KAAK,EAAE,aAAa,CAAA;CACrB;AAED;;;;;;;;;GASG;AACH,8BAAsB,WAAW,CAC/B,MAAM,EACN,aAAa,EACb,YAAY;IAEZ,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAA;gBAE1B,IAAI,EAAE,aAAa;IAI/B;;;;OAIG;IACH,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,YAAY,GAAG,qBAAqB,CAAC,YAAY,CAAC;IAI1E;;;;OAIG;IACH,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,aAAa,GAAG,oBAAoB;IAU1D;;;;;;OAMG;aACa,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,YAAY,CAAC,GAAG,oBAAoB,CAAC;CAC3G"}

package/lib/src/index.d.ts

@@ -9,6 +9,7 @@ import { MongoDBHelper } from './database/mongodb/mongodb-helper';
 import mongodbErrorHandlerMiddleware from './middleware/mongodb-error-handler.middleware';
 export declare const stubDir: string;
 export { BaseUseCase } from './base-usecase';
+export type { IUseCaseOutputSuccess, IUseCaseOutputFailed, IUseCaseError } from './base-usecase';
 export { ExpressCli as BaseConsoleCli } from '@point-hub/express-cli';
 export declare const BaseConsoleCommand: typeof BaseCommand;
 export declare const BaseConsoleKernel: typeof ConsoleKernel;

package/lib/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,EACL,QAAQ,EACR,SAAS,EACT,sBAAsB,EACtB,IAAI,EACJ,qBAAqB,EAErB,KAAK,cAAc,EACpB,MAAM,kCAAkC,CAAA;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAE1C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAA;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAA;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAA;AAEjE,OAAO,6BAA6B,MAAM,+CAA+C,CAAA;AAEzF,eAAO,MAAM,OAAO,QAAqF,CAAA;AAGzG,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAE5C,OAAO,EAAE,UAAU,IAAI,cAAc,EAAE,MAAM,wBAAwB,CAAA;AACrE,eAAO,MAAM,kBAAkB,oBAAc,CAAA;AAC7C,eAAO,MAAM,iBAAiB,sBAAgB,CAAA;AAE9C,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAA;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAC/C,eAAO,MAAM,sBAAsB,2BAAqB,CAAA;AACxD,eAAO,MAAM,qBAAqB,0BAAoB,CAAA;AACtD,eAAO,MAAM,iBAAiB,sBAAgB,CAAA;AAC9C,eAAO,MAAM,sBAAsB;;;;;;;;;;;CAAc,CAAA;AACjD,OAAO,EAAE,OAAO,IAAI,uBAAuB,EAAE,MAAM,0CAA0C,CAAA;AAC7F,eAAO,MAAM,oBAAoB,yBAAmB,CAAA;AACpD,eAAO,MAAM,qBAAqB,0BAAoB,CAAA;AAEtD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAEnE,eAAO,MAAM,gBAAgB;;;;;;;;CAQ5B,CAAA;AAED,OAAO,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,UAAU,CAAA;AAE/C,YAAY,EAAE,cAAc,EAAE,CAAA;AAC9B,YAAY,EACV,gBAAgB,EAChB,oBAAoB,EACpB,SAAS,EACT,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,EACrB,aAAa,EACb,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,qBAAqB,EACrB,aAAa,EACb,iBAAiB,EACjB,SAAS,EACT,oBAAoB,EACpB,oBAAoB,EACpB,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,SAAS,EACT,MAAM,EACN,kBAAkB,EAClB,sBAAsB,EACtB,eAAe,EACf,mBAAmB,EACnB,OAAO,EACP,iBAAiB,EACjB,aAAa,EACb,iBAAiB,EACjB,qBAAqB,EACrB,aAAa,EACb,iBAAiB,GAClB,MAAM,oBAAoB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,EACL,QAAQ,EACR,SAAS,EACT,sBAAsB,EACtB,IAAI,EACJ,qBAAqB,EAErB,KAAK,cAAc,EACpB,MAAM,kCAAkC,CAAA;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAE1C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAA;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAA;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAA;AAEjE,OAAO,6BAA6B,MAAM,+CAA+C,CAAA;AAEzF,eAAO,MAAM,OAAO,QAAqF,CAAA;AAGzG,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAC5C,YAAY,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAEhG,OAAO,EAAE,UAAU,IAAI,cAAc,EAAE,MAAM,wBAAwB,CAAA;AACrE,eAAO,MAAM,kBAAkB,oBAAc,CAAA;AAC7C,eAAO,MAAM,iBAAiB,sBAAgB,CAAA;AAE9C,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAA;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAC/C,eAAO,MAAM,sBAAsB,2BAAqB,CAAA;AACxD,eAAO,MAAM,qBAAqB,0BAAoB,CAAA;AACtD,eAAO,MAAM,iBAAiB,sBAAgB,CAAA;AAC9C,eAAO,MAAM,sBAAsB;;;;;;;;;;;CAAc,CAAA;AACjD,OAAO,EAAE,OAAO,IAAI,uBAAuB,EAAE,MAAM,0CAA0C,CAAA;AAC7F,eAAO,MAAM,oBAAoB,yBAAmB,CAAA;AACpD,eAAO,MAAM,qBAAqB,0BAAoB,CAAA;AAEtD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAEnE,eAAO,MAAM,gBAAgB;;;;;;;;CAQ5B,CAAA;AAED,OAAO,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,UAAU,CAAA;AAE/C,YAAY,EAAE,cAAc,EAAE,CAAA;AAC9B,YAAY,EACV,gBAAgB,EAChB,oBAAoB,EACpB,SAAS,EACT,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,EACrB,aAAa,EACb,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,qBAAqB,EACrB,aAAa,EACb,iBAAiB,EACjB,SAAS,EACT,oBAAoB,EACpB,oBAAoB,EACpB,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,SAAS,EACT,MAAM,EACN,kBAAkB,EAClB,sBAAsB,EACtB,eAAe,EACf,mBAAmB,EACnB,OAAO,EACP,iBAAiB,EACjB,aAAa,EACb,iBAAiB,EACjB,qBAAqB,EACrB,aAAa,EACb,iBAAiB,GAClB,MAAM,oBAAoB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@point-hub/papi",
-  "version": "0.5.24",
+  "version": "0.5.26",
   "description": "Point API Framework",
   "type": "module",
   "main": "lib/index.js",