@xylabs/express 4.3.14

package/dist/node/middleware/metrics/responseProfiler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"responseProfiler.d.ts","sourceRoot":"","sources":["../../../../src/middleware/metrics/responseProfiler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EAAE,OAAO,EAAE,QAAQ,EAChC,MAAM,SAAS,CAAA;AAEhB;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,gBAAgB,SAAU,OAAO,OAAO,QAAQ,QAAQ,YAAY,SAMhF,CAAA"}

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

@@ -0,0 +1,3 @@
+import type { Response } from 'express';
+export declare const getResponseMetadata: (res: Response) => Record<string, unknown>;
+//# sourceMappingURL=getResponseMetadata.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getResponseMetadata.d.ts","sourceRoot":"","sources":["../../../../src/middleware/standardResponses/getResponseMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAEvC,eAAO,MAAM,mBAAmB,QAAS,QAAQ,KAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAezE,CAAA"}

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

@@ -0,0 +1,5 @@
+export * from './getResponseMetadata.ts';
+export * from './jsonApi/index.ts';
+export * from './standardErrors.ts';
+export * from './standardResponses.ts';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/middleware/standardResponses/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAA;AACxC,cAAc,oBAAoB,CAAA;AAClC,cAAc,qBAAqB,CAAA;AACnC,cAAc,wBAAwB,CAAA"}

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

@@ -0,0 +1,51 @@
+import type { ApiLinks } from './links.ts';
+/**
+ * An object containing references to the source of the error
+ */
+export interface Source {
+    /**
+     * A string indicating which URI query parameter caused the error.
+     */
+    parameter?: string;
+    /**
+     * A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object,
+     * or "/data/attributes/title" for a specific attribute].
+     */
+    pointer?: string;
+}
+export interface ApiError {
+    /**
+     *  An application-specific error code, expressed as a string value.
+     */
+    code?: string;
+    /**
+     *  A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized.
+     */
+    detail?: string;
+    /**
+     *  A unique identifier for this particular occurrence of the problem.
+     */
+    id?: string;
+    /**
+     *  A links object containing the following members:
+     *    about: a link that leads to further details about this particular occurrence of the problem
+     */
+    links?: ApiLinks;
+    /**
+     *  A meta object containing non-standard meta-information about the error.
+     */
+    meta?: Record<string, unknown>;
+    /**
+     *  An object containing references to the source of the error, optionally including any of the following members:
+     */
+    source?: Source;
+    /**
+     *  The HTTP status code applicable to this problem, expressed as a string value.
+     */
+    status?: string;
+    /**
+     *  A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
+     */
+    title?: string;
+}
+//# sourceMappingURL=error.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../../../../src/middleware/standardResponses/jsonApi/error.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAE1C;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IACX;;;OAGG;IACH,KAAK,CAAC,EAAE,QAAQ,CAAA;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf"}

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

@@ -0,0 +1,6 @@
+export * from './error.ts';
+export * from './links.ts';
+export * from './relationship.ts';
+export * from './resourceIdentifier.ts';
+export * from './response.ts';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/middleware/standardResponses/jsonApi/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,yBAAyB,CAAA;AACvC,cAAc,eAAe,CAAA"}

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

@@ -0,0 +1,7 @@
+export interface HrefWithMeta {
+    href: string;
+    meta: Record<string, unknown>;
+}
+export type ApiLink = string | HrefWithMeta;
+export type ApiLinks = Record<string, ApiLink>;
+//# sourceMappingURL=links.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"links.d.ts","sourceRoot":"","sources":["../../../../../src/middleware/standardResponses/jsonApi/links.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC9B;AACD,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG,YAAY,CAAA;AAC3C,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA"}

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, 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":"AAAA,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,QAAS,YAAY,OAAO,OAAO,OAAO,QAAQ,QAAQ,YAAY,SAiBhG,CAAA"}

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

@@ -0,0 +1,18 @@
+import type { Request, Response } from 'express';
+/**
+ * Transforms each response to conform to the standard response format (compatible with JSON API)
+ * @param body The original request body
+ * @param _req The request
+ * @param res The response
+ * @returns The transformed response body
+ */
+export declare const transformResponse: (body: unknown, _req: Request, res: Response) => {
+    data: unknown;
+    meta: Record<string, unknown>;
+};
+/**
+ * Connect middleware to enable the transform of all responses to match
+ * the standard response format (compatible with JSON API)
+ */
+export declare const standardResponses: import(".store/@types-express-npm-5.0.0-a645691cd5/package").RequestHandler<import(".store/@types-express-serve-static-core-npm-5.0.1-32d5354816/package").ParamsDictionary, any, any, import(".store/@types-qs-npm-6.9.17-f0eceee63c/package").ParsedQs, Record<string, any>>;
+//# 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,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAKhD;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,SAAU,OAAO,QAAQ,OAAO,OAAO,QAAQ;;;CAG5E,CAAA;AAED;;;GAGG;AAEH,eAAO,MAAM,iBAAiB,gRAAqD,CAAA"}

package/package.json

@@ -0,0 +1,101 @@
+{
+  "name": "@xylabs/express",
+  "version": "4.3.14",
+  "description": "SDK for base code for Api repos that use express and deploy on AWS ECS",
+  "keywords": [
+    "xylabs",
+    "typescript",
+    "esm",
+    "aws",
+    "ecs",
+    "api",
+    "express"
+  ],
+  "homepage": "https://xylabs.com",
+  "bugs": {
+    "url": "https://github.com/xylabs/sdk-api-express-ecs-js/issues",
+    "email": "support@xylabs.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/xylabs/sdk-api-express-ecs-js.git"
+  },
+  "license": "LGPL-3.0",
+  "author": {
+    "name": "XY Labs Development Team",
+    "email": "support@xylabs.com",
+    "url": "https://xylabs.com"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "node": {
+        "types": "./dist/node/index.d.ts",
+        "default": "./dist/node/index.mjs"
+      }
+    },
+    "./package.json": "./package.json",
+    "./README.md": "./README.md"
+  },
+  "main": "dist/node/index.mjs",
+  "module": "dist/node/index.mjs",
+  "types": "dist/node/index.d.ts",
+  "scripts": {
+    "coverage": "jest --coverage",
+    "package-compile": "tsup && publint",
+    "package-recompile": "tsup && publint"
+  },
+  "resolutions": {
+    "eslint": "9.14.0",
+    "uuid": "^8"
+  },
+  "dependencies": {
+    "@aws-sdk/client-secrets-manager": "^3.693.0",
+    "@xylabs/assert": "^4.3.14",
+    "body-parser": "^1.20.3",
+    "connect": "^3.7.0",
+    "express-mung": "^0.5.1",
+    "http-status-codes": "^2.3.0",
+    "node-cache": "^5.1.2",
+    "rollbar": "^2.26.4",
+    "winston": "^3.17.0",
+    "winston-transport": "^4.9.0"
+  },
+  "devDependencies": {
+    "@types/body-parser": "^1.19.5",
+    "@types/connect": "^3.4.38",
+    "@types/express": "^4.17.21",
+    "@types/express-mung": "^0.5.5",
+    "@types/express-serve-static-core": "^4.19.6",
+    "@types/node": "^22.9.0",
+    "@xylabs/ts-scripts-yarn3": "^4.2.4",
+    "@xylabs/tsconfig": "^4.2.4",
+    "@xylabs/tsconfig-jest": "^4.1.0",
+    "@xylabs/vitest-extended": "^4.3.14",
+    "body-parser": "^1.20.3",
+    "express": "^4.21.1",
+    "express-mung": "^0.5.1",
+    "http-status-codes": "^2.3.0",
+    "node-cache": "^5.1.2",
+    "publint": "^0.2.12",
+    "rollbar": "^2.26.4",
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.5",
+    "vitest-mock-extended": "^2.0.2",
+    "winston": "^3.17.0",
+    "winston-transport": "^4.9.0"
+  },
+  "peerDependencies": {
+    "express": "^4"
+  },
+  "packageManager": "yarn@4.5.1",
+  "volta": {
+    "node": "18.19.0",
+    "yarn": "1.22.19"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "docs": "dist/docs.json"
+}

package/src/AWS/getEnvFromAws.ts

@@ -0,0 +1,24 @@
+import { SecretsManager } from '@aws-sdk/client-secrets-manager'
+import NodeCache from 'node-cache'
+
+const region = 'us-east-1'
+const envCache = new NodeCache({ stdTTL: 3600 * 24 })
+
+export const getEnvFromAws = async (secretId: string) => {
+  const cacheResult = envCache.get<Record<string, string>>(secretId)
+  if (cacheResult) {
+    return cacheResult
+  } else {
+    const client = new SecretsManager({ region })
+    const awsResult = await client.getSecretValue({ SecretId: secretId })
+    console.log(`ENV read from AWS Success [${awsResult?.Name}, ${!!awsResult?.SecretString}, ${!!awsResult?.SecretBinary}]`)
+    if (awsResult?.SecretString) {
+      const secretObject = JSON.parse(awsResult?.SecretString) as Record<string, string>
+      console.log(`ENV read from AWS [${Object.entries(secretObject).length}]`)
+      envCache.set(secretId, secretObject)
+      return secretObject
+    } else {
+      throw new Error('Missing SecretString')
+    }
+  }
+}

package/src/AWS/index.ts

@@ -0,0 +1 @@
+export * from './getEnvFromAws.ts'

package/src/AWS/spec/getEnvFromAws.spec.ts

@@ -0,0 +1,16 @@
+import '@xylabs/vitest-extended'
+
+import {
+  describe, expect, it,
+} from 'vitest'
+
+import { getEnvFromAws } from '../getEnvFromAws.ts'
+
+const nonExistentSecret = 'does-not-exist'
+const errorMessage = "Secrets Manager can't find the specified secret."
+
+describe('getEnvFromAws', () => {
+  it('gets the ENV from AWS', async () => {
+    await expect(async () => await getEnvFromAws(nonExistentSecret)).rejects.toThrow(errorMessage)
+  })
+})

package/src/Handler/StatusCodeHandlers/index.ts

@@ -0,0 +1 @@
+export * from './notImplemented.ts'

package/src/Handler/StatusCodeHandlers/notImplemented.ts

@@ -0,0 +1,6 @@
+import type { RequestHandler } from 'express'
+import { ReasonPhrases, StatusCodes } from 'http-status-codes'
+
+export const notImplemented: RequestHandler = (_req, _res, next) => {
+  next({ message: ReasonPhrases.NOT_IMPLEMENTED, statusCode: StatusCodes.NOT_IMPLEMENTED })
+}

package/src/Handler/asyncHandler.ts

@@ -0,0 +1,21 @@
+import type {
+  NextFunction, Request, RequestHandler, Response,
+} from 'express'
+import type { ParamsDictionary, Query } from 'express-serve-static-core'
+
+export function asyncHandler<P = NoReqParams, ResBody = NoResBody, ReqBody = NoReqBody, ReqQuery = NoReqQuery, Locals extends NoLocals = NoLocals>(
+  fn: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals>,
+) {
+  return (req: Request<P, ResBody, ReqBody, ReqQuery, Locals>, res: Response<ResBody, Locals>, next: NextFunction) => {
+    return Promise.resolve(fn(req, res, next)).catch(next)
+  }
+}
+
+export interface Empty {}
+
+export type NoReqParams = ParamsDictionary
+export type NoResBody = Empty
+export type NoReqBody = Empty
+export type NoReqQuery = Query
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type NoLocals = Record<string, any>

package/src/Handler/errorToJsonHandler.ts

@@ -0,0 +1,14 @@
+import type {
+  NextFunction, Request, Response,
+} from 'express'
+
+import type { ExpressError } from '../Model/index.ts'
+
+export const errorToJsonHandler = (error: ExpressError, req: Request, res: Response, next: NextFunction) => {
+  if (error) {
+    console.error(error.message)
+    if (!error.statusCode) error.statusCode = 500
+    res.status(error.statusCode).send({ error: error.message })
+  }
+  next(error)
+}

package/src/Handler/index.ts

@@ -0,0 +1,3 @@
+export * from './asyncHandler.ts'
+export * from './errorToJsonHandler.ts'
+export * from './StatusCodeHandlers/index.ts'

package/src/HttpUtil/getHttpHeader.ts

@@ -0,0 +1,26 @@
+import type { Request } from 'express-serve-static-core'
+
+/**
+ * Since there can be multiple of certain HTTP headers or
+ * to prevent ugliness if someone did send us multiple
+ * instances of a header we only expect one of, this
+ * method grabs the 1st/only one of the desired header
+ * @param header The header to find
+ * @param req The received HTTP request (with headers)
+ * @returns The first or only occurrence of the specified HTTP header
+ */
+export const getHttpHeader = (header: string, req: Request): string | undefined => {
+  const headerValue = req.headers[header]
+  const value
+    // If the header exists
+    = headerValue
+      // If there's multiple of the same header
+      ? Array.isArray(headerValue)
+        // Grab the first one
+        ? (headerValue as string[]).shift()
+        // Otherwise grab the only one
+        : (headerValue as string)
+      // Otherwise undefined
+      : undefined
+  return value
+}

package/src/HttpUtil/index.ts

@@ -0,0 +1 @@
+export * from './getHttpHeader.ts'

package/src/Logger/LogFormats/LocalDev/index.ts

@@ -0,0 +1 @@
+export * from './logFormatLocalDev.ts'

package/src/Logger/LogFormats/LocalDev/logFormatLocalDev.ts

@@ -0,0 +1,11 @@
+import { format } from 'winston'
+
+const {
+  colorize, combine, timestamp, printf,
+} = format
+
+export const logFormatLocalDev = combine(
+  colorize(),
+  timestamp(),
+  printf(info => `[${info.timestamp} ${info.level}] ${info.message}`),
+)

package/src/Logger/LogFormats/LocalDev/spec/logFormatLocalDev.spec.ts

@@ -0,0 +1,13 @@
+import '@xylabs/vitest-extended'
+
+import {
+  describe, expect, it,
+} from 'vitest'
+
+import { logFormatLocalDev } from '../logFormatLocalDev.ts'
+
+describe('logFormatLocalDev', () => {
+  it('provides a logger format', () => {
+    expect(logFormatLocalDev).toBeObject()
+  })
+})

package/src/Logger/LogFormats/Rollbar/index.ts

@@ -0,0 +1 @@
+export * from './logFormatRollbar.ts'

package/src/Logger/LogFormats/Rollbar/logFormatRollbar.ts

@@ -0,0 +1,5 @@
+import { format } from 'winston'
+
+const { simple } = format
+
+export const logFormatRollbar = simple()

package/src/Logger/LogFormats/Rollbar/spec/logFormatRollbar.spec.ts

@@ -0,0 +1,13 @@
+import '@xylabs/vitest-extended'
+
+import {
+  describe, expect, it,
+} from 'vitest'
+
+import { logFormatRollbar } from '../logFormatRollbar.ts'
+
+describe('logFormatRollbar', () => {
+  it('provides a logger format', () => {
+    expect(logFormatRollbar).toBeObject()
+  })
+})

package/src/Logger/LogFormats/Structured/index.ts

@@ -0,0 +1 @@
+export * from './logFormatStructured.ts'

package/src/Logger/LogFormats/Structured/logFormatStructured.ts

@@ -0,0 +1,7 @@
+import { format } from 'winston'
+
+const {
+  combine, timestamp, json,
+} = format
+
+export const logFormatStructured = combine(timestamp(), json())

package/src/Logger/LogFormats/Structured/spec/logFormatStructured.spec.ts

@@ -0,0 +1,13 @@
+import '@xylabs/vitest-extended'
+
+import {
+  describe, expect, it,
+} from 'vitest'
+
+import { logFormatStructured } from '../logFormatStructured.ts'
+
+describe('logFormatStructured', () => {
+  it('provides a logger format', () => {
+    expect(logFormatStructured).toBeObject()
+  })
+})

package/src/Logger/LogFormats/index.ts

@@ -0,0 +1,3 @@
+export * from './LocalDev/index.ts'
+export * from './Rollbar/index.ts'
+export * from './Structured/index.ts'

package/src/Logger/Logger.ts

@@ -0,0 +1,15 @@
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type LogFunction = (message?: any) => void
+
+/**
+ * Interface to handle overlap between Winston &
+ * `console` with as much congruency as possible.
+ */
+export interface Logger {
+  debug: LogFunction
+  error: LogFunction
+  info: LogFunction
+  log: LogFunction
+  // trace: LogFunction
+  warn: LogFunction
+}

package/src/Logger/LoggerMeta.ts

@@ -0,0 +1 @@
+export type LoggerMeta = Record<string, string | number>

package/src/Logger/LoggerOptions.ts

@@ -0,0 +1,7 @@
+import type { LoggerMeta } from './LoggerMeta.ts'
+import type { LoggerVerbosity } from './LoggerVerbosity.ts'
+
+export interface LoggerOptions {
+  defaultMeta?: LoggerMeta
+  level?: LoggerVerbosity
+}

package/src/Logger/LoggerVerbosity.ts

@@ -0,0 +1 @@
+export type LoggerVerbosity = 'error' | 'warn' | 'info' | 'debug' | 'all'

package/src/Logger/Transports/Rollbar/RollbarTransport.ts

@@ -0,0 +1,22 @@
+import type Rollbar from 'rollbar'
+import type { TransportStreamOptions } from 'winston-transport'
+import Transport from 'winston-transport'
+
+import { logFormatRollbar } from '../../LogFormats'
+
+export class RollbarTransport extends Transport {
+  constructor(
+    opts: TransportStreamOptions,
+    protected readonly rollbar?: Rollbar,
+  ) {
+    super({
+      ...opts, format: logFormatRollbar, level: 'error',
+    })
+  }
+
+  override log(info: { message?: string }, next: () => void) {
+    this.rollbar?.error(info?.message)
+    this.emit('logged', info?.message)
+    next()
+  }
+}

package/src/Logger/Transports/Rollbar/canGetDefaultRollbarTransport.ts

@@ -0,0 +1,3 @@
+export const canGetDefaultRollbarTransport = (env: { [key: string]: string | undefined }): boolean => {
+  return env.ROLLBAR_ACCESS_TOKEN ? true : false
+}