@xylabs/express 5.0.83 → 5.0.86

package/dist/node/middleware/standardResponses/jsonApi/relationship.d.ts

@@ -1,4 +1,5 @@
 import type { ApiResourceIdentifierObject } from './resourceIdentifier.ts';
+/** A relationship link pointing to the relationship itself. */
 export interface IRelationshipSelfLink {
     /**
      * A link for the relationship itself (a "relationship link"). This link allows the client to directly manipulate the relationship.
@@ -7,12 +8,14 @@ export interface IRelationshipSelfLink {
      */
     self: string;
 }
+/** A relationship link pointing to a related resource. */
 export interface IRelationshipRelatedLink {
     /**
      * A related resource link
      */
     related: string;
 }
+/** Contains the links for a JSON:API relationship. */
 export interface IRelationshipLinks {
     links: IRelationshipRelatedLink | IRelationshipSelfLink;
 }
@@ -25,9 +28,11 @@ export interface IRelationshipLinks {
  *    • an array of resource identifier objects for non-empty to-many relationships.
  */
 export type ResourceLinkage = null | [] | ApiResourceIdentifierObject | ApiResourceIdentifierObject[];
+/** Contains the resource linkage data for a JSON:API relationship. */
 export interface IRelationshipData {
     data: ResourceLinkage;
 }
+/** Non-standard metadata associated with a JSON:API relationship. */
 export type RelationshipMeta = Record<string, unknown>;
 /**
  * The value of the relationships key MUST be an object (a "relationships object"). Members of the relationships object ("relationships")

package/dist/node/middleware/standardResponses/jsonApi/relationship.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"relationship.d.ts","sourceRoot":"","sources":["../../../../../src/middleware/standardResponses/jsonApi/relationship.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAA;AAE1E,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,wBAAwB,GAAG,qBAAqB,CAAA;CACxD;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,eAAe,GAAG,IAAI,GAAG,EAAE,GAAG,2BAA2B,GAAG,2BAA2B,EAAE,CAAA;AACrG,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,eAAe,CAAA;CACtB;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEtD;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,kBAAkB,GAAG,iBAAiB,GAAG,gBAAgB,CAAA"}
+{"version":3,"file":"relationship.d.ts","sourceRoot":"","sources":["../../../../../src/middleware/standardResponses/jsonApi/relationship.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAA;AAE1E,+DAA+D;AAC/D,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED,0DAA0D;AAC1D,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,sDAAsD;AACtD,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,wBAAwB,GAAG,qBAAqB,CAAA;CACxD;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,eAAe,GAAG,IAAI,GAAG,EAAE,GAAG,2BAA2B,GAAG,2BAA2B,EAAE,CAAA;AACrG,sEAAsE;AACtE,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,eAAe,CAAA;CACtB;AAED,qEAAqE;AACrE,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEtD;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,kBAAkB,GAAG,iBAAiB,GAAG,gBAAgB,CAAA"}

package/dist/node/middleware/standardResponses/jsonApi/response.d.ts

@@ -6,6 +6,7 @@ import type { ApiError } from './error.ts';
 import type { ApiLinks } from './links.ts';
 import type { Relationship } from './relationship.ts';
 import type { ApiResourceIdentifierObject } from './resourceIdentifier.ts';
+/** A JSON:API resource object with optional attributes, links, meta, and relationships. */
 export interface ApiResourceObject extends ApiResourceIdentifierObject {
     /**
      * An attributes object representing some of the resource's data.
@@ -24,21 +25,26 @@ export interface ApiResourceObject extends ApiResourceIdentifierObject {
      */
     relationships?: Record<string, Relationship>;
 }
+/** JSON:API version and metadata descriptor. */
 export interface JsonApi {
     meta?: Record<string, unknown>;
     version?: '1.0' | '1.1';
 }
+/** Base interface for all JSON:API responses, including optional links and metadata. */
 export interface ApiResponseBase {
     jsonapi?: JsonApi;
     links?: ApiLinks;
     meta?: Record<string, unknown>;
 }
+/** A successful JSON:API response containing primary data and optional included resources. */
 export interface ApiDataResponse<T extends ApiResourceIdentifierObject> extends ApiResponseBase {
     data: T;
     included?: ApiResourceObject[];
 }
+/** A JSON:API error response containing one or more error objects. */
 export interface ApiErrorResponse extends ApiResponseBase {
     errors: ApiError[];
 }
+/** A JSON:API response, either a data response or an error response. */
 export type ApiResponse<T extends ApiResourceIdentifierObject> = ApiDataResponse<T> | ApiErrorResponse;
 //# sourceMappingURL=response.d.ts.map

package/dist/node/middleware/standardResponses/jsonApi/response.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../../../../src/middleware/standardResponses/jsonApi/response.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAC1C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAC1C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAA;AAE1E,MAAM,WAAW,iBAAkB,SAAQ,2BAA2B;IACpE;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpC;;OAEG;IACH,KAAK,CAAC,EAAE,QAAQ,CAAA;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;CAC7C;AAED,MAAM,WAAW,OAAO;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B,OAAO,CAAC,EAAE,KAAK,GAAG,KAAK,CAAA;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE,QAAQ,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,2BAA2B,CAAE,SAAQ,eAAe;IAC7F,IAAI,EAAE,CAAC,CAAA;IACP,QAAQ,CAAC,EAAE,iBAAiB,EAAE,CAAA;CAC/B;AACD,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,MAAM,EAAE,QAAQ,EAAE,CAAA;CACnB;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,2BAA2B,IAAI,eAAe,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAA"}
+{"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../../../../src/middleware/standardResponses/jsonApi/response.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAC1C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAC1C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAA;AAE1E,2FAA2F;AAC3F,MAAM,WAAW,iBAAkB,SAAQ,2BAA2B;IACpE;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpC;;OAEG;IACH,KAAK,CAAC,EAAE,QAAQ,CAAA;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;CAC7C;AAED,gDAAgD;AAChD,MAAM,WAAW,OAAO;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B,OAAO,CAAC,EAAE,KAAK,GAAG,KAAK,CAAA;CACxB;AAED,wFAAwF;AACxF,MAAM,WAAW,eAAe;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE,QAAQ,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B;AAED,8FAA8F;AAC9F,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,2BAA2B,CAAE,SAAQ,eAAe;IAC7F,IAAI,EAAE,CAAC,CAAA;IACP,QAAQ,CAAC,EAAE,iBAAiB,EAAE,CAAA;CAC/B;AACD,sEAAsE;AACtE,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,MAAM,EAAE,QAAQ,EAAE,CAAA;CACnB;AAED,wEAAwE;AACxE,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,2BAA2B,IAAI,eAAe,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAA"}

package/dist/node/middleware/standardResponses/standardErrors.d.ts

@@ -1,4 +1,11 @@
 import type { NextFunction, Request, Response } from 'express-serve-static-core';
 import type { ExpressError } from '../../Model/index.ts';
+/**
+ * Express error handler that logs the error and sends a JSON:API-compliant error response.
+ * @param err The error to handle, or undefined if no error.
+ * @param req The incoming request.
+ * @param res The outgoing response.
+ * @param next The next middleware function.
+ */
 export declare const standardErrors: (err: ExpressError | undefined, req: Request, res: Response, next: NextFunction) => void;
 //# sourceMappingURL=standardErrors.d.ts.map

package/dist/node/middleware/standardResponses/standardErrors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"standardErrors.d.ts","sourceRoot":"","sources":["../../../../src/middleware/standardResponses/standardErrors.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,YAAY,EAAE,OAAO,EAAE,QAAQ,EAChC,MAAM,2BAA2B,CAAA;AAGlC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAGxD,eAAO,MAAM,cAAc,GAAI,KAAK,YAAY,GAAG,SAAS,EAAE,KAAK,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,SAiB5G,CAAA"}
+{"version":3,"file":"standardErrors.d.ts","sourceRoot":"","sources":["../../../../src/middleware/standardResponses/standardErrors.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,YAAY,EAAE,OAAO,EAAE,QAAQ,EAChC,MAAM,2BAA2B,CAAA;AAGlC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAGxD;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GAAI,KAAK,YAAY,GAAG,SAAS,EAAE,KAAK,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,SAiB5G,CAAA"}

package/dist/node/middleware/standardResponses/standardResponses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"standardResponses.d.ts","sourceRoot":"","sources":["../../../../src/middleware/standardResponses/standardResponses.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACD,cAAc,EAAE,QAAQ,EAClC,MAAM,2BAA2B,CAAA;AASlC;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,GAAI,KAAK,QAAQ,KAAG,IAEpD,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,GAAI,KAAK,QAAQ,KAAG,IAEtD,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB,GAAI,KAAK,QAAQ,KAAG,OAEtD,CAAA;AAiBD;;;GAGG;AAEH,eAAO,MAAM,iBAAiB,EAAE,cAAkE,CAAA"}
+{"version":3,"file":"standardResponses.d.ts","sourceRoot":"","sources":["../../../../src/middleware/standardResponses/standardResponses.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACD,cAAc,EAAE,QAAQ,EAClC,MAAM,2BAA2B,CAAA;AAQlC;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,GAAI,KAAK,QAAQ,KAAG,IAEpD,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,GAAI,KAAK,QAAQ,KAAG,IAEtD,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB,GAAI,KAAK,QAAQ,KAAG,OAEtD,CAAA;AAiBD;;;GAGG;AAEH,eAAO,MAAM,iBAAiB,EAAE,cAAkE,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/express",
-  "version": "5.0.83",
+  "version": "5.0.86",
   "description": "SDK for base code for Api repos that use express and deploy on AWS ECS",
   "keywords": [
     "xylabs",
@@ -50,9 +50,9 @@
     "coverage": "vitest --coverage"
   },
   "dependencies": {
-    "@xylabs/assert": "~5.0.83",
-    "@xylabs/logger": "~5.0.83",
-    "@xylabs/typeof": "~5.0.83",
+    "@xylabs/assert": "~5.0.86",
+    "@xylabs/logger": "~5.0.86",
+    "@xylabs/typeof": "~5.0.86",
     "body-parser": "~2.2.2",
     "connect": "^3.7.0",
     "express-mung": "~0.5.1",
@@ -67,9 +67,9 @@
     "@types/express-mung": "~0.5.5",
     "@types/express-serve-static-core": "^5.1.1",
     "@types/node": "~25.4.0",
-    "@xylabs/ts-scripts-yarn3": "~7.4.11",
-    "@xylabs/tsconfig": "~7.4.11",
-    "@xylabs/vitest-extended": "~5.0.83",
+    "@xylabs/ts-scripts-yarn3": "~7.4.16",
+    "@xylabs/tsconfig": "~7.4.16",
+    "@xylabs/vitest-extended": "~5.0.86",
     "body-parser": "~2.2.2",
     "express-mung": "~0.5.1",
     "http-status-codes": "~2.3.0",