@web-ts-toolkit/express-response-handler 0.30.0 → 0.31.1

package/create-handler.mjs

@@ -1,29 +1,327 @@
+// src/create-handler.ts
 import assert from "assert";
-import { isArray, isFunction, isPromise } from "@web-ts-toolkit/utils";
-import { CSVResponse } from "./responses/csv";
-import { Response } from "./responses";
-import { HttpResponse } from "./http-response";
+import { isArray as isArray2, isFunction, isPromise } from "@web-ts-toolkit/utils";
+
+// src/responses/csv.ts
+import { format } from "@fast-csv/format";
+import { castArray, isBoolean, isPlainObject } from "@web-ts-toolkit/utils";
+var csvResponseBrand = /* @__PURE__ */ Symbol.for("@web-ts-toolkit/express-response-handler.csv-response");
+var isCSVResponse = (value) => {
+  if (value instanceof CSVResponse) {
+    return true;
+  }
+  if (typeof value !== "object" || value === null) {
+    return false;
+  }
+  const candidate = value;
+  return candidate[csvResponseBrand] === true && typeof candidate.streamCsv === "function";
+};
+var _a;
+_a = csvResponseBrand;
+var CSVResponse = class {
+  constructor(dataset = [], options = {}) {
+    this[_a] = true;
+    this.dataset = castArray(dataset);
+    this.filename = options.filename || "download.csv";
+    this.processor = options.processor || ((value) => value);
+    if (isBoolean(options.headers)) {
+      this.headers = options.headers;
+    } else if (this.dataset.length > 0) {
+      this.headers = isPlainObject(this.dataset[0]);
+    }
+  }
+  streamCsv(res) {
+    const stream = format({ headers: this.headers });
+    res.set("Content-Type", "text/csv");
+    res.set("Content-Disposition", `attachment;filename=${this.filename}`);
+    stream.pipe(res);
+    stream.on("error", (error) => {
+      if (res.destroy) {
+        res.destroy(error);
+        return;
+      }
+      res.end();
+    });
+    stream.on("end", () => res.end());
+    this.dataset.forEach((value) => stream.write(this.processor(value)));
+    stream.end();
+  }
+};
+
+// src/responses/index.ts
+var responseBrand = /* @__PURE__ */ Symbol.for("@web-ts-toolkit/express-response-handler.response");
+var isResponse = (value) => {
+  if (value instanceof Response) {
+    return true;
+  }
+  if (typeof value !== "object" || value === null) {
+    return false;
+  }
+  const candidate = value;
+  return candidate[responseBrand] === true && typeof candidate.statusCode === "number" && "data" in candidate;
+};
+var _a2;
+_a2 = responseBrand;
+var Response = class {
+  constructor(statusCode = 200, data) {
+    this[_a2] = true;
+    this.statusCode = statusCode;
+    this.data = data;
+  }
+};
+
+// src/responses/success.ts
+var OK = class extends Response {
+  constructor(data) {
+    super(200, data);
+  }
+};
+var Created = class extends Response {
+  constructor(data) {
+    super(201, data);
+  }
+};
+var Accepted = class extends Response {
+  constructor(data) {
+    super(202, data);
+  }
+};
+var NonAuthoritativeInfo = class extends Response {
+  constructor(data) {
+    super(203, data);
+  }
+};
+var NoContent = class extends Response {
+  constructor() {
+    super(204, void 0);
+  }
+};
+var ResetContent = class extends Response {
+  constructor(data) {
+    super(205, data);
+  }
+};
+var PartialContent = class extends Response {
+  constructor(data) {
+    super(206, data);
+  }
+};
+var MultiStatus = class extends Response {
+  constructor(data) {
+    super(207, data);
+  }
+};
+var AlreadyReported = class extends Response {
+  constructor(data) {
+    super(208, data);
+  }
+};
+var IMUsed = class extends Response {
+  constructor(data) {
+    super(226, data);
+  }
+};
+
+// src/http-response.ts
+import {
+  BadRequestError,
+  ConflictError,
+  ExpectationFailedError,
+  FailedDependencyError,
+  ForbiddenError,
+  GoneError,
+  LengthRequiredError,
+  LockedError,
+  MethodNotAllowedError,
+  MisdirectedRequestError,
+  NotAcceptableError,
+  NotFoundError,
+  PayloadTooLargeError,
+  PreconditionFailedError,
+  PreconditionRequiredError,
+  ProxyAuthRequiredError,
+  RequestHeaderFieldsTooLargeError,
+  RequestedRangeNotSatisfiableError,
+  RequestTimeoutError,
+  TeapotError,
+  TooManyRequestsError,
+  UnauthorizedError,
+  UnavailableForLegalReasonsError,
+  UnprocessableEntityError,
+  UnsupportedMediaTypeError,
+  UpgradeRequiredError,
+  UriTooLongError
+} from "@web-ts-toolkit/http-errors";
+var HttpResponse = {
+  ok: (...args) => new OK(...args),
+  created: (...args) => new Created(...args),
+  accepted: (...args) => new Accepted(...args),
+  nonAuthoritativeInfo: (...args) => new NonAuthoritativeInfo(...args),
+  noContent: (...args) => new NoContent(...args),
+  resetContent: (...args) => new ResetContent(...args),
+  partialContent: (...args) => new PartialContent(...args),
+  multiStatus: (...args) => new MultiStatus(...args),
+  alreadyReported: (...args) => new AlreadyReported(...args),
+  imUsed: (...args) => new IMUsed(...args),
+  badRequest: (...args) => new BadRequestError(...args),
+  unauthorized: (...args) => new UnauthorizedError(...args),
+  forbidden: (...args) => new ForbiddenError(...args),
+  notFound: (...args) => new NotFoundError(...args),
+  methodNotAllowed: (...args) => new MethodNotAllowedError(...args),
+  notAcceptable: (...args) => new NotAcceptableError(...args),
+  proxyAuthRequired: (...args) => new ProxyAuthRequiredError(...args),
+  requestTimeout: (...args) => new RequestTimeoutError(...args),
+  conflict: (...args) => new ConflictError(...args),
+  gone: (...args) => new GoneError(...args),
+  lengthRequired: (...args) => new LengthRequiredError(...args),
+  preconditionFailed: (...args) => new PreconditionFailedError(...args),
+  payloadTooLarge: (...args) => new PayloadTooLargeError(...args),
+  uriTooLong: (...args) => new UriTooLongError(...args),
+  unsupportedMediaType: (...args) => new UnsupportedMediaTypeError(...args),
+  requestedRangeNotSatisfiable: (...args) => new RequestedRangeNotSatisfiableError(...args),
+  expectationFailed: (...args) => new ExpectationFailedError(...args),
+  teapot: (...args) => new TeapotError(...args),
+  misdirectedRequest: (...args) => new MisdirectedRequestError(...args),
+  unprocessableEntity: (...args) => new UnprocessableEntityError(...args),
+  locked: (...args) => new LockedError(...args),
+  failedDependency: (...args) => new FailedDependencyError(...args),
+  upgradeRequired: (...args) => new UpgradeRequiredError(...args),
+  preconditionRequired: (...args) => new PreconditionRequiredError(...args),
+  tooManyRequests: (...args) => new TooManyRequestsError(...args),
+  requestHeaderFieldsTooLarge: (...args) => new RequestHeaderFieldsTooLargeError(...args),
+  unavailableForLegalReasons: (...args) => new UnavailableForLegalReasonsError(...args),
+  json: (...args) => new OK(...args),
+  csv: (...args) => new CSVResponse(...args)
+};
+
+// src/error-format.ts
 import {
-  defaultErrorMessageProvider,
-  toRfc9457GenericErrorPayload,
-  toRfc9457HttpErrorPayload,
-  toSimpleErrorPayload,
-  toStructuredGenericErrorPayload,
-  toStructuredHttpErrorPayload
-} from "./error-format";
-import { ErrorFormats } from "./error-formats";
-const promisify = (fn) => (value) => Promise.resolve().then(() => fn(value));
-const invokePostHook = (hook, value) => {
+  createAip193ErrorInfoDetail,
+  getCanonicalStatus,
+  toAip193ErrorPayload,
+  toRfc9457ErrorPayload
+} from "@web-ts-toolkit/http-errors";
+import { isArray, isPlainObject as isPlainObject2, isString, toStringRecord } from "@web-ts-toolkit/utils";
+var toStatusCode = (status, code, fallbackStatusCode) => {
+  if (typeof status === "number") {
+    return status;
+  }
+  return typeof code === "number" ? code : fallbackStatusCode;
+};
+var toOptionalString = (value) => typeof value === "string" ? value : void 0;
+var toMetadata = (value) => {
+  return toStringRecord(value);
+};
+var toArray = (value) => {
+  if (value === void 0 || value === null) {
+    return void 0;
+  }
+  return isArray(value) ? value : [value];
+};
+var toHttpErrorShape = (error, fallbackDomain) => ({
+  statusCode: error.statusCode ?? 500,
+  status: error.status,
+  message: error.message ?? "",
+  reason: error.reason,
+  domain: error.domain ?? fallbackDomain,
+  metadata: toMetadata(error.metadata),
+  details: toArray(error.details),
+  errors: error.errors,
+  type: error.type,
+  title: error.title,
+  instance: error.instance
+});
+var toProblemDetailsSource = (result) => {
+  if (isPlainObject2(result) && isPlainObject2(result.error)) {
+    return result.error;
+  }
+  return isPlainObject2(result) ? result : void 0;
+};
+var defaultErrorMessageProvider = function(error) {
+  const errorLike = error;
+  return errorLike.message ?? errorLike._message ?? String(error);
+};
+var toSimpleErrorPayload = (result) => isString(result) ? { message: result } : { ...result };
+var toStructuredHttpErrorPayload = (error, errorDomain) => toAip193ErrorPayload(toHttpErrorShape(error, errorDomain), errorDomain);
+var toRfc9457HttpErrorPayload = (error, errorDomain) => toRfc9457ErrorPayload(toHttpErrorShape(error, errorDomain));
+var toStructuredGenericErrorPayload = (result, errorDomain) => {
+  if (isPlainObject2(result) && isPlainObject2(result.error)) {
+    const error = result.error;
+    const statusCode = typeof error.code === "number" ? error.code : 422;
+    const status = typeof error.status === "string" ? error.status : getCanonicalStatus(statusCode);
+    const message = typeof error.message === "string" ? error.message : "";
+    const details = toArray(error.details);
+    return {
+      error: {
+        code: statusCode,
+        status,
+        message,
+        ...details ? { details } : {}
+      }
+    };
+  }
+  if (isPlainObject2(result)) {
+    const statusCode = typeof result.code === "number" ? result.code : 422;
+    const status = typeof result.status === "string" ? result.status : getCanonicalStatus(statusCode);
+    const message = typeof result.message === "string" ? result.message : "";
+    const details = toArray(result.details) || [createAip193ErrorInfoDetail(status, errorDomain)];
+    return {
+      error: {
+        code: statusCode,
+        status,
+        message,
+        ...details ? { details } : {}
+      }
+    };
+  }
+  return {
+    error: {
+      code: 422,
+      status: getCanonicalStatus(422),
+      message: String(result),
+      details: [createAip193ErrorInfoDetail(getCanonicalStatus(422), errorDomain)]
+    }
+  };
+};
+var toRfc9457GenericErrorPayload = (result) => {
+  const problem = toProblemDetailsSource(result);
+  if (problem) {
+    const statusCode = toStatusCode(problem.status, problem.code, 422);
+    return toRfc9457ErrorPayload({
+      statusCode,
+      message: toOptionalString(problem.detail) ?? toOptionalString(problem.message) ?? "",
+      errors: problem.errors,
+      type: toOptionalString(problem.type),
+      title: toOptionalString(problem.title),
+      instance: toOptionalString(problem.instance)
+    });
+  }
+  return toRfc9457ErrorPayload({
+    statusCode: 422,
+    message: String(result)
+  });
+};
+
+// src/error-formats.ts
+var ErrorFormats = {
+  simple: "simple",
+  aip193: "aip193",
+  rfc9457: "rfc9457"
+};
+
+// src/create-handler.ts
+var promisify = (fn) => (value) => Promise.resolve().then(() => fn(value));
+var invokePostHook = (hook, value) => {
   void hook(value).catch(() => void 0);
 };
-const RFC_9457_CONTENT_TYPE = "application/problem+json";
-const shouldSkipResponse = (res, event) => res.headersSent || event.canceled;
-const sendProblemJson = (res, statusCode, payload, contentType) => {
+var RFC_9457_CONTENT_TYPE = "application/problem+json";
+var shouldSkipResponse = (res, event) => res.headersSent || event.canceled;
+var sendProblemJson = (res, statusCode, payload, contentType) => {
   res.status(statusCode);
   res.set("Content-Type", contentType);
   res.send(payload);
 };
-const sendHttpErrorByFormat = {
+var sendHttpErrorByFormat = {
   [ErrorFormats.simple]: (res, error) => {
     const payload = { message: error.message ?? "" };
     if (error.errors !== void 0) {
@@ -38,7 +336,7 @@ const sendHttpErrorByFormat = {
     sendProblemJson(res, error.statusCode ?? 500, toRfc9457HttpErrorPayload(error, domain), RFC_9457_CONTENT_TYPE);
   }
 };
-const sendGenericErrorByFormat = {
+var sendGenericErrorByFormat = {
   [ErrorFormats.simple]: (res, result) => {
     res.status(422).send(toSimpleErrorPayload(result));
   },
@@ -51,16 +349,16 @@ const sendGenericErrorByFormat = {
     sendProblemJson(res, payload.status ?? 422, payload, RFC_9457_CONTENT_TYPE);
   }
 };
-const assertMiddleware = (fn) => {
+var assertMiddleware = (fn) => {
   assert.ok(isFunction(fn), "middleware handler must be a function");
 };
-const normalizeMiddlewareList = (fns) => {
+var normalizeMiddlewareList = (fns) => {
   assert.ok(fns.length > 0, "at least one middleware handler is required");
   if (fns.length > 1) {
     fns.forEach(assertMiddleware);
     return fns;
   }
-  if (isArray(fns[0])) {
+  if (isArray2(fns[0])) {
     assert.ok(fns[0].length > 0, "at least one middleware handler is required");
     fns[0].forEach(assertMiddleware);
     return fns[0];
@@ -98,11 +396,11 @@ function createHandler(options = {}) {
     if (data === void 0) {
       return;
     }
-    if (data instanceof Response) {
+    if (isResponse(data)) {
       res.status(data.statusCode).json(data.data);
       return;
     }
-    if (data instanceof CSVResponse) {
+    if (isCSVResponse(data)) {
       data.streamCsv(res);
       return;
     }

package/error-format.js

@@ -16,6 +16,8 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/error-format.ts
 var error_format_exports = {};
 __export(error_format_exports, {
   defaultErrorMessageProvider: () => defaultErrorMessageProvider,
@@ -28,23 +30,23 @@ __export(error_format_exports, {
 module.exports = __toCommonJS(error_format_exports);
 var import_http_errors = require("@web-ts-toolkit/http-errors");
 var import_utils = require("@web-ts-toolkit/utils");
-const toStatusCode = (status, code, fallbackStatusCode) => {
+var toStatusCode = (status, code, fallbackStatusCode) => {
   if (typeof status === "number") {
     return status;
   }
   return typeof code === "number" ? code : fallbackStatusCode;
 };
-const toOptionalString = (value) => typeof value === "string" ? value : void 0;
-const toMetadata = (value) => {
+var toOptionalString = (value) => typeof value === "string" ? value : void 0;
+var toMetadata = (value) => {
   return (0, import_utils.toStringRecord)(value);
 };
-const toArray = (value) => {
+var toArray = (value) => {
   if (value === void 0 || value === null) {
     return void 0;
   }
   return (0, import_utils.isArray)(value) ? value : [value];
 };
-const toHttpErrorShape = (error, fallbackDomain) => ({
+var toHttpErrorShape = (error, fallbackDomain) => ({
   statusCode: error.statusCode ?? 500,
   status: error.status,
   message: error.message ?? "",
@@ -57,20 +59,20 @@ const toHttpErrorShape = (error, fallbackDomain) => ({
   title: error.title,
   instance: error.instance
 });
-const toProblemDetailsSource = (result) => {
+var toProblemDetailsSource = (result) => {
   if ((0, import_utils.isPlainObject)(result) && (0, import_utils.isPlainObject)(result.error)) {
     return result.error;
   }
   return (0, import_utils.isPlainObject)(result) ? result : void 0;
 };
-const defaultErrorMessageProvider = function(error) {
+var defaultErrorMessageProvider = function(error) {
   const errorLike = error;
   return errorLike.message ?? errorLike._message ?? String(error);
 };
-const toSimpleErrorPayload = (result) => (0, import_utils.isString)(result) ? { message: result } : { ...result };
-const toStructuredHttpErrorPayload = (error, errorDomain) => (0, import_http_errors.toAip193ErrorPayload)(toHttpErrorShape(error, errorDomain), errorDomain);
-const toRfc9457HttpErrorPayload = (error, errorDomain) => (0, import_http_errors.toRfc9457ErrorPayload)(toHttpErrorShape(error, errorDomain));
-const toStructuredGenericErrorPayload = (result, errorDomain) => {
+var toSimpleErrorPayload = (result) => (0, import_utils.isString)(result) ? { message: result } : { ...result };
+var toStructuredHttpErrorPayload = (error, errorDomain) => (0, import_http_errors.toAip193ErrorPayload)(toHttpErrorShape(error, errorDomain), errorDomain);
+var toRfc9457HttpErrorPayload = (error, errorDomain) => (0, import_http_errors.toRfc9457ErrorPayload)(toHttpErrorShape(error, errorDomain));
+var toStructuredGenericErrorPayload = (result, errorDomain) => {
   if ((0, import_utils.isPlainObject)(result) && (0, import_utils.isPlainObject)(result.error)) {
     const error = result.error;
     const statusCode = typeof error.code === "number" ? error.code : 422;
@@ -109,7 +111,7 @@ const toStructuredGenericErrorPayload = (result, errorDomain) => {
     }
   };
 };
-const toRfc9457GenericErrorPayload = (result) => {
+var toRfc9457GenericErrorPayload = (result) => {
   const problem = toProblemDetailsSource(result);
   if (problem) {
     const statusCode = toStatusCode(problem.status, problem.code, 422);

package/error-format.mjs

@@ -1,3 +1,4 @@
+// src/error-format.ts
 import {
   createAip193ErrorInfoDetail,
   getCanonicalStatus,
@@ -5,23 +6,23 @@ import {
   toRfc9457ErrorPayload
 } from "@web-ts-toolkit/http-errors";
 import { isArray, isPlainObject, isString, toStringRecord } from "@web-ts-toolkit/utils";
-const toStatusCode = (status, code, fallbackStatusCode) => {
+var toStatusCode = (status, code, fallbackStatusCode) => {
   if (typeof status === "number") {
     return status;
   }
   return typeof code === "number" ? code : fallbackStatusCode;
 };
-const toOptionalString = (value) => typeof value === "string" ? value : void 0;
-const toMetadata = (value) => {
+var toOptionalString = (value) => typeof value === "string" ? value : void 0;
+var toMetadata = (value) => {
   return toStringRecord(value);
 };
-const toArray = (value) => {
+var toArray = (value) => {
   if (value === void 0 || value === null) {
     return void 0;
   }
   return isArray(value) ? value : [value];
 };
-const toHttpErrorShape = (error, fallbackDomain) => ({
+var toHttpErrorShape = (error, fallbackDomain) => ({
   statusCode: error.statusCode ?? 500,
   status: error.status,
   message: error.message ?? "",
@@ -34,20 +35,20 @@ const toHttpErrorShape = (error, fallbackDomain) => ({
   title: error.title,
   instance: error.instance
 });
-const toProblemDetailsSource = (result) => {
+var toProblemDetailsSource = (result) => {
   if (isPlainObject(result) && isPlainObject(result.error)) {
     return result.error;
   }
   return isPlainObject(result) ? result : void 0;
 };
-const defaultErrorMessageProvider = function(error) {
+var defaultErrorMessageProvider = function(error) {
   const errorLike = error;
   return errorLike.message ?? errorLike._message ?? String(error);
 };
-const toSimpleErrorPayload = (result) => isString(result) ? { message: result } : { ...result };
-const toStructuredHttpErrorPayload = (error, errorDomain) => toAip193ErrorPayload(toHttpErrorShape(error, errorDomain), errorDomain);
-const toRfc9457HttpErrorPayload = (error, errorDomain) => toRfc9457ErrorPayload(toHttpErrorShape(error, errorDomain));
-const toStructuredGenericErrorPayload = (result, errorDomain) => {
+var toSimpleErrorPayload = (result) => isString(result) ? { message: result } : { ...result };
+var toStructuredHttpErrorPayload = (error, errorDomain) => toAip193ErrorPayload(toHttpErrorShape(error, errorDomain), errorDomain);
+var toRfc9457HttpErrorPayload = (error, errorDomain) => toRfc9457ErrorPayload(toHttpErrorShape(error, errorDomain));
+var toStructuredGenericErrorPayload = (result, errorDomain) => {
   if (isPlainObject(result) && isPlainObject(result.error)) {
     const error = result.error;
     const statusCode = typeof error.code === "number" ? error.code : 422;
@@ -86,7 +87,7 @@ const toStructuredGenericErrorPayload = (result, errorDomain) => {
     }
   };
 };
-const toRfc9457GenericErrorPayload = (result) => {
+var toRfc9457GenericErrorPayload = (result) => {
   const problem = toProblemDetailsSource(result);
   if (problem) {
     const statusCode = toStatusCode(problem.status, problem.code, 422);

package/error-formats.js

@@ -16,12 +16,14 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/error-formats.ts
 var error_formats_exports = {};
 __export(error_formats_exports, {
   ErrorFormats: () => ErrorFormats
 });
 module.exports = __toCommonJS(error_formats_exports);
-const ErrorFormats = {
+var ErrorFormats = {
   simple: "simple",
   aip193: "aip193",
   rfc9457: "rfc9457"

package/error-formats.mjs

@@ -1,4 +1,5 @@
-const ErrorFormats = {
+// src/error-formats.ts
+var ErrorFormats = {
   simple: "simple",
   aip193: "aip193",
   rfc9457: "rfc9457"