@schafevormfenster/rest-commons 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (264) hide show
  1. package/CONTRIBUTING.md +1190 -0
  2. package/README.md +275 -0
  3. package/bin/setup.js +10 -0
  4. package/dist/api-schemas/error.schema.d.ts +20 -0
  5. package/dist/api-schemas/error.schema.d.ts.map +1 -0
  6. package/dist/api-schemas/error.schema.js +17 -0
  7. package/dist/api-schemas/health.schema.d.ts +497 -0
  8. package/dist/api-schemas/health.schema.d.ts.map +1 -0
  9. package/dist/api-schemas/health.schema.js +33 -0
  10. package/dist/api-schemas/okay.schema.d.ts +13 -0
  11. package/dist/api-schemas/okay.schema.d.ts.map +1 -0
  12. package/dist/api-schemas/okay.schema.js +5 -0
  13. package/dist/api-schemas/paginated-results.schema.d.ts +59 -0
  14. package/dist/api-schemas/paginated-results.schema.d.ts.map +1 -0
  15. package/dist/api-schemas/paginated-results.schema.js +10 -0
  16. package/dist/api-schemas/partial-results.schema.d.ts +30 -0
  17. package/dist/api-schemas/partial-results.schema.d.ts.map +1 -0
  18. package/dist/api-schemas/partial-results.schema.js +10 -0
  19. package/dist/api-schemas/result.schema.d.ts +17 -0
  20. package/dist/api-schemas/result.schema.d.ts.map +1 -0
  21. package/dist/api-schemas/result.schema.js +5 -0
  22. package/dist/api-schemas/results.schema.d.ts +21 -0
  23. package/dist/api-schemas/results.schema.d.ts.map +1 -0
  24. package/dist/api-schemas/results.schema.js +5 -0
  25. package/dist/helpers/correlation/get-correlation-id.d.ts +7 -0
  26. package/dist/helpers/correlation/get-correlation-id.d.ts.map +1 -0
  27. package/dist/helpers/correlation/get-correlation-id.js +16 -0
  28. package/dist/helpers/correlation/get-header.d.ts +7 -0
  29. package/dist/helpers/correlation/get-header.d.ts.map +1 -0
  30. package/dist/helpers/correlation/get-header.js +11 -0
  31. package/dist/helpers/detect-mime-type.d.ts +11 -0
  32. package/dist/helpers/detect-mime-type.d.ts.map +1 -0
  33. package/dist/helpers/detect-mime-type.js +40 -0
  34. package/dist/helpers/detect-suspicious-patterns.d.ts +8 -0
  35. package/dist/helpers/detect-suspicious-patterns.d.ts.map +1 -0
  36. package/dist/helpers/detect-suspicious-patterns.js +55 -0
  37. package/dist/helpers/eventify-constants.types.d.ts +32 -0
  38. package/dist/helpers/eventify-constants.types.d.ts.map +1 -0
  39. package/dist/helpers/eventify-constants.types.js +40 -0
  40. package/dist/helpers/hash-binary.d.ts +21 -0
  41. package/dist/helpers/hash-binary.d.ts.map +1 -0
  42. package/dist/helpers/hash-binary.js +28 -0
  43. package/dist/helpers/mime-types/detect-image-mime-type.d.ts +5 -0
  44. package/dist/helpers/mime-types/detect-image-mime-type.d.ts.map +1 -0
  45. package/dist/helpers/mime-types/detect-image-mime-type.js +41 -0
  46. package/dist/helpers/mime-types/detect-ole-mime-type.d.ts +6 -0
  47. package/dist/helpers/mime-types/detect-ole-mime-type.d.ts.map +1 -0
  48. package/dist/helpers/mime-types/detect-ole-mime-type.js +34 -0
  49. package/dist/helpers/mime-types/detect-pdf-mime-type.d.ts +5 -0
  50. package/dist/helpers/mime-types/detect-pdf-mime-type.d.ts.map +1 -0
  51. package/dist/helpers/mime-types/detect-pdf-mime-type.js +13 -0
  52. package/dist/helpers/mime-types/detect-zip-mime-type.d.ts +6 -0
  53. package/dist/helpers/mime-types/detect-zip-mime-type.d.ts.map +1 -0
  54. package/dist/helpers/mime-types/detect-zip-mime-type.js +23 -0
  55. package/dist/helpers/parameter-validation.d.ts +6 -0
  56. package/dist/helpers/parameter-validation.d.ts.map +1 -0
  57. package/dist/helpers/parameter-validation.js +19 -0
  58. package/dist/helpers/parameter-validation.types.d.ts +16 -0
  59. package/dist/helpers/parameter-validation.types.d.ts.map +1 -0
  60. package/dist/helpers/parameter-validation.types.js +38 -0
  61. package/dist/helpers/response-headers/build-api-unauthorized-headers.d.ts +6 -0
  62. package/dist/helpers/response-headers/build-api-unauthorized-headers.d.ts.map +1 -0
  63. package/dist/helpers/response-headers/build-api-unauthorized-headers.js +23 -0
  64. package/dist/helpers/response-headers/environment.types.d.ts +2 -0
  65. package/dist/helpers/response-headers/environment.types.d.ts.map +1 -0
  66. package/dist/helpers/response-headers/environment.types.js +1 -0
  67. package/dist/helpers/response-headers/resolve-environment.d.ts +8 -0
  68. package/dist/helpers/response-headers/resolve-environment.d.ts.map +1 -0
  69. package/dist/helpers/response-headers/resolve-environment.js +18 -0
  70. package/dist/helpers/slugify.d.ts +15 -0
  71. package/dist/helpers/slugify.d.ts.map +1 -0
  72. package/dist/helpers/slugify.js +32 -0
  73. package/dist/index.d.ts +36 -0
  74. package/dist/index.d.ts.map +1 -0
  75. package/dist/index.js +41 -0
  76. package/dist/normalization/normalize-list.d.ts +11 -0
  77. package/dist/normalization/normalize-list.d.ts.map +1 -0
  78. package/dist/normalization/normalize-list.js +19 -0
  79. package/dist/normalization/normalize-location.d.ts +16 -0
  80. package/dist/normalization/normalize-location.d.ts.map +1 -0
  81. package/dist/normalization/normalize-location.js +26 -0
  82. package/dist/primitives/coordinate-precision.d.ts +10 -0
  83. package/dist/primitives/coordinate-precision.d.ts.map +1 -0
  84. package/dist/primitives/coordinate-precision.js +27 -0
  85. package/dist/primitives/geo-point.schema.d.ts +8 -0
  86. package/dist/primitives/geo-point.schema.d.ts.map +1 -0
  87. package/dist/primitives/geo-point.schema.js +10 -0
  88. package/dist/primitives/geoname-id.schema.d.ts +8 -0
  89. package/dist/primitives/geoname-id.schema.d.ts.map +1 -0
  90. package/dist/primitives/geoname-id.schema.js +9 -0
  91. package/dist/primitives/international-zip.schema.d.ts +76 -0
  92. package/dist/primitives/international-zip.schema.d.ts.map +1 -0
  93. package/dist/primitives/international-zip.schema.js +81 -0
  94. package/dist/primitives/latitude.schema.d.ts +9 -0
  95. package/dist/primitives/latitude.schema.d.ts.map +1 -0
  96. package/dist/primitives/latitude.schema.js +13 -0
  97. package/dist/primitives/location.schema.d.ts +8 -0
  98. package/dist/primitives/location.schema.d.ts.map +1 -0
  99. package/dist/primitives/location.schema.js +15 -0
  100. package/dist/primitives/longitude.schema.d.ts +9 -0
  101. package/dist/primitives/longitude.schema.d.ts.map +1 -0
  102. package/dist/primitives/longitude.schema.js +13 -0
  103. package/dist/primitives/numeric-id.schema.d.ts +8 -0
  104. package/dist/primitives/numeric-id.schema.d.ts.map +1 -0
  105. package/dist/primitives/numeric-id.schema.js +10 -0
  106. package/dist/primitives/slug.schema.d.ts +17 -0
  107. package/dist/primitives/slug.schema.d.ts.map +1 -0
  108. package/dist/primitives/slug.schema.js +30 -0
  109. package/dist/primitives/uuid.schema.d.ts +8 -0
  110. package/dist/primitives/uuid.schema.d.ts.map +1 -0
  111. package/dist/primitives/uuid.schema.js +9 -0
  112. package/dist/primitives/wikidata-id.schema.d.ts +9 -0
  113. package/dist/primitives/wikidata-id.schema.d.ts.map +1 -0
  114. package/dist/primitives/wikidata-id.schema.js +10 -0
  115. package/dist/time/boundary-enforcement.d.ts +11 -0
  116. package/dist/time/boundary-enforcement.d.ts.map +1 -0
  117. package/dist/time/boundary-enforcement.js +43 -0
  118. package/dist/time/bounded-time.schema.d.ts +31 -0
  119. package/dist/time/bounded-time.schema.d.ts.map +1 -0
  120. package/dist/time/bounded-time.schema.js +77 -0
  121. package/dist/time/flexible-time-parser.d.ts +12 -0
  122. package/dist/time/flexible-time-parser.d.ts.map +1 -0
  123. package/dist/time/flexible-time-parser.js +94 -0
  124. package/dist/time/flexible-time.schema.d.ts +31 -0
  125. package/dist/time/flexible-time.schema.d.ts.map +1 -0
  126. package/dist/time/flexible-time.schema.js +31 -0
  127. package/dist/time/get-week-end.d.ts +10 -0
  128. package/dist/time/get-week-end.d.ts.map +1 -0
  129. package/dist/time/get-week-end.js +25 -0
  130. package/dist/time/get-week-start.d.ts +10 -0
  131. package/dist/time/get-week-start.d.ts.map +1 -0
  132. package/dist/time/get-week-start.js +25 -0
  133. package/dist/time/is-relative-time.d.ts +8 -0
  134. package/dist/time/is-relative-time.d.ts.map +1 -0
  135. package/dist/time/is-relative-time.js +9 -0
  136. package/dist/time/iso8601.schema.d.ts +14 -0
  137. package/dist/time/iso8601.schema.d.ts.map +1 -0
  138. package/dist/time/iso8601.schema.js +17 -0
  139. package/dist/time/iso8601.types.d.ts +6 -0
  140. package/dist/time/iso8601.types.d.ts.map +1 -0
  141. package/dist/time/iso8601.types.js +11 -0
  142. package/dist/time/parse-relative-time.d.ts +9 -0
  143. package/dist/time/parse-relative-time.d.ts.map +1 -0
  144. package/dist/time/parse-relative-time.js +36 -0
  145. package/dist/time/relative-time.schema.d.ts +23 -0
  146. package/dist/time/relative-time.schema.d.ts.map +1 -0
  147. package/dist/time/relative-time.schema.js +25 -0
  148. package/dist/time/since-parameter.schema.d.ts +8 -0
  149. package/dist/time/since-parameter.schema.d.ts.map +1 -0
  150. package/dist/time/since-parameter.schema.js +56 -0
  151. package/dist/time/time-helpers.d.ts +19 -0
  152. package/dist/time/time-helpers.d.ts.map +1 -0
  153. package/dist/time/time-helpers.js +56 -0
  154. package/dist/time/time-schemas.d.ts +20 -0
  155. package/dist/time/time-schemas.d.ts.map +1 -0
  156. package/dist/time/time-schemas.js +25 -0
  157. package/dist/time/timezone.types.d.ts +17 -0
  158. package/dist/time/timezone.types.d.ts.map +1 -0
  159. package/dist/time/timezone.types.js +15 -0
  160. package/dist/validation/zod-error-handler.d.ts +3 -0
  161. package/dist/validation/zod-error-handler.d.ts.map +1 -0
  162. package/dist/validation/zod-error-handler.js +189 -0
  163. package/dist/validation/zod-utils.d.ts +9 -0
  164. package/dist/validation/zod-utils.d.ts.map +1 -0
  165. package/dist/validation/zod-utils.js +23 -0
  166. package/eslint.config.mjs +16 -0
  167. package/package.json +44 -0
  168. package/src/api-schemas/error.schema.test.ts +27 -0
  169. package/src/api-schemas/error.schema.ts +23 -0
  170. package/src/api-schemas/health.schema.test.ts +104 -0
  171. package/src/api-schemas/health.schema.ts +63 -0
  172. package/src/api-schemas/okay.schema.test.ts +15 -0
  173. package/src/api-schemas/okay.schema.ts +8 -0
  174. package/src/api-schemas/paginated-results.schema.ts +17 -0
  175. package/src/api-schemas/partial-results.schema.ts +13 -0
  176. package/src/api-schemas/result.schema.test.ts +19 -0
  177. package/src/api-schemas/result.schema.ts +9 -0
  178. package/src/api-schemas/results.schema.test.ts +15 -0
  179. package/src/api-schemas/results.schema.ts +9 -0
  180. package/src/helpers/correlation/get-correlation-id.test.ts +126 -0
  181. package/src/helpers/correlation/get-correlation-id.ts +22 -0
  182. package/src/helpers/correlation/get-header.test.ts +179 -0
  183. package/src/helpers/correlation/get-header.ts +21 -0
  184. package/src/helpers/detect-mime-type.test.ts +100 -0
  185. package/src/helpers/detect-mime-type.ts +46 -0
  186. package/src/helpers/detect-suspicious-patterns.test.ts +45 -0
  187. package/src/helpers/detect-suspicious-patterns.ts +57 -0
  188. package/src/helpers/eventify-constants.test.ts +52 -0
  189. package/src/helpers/eventify-constants.types.test.ts +52 -0
  190. package/src/helpers/eventify-constants.types.ts +51 -0
  191. package/src/helpers/hash-binary.test.ts +60 -0
  192. package/src/helpers/hash-binary.ts +30 -0
  193. package/src/helpers/mime-types/detect-image-mime-type.test.ts +73 -0
  194. package/src/helpers/mime-types/detect-image-mime-type.ts +50 -0
  195. package/src/helpers/mime-types/detect-ole-mime-type.test.ts +86 -0
  196. package/src/helpers/mime-types/detect-ole-mime-type.ts +44 -0
  197. package/src/helpers/mime-types/detect-pdf-mime-type.test.ts +39 -0
  198. package/src/helpers/mime-types/detect-pdf-mime-type.ts +15 -0
  199. package/src/helpers/mime-types/detect-zip-mime-type.test.ts +88 -0
  200. package/src/helpers/mime-types/detect-zip-mime-type.ts +28 -0
  201. package/src/helpers/parameter-validation.test.ts +35 -0
  202. package/src/helpers/parameter-validation.ts +32 -0
  203. package/src/helpers/process-eventify-request.ts +146 -0
  204. package/src/helpers/response-headers/build-api-unauthorized-headers.ts +30 -0
  205. package/src/helpers/response-headers/environment.types.ts +1 -0
  206. package/src/helpers/response-headers/resolve-environment.ts +17 -0
  207. package/src/helpers/slugify.test.ts +77 -0
  208. package/src/helpers/slugify.ts +34 -0
  209. package/src/index.ts +46 -0
  210. package/src/normalization/normalize-list.test.ts +43 -0
  211. package/src/normalization/normalize-list.ts +21 -0
  212. package/src/normalization/normalize-location.test.ts +91 -0
  213. package/src/normalization/normalize-location.ts +29 -0
  214. package/src/primitives/coordinate-precision.test.ts +46 -0
  215. package/src/primitives/coordinate-precision.ts +30 -0
  216. package/src/primitives/geo-point.schema.test.ts +70 -0
  217. package/src/primitives/geo-point.schema.ts +14 -0
  218. package/src/primitives/geoname-id.schema.test.ts +60 -0
  219. package/src/primitives/geoname-id.schema.ts +12 -0
  220. package/src/primitives/international-zip.schema.test.ts +212 -0
  221. package/src/primitives/international-zip.schema.ts +103 -0
  222. package/src/primitives/latitude.schema.test.ts +77 -0
  223. package/src/primitives/latitude.schema.ts +20 -0
  224. package/src/primitives/location.schema.test.ts +21 -0
  225. package/src/primitives/location.schema.ts +22 -0
  226. package/src/primitives/longitude.schema.test.ts +77 -0
  227. package/src/primitives/longitude.schema.ts +20 -0
  228. package/src/primitives/numeric-id.schema.test.ts +32 -0
  229. package/src/primitives/numeric-id.schema.ts +13 -0
  230. package/src/primitives/slug.schema.test.ts +101 -0
  231. package/src/primitives/slug.schema.ts +41 -0
  232. package/src/primitives/uuid.schema.test.ts +45 -0
  233. package/src/primitives/uuid.schema.ts +12 -0
  234. package/src/primitives/wikidata-id.schema.test.ts +51 -0
  235. package/src/primitives/wikidata-id.schema.ts +16 -0
  236. package/src/time/README.md +220 -0
  237. package/src/time/boundary-enforcement.test.ts +130 -0
  238. package/src/time/boundary-enforcement.ts +59 -0
  239. package/src/time/bounded-time.schema.test.ts +294 -0
  240. package/src/time/bounded-time.schema.ts +111 -0
  241. package/src/time/flexible-time-parser.test.ts +586 -0
  242. package/src/time/flexible-time-parser.ts +122 -0
  243. package/src/time/flexible-time.schema.test.ts +243 -0
  244. package/src/time/flexible-time.schema.ts +43 -0
  245. package/src/time/is-relative-time.test.ts +23 -0
  246. package/src/time/is-relative-time.ts +9 -0
  247. package/src/time/iso8601.schema.ts +29 -0
  248. package/src/time/iso8601.types.test.ts +112 -0
  249. package/src/time/iso8601.types.ts +21 -0
  250. package/src/time/parse-relative-time.test.ts +49 -0
  251. package/src/time/parse-relative-time.ts +50 -0
  252. package/src/time/relative-time.schema.test.ts +23 -0
  253. package/src/time/relative-time.schema.ts +38 -0
  254. package/src/time/since-parameter.schema.test.ts +59 -0
  255. package/src/time/since-parameter.schema.ts +69 -0
  256. package/src/time/time-helpers.test.ts +263 -0
  257. package/src/time/time-helpers.ts +78 -0
  258. package/src/time/time-schemas.test.ts +181 -0
  259. package/src/time/time-schemas.ts +42 -0
  260. package/src/time/time.schema.test.ts +237 -0
  261. package/src/time/timezone-independence.test.ts +188 -0
  262. package/src/time/timezone.types.test.ts +55 -0
  263. package/src/time/timezone.types.ts +22 -0
  264. package/tsconfig.json +26 -0
@@ -0,0 +1,497 @@
1
+ import { z } from "zod";
2
+ /**
3
+ * Services
4
+ */
5
+ export declare const ServiceInfoSchema: z.ZodObject<{
6
+ name: z.ZodString;
7
+ version: z.ZodOptional<z.ZodString>;
8
+ }, "strict", z.ZodTypeAny, {
9
+ name: string;
10
+ version?: string | undefined;
11
+ }, {
12
+ name: string;
13
+ version?: string | undefined;
14
+ }>;
15
+ export type ServiceInfo = z.infer<typeof ServiceInfoSchema>;
16
+ export declare const HealthyServiceInfoSchema: z.ZodObject<{
17
+ status: z.ZodNumber;
18
+ name: z.ZodString;
19
+ version: z.ZodOptional<z.ZodString>;
20
+ } & {
21
+ message: z.ZodLiteral<"healthy">;
22
+ }, "strict", z.ZodTypeAny, {
23
+ status: number;
24
+ message: "healthy";
25
+ name: string;
26
+ version?: string | undefined;
27
+ }, {
28
+ status: number;
29
+ message: "healthy";
30
+ name: string;
31
+ version?: string | undefined;
32
+ }>;
33
+ export type HealthyServiceInfo = z.infer<typeof HealthyServiceInfoSchema>;
34
+ export declare const UnhealthyServiceInfoSchema: z.ZodObject<{
35
+ status: z.ZodNumber;
36
+ error: z.ZodString;
37
+ trace: z.ZodOptional<z.ZodAny>;
38
+ } & {
39
+ name: z.ZodString;
40
+ version: z.ZodOptional<z.ZodString>;
41
+ }, "strict", z.ZodTypeAny, {
42
+ status: number;
43
+ error: string;
44
+ name: string;
45
+ trace?: any;
46
+ version?: string | undefined;
47
+ }, {
48
+ status: number;
49
+ error: string;
50
+ name: string;
51
+ trace?: any;
52
+ version?: string | undefined;
53
+ }>;
54
+ export type UnhealthyServiceInfo = z.infer<typeof UnhealthyServiceInfoSchema>;
55
+ export declare const ServiceStatusSchema: z.ZodUnion<[z.ZodObject<{
56
+ status: z.ZodNumber;
57
+ name: z.ZodString;
58
+ version: z.ZodOptional<z.ZodString>;
59
+ } & {
60
+ message: z.ZodLiteral<"healthy">;
61
+ }, "strict", z.ZodTypeAny, {
62
+ status: number;
63
+ message: "healthy";
64
+ name: string;
65
+ version?: string | undefined;
66
+ }, {
67
+ status: number;
68
+ message: "healthy";
69
+ name: string;
70
+ version?: string | undefined;
71
+ }>, z.ZodObject<{
72
+ status: z.ZodNumber;
73
+ error: z.ZodString;
74
+ trace: z.ZodOptional<z.ZodAny>;
75
+ } & {
76
+ name: z.ZodString;
77
+ version: z.ZodOptional<z.ZodString>;
78
+ }, "strict", z.ZodTypeAny, {
79
+ status: number;
80
+ error: string;
81
+ name: string;
82
+ trace?: any;
83
+ version?: string | undefined;
84
+ }, {
85
+ status: number;
86
+ error: string;
87
+ name: string;
88
+ trace?: any;
89
+ version?: string | undefined;
90
+ }>]>;
91
+ export type ServiceStatus = z.infer<typeof ServiceStatusSchema>;
92
+ /**
93
+ * API
94
+ */
95
+ export declare const ApiInfoSchema: z.ZodObject<{
96
+ name: z.ZodString;
97
+ version: z.ZodString;
98
+ description: z.ZodOptional<z.ZodString>;
99
+ services: z.ZodArray<z.ZodUnion<[z.ZodObject<{
100
+ status: z.ZodNumber;
101
+ name: z.ZodString;
102
+ version: z.ZodOptional<z.ZodString>;
103
+ } & {
104
+ message: z.ZodLiteral<"healthy">;
105
+ }, "strict", z.ZodTypeAny, {
106
+ status: number;
107
+ message: "healthy";
108
+ name: string;
109
+ version?: string | undefined;
110
+ }, {
111
+ status: number;
112
+ message: "healthy";
113
+ name: string;
114
+ version?: string | undefined;
115
+ }>, z.ZodObject<{
116
+ status: z.ZodNumber;
117
+ error: z.ZodString;
118
+ trace: z.ZodOptional<z.ZodAny>;
119
+ } & {
120
+ name: z.ZodString;
121
+ version: z.ZodOptional<z.ZodString>;
122
+ }, "strict", z.ZodTypeAny, {
123
+ status: number;
124
+ error: string;
125
+ name: string;
126
+ trace?: any;
127
+ version?: string | undefined;
128
+ }, {
129
+ status: number;
130
+ error: string;
131
+ name: string;
132
+ trace?: any;
133
+ version?: string | undefined;
134
+ }>]>, "many">;
135
+ }, "strict", z.ZodTypeAny, {
136
+ name: string;
137
+ version: string;
138
+ services: ({
139
+ status: number;
140
+ message: "healthy";
141
+ name: string;
142
+ version?: string | undefined;
143
+ } | {
144
+ status: number;
145
+ error: string;
146
+ name: string;
147
+ trace?: any;
148
+ version?: string | undefined;
149
+ })[];
150
+ description?: string | undefined;
151
+ }, {
152
+ name: string;
153
+ version: string;
154
+ services: ({
155
+ status: number;
156
+ message: "healthy";
157
+ name: string;
158
+ version?: string | undefined;
159
+ } | {
160
+ status: number;
161
+ error: string;
162
+ name: string;
163
+ trace?: any;
164
+ version?: string | undefined;
165
+ })[];
166
+ description?: string | undefined;
167
+ }>;
168
+ export type ApiInfo = z.infer<typeof ApiInfoSchema>;
169
+ export declare const HealthyApiStatusSchema: z.ZodObject<{
170
+ status: z.ZodNumber;
171
+ message: z.ZodOptional<z.ZodString>;
172
+ } & {
173
+ name: z.ZodString;
174
+ version: z.ZodString;
175
+ description: z.ZodOptional<z.ZodString>;
176
+ services: z.ZodArray<z.ZodUnion<[z.ZodObject<{
177
+ status: z.ZodNumber;
178
+ name: z.ZodString;
179
+ version: z.ZodOptional<z.ZodString>;
180
+ } & {
181
+ message: z.ZodLiteral<"healthy">;
182
+ }, "strict", z.ZodTypeAny, {
183
+ status: number;
184
+ message: "healthy";
185
+ name: string;
186
+ version?: string | undefined;
187
+ }, {
188
+ status: number;
189
+ message: "healthy";
190
+ name: string;
191
+ version?: string | undefined;
192
+ }>, z.ZodObject<{
193
+ status: z.ZodNumber;
194
+ error: z.ZodString;
195
+ trace: z.ZodOptional<z.ZodAny>;
196
+ } & {
197
+ name: z.ZodString;
198
+ version: z.ZodOptional<z.ZodString>;
199
+ }, "strict", z.ZodTypeAny, {
200
+ status: number;
201
+ error: string;
202
+ name: string;
203
+ trace?: any;
204
+ version?: string | undefined;
205
+ }, {
206
+ status: number;
207
+ error: string;
208
+ name: string;
209
+ trace?: any;
210
+ version?: string | undefined;
211
+ }>]>, "many">;
212
+ }, "strict", z.ZodTypeAny, {
213
+ status: number;
214
+ name: string;
215
+ version: string;
216
+ services: ({
217
+ status: number;
218
+ message: "healthy";
219
+ name: string;
220
+ version?: string | undefined;
221
+ } | {
222
+ status: number;
223
+ error: string;
224
+ name: string;
225
+ trace?: any;
226
+ version?: string | undefined;
227
+ })[];
228
+ message?: string | undefined;
229
+ description?: string | undefined;
230
+ }, {
231
+ status: number;
232
+ name: string;
233
+ version: string;
234
+ services: ({
235
+ status: number;
236
+ message: "healthy";
237
+ name: string;
238
+ version?: string | undefined;
239
+ } | {
240
+ status: number;
241
+ error: string;
242
+ name: string;
243
+ trace?: any;
244
+ version?: string | undefined;
245
+ })[];
246
+ message?: string | undefined;
247
+ description?: string | undefined;
248
+ }>;
249
+ export type HealthyApiStatus = z.infer<typeof HealthyApiStatusSchema>;
250
+ export declare const UnhealthyApiStatusSchema: z.ZodObject<{
251
+ status: z.ZodNumber;
252
+ error: z.ZodString;
253
+ trace: z.ZodOptional<z.ZodAny>;
254
+ } & {
255
+ name: z.ZodString;
256
+ version: z.ZodString;
257
+ description: z.ZodOptional<z.ZodString>;
258
+ services: z.ZodArray<z.ZodUnion<[z.ZodObject<{
259
+ status: z.ZodNumber;
260
+ name: z.ZodString;
261
+ version: z.ZodOptional<z.ZodString>;
262
+ } & {
263
+ message: z.ZodLiteral<"healthy">;
264
+ }, "strict", z.ZodTypeAny, {
265
+ status: number;
266
+ message: "healthy";
267
+ name: string;
268
+ version?: string | undefined;
269
+ }, {
270
+ status: number;
271
+ message: "healthy";
272
+ name: string;
273
+ version?: string | undefined;
274
+ }>, z.ZodObject<{
275
+ status: z.ZodNumber;
276
+ error: z.ZodString;
277
+ trace: z.ZodOptional<z.ZodAny>;
278
+ } & {
279
+ name: z.ZodString;
280
+ version: z.ZodOptional<z.ZodString>;
281
+ }, "strict", z.ZodTypeAny, {
282
+ status: number;
283
+ error: string;
284
+ name: string;
285
+ trace?: any;
286
+ version?: string | undefined;
287
+ }, {
288
+ status: number;
289
+ error: string;
290
+ name: string;
291
+ trace?: any;
292
+ version?: string | undefined;
293
+ }>]>, "many">;
294
+ }, "strict", z.ZodTypeAny, {
295
+ status: number;
296
+ error: string;
297
+ name: string;
298
+ version: string;
299
+ services: ({
300
+ status: number;
301
+ message: "healthy";
302
+ name: string;
303
+ version?: string | undefined;
304
+ } | {
305
+ status: number;
306
+ error: string;
307
+ name: string;
308
+ trace?: any;
309
+ version?: string | undefined;
310
+ })[];
311
+ trace?: any;
312
+ description?: string | undefined;
313
+ }, {
314
+ status: number;
315
+ error: string;
316
+ name: string;
317
+ version: string;
318
+ services: ({
319
+ status: number;
320
+ message: "healthy";
321
+ name: string;
322
+ version?: string | undefined;
323
+ } | {
324
+ status: number;
325
+ error: string;
326
+ name: string;
327
+ trace?: any;
328
+ version?: string | undefined;
329
+ })[];
330
+ trace?: any;
331
+ description?: string | undefined;
332
+ }>;
333
+ export type UnhealthyApiStatus = z.infer<typeof UnhealthyApiStatusSchema>;
334
+ export declare const ApiStatusSchema: z.ZodUnion<[z.ZodObject<{
335
+ status: z.ZodNumber;
336
+ message: z.ZodOptional<z.ZodString>;
337
+ } & {
338
+ name: z.ZodString;
339
+ version: z.ZodString;
340
+ description: z.ZodOptional<z.ZodString>;
341
+ services: z.ZodArray<z.ZodUnion<[z.ZodObject<{
342
+ status: z.ZodNumber;
343
+ name: z.ZodString;
344
+ version: z.ZodOptional<z.ZodString>;
345
+ } & {
346
+ message: z.ZodLiteral<"healthy">;
347
+ }, "strict", z.ZodTypeAny, {
348
+ status: number;
349
+ message: "healthy";
350
+ name: string;
351
+ version?: string | undefined;
352
+ }, {
353
+ status: number;
354
+ message: "healthy";
355
+ name: string;
356
+ version?: string | undefined;
357
+ }>, z.ZodObject<{
358
+ status: z.ZodNumber;
359
+ error: z.ZodString;
360
+ trace: z.ZodOptional<z.ZodAny>;
361
+ } & {
362
+ name: z.ZodString;
363
+ version: z.ZodOptional<z.ZodString>;
364
+ }, "strict", z.ZodTypeAny, {
365
+ status: number;
366
+ error: string;
367
+ name: string;
368
+ trace?: any;
369
+ version?: string | undefined;
370
+ }, {
371
+ status: number;
372
+ error: string;
373
+ name: string;
374
+ trace?: any;
375
+ version?: string | undefined;
376
+ }>]>, "many">;
377
+ }, "strict", z.ZodTypeAny, {
378
+ status: number;
379
+ name: string;
380
+ version: string;
381
+ services: ({
382
+ status: number;
383
+ message: "healthy";
384
+ name: string;
385
+ version?: string | undefined;
386
+ } | {
387
+ status: number;
388
+ error: string;
389
+ name: string;
390
+ trace?: any;
391
+ version?: string | undefined;
392
+ })[];
393
+ message?: string | undefined;
394
+ description?: string | undefined;
395
+ }, {
396
+ status: number;
397
+ name: string;
398
+ version: string;
399
+ services: ({
400
+ status: number;
401
+ message: "healthy";
402
+ name: string;
403
+ version?: string | undefined;
404
+ } | {
405
+ status: number;
406
+ error: string;
407
+ name: string;
408
+ trace?: any;
409
+ version?: string | undefined;
410
+ })[];
411
+ message?: string | undefined;
412
+ description?: string | undefined;
413
+ }>, z.ZodObject<{
414
+ status: z.ZodNumber;
415
+ error: z.ZodString;
416
+ trace: z.ZodOptional<z.ZodAny>;
417
+ } & {
418
+ name: z.ZodString;
419
+ version: z.ZodString;
420
+ description: z.ZodOptional<z.ZodString>;
421
+ services: z.ZodArray<z.ZodUnion<[z.ZodObject<{
422
+ status: z.ZodNumber;
423
+ name: z.ZodString;
424
+ version: z.ZodOptional<z.ZodString>;
425
+ } & {
426
+ message: z.ZodLiteral<"healthy">;
427
+ }, "strict", z.ZodTypeAny, {
428
+ status: number;
429
+ message: "healthy";
430
+ name: string;
431
+ version?: string | undefined;
432
+ }, {
433
+ status: number;
434
+ message: "healthy";
435
+ name: string;
436
+ version?: string | undefined;
437
+ }>, z.ZodObject<{
438
+ status: z.ZodNumber;
439
+ error: z.ZodString;
440
+ trace: z.ZodOptional<z.ZodAny>;
441
+ } & {
442
+ name: z.ZodString;
443
+ version: z.ZodOptional<z.ZodString>;
444
+ }, "strict", z.ZodTypeAny, {
445
+ status: number;
446
+ error: string;
447
+ name: string;
448
+ trace?: any;
449
+ version?: string | undefined;
450
+ }, {
451
+ status: number;
452
+ error: string;
453
+ name: string;
454
+ trace?: any;
455
+ version?: string | undefined;
456
+ }>]>, "many">;
457
+ }, "strict", z.ZodTypeAny, {
458
+ status: number;
459
+ error: string;
460
+ name: string;
461
+ version: string;
462
+ services: ({
463
+ status: number;
464
+ message: "healthy";
465
+ name: string;
466
+ version?: string | undefined;
467
+ } | {
468
+ status: number;
469
+ error: string;
470
+ name: string;
471
+ trace?: any;
472
+ version?: string | undefined;
473
+ })[];
474
+ trace?: any;
475
+ description?: string | undefined;
476
+ }, {
477
+ status: number;
478
+ error: string;
479
+ name: string;
480
+ version: string;
481
+ services: ({
482
+ status: number;
483
+ message: "healthy";
484
+ name: string;
485
+ version?: string | undefined;
486
+ } | {
487
+ status: number;
488
+ error: string;
489
+ name: string;
490
+ trace?: any;
491
+ version?: string | undefined;
492
+ })[];
493
+ trace?: any;
494
+ description?: string | undefined;
495
+ }>]>;
496
+ export type ApiStatus = z.infer<typeof ApiStatusSchema>;
497
+ //# sourceMappingURL=health.schema.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"health.schema.d.ts","sourceRoot":"","sources":["../../src/api-schemas/health.schema.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB;;GAEG;AAEH,eAAO,MAAM,iBAAiB;;;;;;;;;EAGnB,CAAC;AAEZ,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;EAInC,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;EACE,CAAC;AAE1C,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CACxC,OAAO,0BAA0B,CAClC,CAAC;AAEF,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAG9B,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKf,CAAC;AAEZ,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAEpD,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAkC,CAAC;AACtE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAsC,CAAC;AAC5E,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAG1B,CAAC;AAEH,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC"}
@@ -0,0 +1,33 @@
1
+ import { z } from "zod";
2
+ import { ApiErrorSchema } from "./error.schema";
3
+ import { OkaySchema } from "./okay.schema";
4
+ /**
5
+ * Services
6
+ */
7
+ export const ServiceInfoSchema = z.object({
8
+ name: z.string(),
9
+ version: z.string().optional(),
10
+ }).strict();
11
+ export const HealthyServiceInfoSchema = OkaySchema.merge(ServiceInfoSchema).extend({
12
+ message: z.literal("healthy"),
13
+ });
14
+ export const UnhealthyServiceInfoSchema = ApiErrorSchema.merge(ServiceInfoSchema);
15
+ export const ServiceStatusSchema = z.union([
16
+ HealthyServiceInfoSchema,
17
+ UnhealthyServiceInfoSchema,
18
+ ]);
19
+ /**
20
+ * API
21
+ */
22
+ export const ApiInfoSchema = z.object({
23
+ name: z.string(),
24
+ version: z.string(),
25
+ description: z.string().optional(),
26
+ services: ServiceStatusSchema.array(),
27
+ }).strict();
28
+ export const HealthyApiStatusSchema = OkaySchema.merge(ApiInfoSchema);
29
+ export const UnhealthyApiStatusSchema = ApiErrorSchema.merge(ApiInfoSchema);
30
+ export const ApiStatusSchema = z.union([
31
+ HealthyApiStatusSchema,
32
+ UnhealthyApiStatusSchema,
33
+ ]);
@@ -0,0 +1,13 @@
1
+ import { z } from "zod";
2
+ export declare const OkaySchema: z.ZodObject<{
3
+ status: z.ZodNumber;
4
+ message: z.ZodOptional<z.ZodString>;
5
+ }, "strict", z.ZodTypeAny, {
6
+ status: number;
7
+ message?: string | undefined;
8
+ }, {
9
+ status: number;
10
+ message?: string | undefined;
11
+ }>;
12
+ export type Okay = z.infer<typeof OkaySchema>;
13
+ //# sourceMappingURL=okay.schema.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"okay.schema.d.ts","sourceRoot":"","sources":["../../src/api-schemas/okay.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,UAAU;;;;;;;;;EAGZ,CAAC;AAEZ,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC"}
@@ -0,0 +1,5 @@
1
+ import { z } from "zod";
2
+ export const OkaySchema = z.object({
3
+ status: z.number().min(200).max(299),
4
+ message: z.string().optional(),
5
+ }).strict();
@@ -0,0 +1,59 @@
1
+ import { z } from "zod";
2
+ export declare const PaginationSchema: z.ZodObject<{
3
+ page: z.ZodNumber;
4
+ limit: z.ZodNumber;
5
+ totalPages: z.ZodNumber;
6
+ }, "strict", z.ZodTypeAny, {
7
+ page: number;
8
+ limit: number;
9
+ totalPages: number;
10
+ }, {
11
+ page: number;
12
+ limit: number;
13
+ totalPages: number;
14
+ }>;
15
+ export type Pagination = z.infer<typeof PaginationSchema>;
16
+ export declare const PaginatedResultsSchema: z.ZodObject<{
17
+ status: z.ZodNumber;
18
+ message: z.ZodOptional<z.ZodString>;
19
+ } & {
20
+ timestamp: z.ZodEffects<z.ZodString, string, string>;
21
+ } & {
22
+ results: z.ZodNumber;
23
+ } & {
24
+ pagination: z.ZodObject<{
25
+ page: z.ZodNumber;
26
+ limit: z.ZodNumber;
27
+ totalPages: z.ZodNumber;
28
+ }, "strict", z.ZodTypeAny, {
29
+ page: number;
30
+ limit: number;
31
+ totalPages: number;
32
+ }, {
33
+ page: number;
34
+ limit: number;
35
+ totalPages: number;
36
+ }>;
37
+ }, "strict", z.ZodTypeAny, {
38
+ status: number;
39
+ timestamp: string;
40
+ results: number;
41
+ pagination: {
42
+ page: number;
43
+ limit: number;
44
+ totalPages: number;
45
+ };
46
+ message?: string | undefined;
47
+ }, {
48
+ status: number;
49
+ timestamp: string;
50
+ results: number;
51
+ pagination: {
52
+ page: number;
53
+ limit: number;
54
+ totalPages: number;
55
+ };
56
+ message?: string | undefined;
57
+ }>;
58
+ export type PaginatedResults = z.infer<typeof PaginatedResultsSchema>;
59
+ //# sourceMappingURL=paginated-results.schema.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"paginated-results.schema.d.ts","sourceRoot":"","sources":["../../src/api-schemas/paginated-results.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,eAAO,MAAM,gBAAgB;;;;;;;;;;;;EAIlB,CAAC;AAEZ,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEjC,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC"}
@@ -0,0 +1,10 @@
1
+ import { z } from "zod";
2
+ import { ResultsSchema } from "./results.schema";
3
+ export const PaginationSchema = z.object({
4
+ page: z.number().describe("Current page number"),
5
+ limit: z.number().describe("Maximum results per page"),
6
+ totalPages: z.number().describe("Total number of pages"),
7
+ }).strict();
8
+ export const PaginatedResultsSchema = ResultsSchema.extend({
9
+ pagination: PaginationSchema,
10
+ });
@@ -0,0 +1,30 @@
1
+ import { z } from "zod";
2
+ /**
3
+ * Schema for partial success responses where some items succeeded and others failed.
4
+ * Extends ResultsSchema with an errors count field.
5
+ * Useful for batch operations that can have mixed results (e.g., 422 responses).
6
+ */
7
+ export declare const PartialResultsSchema: z.ZodObject<{
8
+ status: z.ZodNumber;
9
+ message: z.ZodOptional<z.ZodString>;
10
+ } & {
11
+ timestamp: z.ZodEffects<z.ZodString, string, string>;
12
+ } & {
13
+ results: z.ZodNumber;
14
+ } & {
15
+ errors: z.ZodNumber;
16
+ }, "strict", z.ZodTypeAny, {
17
+ status: number;
18
+ timestamp: string;
19
+ results: number;
20
+ errors: number;
21
+ message?: string | undefined;
22
+ }, {
23
+ status: number;
24
+ timestamp: string;
25
+ results: number;
26
+ errors: number;
27
+ message?: string | undefined;
28
+ }>;
29
+ export type PartialResults = z.infer<typeof PartialResultsSchema>;
30
+ //# sourceMappingURL=partial-results.schema.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"partial-results.schema.d.ts","sourceRoot":"","sources":["../../src/api-schemas/partial-results.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB;;;;GAIG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;EAE/B,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC"}
@@ -0,0 +1,10 @@
1
+ import { z } from "zod";
2
+ import { ResultsSchema } from "./results.schema";
3
+ /**
4
+ * Schema for partial success responses where some items succeeded and others failed.
5
+ * Extends ResultsSchema with an errors count field.
6
+ * Useful for batch operations that can have mixed results (e.g., 422 responses).
7
+ */
8
+ export const PartialResultsSchema = ResultsSchema.extend({
9
+ errors: z.number(), // Count of failed items
10
+ });
@@ -0,0 +1,17 @@
1
+ import { z } from "zod";
2
+ export declare const ResultSchema: z.ZodObject<{
3
+ status: z.ZodNumber;
4
+ message: z.ZodOptional<z.ZodString>;
5
+ } & {
6
+ timestamp: z.ZodEffects<z.ZodString, string, string>;
7
+ }, "strict", z.ZodTypeAny, {
8
+ status: number;
9
+ timestamp: string;
10
+ message?: string | undefined;
11
+ }, {
12
+ status: number;
13
+ timestamp: string;
14
+ message?: string | undefined;
15
+ }>;
16
+ export type Result = z.infer<typeof ResultSchema>;
17
+ //# sourceMappingURL=result.schema.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"result.schema.d.ts","sourceRoot":"","sources":["../../src/api-schemas/result.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,eAAO,MAAM,YAAY;;;;;;;;;;;;;EAEvB,CAAC;AAEH,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC"}