@aligent/microservice-util-lib 1.5.0 → 1.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aligent/microservice-util-lib",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "A set of utility functions for Aligent Microservices",
   "type": "commonjs",
   "main": "./src/index.js",
@@ -15,7 +15,8 @@
     "@aws-sdk/client-ssm": "^3.922.0",
     "oauth-sign": "^0.9.0",
     "object-hash": "^3.0.0",
-    "openapi-fetch": "^0.17.0"
+    "openapi-fetch": "^0.17.0",
+    "openapi-typescript-helpers": "0.1.0"
   },
   "author": "Aligent",
   "license": "MIT",

package/src/index.d.ts

@@ -5,8 +5,10 @@ import hasDefinedProperties from './has-properties-defined/has-properties-define
 import { ApiKey, Basic, OAuth10a, OAuth20, apiKeyAuthMiddleware, basicAuthMiddleware, oAuth10aAuthMiddleware, oAuth20AuthMiddleware, resignOauth10aRequest } from './openapi-fetch-middlewares/authentications';
 import { LogLevel, Logger, logMiddleware } from './openapi-fetch-middlewares/log';
 import { RetryConfig as RetryMiddlewareConfig, retryMiddleware } from './openapi-fetch-middlewares/retry';
+import { ErrorThrowingClient, asErrorThrowingClient } from './openapi-fetch-middlewares/throwing-client';
+import { HttpResponseError, isHttpResponseError } from './openapi-fetch-middlewares/utils/http-response-error';
 import remap, { ObjectMap, Remap } from './remap/remap';
 import retryWrapper, { RetryConfig } from './retry-wrapper/retry-wrapper';
 import S3Dao from './s3/s3';
-export type { ApiKey, Basic, LogLevel, Logger, OAuth10a, OAuth20, ObjectMap, Remap, RetryConfig, RetryMiddlewareConfig, S3Dao, };
-export { apiKeyAuthMiddleware, basicAuthMiddleware, chunkBy, fetchSsmParams, getAwsIdFromArn, hasDefinedProperties, logMiddleware, oAuth10aAuthMiddleware, oAuth20AuthMiddleware, remap, resignOauth10aRequest, retryMiddleware, retryWrapper, };
+export type { ApiKey, Basic, ErrorThrowingClient, LogLevel, Logger, OAuth10a, OAuth20, ObjectMap, Remap, RetryConfig, RetryMiddlewareConfig, S3Dao, };
+export { HttpResponseError, apiKeyAuthMiddleware, asErrorThrowingClient, basicAuthMiddleware, chunkBy, fetchSsmParams, getAwsIdFromArn, hasDefinedProperties, isHttpResponseError, logMiddleware, oAuth10aAuthMiddleware, oAuth20AuthMiddleware, remap, resignOauth10aRequest, retryMiddleware, retryWrapper, };

package/src/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.retryWrapper = exports.retryMiddleware = exports.resignOauth10aRequest = exports.remap = exports.oAuth20AuthMiddleware = exports.oAuth10aAuthMiddleware = exports.logMiddleware = exports.hasDefinedProperties = exports.getAwsIdFromArn = exports.fetchSsmParams = exports.chunkBy = exports.basicAuthMiddleware = exports.apiKeyAuthMiddleware = void 0;
+exports.retryWrapper = exports.retryMiddleware = exports.resignOauth10aRequest = exports.remap = exports.oAuth20AuthMiddleware = exports.oAuth10aAuthMiddleware = exports.logMiddleware = exports.isHttpResponseError = exports.hasDefinedProperties = exports.getAwsIdFromArn = exports.fetchSsmParams = exports.chunkBy = exports.basicAuthMiddleware = exports.asErrorThrowingClient = exports.apiKeyAuthMiddleware = exports.HttpResponseError = void 0;
 /* v8 ignore start */
 const chunk_by_1 = __importDefault(require("./chunk-by/chunk-by"));
 exports.chunkBy = chunk_by_1.default;
@@ -23,6 +23,11 @@ const log_1 = require("./openapi-fetch-middlewares/log");
 Object.defineProperty(exports, "logMiddleware", { enumerable: true, get: function () { return log_1.logMiddleware; } });
 const retry_1 = require("./openapi-fetch-middlewares/retry");
 Object.defineProperty(exports, "retryMiddleware", { enumerable: true, get: function () { return retry_1.retryMiddleware; } });
+const throwing_client_1 = require("./openapi-fetch-middlewares/throwing-client");
+Object.defineProperty(exports, "asErrorThrowingClient", { enumerable: true, get: function () { return throwing_client_1.asErrorThrowingClient; } });
+const http_response_error_1 = require("./openapi-fetch-middlewares/utils/http-response-error");
+Object.defineProperty(exports, "HttpResponseError", { enumerable: true, get: function () { return http_response_error_1.HttpResponseError; } });
+Object.defineProperty(exports, "isHttpResponseError", { enumerable: true, get: function () { return http_response_error_1.isHttpResponseError; } });
 const remap_1 = __importDefault(require("./remap/remap"));
 exports.remap = remap_1.default;
 const retry_wrapper_1 = __importDefault(require("./retry-wrapper/retry-wrapper"));

package/src/openapi-fetch-middlewares/throwing-client.d.ts

@@ -0,0 +1,24 @@
+import type { Client } from 'openapi-fetch';
+import type { MediaType } from 'openapi-typescript-helpers';
+/**
+ * A Client whose HTTP methods return only the success branch
+ * ({ data: D; response: Response }), reflecting the runtime contract
+ * when retryMiddleware is registered with throwOnNotOk: true (the default).
+ *
+ * Errors are thrown as HttpResponseError, never returned in the union.
+ */
+export type ErrorThrowingClient<Paths extends Record<string, unknown>, Media extends MediaType = MediaType> = {
+    [K in keyof Client<Paths, Media>]: Client<Paths, Media>[K] extends (...args: infer A) => Promise<infer R> ? (...args: A) => Promise<Extract<R, {
+        error?: never;
+    }>> : Client<Paths, Media>[K];
+};
+/**
+ * Cast an openapi-fetch Client to an ErrorThrowingClient.
+ *
+ * Use this after registering retryMiddleware (with default throwOnNotOk: true),
+ * which throws HttpResponseError on !response.ok and makes the error branch
+ * of the discriminated union unreachable. Zero runtime cost — purely a type narrowing.
+ *
+ * WARNING: Do not use if retryMiddleware is configured with throwOnNotOk: false.
+ */
+export declare function asErrorThrowingClient<Paths extends Record<string, unknown>, Media extends MediaType = MediaType>(client: Client<Paths, Media>): ErrorThrowingClient<Paths, Media>;

package/src/openapi-fetch-middlewares/throwing-client.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.asErrorThrowingClient = asErrorThrowingClient;
+/**
+ * Cast an openapi-fetch Client to an ErrorThrowingClient.
+ *
+ * Use this after registering retryMiddleware (with default throwOnNotOk: true),
+ * which throws HttpResponseError on !response.ok and makes the error branch
+ * of the discriminated union unreachable. Zero runtime cost — purely a type narrowing.
+ *
+ * WARNING: Do not use if retryMiddleware is configured with throwOnNotOk: false.
+ */
+function asErrorThrowingClient(client) {
+    return client;
+}