http-response-kit 1.0.0 → 2.0.0

package/dist/schemas.d.ts

@@ -0,0 +1,452 @@
+/**
+ * HTTP Response Kit - JSON Schemas
+ *
+ * Machine-readable JSON Schema (draft 2020-12) definitions of the response
+ * shapes, usable for contract testing, gateway validation, and OpenAPI specs.
+ *
+ * Import from the dedicated subpath to keep your main bundle lean:
+ * `import { errorResponseSchema } from 'http-response-kit/schemas'`
+ *
+ * @module schemas
+ */
+/** JSON Schema for the standard success envelope */
+declare const successResponseSchema: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://github.com/matteo-teodori/http-response-kit/schemas/success-response.json";
+    readonly title: "SuccessResponse";
+    readonly type: "object";
+    readonly required: readonly ["success", "status_code"];
+    readonly properties: {
+        readonly success: {
+            readonly const: true;
+        };
+        readonly status_code: {
+            readonly type: "integer";
+            readonly minimum: 100;
+            readonly maximum: 399;
+        };
+        readonly timestamp: {
+            readonly type: "string";
+            readonly format: "date-time";
+        };
+        readonly request_id: {
+            readonly type: "string";
+        };
+        readonly data: {};
+        readonly message: {
+            readonly type: "string";
+        };
+        readonly metadata: {
+            readonly type: "object";
+        };
+    };
+};
+/** JSON Schema for the standard error envelope */
+declare const errorResponseSchema: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://github.com/matteo-teodori/http-response-kit/schemas/error-response.json";
+    readonly title: "ErrorResponse";
+    readonly type: "object";
+    readonly required: readonly ["success", "status_code", "error"];
+    readonly properties: {
+        readonly success: {
+            readonly const: false;
+        };
+        readonly status_code: {
+            readonly type: "integer";
+            readonly minimum: 400;
+            readonly maximum: 599;
+        };
+        readonly timestamp: {
+            readonly type: "string";
+            readonly format: "date-time";
+        };
+        readonly request_id: {
+            readonly type: "string";
+        };
+        readonly retry_after: {
+            readonly type: "number";
+        };
+        readonly error: {
+            readonly type: "object";
+            readonly required: readonly ["type", "title", "message"];
+            readonly properties: {
+                readonly type: {
+                    readonly type: "string";
+                };
+                readonly title: {
+                    readonly type: "string";
+                };
+                readonly message: {
+                    readonly type: "string";
+                };
+                readonly code: {
+                    readonly type: "string";
+                };
+                readonly details: {
+                    readonly type: "string";
+                };
+                readonly errors: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly required: readonly ["field", "message"];
+                        readonly properties: {
+                            readonly field: {
+                                readonly type: "string";
+                                readonly description: "Field/path that failed validation";
+                            };
+                            readonly message: {
+                                readonly type: "string";
+                                readonly description: "Human-readable description";
+                            };
+                            readonly code: {
+                                readonly type: "string";
+                                readonly description: "Stable machine-readable code";
+                            };
+                        };
+                        readonly additionalProperties: false;
+                    };
+                };
+                readonly stack: {
+                    readonly type: "string";
+                };
+                readonly causes: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+            };
+        };
+        readonly metadata: {
+            readonly type: "object";
+        };
+    };
+};
+/** JSON Schema for RFC 9457 Problem Details (with common extensions) */
+declare const problemDetailsSchema: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://github.com/matteo-teodori/http-response-kit/schemas/problem-details.json";
+    readonly title: "ProblemDetails";
+    readonly description: "RFC 9457 Problem Details for HTTP APIs";
+    readonly type: "object";
+    readonly required: readonly ["type", "title", "status"];
+    readonly properties: {
+        readonly type: {
+            readonly type: "string";
+            readonly format: "uri-reference";
+            readonly default: "about:blank";
+        };
+        readonly title: {
+            readonly type: "string";
+        };
+        readonly status: {
+            readonly type: "integer";
+            readonly minimum: 100;
+            readonly maximum: 599;
+        };
+        readonly detail: {
+            readonly type: "string";
+        };
+        readonly instance: {
+            readonly type: "string";
+            readonly format: "uri-reference";
+        };
+        readonly code: {
+            readonly type: "string";
+        };
+        readonly errors: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "object";
+                readonly required: readonly ["field", "message"];
+                readonly properties: {
+                    readonly field: {
+                        readonly type: "string";
+                        readonly description: "Field/path that failed validation";
+                    };
+                    readonly message: {
+                        readonly type: "string";
+                        readonly description: "Human-readable description";
+                    };
+                    readonly code: {
+                        readonly type: "string";
+                        readonly description: "Stable machine-readable code";
+                    };
+                };
+                readonly additionalProperties: false;
+            };
+        };
+        readonly request_id: {
+            readonly type: "string";
+        };
+    };
+};
+/**
+ * Ready-to-merge OpenAPI 3.1 `components` fragment.
+ *
+ * @example
+ * ```ts
+ * const spec = { openapi: '3.1.0', ...yourSpec, components: { schemas: { ...openApiComponents.schemas } } };
+ * ```
+ */
+declare const openApiComponents: {
+    readonly schemas: {
+        readonly SuccessResponse: {
+            readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+            readonly $id: "https://github.com/matteo-teodori/http-response-kit/schemas/success-response.json";
+            readonly title: "SuccessResponse";
+            readonly type: "object";
+            readonly required: readonly ["success", "status_code"];
+            readonly properties: {
+                readonly success: {
+                    readonly const: true;
+                };
+                readonly status_code: {
+                    readonly type: "integer";
+                    readonly minimum: 100;
+                    readonly maximum: 399;
+                };
+                readonly timestamp: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly request_id: {
+                    readonly type: "string";
+                };
+                readonly data: {};
+                readonly message: {
+                    readonly type: "string";
+                };
+                readonly metadata: {
+                    readonly type: "object";
+                };
+            };
+        };
+        readonly ErrorResponse: {
+            readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+            readonly $id: "https://github.com/matteo-teodori/http-response-kit/schemas/error-response.json";
+            readonly title: "ErrorResponse";
+            readonly type: "object";
+            readonly required: readonly ["success", "status_code", "error"];
+            readonly properties: {
+                readonly success: {
+                    readonly const: false;
+                };
+                readonly status_code: {
+                    readonly type: "integer";
+                    readonly minimum: 400;
+                    readonly maximum: 599;
+                };
+                readonly timestamp: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly request_id: {
+                    readonly type: "string";
+                };
+                readonly retry_after: {
+                    readonly type: "number";
+                };
+                readonly error: {
+                    readonly type: "object";
+                    readonly required: readonly ["type", "title", "message"];
+                    readonly properties: {
+                        readonly type: {
+                            readonly type: "string";
+                        };
+                        readonly title: {
+                            readonly type: "string";
+                        };
+                        readonly message: {
+                            readonly type: "string";
+                        };
+                        readonly code: {
+                            readonly type: "string";
+                        };
+                        readonly details: {
+                            readonly type: "string";
+                        };
+                        readonly errors: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "object";
+                                readonly required: readonly ["field", "message"];
+                                readonly properties: {
+                                    readonly field: {
+                                        readonly type: "string";
+                                        readonly description: "Field/path that failed validation";
+                                    };
+                                    readonly message: {
+                                        readonly type: "string";
+                                        readonly description: "Human-readable description";
+                                    };
+                                    readonly code: {
+                                        readonly type: "string";
+                                        readonly description: "Stable machine-readable code";
+                                    };
+                                };
+                                readonly additionalProperties: false;
+                            };
+                        };
+                        readonly stack: {
+                            readonly type: "string";
+                        };
+                        readonly causes: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "string";
+                            };
+                        };
+                    };
+                };
+                readonly metadata: {
+                    readonly type: "object";
+                };
+            };
+        };
+        readonly ProblemDetails: {
+            readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+            readonly $id: "https://github.com/matteo-teodori/http-response-kit/schemas/problem-details.json";
+            readonly title: "ProblemDetails";
+            readonly description: "RFC 9457 Problem Details for HTTP APIs";
+            readonly type: "object";
+            readonly required: readonly ["type", "title", "status"];
+            readonly properties: {
+                readonly type: {
+                    readonly type: "string";
+                    readonly format: "uri-reference";
+                    readonly default: "about:blank";
+                };
+                readonly title: {
+                    readonly type: "string";
+                };
+                readonly status: {
+                    readonly type: "integer";
+                    readonly minimum: 100;
+                    readonly maximum: 599;
+                };
+                readonly detail: {
+                    readonly type: "string";
+                };
+                readonly instance: {
+                    readonly type: "string";
+                    readonly format: "uri-reference";
+                };
+                readonly code: {
+                    readonly type: "string";
+                };
+                readonly errors: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly required: readonly ["field", "message"];
+                        readonly properties: {
+                            readonly field: {
+                                readonly type: "string";
+                                readonly description: "Field/path that failed validation";
+                            };
+                            readonly message: {
+                                readonly type: "string";
+                                readonly description: "Human-readable description";
+                            };
+                            readonly code: {
+                                readonly type: "string";
+                                readonly description: "Stable machine-readable code";
+                            };
+                        };
+                        readonly additionalProperties: false;
+                    };
+                };
+                readonly request_id: {
+                    readonly type: "string";
+                };
+            };
+        };
+    };
+    readonly responses: {
+        readonly BadRequest: {
+            readonly description: "Bad Request";
+            readonly content: {
+                readonly 'application/json': {
+                    readonly schema: {
+                        readonly $ref: "#/components/schemas/ErrorResponse";
+                    };
+                };
+            };
+        };
+        readonly Unauthorized: {
+            readonly description: "Unauthorized";
+            readonly content: {
+                readonly 'application/json': {
+                    readonly schema: {
+                        readonly $ref: "#/components/schemas/ErrorResponse";
+                    };
+                };
+            };
+        };
+        readonly Forbidden: {
+            readonly description: "Forbidden";
+            readonly content: {
+                readonly 'application/json': {
+                    readonly schema: {
+                        readonly $ref: "#/components/schemas/ErrorResponse";
+                    };
+                };
+            };
+        };
+        readonly NotFound: {
+            readonly description: "Not Found";
+            readonly content: {
+                readonly 'application/json': {
+                    readonly schema: {
+                        readonly $ref: "#/components/schemas/ErrorResponse";
+                    };
+                };
+            };
+        };
+        readonly UnprocessableEntity: {
+            readonly description: "Validation failed";
+            readonly content: {
+                readonly 'application/json': {
+                    readonly schema: {
+                        readonly $ref: "#/components/schemas/ErrorResponse";
+                    };
+                };
+            };
+        };
+        readonly TooManyRequests: {
+            readonly description: "Too Many Requests";
+            readonly content: {
+                readonly 'application/json': {
+                    readonly schema: {
+                        readonly $ref: "#/components/schemas/ErrorResponse";
+                    };
+                };
+            };
+        };
+        readonly InternalServerError: {
+            readonly description: "Internal Server Error";
+            readonly content: {
+                readonly 'application/json': {
+                    readonly schema: {
+                        readonly $ref: "#/components/schemas/ErrorResponse";
+                    };
+                };
+            };
+        };
+        readonly Problem: {
+            readonly description: "RFC 9457 Problem Details";
+            readonly content: {
+                readonly 'application/problem+json': {
+                    readonly schema: {
+                        readonly $ref: "#/components/schemas/ProblemDetails";
+                    };
+                };
+            };
+        };
+    };
+};
+
+export { errorResponseSchema, openApiComponents, problemDetailsSchema, successResponseSchema };

package/dist/schemas.js

@@ -0,0 +1,124 @@
+'use strict';
+
+// src/schemas/index.ts
+var validationIssueSchema = {
+  type: "object",
+  required: ["field", "message"],
+  properties: {
+    field: { type: "string", description: "Field/path that failed validation" },
+    message: { type: "string", description: "Human-readable description" },
+    code: { type: "string", description: "Stable machine-readable code" }
+  },
+  additionalProperties: false
+};
+var successResponseSchema = {
+  $schema: "https://json-schema.org/draft/2020-12/schema",
+  $id: "https://github.com/matteo-teodori/http-response-kit/schemas/success-response.json",
+  title: "SuccessResponse",
+  type: "object",
+  required: ["success", "status_code"],
+  properties: {
+    success: { const: true },
+    status_code: { type: "integer", minimum: 100, maximum: 399 },
+    timestamp: { type: "string", format: "date-time" },
+    request_id: { type: "string" },
+    data: {},
+    message: { type: "string" },
+    metadata: { type: "object" }
+  }
+};
+var errorResponseSchema = {
+  $schema: "https://json-schema.org/draft/2020-12/schema",
+  $id: "https://github.com/matteo-teodori/http-response-kit/schemas/error-response.json",
+  title: "ErrorResponse",
+  type: "object",
+  required: ["success", "status_code", "error"],
+  properties: {
+    success: { const: false },
+    status_code: { type: "integer", minimum: 400, maximum: 599 },
+    timestamp: { type: "string", format: "date-time" },
+    request_id: { type: "string" },
+    retry_after: { type: "number" },
+    error: {
+      type: "object",
+      required: ["type", "title", "message"],
+      properties: {
+        type: { type: "string" },
+        title: { type: "string" },
+        message: { type: "string" },
+        code: { type: "string" },
+        details: { type: "string" },
+        errors: { type: "array", items: validationIssueSchema },
+        stack: { type: "string" },
+        causes: { type: "array", items: { type: "string" } }
+      }
+    },
+    metadata: { type: "object" }
+  }
+};
+var problemDetailsSchema = {
+  $schema: "https://json-schema.org/draft/2020-12/schema",
+  $id: "https://github.com/matteo-teodori/http-response-kit/schemas/problem-details.json",
+  title: "ProblemDetails",
+  description: "RFC 9457 Problem Details for HTTP APIs",
+  type: "object",
+  required: ["type", "title", "status"],
+  properties: {
+    type: { type: "string", format: "uri-reference", default: "about:blank" },
+    title: { type: "string" },
+    status: { type: "integer", minimum: 100, maximum: 599 },
+    detail: { type: "string" },
+    instance: { type: "string", format: "uri-reference" },
+    code: { type: "string" },
+    errors: { type: "array", items: validationIssueSchema },
+    request_id: { type: "string" }
+  }
+};
+var openApiComponents = {
+  schemas: {
+    SuccessResponse: successResponseSchema,
+    ErrorResponse: errorResponseSchema,
+    ProblemDetails: problemDetailsSchema
+  },
+  responses: {
+    BadRequest: {
+      description: "Bad Request",
+      content: { "application/json": { schema: { $ref: "#/components/schemas/ErrorResponse" } } }
+    },
+    Unauthorized: {
+      description: "Unauthorized",
+      content: { "application/json": { schema: { $ref: "#/components/schemas/ErrorResponse" } } }
+    },
+    Forbidden: {
+      description: "Forbidden",
+      content: { "application/json": { schema: { $ref: "#/components/schemas/ErrorResponse" } } }
+    },
+    NotFound: {
+      description: "Not Found",
+      content: { "application/json": { schema: { $ref: "#/components/schemas/ErrorResponse" } } }
+    },
+    UnprocessableEntity: {
+      description: "Validation failed",
+      content: { "application/json": { schema: { $ref: "#/components/schemas/ErrorResponse" } } }
+    },
+    TooManyRequests: {
+      description: "Too Many Requests",
+      content: { "application/json": { schema: { $ref: "#/components/schemas/ErrorResponse" } } }
+    },
+    InternalServerError: {
+      description: "Internal Server Error",
+      content: { "application/json": { schema: { $ref: "#/components/schemas/ErrorResponse" } } }
+    },
+    Problem: {
+      description: "RFC 9457 Problem Details",
+      content: { "application/problem+json": { schema: { $ref: "#/components/schemas/ProblemDetails" } } }
+    }
+  }
+};
+
+exports.errorResponseSchema = errorResponseSchema;
+exports.openApiComponents = openApiComponents;
+exports.problemDetailsSchema = problemDetailsSchema;
+exports.successResponseSchema = successResponseSchema;
+//# sourceMappingURL=schemas.js.map
+//# sourceMappingURL=schemas.js.map

package/dist/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/schemas/index.ts"],"names":[],"mappings":";;;AAYA,IAAM,qBAAA,GAAwB;AAAA,EAC1B,IAAA,EAAM,QAAA;AAAA,EACN,QAAA,EAAU,CAAC,OAAA,EAAS,SAAS,CAAA;AAAA,EAC7B,UAAA,EAAY;AAAA,IACR,KAAA,EAAO,EAAE,IAAA,EAAM,QAAA,EAAU,aAAa,mCAAA,EAAoC;AAAA,IAC1E,OAAA,EAAS,EAAE,IAAA,EAAM,QAAA,EAAU,aAAa,4BAAA,EAA6B;AAAA,IACrE,IAAA,EAAM,EAAE,IAAA,EAAM,QAAA,EAAU,aAAa,8BAAA;AAA+B,GACxE;AAAA,EACA,oBAAA,EAAsB;AAC1B,CAAA;AAGO,IAAM,qBAAA,GAAwB;AAAA,EACjC,OAAA,EAAS,8CAAA;AAAA,EACT,GAAA,EAAK,mFAAA;AAAA,EACL,KAAA,EAAO,iBAAA;AAAA,EACP,IAAA,EAAM,QAAA;AAAA,EACN,QAAA,EAAU,CAAC,SAAA,EAAW,aAAa,CAAA;AAAA,EACnC,UAAA,EAAY;AAAA,IACR,OAAA,EAAS,EAAE,KAAA,EAAO,IAAA,EAAK;AAAA,IACvB,aAAa,EAAE,IAAA,EAAM,WAAW,OAAA,EAAS,GAAA,EAAK,SAAS,GAAA,EAAI;AAAA,IAC3D,SAAA,EAAW,EAAE,IAAA,EAAM,QAAA,EAAU,QAAQ,WAAA,EAAY;AAAA,IACjD,UAAA,EAAY,EAAE,IAAA,EAAM,QAAA,EAAS;AAAA,IAC7B,MAAM,EAAC;AAAA,IACP,OAAA,EAAS,EAAE,IAAA,EAAM,QAAA,EAAS;AAAA,IAC1B,QAAA,EAAU,EAAE,IAAA,EAAM,QAAA;AAAS;AAEnC;AAGO,IAAM,mBAAA,GAAsB;AAAA,EAC/B,OAAA,EAAS,8CAAA;AAAA,EACT,GAAA,EAAK,iFAAA;AAAA,EACL,KAAA,EAAO,eAAA;AAAA,EACP,IAAA,EAAM,QAAA;AAAA,EACN,QAAA,EAAU,CAAC,SAAA,EAAW,aAAA,EAAe,OAAO,CAAA;AAAA,EAC5C,UAAA,EAAY;AAAA,IACR,OAAA,EAAS,EAAE,KAAA,EAAO,KAAA,EAAM;AAAA,IACxB,aAAa,EAAE,IAAA,EAAM,WAAW,OAAA,EAAS,GAAA,EAAK,SAAS,GAAA,EAAI;AAAA,IAC3D,SAAA,EAAW,EAAE,IAAA,EAAM,QAAA,EAAU,QAAQ,WAAA,EAAY;AAAA,IACjD,UAAA,EAAY,EAAE,IAAA,EAAM,QAAA,EAAS;AAAA,IAC7B,WAAA,EAAa,EAAE,IAAA,EAAM,QAAA,EAAS;AAAA,IAC9B,KAAA,EAAO;AAAA,MACH,IAAA,EAAM,QAAA;AAAA,MACN,QAAA,EAAU,CAAC,MAAA,EAAQ,OAAA,EAAS,SAAS,CAAA;AAAA,MACrC,UAAA,EAAY;AAAA,QACR,IAAA,EAAM,EAAE,IAAA,EAAM,QAAA,EAAS;AAAA,QACvB,KAAA,EAAO,EAAE,IAAA,EAAM,QAAA,EAAS;AAAA,QACxB,OAAA,EAAS,EAAE,IAAA,EAAM,QAAA,EAAS;AAAA,QAC1B,IAAA,EAAM,EAAE,IAAA,EAAM,QAAA,EAAS;AAAA,QACvB,OAAA,EAAS,EAAE,IAAA,EAAM,QAAA,EAAS;AAAA,QAC1B,MAAA,EAAQ,EAAE,IAAA,EAAM,OAAA,EAAS,OAAO,qBAAA,EAAsB;AAAA,QACtD,KAAA,EAAO,EAAE,IAAA,EAAM,QAAA,EAAS;AAAA,QACxB,MAAA,EAAQ,EAAE,IAAA,EAAM,OAAA,EAAS,OAAO,EAAE,IAAA,EAAM,UAAS;AAAE;AACvD,KACJ;AAAA,IACA,QAAA,EAAU,EAAE,IAAA,EAAM,QAAA;AAAS;AAEnC;AAGO,IAAM,oBAAA,GAAuB;AAAA,EAChC,OAAA,EAAS,8CAAA;AAAA,EACT,GAAA,EAAK,kFAAA;AAAA,EACL,KAAA,EAAO,gBAAA;AAAA,EACP,WAAA,EAAa,wCAAA;AAAA,EACb,IAAA,EAAM,QAAA;AAAA,EACN,QAAA,EAAU,CAAC,MAAA,EAAQ,OAAA,EAAS,QAAQ,CAAA;AAAA,EACpC,UAAA,EAAY;AAAA,IACR,MAAM,EAAE,IAAA,EAAM,UAAU,MAAA,EAAQ,eAAA,EAAiB,SAAS,aAAA,EAAc;AAAA,IACxE,KAAA,EAAO,EAAE,IAAA,EAAM,QAAA,EAAS;AAAA,IACxB,QAAQ,EAAE,IAAA,EAAM,WAAW,OAAA,EAAS,GAAA,EAAK,SAAS,GAAA,EAAI;AAAA,IACtD,MAAA,EAAQ,EAAE,IAAA,EAAM,QAAA,EAAS;AAAA,IACzB,QAAA,EAAU,EAAE,IAAA,EAAM,QAAA,EAAU,QAAQ,eAAA,EAAgB;AAAA,IACpD,IAAA,EAAM,EAAE,IAAA,EAAM,QAAA,EAAS;AAAA,IACvB,MAAA,EAAQ,EAAE,IAAA,EAAM,OAAA,EAAS,OAAO,qBAAA,EAAsB;AAAA,IACtD,UAAA,EAAY,EAAE,IAAA,EAAM,QAAA;AAAS;AAErC;AAUO,IAAM,iBAAA,GAAoB;AAAA,EAC7B,OAAA,EAAS;AAAA,IACL,eAAA,EAAiB,qBAAA;AAAA,IACjB,aAAA,EAAe,mBAAA;AAAA,IACf,cAAA,EAAgB;AAAA,GACpB;AAAA,EACA,SAAA,EAAW;AAAA,IACP,UAAA,EAAY;AAAA,MACR,WAAA,EAAa,aAAA;AAAA,MACb,OAAA,EAAS,EAAE,kBAAA,EAAoB,EAAE,QAAQ,EAAE,IAAA,EAAM,oCAAA,EAAqC,EAAE;AAAE,KAC9F;AAAA,IACA,YAAA,EAAc;AAAA,MACV,WAAA,EAAa,cAAA;AAAA,MACb,OAAA,EAAS,EAAE,kBAAA,EAAoB,EAAE,QAAQ,EAAE,IAAA,EAAM,oCAAA,EAAqC,EAAE;AAAE,KAC9F;AAAA,IACA,SAAA,EAAW;AAAA,MACP,WAAA,EAAa,WAAA;AAAA,MACb,OAAA,EAAS,EAAE,kBAAA,EAAoB,EAAE,QAAQ,EAAE,IAAA,EAAM,oCAAA,EAAqC,EAAE;AAAE,KAC9F;AAAA,IACA,QAAA,EAAU;AAAA,MACN,WAAA,EAAa,WAAA;AAAA,MACb,OAAA,EAAS,EAAE,kBAAA,EAAoB,EAAE,QAAQ,EAAE,IAAA,EAAM,oCAAA,EAAqC,EAAE;AAAE,KAC9F;AAAA,IACA,mBAAA,EAAqB;AAAA,MACjB,WAAA,EAAa,mBAAA;AAAA,MACb,OAAA,EAAS,EAAE,kBAAA,EAAoB,EAAE,QAAQ,EAAE,IAAA,EAAM,oCAAA,EAAqC,EAAE;AAAE,KAC9F;AAAA,IACA,eAAA,EAAiB;AAAA,MACb,WAAA,EAAa,mBAAA;AAAA,MACb,OAAA,EAAS,EAAE,kBAAA,EAAoB,EAAE,QAAQ,EAAE,IAAA,EAAM,oCAAA,EAAqC,EAAE;AAAE,KAC9F;AAAA,IACA,mBAAA,EAAqB;AAAA,MACjB,WAAA,EAAa,uBAAA;AAAA,MACb,OAAA,EAAS,EAAE,kBAAA,EAAoB,EAAE,QAAQ,EAAE,IAAA,EAAM,oCAAA,EAAqC,EAAE;AAAE,KAC9F;AAAA,IACA,OAAA,EAAS;AAAA,MACL,WAAA,EAAa,0BAAA;AAAA,MACb,OAAA,EAAS,EAAE,0BAAA,EAA4B,EAAE,QAAQ,EAAE,IAAA,EAAM,qCAAA,EAAsC,EAAE;AAAE;AACvG;AAER","file":"schemas.js","sourcesContent":["/**\n * HTTP Response Kit - JSON Schemas\n *\n * Machine-readable JSON Schema (draft 2020-12) definitions of the response\n * shapes, usable for contract testing, gateway validation, and OpenAPI specs.\n *\n * Import from the dedicated subpath to keep your main bundle lean:\n * `import { errorResponseSchema } from 'http-response-kit/schemas'`\n *\n * @module schemas\n */\n\nconst validationIssueSchema = {\n    type: 'object',\n    required: ['field', 'message'],\n    properties: {\n        field: { type: 'string', description: 'Field/path that failed validation' },\n        message: { type: 'string', description: 'Human-readable description' },\n        code: { type: 'string', description: 'Stable machine-readable code' },\n    },\n    additionalProperties: false,\n} as const;\n\n/** JSON Schema for the standard success envelope */\nexport const successResponseSchema = {\n    $schema: 'https://json-schema.org/draft/2020-12/schema',\n    $id: 'https://github.com/matteo-teodori/http-response-kit/schemas/success-response.json',\n    title: 'SuccessResponse',\n    type: 'object',\n    required: ['success', 'status_code'],\n    properties: {\n        success: { const: true },\n        status_code: { type: 'integer', minimum: 100, maximum: 399 },\n        timestamp: { type: 'string', format: 'date-time' },\n        request_id: { type: 'string' },\n        data: {},\n        message: { type: 'string' },\n        metadata: { type: 'object' },\n    },\n} as const;\n\n/** JSON Schema for the standard error envelope */\nexport const errorResponseSchema = {\n    $schema: 'https://json-schema.org/draft/2020-12/schema',\n    $id: 'https://github.com/matteo-teodori/http-response-kit/schemas/error-response.json',\n    title: 'ErrorResponse',\n    type: 'object',\n    required: ['success', 'status_code', 'error'],\n    properties: {\n        success: { const: false },\n        status_code: { type: 'integer', minimum: 400, maximum: 599 },\n        timestamp: { type: 'string', format: 'date-time' },\n        request_id: { type: 'string' },\n        retry_after: { type: 'number' },\n        error: {\n            type: 'object',\n            required: ['type', 'title', 'message'],\n            properties: {\n                type: { type: 'string' },\n                title: { type: 'string' },\n                message: { type: 'string' },\n                code: { type: 'string' },\n                details: { type: 'string' },\n                errors: { type: 'array', items: validationIssueSchema },\n                stack: { type: 'string' },\n                causes: { type: 'array', items: { type: 'string' } },\n            },\n        },\n        metadata: { type: 'object' },\n    },\n} as const;\n\n/** JSON Schema for RFC 9457 Problem Details (with common extensions) */\nexport const problemDetailsSchema = {\n    $schema: 'https://json-schema.org/draft/2020-12/schema',\n    $id: 'https://github.com/matteo-teodori/http-response-kit/schemas/problem-details.json',\n    title: 'ProblemDetails',\n    description: 'RFC 9457 Problem Details for HTTP APIs',\n    type: 'object',\n    required: ['type', 'title', 'status'],\n    properties: {\n        type: { type: 'string', format: 'uri-reference', default: 'about:blank' },\n        title: { type: 'string' },\n        status: { type: 'integer', minimum: 100, maximum: 599 },\n        detail: { type: 'string' },\n        instance: { type: 'string', format: 'uri-reference' },\n        code: { type: 'string' },\n        errors: { type: 'array', items: validationIssueSchema },\n        request_id: { type: 'string' },\n    },\n} as const;\n\n/**\n * Ready-to-merge OpenAPI 3.1 `components` fragment.\n *\n * @example\n * ```ts\n * const spec = { openapi: '3.1.0', ...yourSpec, components: { schemas: { ...openApiComponents.schemas } } };\n * ```\n */\nexport const openApiComponents = {\n    schemas: {\n        SuccessResponse: successResponseSchema,\n        ErrorResponse: errorResponseSchema,\n        ProblemDetails: problemDetailsSchema,\n    },\n    responses: {\n        BadRequest: {\n            description: 'Bad Request',\n            content: { 'application/json': { schema: { $ref: '#/components/schemas/ErrorResponse' } } },\n        },\n        Unauthorized: {\n            description: 'Unauthorized',\n            content: { 'application/json': { schema: { $ref: '#/components/schemas/ErrorResponse' } } },\n        },\n        Forbidden: {\n            description: 'Forbidden',\n            content: { 'application/json': { schema: { $ref: '#/components/schemas/ErrorResponse' } } },\n        },\n        NotFound: {\n            description: 'Not Found',\n            content: { 'application/json': { schema: { $ref: '#/components/schemas/ErrorResponse' } } },\n        },\n        UnprocessableEntity: {\n            description: 'Validation failed',\n            content: { 'application/json': { schema: { $ref: '#/components/schemas/ErrorResponse' } } },\n        },\n        TooManyRequests: {\n            description: 'Too Many Requests',\n            content: { 'application/json': { schema: { $ref: '#/components/schemas/ErrorResponse' } } },\n        },\n        InternalServerError: {\n            description: 'Internal Server Error',\n            content: { 'application/json': { schema: { $ref: '#/components/schemas/ErrorResponse' } } },\n        },\n        Problem: {\n            description: 'RFC 9457 Problem Details',\n            content: { 'application/problem+json': { schema: { $ref: '#/components/schemas/ProblemDetails' } } },\n        },\n    },\n} as const;\n"]}