@xylabs/express 4.13.14 → 4.13.16

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

@@ -0,0 +1,38 @@
+import type { ApiResourceIdentifierObject } from './resourceIdentifier.ts';
+export interface IRelationshipSelfLink {
+    /**
+     * A link for the relationship itself (a "relationship link"). This link allows the client to directly manipulate the relationship.
+     * For example, removing an author through an article’s relationship URL would disconnect the person from the article without
+     * deleting the people resource itself. When fetched successfully, this link returns the linkage for the related resources as its primary data.
+     */
+    self: string;
+}
+export interface IRelationshipRelatedLink {
+    /**
+     * A related resource link
+     */
+    related: string;
+}
+export interface IRelationshipLinks {
+    links: IRelationshipRelatedLink | IRelationshipSelfLink;
+}
+/**
+ * Resource linkage in a compound document allows a client to link together all of the included resource objects without having to GET any URLs via links.
+ * Resource linkage MUST be represented as one of the following:
+ *    • null for empty to-one relationships.
+ *    • an empty array ([]) for empty to-many relationships.
+ *    • a single resource identifier object for non-empty to-one relationships.
+ *    • an array of resource identifier objects for non-empty to-many relationships.
+ */
+export type ResourceLinkage = null | [] | ApiResourceIdentifierObject | ApiResourceIdentifierObject[];
+export interface IRelationshipData {
+    data: ResourceLinkage;
+}
+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")
+ * represent references from the resource object in which it’s defined to other resource objects.
+ * Relationships may be to-one or to-many.
+ */
+export type Relationship = IRelationshipLinks | IRelationshipData | RelationshipMeta;
+//# sourceMappingURL=relationship.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,16 @@
+/**
+ * Within a given API, each resource object's type and id pair MUST identify a single, unique resource.
+ * (The set of URIs controlled by a server, or multiple servers acting as one, constitute an API.)
+ */
+export interface ApiResourceIdentifierObject {
+    /**
+     * The id member is not required when the resource object originates at the client and represents a new resource to be created on the server.
+     */
+    id: string;
+    /**
+     * The type member is used to describe resource objects that share common attributes and relationships.
+     * The values of type members MUST adhere to the same constraints as member names.
+     */
+    type: string;
+}
+//# sourceMappingURL=resourceIdentifier.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"resourceIdentifier.d.ts","sourceRoot":"","sources":["../../../../../src/middleware/standardResponses/jsonApi/resourceIdentifier.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;CACb"}

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

@@ -0,0 +1,44 @@
+/**
+ * Loosely following the JSON API 1.0 formats and conventions
+ * https://jsonapi.org/format/
+ */
+import type { ApiError } from './error.ts';
+import type { ApiLinks } from './links.ts';
+import type { Relationship } from './relationship.ts';
+import type { ApiResourceIdentifierObject } from './resourceIdentifier.ts';
+export interface ApiResourceObject extends ApiResourceIdentifierObject {
+    /**
+     * An attributes object representing some of the resource's data.
+     */
+    attributes?: Record<string, unknown>;
+    /**
+     * A links object containing links related to the resource.
+     */
+    links?: ApiLinks;
+    /**
+     * A meta object containing non-standard meta-information about a resource that can not be represented as an attribute or relationship.
+     */
+    meta?: Record<string, unknown>;
+    /**
+     * A relationships object describing relationships between the resource and other JSON:API resources.
+     */
+    relationships?: Record<string, Relationship>;
+}
+export interface JsonApi {
+    meta?: Record<string, unknown>;
+    version?: '1.0' | '1.1';
+}
+export interface ApiResponseBase {
+    jsonapi?: JsonApi;
+    links?: ApiLinks;
+    meta?: Record<string, unknown>;
+}
+export interface ApiDataResponse<T extends ApiResourceIdentifierObject> extends ApiResponseBase {
+    data: T;
+    included?: ApiResourceObject[];
+}
+export interface ApiErrorResponse extends ApiResponseBase {
+    errors: ApiError[];
+}
+export type ApiResponse<T extends ApiResourceIdentifierObject> = ApiDataResponse<T> | ApiErrorResponse;
+//# sourceMappingURL=response.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,4 @@
+import type { NextFunction, Request, Response } from 'express';
+import type { ExpressError } from '../../Model/index.ts';
+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

@@ -0,0 +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,SAAS,CAAA;AAEhB,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"}

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

@@ -0,0 +1,27 @@
+import type { RequestHandler, Response } from 'express';
+/**
+ * Flags the response to forgo the standard response envelope
+ * and return the raw response body to the client
+ * @param res The response to disable the standard response format on
+ */
+export declare const setRawResponseFormat: (res: Response) => void;
+/**
+ * Clears any flags on the response, allowing the response to
+ * use the default standard response envelope
+ * @param res The response to set to the standard response format
+ */
+export declare const clearRawResponseFormat: (res: Response) => void;
+/**
+ * Checks if there are any flags on the response that would cause it
+ * to forgo the standard response envelope and return the raw response
+ * body to the client
+ * @param res
+ * @returns True if there are any flags on the response, false otherwise
+ */
+export declare const isRawResponseFormatSet: (res: Response) => boolean;
+/**
+ * Connect middleware to enable the transform of all responses to match
+ * the standard response format (compatible with JSON API)
+ */
+export declare const standardResponses: RequestHandler;
+//# sourceMappingURL=standardResponses.d.ts.map

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

@@ -0,0 +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,SAAS,CAAA;AAShB;;;;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": "4.13.14",
+  "version": "4.13.16",
   "description": "SDK for base code for Api repos that use express and deploy on AWS ECS",
   "keywords": [
     "xylabs",
@@ -47,9 +47,9 @@
   "dependencies": {
     "@types/connect": "^3.4.38",
     "@types/express-serve-static-core": "^5.0.7",
-    "@xylabs/assert": "^4.13.14",
-    "@xylabs/logger": "^4.13.14",
-    "@xylabs/typeof": "^4.13.14",
+    "@xylabs/assert": "^4.13.16",
+    "@xylabs/logger": "^4.13.16",
+    "@xylabs/typeof": "^4.13.16",
     "body-parser": "^2.2.0",
     "express-mung": "^0.5.1",
     "http-status-codes": "^2.3.0",
@@ -61,10 +61,10 @@
     "@types/body-parser": "^1.19.6",
     "@types/express": "^5.0.3",
     "@types/express-mung": "^0.5.5",
-    "@types/node": "^24.0.13",
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.12",
-    "@xylabs/tsconfig": "^7.0.0-rc.12",
-    "@xylabs/vitest-extended": "^4.13.14",
+    "@types/node": "^24.0.14",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
+    "@xylabs/tsconfig": "^7.0.0-rc.27",
+    "@xylabs/vitest-extended": "^4.13.16",
     "body-parser": "^2.2.0",
     "express": "^5.1.0",
     "express-mung": "^0.5.1",