@ipetsadmin/contracts 1.0.3 → 1.0.4

package/CHANGELOG.md

@@ -19,6 +19,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Security
 
+## [1.0.4] - 2026-04-02
+
+### Added
+
+- **`HealthCheck` type** (`src/types/HealthCheck.ts`) — shape for `IApiResponse<HealthCheck>['data']` on health-check
+  endpoints (`message`, optional `status`).
+- **`HealthStatus` enum** (`src/enums/health-status.ts`) — `healthy` / `unhealthy`; exported for use with `HealthCheck`
+  and API handlers.
+
 ## [1.0.3] - 2026-04-02
 
 ### Fixed

package/README.md

@@ -35,6 +35,8 @@ pnpm add git+https://github.com/your-org/contracts.git#v1.0.0
 ```typescript
 import {
   Errors,
+  HealthCheck,
+  HealthStatus,
   IConfig,
   IApiResponse,
   IPaginatedResponse,
@@ -46,6 +48,13 @@ import {
   ServerError,
   UnauthorizedError,
 } from '@ipetsadmin/contracts';
+
+// Example: typed health-check response body
+const health: IApiResponse<HealthCheck> = {
+  success: true,
+  message: 'API is running',
+  data: { message: 'API is running', status: HealthStatus.HEALTHY },
+};
 ```
 
 Path aliases (`@/…`) apply only inside this package’s source; consumers import from `@ipetsadmin/contracts` as above.
@@ -98,9 +107,10 @@ pnpm install
 
 Source lives under `src/`:
 
-- `enums/` — shared enums (e.g. `Errors`)
+- `enums/` — shared enums (e.g. `Errors`, `HealthStatus`)
 - `errors/` — error classes (`BaseError`, domain errors, …)
 - `interfaces/general/` — cross-cutting interfaces (`IConfig`, pagination, API responses, server bootstrap types, …)
+- `types/` — shared type aliases (e.g. `HealthCheck` for `IApiResponse` payloads)
 
 The public API is whatever `src/index.ts` re-exports. Additional error classes may exist under `src/errors/` but only appear in consumers if listed in `index.ts`.
 

package/dist/index.d.mts

@@ -1,6 +1,16 @@
 import { Application } from 'express';
 import { Logger } from 'winston';
 
+declare enum HealthStatus {
+    HEALTHY = "healthy",
+    UNHEALTHY = "unhealthy"
+}
+
+type HealthCheck = {
+    message: string;
+    status?: HealthStatus;
+};
+
 interface IConfig {
     port: number;
     cors: {
@@ -103,4 +113,4 @@ declare class UnauthorizedError extends BaseError {
     constructor(message: string, details?: Record<string, unknown>);
 }
 
-export { BaseError, BusinessError, Errors, ForbiddenError, type IApiResponse, type IConfig, type IPaginatedResponse, type IServerInit, NotFoundError, ServerError, UnauthorizedError };
+export { BaseError, BusinessError, Errors, ForbiddenError, type HealthCheck, HealthStatus, type IApiResponse, type IConfig, type IPaginatedResponse, type IServerInit, NotFoundError, ServerError, UnauthorizedError };

package/dist/index.d.ts

@@ -1,6 +1,16 @@
 import { Application } from 'express';
 import { Logger } from 'winston';
 
+declare enum HealthStatus {
+    HEALTHY = "healthy",
+    UNHEALTHY = "unhealthy"
+}
+
+type HealthCheck = {
+    message: string;
+    status?: HealthStatus;
+};
+
 interface IConfig {
     port: number;
     cors: {
@@ -103,4 +113,4 @@ declare class UnauthorizedError extends BaseError {
     constructor(message: string, details?: Record<string, unknown>);
 }
 
-export { BaseError, BusinessError, Errors, ForbiddenError, type IApiResponse, type IConfig, type IPaginatedResponse, type IServerInit, NotFoundError, ServerError, UnauthorizedError };
+export { BaseError, BusinessError, Errors, ForbiddenError, type HealthCheck, HealthStatus, type IApiResponse, type IConfig, type IPaginatedResponse, type IServerInit, NotFoundError, ServerError, UnauthorizedError };

package/dist/index.js

@@ -19,6 +19,13 @@ var Errors = /* @__PURE__ */ ((Errors2) => {
   return Errors2;
 })(Errors || {});
 
+// src/enums/health-status.ts
+var HealthStatus = /* @__PURE__ */ ((HealthStatus2) => {
+  HealthStatus2["HEALTHY"] = "healthy";
+  HealthStatus2["UNHEALTHY"] = "unhealthy";
+  return HealthStatus2;
+})(HealthStatus || {});
+
 // src/errors/BaseError.ts
 var BaseError = class extends Error {
   toErrorRecord() {
@@ -84,6 +91,7 @@ exports.BaseError = BaseError;
 exports.BusinessError = BusinessError;
 exports.Errors = Errors;
 exports.ForbiddenError = ForbiddenError;
+exports.HealthStatus = HealthStatus;
 exports.NotFoundError = NotFoundError;
 exports.ServerError = ServerError;
 exports.UnauthorizedError = UnauthorizedError;

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/enums/errors.ts","../src/errors/BaseError.ts","../src/errors/BusinessError.ts","../src/errors/ForbiddenError.ts","../src/errors/NotFoundError.ts","../src/errors/ServerError.ts","../src/errors/UnauthorizedError.ts"],"names":["Errors"],"mappings":";;;AAAO,IAAK,MAAA,qBAAAA,OAAAA,KAAL;AACL,EAAAA,QAAA,iBAAA,CAAA,GAAkB,eAAA;AAClB,EAAAA,QAAA,gBAAA,CAAA,GAAiB,eAAA;AACjB,EAAAA,QAAA,iBAAA,CAAA,GAAkB,gBAAA;AAClB,EAAAA,QAAA,cAAA,CAAA,GAAe,aAAA;AACf,EAAAA,QAAA,oBAAA,CAAA,GAAqB,mBAAA;AACrB,EAAAA,QAAA,mBAAA,CAAA,GAAoB,iBAAA;AACpB,EAAAA,QAAA,4BAAA,CAAA,GAA6B,0BAAA;AAC7B,EAAAA,QAAA,yBAAA,CAAA,GAA0B,sBAAA;AAC1B,EAAAA,QAAA,uBAAA,CAAA,GAAwB,qBAAA;AACxB,EAAAA,QAAA,2BAAA,CAAA,GAA4B,yBAAA;AAC5B,EAAAA,QAAA,uBAAA,CAAA,GAAwB,qBAAA;AACxB,EAAAA,QAAA,mBAAA,CAAA,GAAoB,iBAAA;AACpB,EAAAA,QAAA,2BAAA,CAAA,GAA4B,yBAAA;AAC5B,EAAAA,QAAA,yBAAA,CAAA,GAA0B,sBAAA;AAdhB,EAAA,OAAAA,OAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA;;;ACAL,IAAM,SAAA,GAAN,cAAwB,KAAA,CAAM;AAAA,EAE5B,aAAA,GAAsD;AAC3D,IAAA,MAAM,GAAA,GAA4C,EAAE,KAAA,EAAO,IAAA,CAAK,OAAA,EAAQ;AACxE,IAAA,IAAI,KAAK,OAAA,EAAS;AAChB,MAAA,GAAA,CAAI,UAAU,IAAA,CAAK,OAAA;AAAA,IACrB;AACA,IAAA,OAAO,GAAA;AAAA,EACT;AACF;;;ACNO,IAAM,aAAA,GAAN,MAAM,cAAA,SAAsB,SAAA,CAAU;AAAA,EAEpC,WAAA,CAAY,SAAiB,OAAA,EAAmC;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAA,eAAA;AACL,IAAA,IAAA,CAAK,OAAA,GAAU,WAAW,EAAC;AAC3B,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,cAAA,CAAc,SAAS,CAAA;AAAA,EACrD;AACF;;;ACRO,IAAM,cAAA,GAAN,MAAM,eAAA,SAAuB,SAAA,CAAU;AAAA,EAErC,WAAA,CAAY,SAAiB,OAAA,EAAmC;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAA,gBAAA;AACL,IAAA,IAAA,CAAK,OAAA,GAAU,WAAW,EAAC;AAC3B,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,eAAA,CAAe,SAAS,CAAA;AAAA,EACtD;AACF;;;ACRO,IAAM,aAAA,GAAN,MAAM,cAAA,SAAsB,SAAA,CAAU;AAAA,EAEpC,WAAA,CAAY,SAAiB,OAAA,EAAmC;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAA,eAAA;AACL,IAAA,IAAA,CAAK,OAAA,GAAU,WAAW,EAAC;AAC3B,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,cAAA,CAAc,SAAS,CAAA;AAAA,EACrD;AACF;;;ACRO,IAAM,WAAA,GAAN,MAAM,YAAA,SAAoB,SAAA,CAAU;AAAA,EAElC,WAAA,CAAY,SAAiB,OAAA,EAAmC;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAA,aAAA;AACL,IAAA,IAAA,CAAK,OAAA,GAAU,WAAW,EAAC;AAC3B,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,YAAA,CAAY,SAAS,CAAA;AAAA,EACnD;AACF;;;ACRO,IAAM,iBAAA,GAAN,MAAM,kBAAA,SAA0B,SAAA,CAAU;AAAA,EAExC,WAAA,CAAY,SAAiB,OAAA,EAAmC;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAA,mBAAA;AACL,IAAA,IAAA,CAAK,OAAA,GAAU,WAAW,EAAC;AAC3B,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,kBAAA,CAAkB,SAAS,CAAA;AAAA,EACzD;AACF","file":"index.js","sourcesContent":["export enum Errors {\n  NOT_FOUND_ERROR = 'NotFoundError',\n  BUSINESS_ERROR = 'BusinessError',\n  FORBIDDEN_ERROR = 'ForbiddenError',\n  SERVER_ERROR = 'ServerError',\n  UNAUTHORIZED_ERROR = 'UnauthorizedError',\n  BAD_REQUEST_ERROR = 'BadRequestError',\n  UNPROCESSABLE_ENTITY_ERROR = 'UnprocessableEntityError',\n  TOO_MANY_REQUESTS_ERROR = 'TooManyRequestsError',\n  INTERNAL_SERVER_ERROR = 'InternalServerError',\n  SERVICE_UNAVAILABLE_ERROR = 'ServiceUnavailableError',\n  GATEWAY_TIMEOUT_ERROR = 'GatewayTimeoutError',\n  BAD_GATEWAY_ERROR = 'BadGatewayError',\n  PRECONDITION_FAILED_ERROR = 'PreconditionFailedError',\n  PAYLOAD_TOO_LARGE_ERROR = 'PayloadTooLargeError',\n}\n","export class BaseError extends Error {\n  public details?: Record<string, unknown>;\n  public toErrorRecord(): { error: string; details?: unknown } {\n    const obj: { error: string; details?: unknown } = { error: this.message };\n    if (this.details) {\n      obj.details = this.details;\n    }\n    return obj;\n  }\n}\n","import { BaseError } from '@/errors/BaseError';\nimport { Errors } from '@/enums/errors';\n\nexport class BusinessError extends BaseError {\n  public details?: Record<string, unknown>;\n  public constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = Errors.BUSINESS_ERROR;\n    this.details = details || {};\n    Object.setPrototypeOf(this, BusinessError.prototype);\n  }\n}\n","import { BaseError } from '@/errors/BaseError';\nimport { Errors } from '@/enums/errors';\n\nexport class ForbiddenError extends BaseError {\n  public details?: Record<string, unknown>;\n  public constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = Errors.FORBIDDEN_ERROR;\n    this.details = details || {};\n    Object.setPrototypeOf(this, ForbiddenError.prototype);\n  }\n}\n","import { BaseError } from '@/errors/BaseError';\nimport { Errors } from '@/enums/errors';\n\nexport class NotFoundError extends BaseError {\n  public details?: Record<string, unknown>;\n  public constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = Errors.NOT_FOUND_ERROR;\n    this.details = details || {};\n    Object.setPrototypeOf(this, NotFoundError.prototype);\n  }\n}\n","import { BaseError } from '@/errors/BaseError';\nimport { Errors } from '@/enums/errors';\n\nexport class ServerError extends BaseError {\n  public details?: Record<string, unknown>;\n  public constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = Errors.SERVER_ERROR;\n    this.details = details || {};\n    Object.setPrototypeOf(this, ServerError.prototype);\n  }\n}\n","import { BaseError } from '@/errors/BaseError';\nimport { Errors } from '@/enums/errors';\n\nexport class UnauthorizedError extends BaseError {\n  public details?: Record<string, unknown>;\n  public constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = Errors.UNAUTHORIZED_ERROR;\n    this.details = details || {};\n    Object.setPrototypeOf(this, UnauthorizedError.prototype);\n  }\n}\n"]}
+{"version":3,"sources":["../src/enums/errors.ts","../src/enums/health-status.ts","../src/errors/BaseError.ts","../src/errors/BusinessError.ts","../src/errors/ForbiddenError.ts","../src/errors/NotFoundError.ts","../src/errors/ServerError.ts","../src/errors/UnauthorizedError.ts"],"names":["Errors","HealthStatus"],"mappings":";;;AAAO,IAAK,MAAA,qBAAAA,OAAAA,KAAL;AACL,EAAAA,QAAA,iBAAA,CAAA,GAAkB,eAAA;AAClB,EAAAA,QAAA,gBAAA,CAAA,GAAiB,eAAA;AACjB,EAAAA,QAAA,iBAAA,CAAA,GAAkB,gBAAA;AAClB,EAAAA,QAAA,cAAA,CAAA,GAAe,aAAA;AACf,EAAAA,QAAA,oBAAA,CAAA,GAAqB,mBAAA;AACrB,EAAAA,QAAA,mBAAA,CAAA,GAAoB,iBAAA;AACpB,EAAAA,QAAA,4BAAA,CAAA,GAA6B,0BAAA;AAC7B,EAAAA,QAAA,yBAAA,CAAA,GAA0B,sBAAA;AAC1B,EAAAA,QAAA,uBAAA,CAAA,GAAwB,qBAAA;AACxB,EAAAA,QAAA,2BAAA,CAAA,GAA4B,yBAAA;AAC5B,EAAAA,QAAA,uBAAA,CAAA,GAAwB,qBAAA;AACxB,EAAAA,QAAA,mBAAA,CAAA,GAAoB,iBAAA;AACpB,EAAAA,QAAA,2BAAA,CAAA,GAA4B,yBAAA;AAC5B,EAAAA,QAAA,yBAAA,CAAA,GAA0B,sBAAA;AAdhB,EAAA,OAAAA,OAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA;;;ACAL,IAAK,YAAA,qBAAAC,aAAAA,KAAL;AACL,EAAAA,cAAA,SAAA,CAAA,GAAU,SAAA;AACV,EAAAA,cAAA,WAAA,CAAA,GAAY,WAAA;AAFF,EAAA,OAAAA,aAAAA;AAAA,CAAA,EAAA,YAAA,IAAA,EAAA;;;ACAL,IAAM,SAAA,GAAN,cAAwB,KAAA,CAAM;AAAA,EAE5B,aAAA,GAAsD;AAC3D,IAAA,MAAM,GAAA,GAA4C,EAAE,KAAA,EAAO,IAAA,CAAK,OAAA,EAAQ;AACxE,IAAA,IAAI,KAAK,OAAA,EAAS;AAChB,MAAA,GAAA,CAAI,UAAU,IAAA,CAAK,OAAA;AAAA,IACrB;AACA,IAAA,OAAO,GAAA;AAAA,EACT;AACF;;;ACNO,IAAM,aAAA,GAAN,MAAM,cAAA,SAAsB,SAAA,CAAU;AAAA,EAEpC,WAAA,CAAY,SAAiB,OAAA,EAAmC;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAA,eAAA;AACL,IAAA,IAAA,CAAK,OAAA,GAAU,WAAW,EAAC;AAC3B,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,cAAA,CAAc,SAAS,CAAA;AAAA,EACrD;AACF;;;ACRO,IAAM,cAAA,GAAN,MAAM,eAAA,SAAuB,SAAA,CAAU;AAAA,EAErC,WAAA,CAAY,SAAiB,OAAA,EAAmC;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAA,gBAAA;AACL,IAAA,IAAA,CAAK,OAAA,GAAU,WAAW,EAAC;AAC3B,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,eAAA,CAAe,SAAS,CAAA;AAAA,EACtD;AACF;;;ACRO,IAAM,aAAA,GAAN,MAAM,cAAA,SAAsB,SAAA,CAAU;AAAA,EAEpC,WAAA,CAAY,SAAiB,OAAA,EAAmC;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAA,eAAA;AACL,IAAA,IAAA,CAAK,OAAA,GAAU,WAAW,EAAC;AAC3B,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,cAAA,CAAc,SAAS,CAAA;AAAA,EACrD;AACF;;;ACRO,IAAM,WAAA,GAAN,MAAM,YAAA,SAAoB,SAAA,CAAU;AAAA,EAElC,WAAA,CAAY,SAAiB,OAAA,EAAmC;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAA,aAAA;AACL,IAAA,IAAA,CAAK,OAAA,GAAU,WAAW,EAAC;AAC3B,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,YAAA,CAAY,SAAS,CAAA;AAAA,EACnD;AACF;;;ACRO,IAAM,iBAAA,GAAN,MAAM,kBAAA,SAA0B,SAAA,CAAU;AAAA,EAExC,WAAA,CAAY,SAAiB,OAAA,EAAmC;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAA,mBAAA;AACL,IAAA,IAAA,CAAK,OAAA,GAAU,WAAW,EAAC;AAC3B,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,kBAAA,CAAkB,SAAS,CAAA;AAAA,EACzD;AACF","file":"index.js","sourcesContent":["export enum Errors {\n  NOT_FOUND_ERROR = 'NotFoundError',\n  BUSINESS_ERROR = 'BusinessError',\n  FORBIDDEN_ERROR = 'ForbiddenError',\n  SERVER_ERROR = 'ServerError',\n  UNAUTHORIZED_ERROR = 'UnauthorizedError',\n  BAD_REQUEST_ERROR = 'BadRequestError',\n  UNPROCESSABLE_ENTITY_ERROR = 'UnprocessableEntityError',\n  TOO_MANY_REQUESTS_ERROR = 'TooManyRequestsError',\n  INTERNAL_SERVER_ERROR = 'InternalServerError',\n  SERVICE_UNAVAILABLE_ERROR = 'ServiceUnavailableError',\n  GATEWAY_TIMEOUT_ERROR = 'GatewayTimeoutError',\n  BAD_GATEWAY_ERROR = 'BadGatewayError',\n  PRECONDITION_FAILED_ERROR = 'PreconditionFailedError',\n  PAYLOAD_TOO_LARGE_ERROR = 'PayloadTooLargeError',\n}\n","export enum HealthStatus {\n  HEALTHY = 'healthy',\n  UNHEALTHY = 'unhealthy',\n}\n","export class BaseError extends Error {\n  public details?: Record<string, unknown>;\n  public toErrorRecord(): { error: string; details?: unknown } {\n    const obj: { error: string; details?: unknown } = { error: this.message };\n    if (this.details) {\n      obj.details = this.details;\n    }\n    return obj;\n  }\n}\n","import { BaseError } from '@/errors/BaseError';\nimport { Errors } from '@/enums/errors';\n\nexport class BusinessError extends BaseError {\n  public details?: Record<string, unknown>;\n  public constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = Errors.BUSINESS_ERROR;\n    this.details = details || {};\n    Object.setPrototypeOf(this, BusinessError.prototype);\n  }\n}\n","import { BaseError } from '@/errors/BaseError';\nimport { Errors } from '@/enums/errors';\n\nexport class ForbiddenError extends BaseError {\n  public details?: Record<string, unknown>;\n  public constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = Errors.FORBIDDEN_ERROR;\n    this.details = details || {};\n    Object.setPrototypeOf(this, ForbiddenError.prototype);\n  }\n}\n","import { BaseError } from '@/errors/BaseError';\nimport { Errors } from '@/enums/errors';\n\nexport class NotFoundError extends BaseError {\n  public details?: Record<string, unknown>;\n  public constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = Errors.NOT_FOUND_ERROR;\n    this.details = details || {};\n    Object.setPrototypeOf(this, NotFoundError.prototype);\n  }\n}\n","import { BaseError } from '@/errors/BaseError';\nimport { Errors } from '@/enums/errors';\n\nexport class ServerError extends BaseError {\n  public details?: Record<string, unknown>;\n  public constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = Errors.SERVER_ERROR;\n    this.details = details || {};\n    Object.setPrototypeOf(this, ServerError.prototype);\n  }\n}\n","import { BaseError } from '@/errors/BaseError';\nimport { Errors } from '@/enums/errors';\n\nexport class UnauthorizedError extends BaseError {\n  public details?: Record<string, unknown>;\n  public constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = Errors.UNAUTHORIZED_ERROR;\n    this.details = details || {};\n    Object.setPrototypeOf(this, UnauthorizedError.prototype);\n  }\n}\n"]}

package/dist/index.mjs

@@ -17,6 +17,13 @@ var Errors = /* @__PURE__ */ ((Errors2) => {
   return Errors2;
 })(Errors || {});
 
+// src/enums/health-status.ts
+var HealthStatus = /* @__PURE__ */ ((HealthStatus2) => {
+  HealthStatus2["HEALTHY"] = "healthy";
+  HealthStatus2["UNHEALTHY"] = "unhealthy";
+  return HealthStatus2;
+})(HealthStatus || {});
+
 // src/errors/BaseError.ts
 var BaseError = class extends Error {
   toErrorRecord() {
@@ -78,6 +85,6 @@ var UnauthorizedError = class _UnauthorizedError extends BaseError {
   }
 };
 
-export { BaseError, BusinessError, Errors, ForbiddenError, NotFoundError, ServerError, UnauthorizedError };
+export { BaseError, BusinessError, Errors, ForbiddenError, HealthStatus, NotFoundError, ServerError, UnauthorizedError };
 //# sourceMappingURL=index.mjs.map
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/enums/errors.ts","../src/errors/BaseError.ts","../src/errors/BusinessError.ts","../src/errors/ForbiddenError.ts","../src/errors/NotFoundError.ts","../src/errors/ServerError.ts","../src/errors/UnauthorizedError.ts"],"names":["Errors"],"mappings":";AAAO,IAAK,MAAA,qBAAAA,OAAAA,KAAL;AACL,EAAAA,QAAA,iBAAA,CAAA,GAAkB,eAAA;AAClB,EAAAA,QAAA,gBAAA,CAAA,GAAiB,eAAA;AACjB,EAAAA,QAAA,iBAAA,CAAA,GAAkB,gBAAA;AAClB,EAAAA,QAAA,cAAA,CAAA,GAAe,aAAA;AACf,EAAAA,QAAA,oBAAA,CAAA,GAAqB,mBAAA;AACrB,EAAAA,QAAA,mBAAA,CAAA,GAAoB,iBAAA;AACpB,EAAAA,QAAA,4BAAA,CAAA,GAA6B,0BAAA;AAC7B,EAAAA,QAAA,yBAAA,CAAA,GAA0B,sBAAA;AAC1B,EAAAA,QAAA,uBAAA,CAAA,GAAwB,qBAAA;AACxB,EAAAA,QAAA,2BAAA,CAAA,GAA4B,yBAAA;AAC5B,EAAAA,QAAA,uBAAA,CAAA,GAAwB,qBAAA;AACxB,EAAAA,QAAA,mBAAA,CAAA,GAAoB,iBAAA;AACpB,EAAAA,QAAA,2BAAA,CAAA,GAA4B,yBAAA;AAC5B,EAAAA,QAAA,yBAAA,CAAA,GAA0B,sBAAA;AAdhB,EAAA,OAAAA,OAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA;;;ACAL,IAAM,SAAA,GAAN,cAAwB,KAAA,CAAM;AAAA,EAE5B,aAAA,GAAsD;AAC3D,IAAA,MAAM,GAAA,GAA4C,EAAE,KAAA,EAAO,IAAA,CAAK,OAAA,EAAQ;AACxE,IAAA,IAAI,KAAK,OAAA,EAAS;AAChB,MAAA,GAAA,CAAI,UAAU,IAAA,CAAK,OAAA;AAAA,IACrB;AACA,IAAA,OAAO,GAAA;AAAA,EACT;AACF;;;ACNO,IAAM,aAAA,GAAN,MAAM,cAAA,SAAsB,SAAA,CAAU;AAAA,EAEpC,WAAA,CAAY,SAAiB,OAAA,EAAmC;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAA,eAAA;AACL,IAAA,IAAA,CAAK,OAAA,GAAU,WAAW,EAAC;AAC3B,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,cAAA,CAAc,SAAS,CAAA;AAAA,EACrD;AACF;;;ACRO,IAAM,cAAA,GAAN,MAAM,eAAA,SAAuB,SAAA,CAAU;AAAA,EAErC,WAAA,CAAY,SAAiB,OAAA,EAAmC;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAA,gBAAA;AACL,IAAA,IAAA,CAAK,OAAA,GAAU,WAAW,EAAC;AAC3B,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,eAAA,CAAe,SAAS,CAAA;AAAA,EACtD;AACF;;;ACRO,IAAM,aAAA,GAAN,MAAM,cAAA,SAAsB,SAAA,CAAU;AAAA,EAEpC,WAAA,CAAY,SAAiB,OAAA,EAAmC;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAA,eAAA;AACL,IAAA,IAAA,CAAK,OAAA,GAAU,WAAW,EAAC;AAC3B,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,cAAA,CAAc,SAAS,CAAA;AAAA,EACrD;AACF;;;ACRO,IAAM,WAAA,GAAN,MAAM,YAAA,SAAoB,SAAA,CAAU;AAAA,EAElC,WAAA,CAAY,SAAiB,OAAA,EAAmC;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAA,aAAA;AACL,IAAA,IAAA,CAAK,OAAA,GAAU,WAAW,EAAC;AAC3B,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,YAAA,CAAY,SAAS,CAAA;AAAA,EACnD;AACF;;;ACRO,IAAM,iBAAA,GAAN,MAAM,kBAAA,SAA0B,SAAA,CAAU;AAAA,EAExC,WAAA,CAAY,SAAiB,OAAA,EAAmC;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAA,mBAAA;AACL,IAAA,IAAA,CAAK,OAAA,GAAU,WAAW,EAAC;AAC3B,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,kBAAA,CAAkB,SAAS,CAAA;AAAA,EACzD;AACF","file":"index.mjs","sourcesContent":["export enum Errors {\n  NOT_FOUND_ERROR = 'NotFoundError',\n  BUSINESS_ERROR = 'BusinessError',\n  FORBIDDEN_ERROR = 'ForbiddenError',\n  SERVER_ERROR = 'ServerError',\n  UNAUTHORIZED_ERROR = 'UnauthorizedError',\n  BAD_REQUEST_ERROR = 'BadRequestError',\n  UNPROCESSABLE_ENTITY_ERROR = 'UnprocessableEntityError',\n  TOO_MANY_REQUESTS_ERROR = 'TooManyRequestsError',\n  INTERNAL_SERVER_ERROR = 'InternalServerError',\n  SERVICE_UNAVAILABLE_ERROR = 'ServiceUnavailableError',\n  GATEWAY_TIMEOUT_ERROR = 'GatewayTimeoutError',\n  BAD_GATEWAY_ERROR = 'BadGatewayError',\n  PRECONDITION_FAILED_ERROR = 'PreconditionFailedError',\n  PAYLOAD_TOO_LARGE_ERROR = 'PayloadTooLargeError',\n}\n","export class BaseError extends Error {\n  public details?: Record<string, unknown>;\n  public toErrorRecord(): { error: string; details?: unknown } {\n    const obj: { error: string; details?: unknown } = { error: this.message };\n    if (this.details) {\n      obj.details = this.details;\n    }\n    return obj;\n  }\n}\n","import { BaseError } from '@/errors/BaseError';\nimport { Errors } from '@/enums/errors';\n\nexport class BusinessError extends BaseError {\n  public details?: Record<string, unknown>;\n  public constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = Errors.BUSINESS_ERROR;\n    this.details = details || {};\n    Object.setPrototypeOf(this, BusinessError.prototype);\n  }\n}\n","import { BaseError } from '@/errors/BaseError';\nimport { Errors } from '@/enums/errors';\n\nexport class ForbiddenError extends BaseError {\n  public details?: Record<string, unknown>;\n  public constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = Errors.FORBIDDEN_ERROR;\n    this.details = details || {};\n    Object.setPrototypeOf(this, ForbiddenError.prototype);\n  }\n}\n","import { BaseError } from '@/errors/BaseError';\nimport { Errors } from '@/enums/errors';\n\nexport class NotFoundError extends BaseError {\n  public details?: Record<string, unknown>;\n  public constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = Errors.NOT_FOUND_ERROR;\n    this.details = details || {};\n    Object.setPrototypeOf(this, NotFoundError.prototype);\n  }\n}\n","import { BaseError } from '@/errors/BaseError';\nimport { Errors } from '@/enums/errors';\n\nexport class ServerError extends BaseError {\n  public details?: Record<string, unknown>;\n  public constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = Errors.SERVER_ERROR;\n    this.details = details || {};\n    Object.setPrototypeOf(this, ServerError.prototype);\n  }\n}\n","import { BaseError } from '@/errors/BaseError';\nimport { Errors } from '@/enums/errors';\n\nexport class UnauthorizedError extends BaseError {\n  public details?: Record<string, unknown>;\n  public constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = Errors.UNAUTHORIZED_ERROR;\n    this.details = details || {};\n    Object.setPrototypeOf(this, UnauthorizedError.prototype);\n  }\n}\n"]}
+{"version":3,"sources":["../src/enums/errors.ts","../src/enums/health-status.ts","../src/errors/BaseError.ts","../src/errors/BusinessError.ts","../src/errors/ForbiddenError.ts","../src/errors/NotFoundError.ts","../src/errors/ServerError.ts","../src/errors/UnauthorizedError.ts"],"names":["Errors","HealthStatus"],"mappings":";AAAO,IAAK,MAAA,qBAAAA,OAAAA,KAAL;AACL,EAAAA,QAAA,iBAAA,CAAA,GAAkB,eAAA;AAClB,EAAAA,QAAA,gBAAA,CAAA,GAAiB,eAAA;AACjB,EAAAA,QAAA,iBAAA,CAAA,GAAkB,gBAAA;AAClB,EAAAA,QAAA,cAAA,CAAA,GAAe,aAAA;AACf,EAAAA,QAAA,oBAAA,CAAA,GAAqB,mBAAA;AACrB,EAAAA,QAAA,mBAAA,CAAA,GAAoB,iBAAA;AACpB,EAAAA,QAAA,4BAAA,CAAA,GAA6B,0BAAA;AAC7B,EAAAA,QAAA,yBAAA,CAAA,GAA0B,sBAAA;AAC1B,EAAAA,QAAA,uBAAA,CAAA,GAAwB,qBAAA;AACxB,EAAAA,QAAA,2BAAA,CAAA,GAA4B,yBAAA;AAC5B,EAAAA,QAAA,uBAAA,CAAA,GAAwB,qBAAA;AACxB,EAAAA,QAAA,mBAAA,CAAA,GAAoB,iBAAA;AACpB,EAAAA,QAAA,2BAAA,CAAA,GAA4B,yBAAA;AAC5B,EAAAA,QAAA,yBAAA,CAAA,GAA0B,sBAAA;AAdhB,EAAA,OAAAA,OAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA;;;ACAL,IAAK,YAAA,qBAAAC,aAAAA,KAAL;AACL,EAAAA,cAAA,SAAA,CAAA,GAAU,SAAA;AACV,EAAAA,cAAA,WAAA,CAAA,GAAY,WAAA;AAFF,EAAA,OAAAA,aAAAA;AAAA,CAAA,EAAA,YAAA,IAAA,EAAA;;;ACAL,IAAM,SAAA,GAAN,cAAwB,KAAA,CAAM;AAAA,EAE5B,aAAA,GAAsD;AAC3D,IAAA,MAAM,GAAA,GAA4C,EAAE,KAAA,EAAO,IAAA,CAAK,OAAA,EAAQ;AACxE,IAAA,IAAI,KAAK,OAAA,EAAS;AAChB,MAAA,GAAA,CAAI,UAAU,IAAA,CAAK,OAAA;AAAA,IACrB;AACA,IAAA,OAAO,GAAA;AAAA,EACT;AACF;;;ACNO,IAAM,aAAA,GAAN,MAAM,cAAA,SAAsB,SAAA,CAAU;AAAA,EAEpC,WAAA,CAAY,SAAiB,OAAA,EAAmC;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAA,eAAA;AACL,IAAA,IAAA,CAAK,OAAA,GAAU,WAAW,EAAC;AAC3B,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,cAAA,CAAc,SAAS,CAAA;AAAA,EACrD;AACF;;;ACRO,IAAM,cAAA,GAAN,MAAM,eAAA,SAAuB,SAAA,CAAU;AAAA,EAErC,WAAA,CAAY,SAAiB,OAAA,EAAmC;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAA,gBAAA;AACL,IAAA,IAAA,CAAK,OAAA,GAAU,WAAW,EAAC;AAC3B,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,eAAA,CAAe,SAAS,CAAA;AAAA,EACtD;AACF;;;ACRO,IAAM,aAAA,GAAN,MAAM,cAAA,SAAsB,SAAA,CAAU;AAAA,EAEpC,WAAA,CAAY,SAAiB,OAAA,EAAmC;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAA,eAAA;AACL,IAAA,IAAA,CAAK,OAAA,GAAU,WAAW,EAAC;AAC3B,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,cAAA,CAAc,SAAS,CAAA;AAAA,EACrD;AACF;;;ACRO,IAAM,WAAA,GAAN,MAAM,YAAA,SAAoB,SAAA,CAAU;AAAA,EAElC,WAAA,CAAY,SAAiB,OAAA,EAAmC;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAA,aAAA;AACL,IAAA,IAAA,CAAK,OAAA,GAAU,WAAW,EAAC;AAC3B,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,YAAA,CAAY,SAAS,CAAA;AAAA,EACnD;AACF;;;ACRO,IAAM,iBAAA,GAAN,MAAM,kBAAA,SAA0B,SAAA,CAAU;AAAA,EAExC,WAAA,CAAY,SAAiB,OAAA,EAAmC;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAA,mBAAA;AACL,IAAA,IAAA,CAAK,OAAA,GAAU,WAAW,EAAC;AAC3B,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,kBAAA,CAAkB,SAAS,CAAA;AAAA,EACzD;AACF","file":"index.mjs","sourcesContent":["export enum Errors {\n  NOT_FOUND_ERROR = 'NotFoundError',\n  BUSINESS_ERROR = 'BusinessError',\n  FORBIDDEN_ERROR = 'ForbiddenError',\n  SERVER_ERROR = 'ServerError',\n  UNAUTHORIZED_ERROR = 'UnauthorizedError',\n  BAD_REQUEST_ERROR = 'BadRequestError',\n  UNPROCESSABLE_ENTITY_ERROR = 'UnprocessableEntityError',\n  TOO_MANY_REQUESTS_ERROR = 'TooManyRequestsError',\n  INTERNAL_SERVER_ERROR = 'InternalServerError',\n  SERVICE_UNAVAILABLE_ERROR = 'ServiceUnavailableError',\n  GATEWAY_TIMEOUT_ERROR = 'GatewayTimeoutError',\n  BAD_GATEWAY_ERROR = 'BadGatewayError',\n  PRECONDITION_FAILED_ERROR = 'PreconditionFailedError',\n  PAYLOAD_TOO_LARGE_ERROR = 'PayloadTooLargeError',\n}\n","export enum HealthStatus {\n  HEALTHY = 'healthy',\n  UNHEALTHY = 'unhealthy',\n}\n","export class BaseError extends Error {\n  public details?: Record<string, unknown>;\n  public toErrorRecord(): { error: string; details?: unknown } {\n    const obj: { error: string; details?: unknown } = { error: this.message };\n    if (this.details) {\n      obj.details = this.details;\n    }\n    return obj;\n  }\n}\n","import { BaseError } from '@/errors/BaseError';\nimport { Errors } from '@/enums/errors';\n\nexport class BusinessError extends BaseError {\n  public details?: Record<string, unknown>;\n  public constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = Errors.BUSINESS_ERROR;\n    this.details = details || {};\n    Object.setPrototypeOf(this, BusinessError.prototype);\n  }\n}\n","import { BaseError } from '@/errors/BaseError';\nimport { Errors } from '@/enums/errors';\n\nexport class ForbiddenError extends BaseError {\n  public details?: Record<string, unknown>;\n  public constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = Errors.FORBIDDEN_ERROR;\n    this.details = details || {};\n    Object.setPrototypeOf(this, ForbiddenError.prototype);\n  }\n}\n","import { BaseError } from '@/errors/BaseError';\nimport { Errors } from '@/enums/errors';\n\nexport class NotFoundError extends BaseError {\n  public details?: Record<string, unknown>;\n  public constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = Errors.NOT_FOUND_ERROR;\n    this.details = details || {};\n    Object.setPrototypeOf(this, NotFoundError.prototype);\n  }\n}\n","import { BaseError } from '@/errors/BaseError';\nimport { Errors } from '@/enums/errors';\n\nexport class ServerError extends BaseError {\n  public details?: Record<string, unknown>;\n  public constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = Errors.SERVER_ERROR;\n    this.details = details || {};\n    Object.setPrototypeOf(this, ServerError.prototype);\n  }\n}\n","import { BaseError } from '@/errors/BaseError';\nimport { Errors } from '@/enums/errors';\n\nexport class UnauthorizedError extends BaseError {\n  public details?: Record<string, unknown>;\n  public constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = Errors.UNAUTHORIZED_ERROR;\n    this.details = details || {};\n    Object.setPrototypeOf(this, UnauthorizedError.prototype);\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ipetsadmin/contracts",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Shared types, enums, and interfaces for Truffa projects",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",