http-response-kit 1.1.0 → 2.0.0

package/dist/schemas.d.mts

@@ -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 };