@owlmeans/api 0.1.18-rc.9 → 0.1.18

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 (101) hide show
  1. package/README.md +12 -4
  2. package/agent-meta/manifest.json +3 -3
  3. package/agent-meta/skills/api/SKILL.md +117 -11
  4. package/build/consts.d.ts +7 -0
  5. package/build/consts.d.ts.map +1 -1
  6. package/build/consts.js +7 -0
  7. package/build/consts.js.map +1 -1
  8. package/build/errors.d.ts +30 -2
  9. package/build/errors.d.ts.map +1 -1
  10. package/build/errors.js +46 -4
  11. package/build/errors.js.map +1 -1
  12. package/build/index.d.ts +3 -0
  13. package/build/index.d.ts.map +1 -1
  14. package/build/index.js +1 -0
  15. package/build/index.js.map +1 -1
  16. package/build/service.d.ts +1 -6
  17. package/build/service.d.ts.map +1 -1
  18. package/build/service.js +39 -27
  19. package/build/service.js.map +1 -1
  20. package/build/status/consts.d.ts +5 -0
  21. package/build/status/consts.d.ts.map +1 -0
  22. package/build/status/consts.js +5 -0
  23. package/build/status/consts.js.map +1 -0
  24. package/build/status/consts.local.d.ts +10 -0
  25. package/build/status/consts.local.d.ts.map +1 -0
  26. package/build/status/consts.local.js +10 -0
  27. package/build/status/consts.local.js.map +1 -0
  28. package/build/status/helper.d.ts +4 -0
  29. package/build/status/helper.d.ts.map +1 -0
  30. package/build/status/helper.js +49 -0
  31. package/build/status/helper.js.map +1 -0
  32. package/build/status/index.d.ts +9 -0
  33. package/build/status/index.d.ts.map +1 -0
  34. package/build/status/index.js +9 -0
  35. package/build/status/index.js.map +1 -0
  36. package/build/status/marker.d.ts +3 -0
  37. package/build/status/marker.d.ts.map +1 -0
  38. package/build/status/marker.js +16 -0
  39. package/build/status/marker.js.map +1 -0
  40. package/build/status/types.d.ts +35 -0
  41. package/build/status/types.d.ts.map +1 -0
  42. package/build/status/types.js +2 -0
  43. package/build/status/types.js.map +1 -0
  44. package/build/types.local.d.ts +6 -0
  45. package/build/types.local.d.ts.map +1 -0
  46. package/build/types.local.js +2 -0
  47. package/build/types.local.js.map +1 -0
  48. package/build/utils/body/types.d.ts +36 -0
  49. package/build/utils/body/types.d.ts.map +1 -0
  50. package/build/utils/body/types.js +2 -0
  51. package/build/utils/body/types.js.map +1 -0
  52. package/build/utils/body.d.ts +4 -0
  53. package/build/utils/body.d.ts.map +1 -0
  54. package/build/utils/body.js +56 -0
  55. package/build/utils/body.js.map +1 -0
  56. package/build/utils/consts.d.ts +2 -0
  57. package/build/utils/consts.d.ts.map +1 -0
  58. package/build/utils/consts.js +2 -0
  59. package/build/utils/consts.js.map +1 -0
  60. package/build/utils/consts.local.d.ts +2 -0
  61. package/build/utils/consts.local.d.ts.map +1 -0
  62. package/build/utils/consts.local.js +2 -0
  63. package/build/utils/consts.local.js.map +1 -0
  64. package/build/utils/handler.d.ts.map +1 -1
  65. package/build/utils/index.d.ts +2 -1
  66. package/build/utils/index.d.ts.map +1 -1
  67. package/build/utils/index.js +1 -1
  68. package/build/utils/index.js.map +1 -1
  69. package/build/utils/response/types.d.ts +15 -0
  70. package/build/utils/response/types.d.ts.map +1 -0
  71. package/build/utils/response/types.js +2 -0
  72. package/build/utils/response/types.js.map +1 -0
  73. package/build/utils/response.d.ts +4 -0
  74. package/build/utils/response.d.ts.map +1 -0
  75. package/build/utils/response.js +99 -0
  76. package/build/utils/response.js.map +1 -0
  77. package/package.json +24 -14
  78. package/src/consts.ts +8 -0
  79. package/src/errors.ts +55 -4
  80. package/src/index.ts +5 -1
  81. package/src/service.ts +48 -40
  82. package/src/status/consts.local.ts +11 -0
  83. package/src/status/consts.ts +5 -0
  84. package/src/status/helper.ts +63 -0
  85. package/src/status/index.ts +11 -0
  86. package/src/status/marker.ts +19 -0
  87. package/src/status/types.ts +36 -0
  88. package/src/types.local.ts +7 -0
  89. package/src/utils/body/types.ts +37 -0
  90. package/src/utils/body.ts +70 -0
  91. package/src/utils/consts.local.ts +1 -0
  92. package/src/utils/consts.ts +1 -0
  93. package/src/utils/index.ts +2 -1
  94. package/src/utils/response/types.ts +15 -0
  95. package/src/utils/response.ts +117 -0
  96. package/tests/body.spec.ts +124 -0
  97. package/tests/handler.spec.ts +229 -0
  98. package/tests/tsconfig.json +11 -0
  99. package/tsconfig.json +1 -1
  100. package/build/.gitkeep +0 -0
  101. package/src/utils/handler.ts +0 -61
@@ -0,0 +1 @@
1
+ {"version":3,"file":"consts.local.js","sourceRoot":"","sources":["../../src/status/consts.local.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,IAAI,GAAG,iEAAiE,CAAA;AAErF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,gGAAgG,CAAA;AAEtH,MAAM,CAAC,MAAM,YAAY,GAA2B,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,CAAA"}
@@ -0,0 +1,4 @@
1
+ import type { ApiStatusHelper } from './types.js';
2
+ export declare const createApiStatusHelper: () => ApiStatusHelper;
3
+ export declare const apiStatusHelper: ApiStatusHelper;
4
+ //# sourceMappingURL=helper.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../../src/status/helper.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAuC,MAAM,YAAY,CAAA;AAEtF,eAAO,MAAM,qBAAqB,QAAO,eAqDxC,CAAA;AAED,eAAO,MAAM,eAAe,iBAA0B,CAAA"}
@@ -0,0 +1,49 @@
1
+ import { ResilientError } from '@owlmeans/error';
2
+ import { ApiClientError } from '../errors.js';
3
+ import { parseClientMarker } from './marker.js';
4
+ import { ACCESS_DENIED_KIND } from '../consts.js';
5
+ import { UUID } from './consts.local.js';
6
+ export const createApiStatusHelper = () => {
7
+ const isAccessDenied = (error) => httpStatusOf(error) === 403
8
+ && typeof error === 'object' && error != null
9
+ && error.denialKind === ACCESS_DENIED_KIND;
10
+ const httpStatus = (value) => typeof value === 'number' && Number.isInteger(value) && value >= 100 && value <= 599 ? value : null;
11
+ /** The first `api:client:*` marker in an error's `message`, else in its `type`. */
12
+ const markerOf = (error) => {
13
+ const { message, type } = error;
14
+ return (typeof message === 'string' ? parseClientMarker(message) : null)
15
+ ?? (typeof type === 'string' ? parseClientMarker(type) : null);
16
+ };
17
+ const httpStatusOf = (error) => {
18
+ if (error == null || typeof error !== 'object') {
19
+ return null;
20
+ }
21
+ const stamped = httpStatus(error.responseStatus);
22
+ if (stamped != null) {
23
+ return stamped;
24
+ }
25
+ if (error instanceof ApiClientError && httpStatus(error.status) != null) {
26
+ return error.status;
27
+ }
28
+ const declaration = error.constructor;
29
+ const declared = httpStatus(declaration?.httpStatus);
30
+ if (declared != null && (declared < 500 || declaration?.allowServerErrorStatus === true)) {
31
+ return declared;
32
+ }
33
+ return markerOf(error)?.status ?? null;
34
+ };
35
+ const incidentIdOf = (error) => {
36
+ if (error == null || typeof error !== 'object') {
37
+ return null;
38
+ }
39
+ const own = error.incidentId;
40
+ if (typeof own === 'string' && own !== '') {
41
+ return own;
42
+ }
43
+ return markerOf(error)?.incidentId ?? null;
44
+ };
45
+ const isIncidentBody = (data) => typeof data === 'string' && !data.includes(ResilientError.separator) && UUID.test(data.trim());
46
+ return { isAccessDenied, httpStatusOf, incidentIdOf, isIncidentBody };
47
+ };
48
+ export const apiStatusHelper = createApiStatusHelper();
49
+ //# sourceMappingURL=helper.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"helper.js","sourceRoot":"","sources":["../../src/status/helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAGxC,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAoB,EAAE;IACzD,MAAM,cAAc,GAAG,CAAC,KAAc,EAAW,EAAE,CACjD,YAAY,CAAC,KAAK,CAAC,KAAK,GAAG;WACxB,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,IAAI,IAAI;WACzC,KAA+B,CAAC,UAAU,KAAK,kBAAkB,CAAA;IAEvE,MAAM,UAAU,GAAG,CAAC,KAAc,EAAiB,EAAE,CACnD,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,GAAG,IAAI,KAAK,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAA;IAErG,mFAAmF;IACnF,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAuB,EAAE;QACtD,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,KAA8C,CAAA;QAExE,OAAO,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;eACnE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;IAClE,CAAC,CAAA;IAED,MAAM,YAAY,GAAG,CAAC,KAAc,EAAiB,EAAE;QACrD,IAAI,KAAK,IAAI,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC/C,OAAO,IAAI,CAAA;QACb,CAAC;QACD,MAAM,OAAO,GAAG,UAAU,CAAE,KAA+B,CAAC,cAAc,CAAC,CAAA;QAC3E,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YACpB,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,IAAI,KAAK,YAAY,cAAc,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;YACxE,OAAO,KAAK,CAAC,MAAO,CAAA;QACtB,CAAC;QACD,MAAM,WAAW,GAAG,KAAK,CAAC,WAAqF,CAAA;QAC/G,MAAM,QAAQ,GAAG,UAAU,CAAC,WAAW,EAAE,UAAU,CAAC,CAAA;QACpD,IAAI,QAAQ,IAAI,IAAI,IAAI,CAAC,QAAQ,GAAG,GAAG,IAAI,WAAW,EAAE,sBAAsB,KAAK,IAAI,CAAC,EAAE,CAAC;YACzF,OAAO,QAAQ,CAAA;QACjB,CAAC;QAED,OAAO,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,IAAI,IAAI,CAAA;IACxC,CAAC,CAAA;IAED,MAAM,YAAY,GAAG,CAAC,KAAc,EAAiB,EAAE;QACrD,IAAI,KAAK,IAAI,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC/C,OAAO,IAAI,CAAA;QACb,CAAC;QACD,MAAM,GAAG,GAAI,KAAkC,CAAC,UAAU,CAAA;QAC1D,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,EAAE,EAAE,CAAC;YAC1C,OAAO,GAAG,CAAA;QACZ,CAAC;QAED,OAAO,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,IAAI,IAAI,CAAA;IAC5C,CAAC,CAAA;IAED,MAAM,cAAc,GAAG,CAAC,IAAa,EAAkB,EAAE,CACvD,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;IAEhG,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,YAAY,EAAE,cAAc,EAAE,CAAA;AACvE,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,eAAe,GAAG,qBAAqB,EAAE,CAAA"}
@@ -0,0 +1,9 @@
1
+ export { INCIDENT_ID_HEADER } from '../consts.js';
2
+ export { DENIAL_KIND_HEADER, ACCESS_DENIED_KIND } from '../consts.js';
3
+ export { parseClientMarker } from './marker.js';
4
+ export { API_CLIENT_MARKER, API_STATUS_MARKER } from './consts.js';
5
+ export type { ClientMarker, ResponseStatusCarrier, ApiStatusHelper } from './types.js';
6
+ export { apiStatusHelper, createApiStatusHelper } from './helper.js';
7
+ /** @deprecated compat:factory-refactor — use `apiStatusHelper.httpStatusOf(…)` */
8
+ export declare const httpStatusOf: (error: unknown) => number | null;
9
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/status/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAClE,YAAY,EAAE,YAAY,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AACtF,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEpE,kFAAkF;AAClF,eAAO,MAAM,YAAY,UAAW,OAAO,KAAG,MAAM,GAAG,IAA2C,CAAA"}
@@ -0,0 +1,9 @@
1
+ import { apiStatusHelper } from './helper.js';
2
+ export { INCIDENT_ID_HEADER } from '../consts.js';
3
+ export { DENIAL_KIND_HEADER, ACCESS_DENIED_KIND } from '../consts.js';
4
+ export { parseClientMarker } from './marker.js';
5
+ export { API_CLIENT_MARKER, API_STATUS_MARKER } from './consts.js';
6
+ export { apiStatusHelper, createApiStatusHelper } from './helper.js';
7
+ /** @deprecated compat:factory-refactor — use `apiStatusHelper.httpStatusOf(…)` */
8
+ export const httpStatusOf = (error) => apiStatusHelper.httpStatusOf(error);
9
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/status/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAElE,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEpE,kFAAkF;AAClF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,KAAc,EAAiB,EAAE,CAAC,eAAe,CAAC,YAAY,CAAC,KAAK,CAAC,CAAA"}
@@ -0,0 +1,3 @@
1
+ import type { ClientMarker } from './types.js';
2
+ export declare const parseClientMarker: (text: string) => ClientMarker | null;
3
+ //# sourceMappingURL=marker.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"marker.d.ts","sourceRoot":"","sources":["../../src/status/marker.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAE9C,eAAO,MAAM,iBAAiB,SAAU,MAAM,KAAG,YAAY,GAAG,IAa/D,CAAA"}
@@ -0,0 +1,16 @@
1
+ /** Read the first `api:client:*` marker in a text, or `null` when it carries none. */
2
+ import { MARKER, NAMED_STATUS } from './consts.local.js';
3
+ export const parseClientMarker = (text) => {
4
+ const match = MARKER.exec(text);
5
+ if (match == null) {
6
+ return null;
7
+ }
8
+ const [, named, coded, legacy, id] = match;
9
+ const code = named != null ? NAMED_STATUS[named] : Number(coded ?? legacy);
10
+ return {
11
+ status: code >= 100 && code <= 599 ? code : undefined,
12
+ // `error` is the placeholder a marker gets when no incident id was known.
13
+ incidentId: id != null && id !== 'error' ? id : undefined,
14
+ };
15
+ };
16
+ //# sourceMappingURL=marker.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"marker.js","sourceRoot":"","sources":["../../src/status/marker.ts"],"names":[],"mappings":"AACA,sFAAsF;AACtF,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAGxD,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAuB,EAAE;IACrE,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC/B,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAClB,OAAO,IAAI,CAAA;IACb,CAAC;IACD,MAAM,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,GAAG,KAAK,CAAA;IAC1C,MAAM,IAAI,GAAG,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,CAAA;IAE1E,OAAO;QACL,MAAM,EAAE,IAAI,IAAI,GAAG,IAAI,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;QACrD,0EAA0E;QAC1E,UAAU,EAAE,EAAE,IAAI,IAAI,IAAI,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS;KAC1D,CAAA;AACH,CAAC,CAAA"}
@@ -0,0 +1,35 @@
1
+ /** The HTTP status the API client stamps on an error it rebuilt from a response body. */
2
+ export interface ResponseStatusCarrier {
3
+ responseStatus?: number;
4
+ denialKind?: string;
5
+ }
6
+ /** What an `api:client:*` marker states. */
7
+ export interface ClientMarker {
8
+ status?: number;
9
+ incidentId?: string;
10
+ }
11
+ /** Reads the HTTP status, the incident id and the denial kind a failed call carries. */
12
+ export interface ApiStatusHelper {
13
+ /** True only for a server-labelled auth/IAM refusal, never an unrelated 403. */
14
+ isAccessDenied: (error: unknown) => boolean;
15
+ /**
16
+ * The HTTP status an error answers to, or `null` when nothing states one.
17
+ *
18
+ * Read in order: the status the API client stamped on the error it rebuilt from a response
19
+ * (`responseStatus`); the status an `ApiClientError` parsed from its marker; the `httpStatus` its
20
+ * class declares — a 4xx always, a 5xx only with `allowServerErrorStatus`, exactly what an
21
+ * `@owlmeans/server-api` boundary answers with; finally an `api:client:*` marker in the message or
22
+ * the type of anything else. This is what lets a browser recognise a refusal from its status
23
+ * alone when a production body carries nothing but an incident id.
24
+ */
25
+ httpStatusOf: (error: unknown) => number | null;
26
+ /** The server's incident id carried by an error — its own field, else its marker — or `null`. */
27
+ incidentIdOf: (error: unknown) => string | null;
28
+ /**
29
+ * Whether a response body is a production incident body — the bare incident UUID an
30
+ * `@owlmeans/server-api` boundary sends instead of the marshaled error. A development body
31
+ * carries the `ResilientError` separator and is never one.
32
+ */
33
+ isIncidentBody: (data: unknown) => data is string;
34
+ }
35
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/status/types.ts"],"names":[],"mappings":"AAAA,yFAAyF;AACzF,MAAM,WAAW,qBAAqB;IACpC,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,4CAA4C;AAC5C,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,wFAAwF;AACxF,MAAM,WAAW,eAAe;IAC9B,gFAAgF;IAChF,cAAc,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAA;IAC3C;;;;;;;;;OASG;IACH,YAAY,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,MAAM,GAAG,IAAI,CAAA;IAC/C,iGAAiG;IACjG,YAAY,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,MAAM,GAAG,IAAI,CAAA;IAC/C;;;;OAIG;IACH,cAAc,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,IAAI,MAAM,CAAA;CAClD"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/status/types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,6 @@
1
+ import { BasicClientConfig } from '@owlmeans/client-config';
2
+ import type { BasicContext } from '@owlmeans/context';
3
+ export type Config = BasicClientConfig;
4
+ export interface Context<C extends Config = Config> extends BasicContext<C> {
5
+ }
6
+ //# sourceMappingURL=types.local.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.local.d.ts","sourceRoot":"","sources":["../src/types.local.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,MAAM,MAAM,MAAM,GAAG,iBAAiB,CAAA;AAEtC,MAAM,WAAW,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,YAAY,CAAC,CAAC,CAAC;CAC1E"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=types.local.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.local.js","sourceRoot":"","sources":["../src/types.local.ts"],"names":[],"mappings":""}
@@ -0,0 +1,36 @@
1
+ import type { RouteMethod } from '@owlmeans/route';
2
+ export interface RequestBody {
3
+ /** What axios is handed as `data`. */
4
+ data: unknown;
5
+ /** A `content-type` the request lacked and must carry. */
6
+ contentType?: string;
7
+ /** `data` is final text — axios must not transform it again. */
8
+ verbatim: boolean;
9
+ }
10
+ /** How a request's body travels: its content type and the text a scalar body becomes. */
11
+ export interface BodyUtils {
12
+ /** The request's own `content-type`, whatever case its key is written in. */
13
+ contentTypeOf: (headers?: Record<string, unknown>) => string | undefined;
14
+ /** `application/json` or a `+json` suffix type, with or without parameters. */
15
+ isJsonContentType: (type?: string) => boolean;
16
+ /**
17
+ * The JSON text a scalar body travels as, so the server parses it back to the same value.
18
+ *
19
+ * A number or a boolean is `JSON.stringify`'d. A string is a value unless it is already JSON text:
20
+ * one that does not parse is quoted; one that parses is sent as it is (the caller serialized it
21
+ * itself) — except under a body schema of `type: 'string'`, where only a JSON string literal
22
+ * counts as serialized and `123`, `true` or `{…}` are the text the caller means.
23
+ */
24
+ jsonScalarBody: (body: string | number | boolean, schema?: object) => string;
25
+ /**
26
+ * What a request's body becomes on the wire.
27
+ *
28
+ * - A `x-www-form-urlencoded` request: the body through `qs`.
29
+ * - A string, number or boolean under a JSON `content-type` — the caller's, or `application/json`
30
+ * supplied for a `POST` that names none — becomes JSON text ({@link BodyUtils.jsonScalarBody}).
31
+ * - Anything else — objects, arrays, a scalar under another content type — goes to axios as it is,
32
+ * which serializes an object or an array as JSON.
33
+ */
34
+ requestBodyOf: (body: unknown, headers: Record<string, unknown> | undefined, method?: RouteMethod, schema?: object) => RequestBody;
35
+ }
36
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/utils/body/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAElD,MAAM,WAAW,WAAW;IAC1B,sCAAsC;IACtC,IAAI,EAAE,OAAO,CAAA;IACb,0DAA0D;IAC1D,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gEAAgE;IAChE,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED,yFAAyF;AACzF,MAAM,WAAW,SAAS;IACxB,6EAA6E;IAC7E,aAAa,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,MAAM,GAAG,SAAS,CAAA;IACxE,+EAA+E;IAC/E,iBAAiB,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,KAAK,OAAO,CAAA;IAC7C;;;;;;;OAOG;IACH,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;IAC5E;;;;;;;;OAQG;IACH,aAAa,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,EAAE,MAAM,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,WAAW,CAAA;CACnI"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/utils/body/types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ import type { BodyUtils } from './body/types.js';
2
+ export declare const createBodyUtils: () => BodyUtils;
3
+ export declare const bodyUtils: BodyUtils;
4
+ //# sourceMappingURL=body.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"body.d.ts","sourceRoot":"","sources":["../../src/utils/body.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAe,MAAM,iBAAiB,CAAA;AAE7D,eAAO,MAAM,eAAe,QAAO,SA6DlC,CAAA;AAED,eAAO,MAAM,SAAS,WAAoB,CAAA"}
@@ -0,0 +1,56 @@
1
+ import qs from 'qs';
2
+ import { RouteMethod } from '@owlmeans/route';
3
+ import { FORM_CONTENT_TYPE } from './consts.local.js';
4
+ import { JSON_CONTENT_TYPE } from './consts.js';
5
+ export const createBodyUtils = () => {
6
+ const contentTypeOf = (headers) => {
7
+ const value = Object.entries(headers ?? {}).find(([key]) => key.toLowerCase() === 'content-type')?.[1];
8
+ if (value == null || value === '') {
9
+ return undefined;
10
+ }
11
+ return Array.isArray(value) ? value.join(', ') : `${value}`;
12
+ };
13
+ const isJsonContentType = (type) => type != null && /^application\/(?:[^\s;]+\+)?json\s*(?:;|$)/i.test(type.trim());
14
+ /** A JSON value no serializer quotes for us: a string, a number or a boolean. */
15
+ const isScalar = (value) => typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean';
16
+ /** Does the entrypoint's body schema declare a string? */
17
+ const stringContract = (schema) => {
18
+ const type = schema?.type;
19
+ return (Array.isArray(type) ? type : [type]).includes('string');
20
+ };
21
+ const parse = (text) => {
22
+ try {
23
+ return { json: true, value: JSON.parse(text) };
24
+ }
25
+ catch {
26
+ return { json: false };
27
+ }
28
+ };
29
+ const jsonScalarBody = (body, schema) => {
30
+ if (typeof body !== 'string') {
31
+ return JSON.stringify(body);
32
+ }
33
+ const parsed = parse(body);
34
+ const serialized = parsed.json && (!stringContract(schema) || typeof parsed.value === 'string');
35
+ return serialized ? body : JSON.stringify(body);
36
+ };
37
+ const requestBodyOf = (body, headers, method, schema) => {
38
+ const type = contentTypeOf(headers);
39
+ if (body != null && type?.includes(FORM_CONTENT_TYPE) === true) {
40
+ return { data: qs.stringify(body), verbatim: false };
41
+ }
42
+ if (!isScalar(body)) {
43
+ return { data: body, verbatim: false };
44
+ }
45
+ if (type == null && method === RouteMethod.POST) {
46
+ return { data: jsonScalarBody(body, schema), contentType: JSON_CONTENT_TYPE, verbatim: true };
47
+ }
48
+ if (isJsonContentType(type)) {
49
+ return { data: jsonScalarBody(body, schema), verbatim: true };
50
+ }
51
+ return { data: body, verbatim: false };
52
+ };
53
+ return { contentTypeOf, isJsonContentType, jsonScalarBody, requestBodyOf };
54
+ };
55
+ export const bodyUtils = createBodyUtils();
56
+ //# sourceMappingURL=body.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"body.js","sourceRoot":"","sources":["../../src/utils/body.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAA;AACnB,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAG/C,MAAM,CAAC,MAAM,eAAe,GAAG,GAAc,EAAE;IAC7C,MAAM,aAAa,GAAG,CAAC,OAAiC,EAAsB,EAAE;QAC9E,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QACtG,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;YAClC,OAAO,SAAS,CAAA;QAClB,CAAC;QACD,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,EAAE,CAAA;IAC7D,CAAC,CAAA;IAED,MAAM,iBAAiB,GAAG,CAAC,IAAa,EAAW,EAAE,CACnD,IAAI,IAAI,IAAI,IAAI,6CAA6C,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;IAEjF,iFAAiF;IACjF,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAsC,EAAE,CACtE,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,SAAS,CAAA;IAEtF,0DAA0D;IAC1D,MAAM,cAAc,GAAG,CAAC,MAAe,EAAW,EAAE;QAClD,MAAM,IAAI,GAAI,MAAyC,EAAE,IAAI,CAAA;QAC7D,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;IACjE,CAAC,CAAA;IAED,MAAM,KAAK,GAAG,CAAC,IAAY,EAAoD,EAAE;QAC/E,IAAI,CAAC;YACH,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAA;QAChD,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;QACxB,CAAC;IACH,CAAC,CAAA;IAED,MAAM,cAAc,GAAG,CAAC,IAA+B,EAAE,MAAe,EAAU,EAAE;QAClF,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QAC7B,CAAC;QACD,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,CAAA;QAC1B,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAA;QAE/F,OAAO,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;IACjD,CAAC,CAAA;IAED,MAAM,aAAa,GAAG,CACpB,IAAa,EAAE,OAA4C,EAAE,MAAoB,EAAE,MAAe,EACrF,EAAE;QACf,MAAM,IAAI,GAAG,aAAa,CAAC,OAAO,CAAC,CAAA;QACnC,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,EAAE,QAAQ,CAAC,iBAAiB,CAAC,KAAK,IAAI,EAAE,CAAC;YAC/D,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAA;QACtD,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACpB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAA;QACxC,CAAC;QACD,IAAI,IAAI,IAAI,IAAI,IAAI,MAAM,KAAK,WAAW,CAAC,IAAI,EAAE,CAAC;YAChD,OAAO,EAAE,IAAI,EAAE,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,WAAW,EAAE,iBAAiB,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAA;QAC/F,CAAC;QACD,IAAI,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5B,OAAO,EAAE,IAAI,EAAE,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAA;QAC/D,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAA;IACxC,CAAC,CAAA;IAED,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,cAAc,EAAE,aAAa,EAAE,CAAA;AAC5E,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,SAAS,GAAG,eAAe,EAAE,CAAA"}
@@ -0,0 +1,2 @@
1
+ export declare const JSON_CONTENT_TYPE = "application/json";
2
+ //# sourceMappingURL=consts.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"consts.d.ts","sourceRoot":"","sources":["../../src/utils/consts.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,iBAAiB,qBAAqB,CAAA"}
@@ -0,0 +1,2 @@
1
+ export const JSON_CONTENT_TYPE = 'application/json';
2
+ //# sourceMappingURL=consts.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"consts.js","sourceRoot":"","sources":["../../src/utils/consts.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,iBAAiB,GAAG,kBAAkB,CAAA"}
@@ -0,0 +1,2 @@
1
+ export declare const FORM_CONTENT_TYPE = "application/x-www-form-urlencoded";
2
+ //# sourceMappingURL=consts.local.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"consts.local.d.ts","sourceRoot":"","sources":["../../src/utils/consts.local.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,iBAAiB,sCAAsC,CAAA"}
@@ -0,0 +1,2 @@
1
+ export const FORM_CONTENT_TYPE = 'application/x-www-form-urlencoded';
2
+ //# sourceMappingURL=consts.local.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"consts.local.js","sourceRoot":"","sources":["../../src/utils/consts.local.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,iBAAiB,GAAG,mCAAmC,CAAA"}
@@ -1 +1 @@
1
- {"version":3,"file":"handler.d.ts","sourceRoot":"","sources":["../../src/utils/handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAE5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAK1C,eAAO,MAAM,eAAe,aAAc,aAAa,SAAS,gBAAgB,CAAC,GAAG,CAAC,SAyCpF,CAAA"}
1
+ {"version":3,"file":"handler.d.ts","sourceRoot":"","sources":["../../src/utils/handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAE5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAK1C,eAAO,MAAM,eAAe,GAAI,UAAU,aAAa,EAAE,OAAO,gBAAgB,CAAC,GAAG,CAAC,SAyCpF,CAAA"}
@@ -1,2 +1,3 @@
1
- export * from './handler.js';
1
+ export type * from './response/types.js';
2
+ export * from './response.js';
2
3
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AACA,cAAc,cAAc,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AACA,mBAAmB,qBAAqB,CAAA;AACxC,cAAc,eAAe,CAAA"}
@@ -1,2 +1,2 @@
1
- export * from './handler.js';
1
+ export * from './response.js';
2
2
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AACA,cAAc,cAAc,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAEA,cAAc,eAAe,CAAA"}
@@ -0,0 +1,15 @@
1
+ import type { AbstractResponse } from '@owlmeans/entrypoint';
2
+ import type { AxiosResponse } from 'axios';
3
+ import type { ApiClientError } from '../../errors.js';
4
+ /** Turns an axios answer into the entrypoint reply: a resolved value or a typed failure. */
5
+ export interface ResponseUtils {
6
+ /** Resolves `reply` with a 2xx answer's value, or rejects it with the failure of any other status. */
7
+ processResponse: (response: AxiosResponse, reply: AbstractResponse<any>) => void;
8
+ /**
9
+ * The typed error of a bare status: `ServerCrashedError` (500), `ServerAuthError` (401),
10
+ * `ApiClientError('forbidden[:<id>]')` (403), `ApiStatusError` (`api:client:status:<n>[:<id>]`)
11
+ * for every other one.
12
+ */
13
+ statusError: (status: number, incidentId?: string) => ApiClientError;
14
+ }
15
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/utils/response/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAC5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAC1C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAErD,4FAA4F;AAC5F,MAAM,WAAW,aAAa;IAC5B,sGAAsG;IACtG,eAAe,EAAE,CAAC,QAAQ,EAAE,aAAa,EAAE,KAAK,EAAE,gBAAgB,CAAC,GAAG,CAAC,KAAK,IAAI,CAAA;IAChF;;;;OAIG;IACH,WAAW,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,cAAc,CAAA;CACrE"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/utils/response/types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ import type { ResponseUtils } from './response/types.js';
2
+ export declare const createResponseUtils: () => ResponseUtils;
3
+ export declare const responseUtils: ResponseUtils;
4
+ //# sourceMappingURL=response.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../src/utils/response.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAExD,eAAO,MAAM,mBAAmB,QAAO,aAqGtC,CAAA;AAED,eAAO,MAAM,aAAa,eAAwB,CAAA"}
@@ -0,0 +1,99 @@
1
+ import { EntrypointOutcome } from '@owlmeans/entrypoint';
2
+ import { ACCEPTED, CREATED, FINISHED, FORBIDDEN_ERROR, INCIDENT_ID_HEADER, DENIAL_KIND_HEADER, ACCESS_DENIED_KIND, OK, SERVER_ERROR, UNAUTHORIZED_ERROR, } from '../consts.js';
3
+ import { ResilientError } from '@owlmeans/error';
4
+ import { ApiClientError, ApiStatusError, ServerAuthError, ServerCrashedError } from '../errors.js';
5
+ import { apiStatusHelper } from '../status/helper.js';
6
+ import { logger } from '@owlmeans/log';
7
+ export const createResponseUtils = () => {
8
+ const log = logger('api');
9
+ const processResponse = (response, reply) => {
10
+ switch (response.status) {
11
+ case OK:
12
+ reply.resolve(response.data, EntrypointOutcome.Ok);
13
+ return;
14
+ case ACCEPTED:
15
+ reply.resolve(response.data, EntrypointOutcome.Accepted);
16
+ return;
17
+ case CREATED:
18
+ return processEmptyResponse(response, reply, EntrypointOutcome.Created);
19
+ case FINISHED:
20
+ return processEmptyResponse(response, reply, EntrypointOutcome.Finished);
21
+ default:
22
+ // A refusal is ordinary traffic (401, 403, 409, 428): debug, and never the headers.
23
+ log.debug('Request answered with a failure', {
24
+ status: response.status, statusText: response.statusText, url: response.config?.url,
25
+ incidentId: headerOf(response.headers, INCIDENT_ID_HEADER),
26
+ });
27
+ reply.reject(failureOf(response));
28
+ }
29
+ };
30
+ /**
31
+ * The error a non-2xx answer rejects with — always carrying the HTTP status and, when the server
32
+ * sent one, its incident id.
33
+ *
34
+ * A development body is the marshaled `ResilientError`: it is rebuilt into its own class and
35
+ * stamped with `responseStatus`. Anything else — the bare incident id of a production body, a
36
+ * proxy's HTML, a framework's JSON — becomes the status error of {@link statusError}.
37
+ */
38
+ const failureOf = (response) => {
39
+ const incidentId = headerOf(response.headers, INCIDENT_ID_HEADER)
40
+ ?? (apiStatusHelper.isIncidentBody(response.data) ? response.data.trim() : undefined);
41
+ const denialKind = response.status === FORBIDDEN_ERROR
42
+ && headerOf(response.headers, DENIAL_KIND_HEADER) === ACCESS_DENIED_KIND
43
+ ? ACCESS_DENIED_KIND : undefined;
44
+ if (typeof response.data === 'string' && response.data.includes(ResilientError.separator)) {
45
+ try {
46
+ const error = ResilientError.ensure(response.data, true);
47
+ error.incidentId ??= incidentId;
48
+ Object.assign(error, {
49
+ responseStatus: response.status, denialKind,
50
+ });
51
+ return error;
52
+ }
53
+ catch {
54
+ log.warn('Server returned an unrecognizable text error', { status: response.status, body: response.data });
55
+ }
56
+ }
57
+ return Object.assign(statusError(response.status, incidentId), { denialKind });
58
+ };
59
+ /**
60
+ * The typed error of a bare status: `ServerCrashedError` (500), `ServerAuthError` (401),
61
+ * `ApiClientError('forbidden[:<id>]')` (403), `ApiStatusError` (`api:client:status:<n>[:<id>]`)
62
+ * for every other one.
63
+ */
64
+ const statusError = (status, incidentId) => {
65
+ const error = status === SERVER_ERROR ? new ServerCrashedError(incidentId)
66
+ : status === UNAUTHORIZED_ERROR ? new ServerAuthError(incidentId)
67
+ : status === FORBIDDEN_ERROR ? new ApiClientError(incidentId != null ? `forbidden:${incidentId}` : 'forbidden')
68
+ : new ApiStatusError(status, incidentId);
69
+ if (incidentId != null) {
70
+ error.incidentId = incidentId;
71
+ }
72
+ return Object.assign(error, { responseStatus: status });
73
+ };
74
+ /** One response header, from an `AxiosHeaders` instance or a plain header object alike. */
75
+ const headerOf = (headers, name) => {
76
+ if (headers == null || typeof headers !== 'object') {
77
+ return undefined;
78
+ }
79
+ const get = headers.get;
80
+ const viaGet = typeof get === 'function' ? get.call(headers, name) : undefined;
81
+ const value = viaGet ?? Object.entries(headers).find(([key]) => key.toLowerCase() === name.toLowerCase())?.[1];
82
+ const first = Array.isArray(value) ? value[0] : value;
83
+ return typeof first === 'string' && first.trim() !== '' ? first.trim() : undefined;
84
+ };
85
+ const processEmptyResponse = (response, reply, outcome) => {
86
+ if (response.data != null && response.data != '') {
87
+ reply.resolve(response.data, outcome);
88
+ return;
89
+ }
90
+ if (response.headers.toJSON != null && typeof response.headers.toJSON === 'function') {
91
+ reply.resolve(response.headers.toJSON(), outcome);
92
+ return;
93
+ }
94
+ reply.resolve(response.headers, outcome);
95
+ };
96
+ return { processResponse, statusError };
97
+ };
98
+ export const responseUtils = createResponseUtils();
99
+ //# sourceMappingURL=response.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"response.js","sourceRoot":"","sources":["../../src/utils/response.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyB,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAE/E,OAAO,EACL,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,kBAAkB,EAAE,kBAAkB,EACpF,kBAAkB,EAAE,EAAE,EAAE,YAAY,EAAE,kBAAkB,GACzD,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAClG,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAErD,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAGtC,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAkB,EAAE;IACrD,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;IAEzB,MAAM,eAAe,GAAG,CAAC,QAAuB,EAAE,KAA4B,EAAQ,EAAE;QACtF,QAAQ,QAAQ,CAAC,MAAM,EAAE,CAAC;YACxB,KAAK,EAAE;gBACL,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC,EAAE,CAAC,CAAA;gBAClD,OAAM;YACR,KAAK,QAAQ;gBACX,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAA;gBACxD,OAAM;YACR,KAAK,OAAO;gBACV,OAAO,oBAAoB,CAAC,QAAQ,EAAE,KAAK,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAA;YACzE,KAAK,QAAQ;gBACX,OAAO,oBAAoB,CAAC,QAAQ,EAAE,KAAK,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAA;YAC1E;gBACE,oFAAoF;gBACpF,GAAG,CAAC,KAAK,CAAC,iCAAiC,EAAE;oBAC3C,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE,QAAQ,CAAC,MAAM,EAAE,GAAG;oBACnF,UAAU,EAAE,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,CAAC;iBAC3D,CAAC,CAAA;gBAEF,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAA;QACrC,CAAC;IACH,CAAC,CAAA;IAED;;;;;;;OAOG;IACH,MAAM,SAAS,GAAG,CAAC,QAAuB,EAAS,EAAE;QACnD,MAAM,UAAU,GAAG,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,CAAC;eAC5D,CAAC,eAAe,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;QACvF,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,KAAK,eAAe;eACjD,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,CAAC,KAAK,kBAAkB;YACxE,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAA;QAElC,IAAI,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ,IAAI,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1F,IAAI,CAAC;gBACH,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;gBACxD,KAAK,CAAC,UAAU,KAAK,UAAU,CAAA;gBAC/B,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE;oBACnB,cAAc,EAAE,QAAQ,CAAC,MAAM,EAAE,UAAU;iBACZ,CAAC,CAAA;gBAElC,OAAO,KAAK,CAAA;YACd,CAAC;YAAC,MAAM,CAAC;gBACP,GAAG,CAAC,IAAI,CAAC,8CAA8C,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;YAC5G,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,EAAE,UAAU,EAAE,CAAC,CAAA;IAChF,CAAC,CAAA;IAED;;;;OAIG;IACH,MAAM,WAAW,GAAG,CAAC,MAAc,EAAE,UAAmB,EAAkB,EAAE;QAC1E,MAAM,KAAK,GAAG,MAAM,KAAK,YAAY,CAAC,CAAC,CAAC,IAAI,kBAAkB,CAAC,UAAU,CAAC;YACxE,CAAC,CAAC,MAAM,KAAK,kBAAkB,CAAC,CAAC,CAAC,IAAI,eAAe,CAAC,UAAU,CAAC;gBAC/D,CAAC,CAAC,MAAM,KAAK,eAAe,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,aAAa,UAAU,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC;oBAC7G,CAAC,CAAC,IAAI,cAAc,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;QAC9C,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;YACvB,KAAK,CAAC,UAAU,GAAG,UAAU,CAAA;QAC/B,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,cAAc,EAAE,MAAM,EAAkC,CAAC,CAAA;IACzF,CAAC,CAAA;IAED,2FAA2F;IAC3F,MAAM,QAAQ,GAAG,CAAC,OAAgB,EAAE,IAAY,EAAsB,EAAE;QACtE,IAAI,OAAO,IAAI,IAAI,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YACnD,OAAO,SAAS,CAAA;QAClB,CAAC;QACD,MAAM,GAAG,GAAI,OAA6B,CAAC,GAAG,CAAA;QAC9C,MAAM,MAAM,GAAG,OAAO,GAAG,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QAC9E,MAAM,KAAK,GAAG,MAAM,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QAC9G,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;QAErD,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;IACpF,CAAC,CAAA;IAED,MAAM,oBAAoB,GAAG,CAAC,QAAuB,EAAE,KAA4B,EAAE,OAA0B,EAAQ,EAAE;QACvH,IAAI,QAAQ,CAAC,IAAI,IAAI,IAAI,IAAI,QAAQ,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC;YACjD,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;YACrC,OAAM;QACR,CAAC;QACD,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,IAAI,IAAI,IAAI,OAAO,QAAQ,CAAC,OAAO,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YACrF,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,OAAO,CAAC,CAAA;YACjD,OAAM;QACR,CAAC;QACD,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAC1C,CAAC,CAAA;IAED,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,CAAA;AACzC,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,aAAa,GAAG,mBAAmB,EAAE,CAAA"}
package/package.json CHANGED
@@ -1,12 +1,13 @@
1
1
  {
2
2
  "name": "@owlmeans/api",
3
- "version": "0.1.18-rc.9",
3
+ "version": "0.1.18",
4
4
  "license": "MIT",
5
5
  "type": "module",
6
6
  "scripts": {
7
7
  "build": "tsc -b",
8
8
  "dev": "sleep 0 && nodemon -e ts,tsx,json --watch src --exec \"tsc -p ./tsconfig.json\"",
9
- "watch": "tsc -b -w --preserveWatchOutput --pretty"
9
+ "watch": "tsc -b -w --preserveWatchOutput --pretty",
10
+ "test": "bun test ./tests"
10
11
  },
11
12
  "main": "build/index.js",
12
13
  "module": "build/index.js",
@@ -18,23 +19,32 @@
18
19
  "default": "./build/index.js",
19
20
  "module": "./build/index.js",
20
21
  "types": "./build/index.d.ts"
22
+ },
23
+ "./status": {
24
+ "import": "./build/status/index.js",
25
+ "require": "./build/status/index.js",
26
+ "default": "./build/status/index.js",
27
+ "module": "./build/status/index.js",
28
+ "types": "./build/status/index.d.ts"
21
29
  }
22
30
  },
23
31
  "dependencies": {
24
- "@owlmeans/auth-common": "^0.1.18-rc.9",
25
- "@owlmeans/client-config": "^0.1.18-rc.8",
26
- "@owlmeans/client-route": "^0.1.18-rc.9",
27
- "@owlmeans/config": "^0.1.18-rc.8",
28
- "@owlmeans/context": "^0.1.18-rc.6",
29
- "@owlmeans/error": "^0.1.18-rc.6",
30
- "@owlmeans/entrypoint": "^0.1.18-rc.8",
31
- "@owlmeans/route": "^0.1.18-rc.6",
32
- "axios": "^1.7.7",
33
- "qs": "^6.13.0"
32
+ "@owlmeans/auth-common": "^0.1.18",
33
+ "@owlmeans/client-config": "^0.1.18",
34
+ "@owlmeans/client-route": "^0.1.18",
35
+ "@owlmeans/config": "^0.1.18",
36
+ "@owlmeans/context": "^0.1.18",
37
+ "@owlmeans/entrypoint": "^0.1.18",
38
+ "@owlmeans/error": "^0.1.18",
39
+ "@owlmeans/log": "^0.1.18",
40
+ "@owlmeans/route": "^0.1.18",
41
+ "axios": "^1.20.0",
42
+ "qs": "^6.16.0"
34
43
  },
35
44
  "devDependencies": {
36
- "@owlmeans/dep-config": "workspace:*",
37
- "@types/qs": "^6.9.16",
45
+ "@owlmeans/dep-config": "^0.1.18",
46
+ "@owlmeans/resource": "^0.1.18",
47
+ "@types/qs": "^6.15.1",
38
48
  "nodemon": "^3.1.14",
39
49
  "typescript": "^7.0.2"
40
50
  },
package/src/consts.ts CHANGED
@@ -13,6 +13,14 @@ export const ACCEPTED = 202
13
13
 
14
14
  export const FINISHED = 204
15
15
 
16
+ /**
17
+ * The response header an `@owlmeans/server-api` boundary puts its incident id in — the key to the
18
+ * server log entry that owns a failure's full detail.
19
+ */
20
+ export const INCIDENT_ID_HEADER = 'X-Incident-ID'
21
+ export const DENIAL_KIND_HEADER = 'X-OwlMeans-Denial'
22
+ export const ACCESS_DENIED_KIND = 'access-denied'
23
+
16
24
  export const DEFAULT_ALIAS = 'web-client'
17
25
 
18
26
  export const protocols = ['http', 'https', 'wss', 'ws']