@aws-sdk/util-endpoints 3.197.0 → 3.200.0

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.200.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.199.0...v3.200.0) (2022-10-31)
+
+**Note:** Version bump only for package @aws-sdk/util-endpoints
+
+
+
+
+
+# [3.198.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.197.0...v3.198.0) (2022-10-27)
+
+
+### Features
+
+* **endpoint:** log endpoint decisions at debug level ([#4106](https://github.com/aws/aws-sdk-js-v3/issues/4106)) ([d600213](https://github.com/aws/aws-sdk-js-v3/commit/d600213292eb1bea870c43420367f78406db1c82))
+
+
+
+
+
 # [3.197.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.196.0...v3.197.0) (2022-10-26)
 
 **Note:** Version bump only for package @aws-sdk/util-endpoints

package/dist-cjs/debug/debugId.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.debugId = void 0;
+exports.debugId = "endpoints";

package/dist-cjs/debug/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./debugId"), exports);
+tslib_1.__exportStar(require("./toDebugString"), exports);

package/dist-cjs/debug/toDebugString.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toDebugString = void 0;
+function toDebugString(input) {
+    if (typeof input !== "object" || input == null) {
+        return input;
+    }
+    if ("ref" in input) {
+        return `$${toDebugString(input.ref)}`;
+    }
+    if ("fn" in input) {
+        return `${input.fn}(${(input.argv || []).map(toDebugString).join(", ")})`;
+    }
+    return JSON.stringify(input, null, 2);
+}
+exports.toDebugString = toDebugString;

package/dist-cjs/resolveEndpoint.js

@@ -1,18 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveEndpoint = void 0;
+const debug_1 = require("./debug");
 const types_1 = require("./types");
 const utils_1 = require("./utils");
 const resolveEndpoint = (ruleSetObject, options) => {
-    var _a, _b;
+    var _a, _b, _c, _d, _e, _f;
     const { endpointParams, logger } = options;
     const { parameters, rules } = ruleSetObject;
+    (_b = (_a = options.logger) === null || _a === void 0 ? void 0 : _a.debug) === null || _b === void 0 ? void 0 : _b.call(_a, debug_1.debugId, `Initial EndpointParams: ${(0, debug_1.toDebugString)(endpointParams)}`);
     const paramsWithDefault = Object.entries(parameters)
         .filter(([, v]) => v.default != null)
         .map(([k, v]) => [k, v.default]);
     if (paramsWithDefault.length > 0) {
         for (const [paramKey, paramDefaultValue] of paramsWithDefault) {
-            endpointParams[paramKey] = (_a = endpointParams[paramKey]) !== null && _a !== void 0 ? _a : paramDefaultValue;
+            endpointParams[paramKey] = (_c = endpointParams[paramKey]) !== null && _c !== void 0 ? _c : paramDefaultValue;
         }
     }
     const requiredParams = Object.entries(parameters)
@@ -24,7 +26,7 @@ const resolveEndpoint = (ruleSetObject, options) => {
         }
     }
     const endpoint = (0, utils_1.evaluateRules)(rules, { endpointParams, logger, referenceRecord: {} });
-    if ((_b = options.endpointParams) === null || _b === void 0 ? void 0 : _b.Endpoint) {
+    if ((_d = options.endpointParams) === null || _d === void 0 ? void 0 : _d.Endpoint) {
         try {
             const givenEndpoint = new URL(options.endpointParams.Endpoint);
             const { protocol, port } = givenEndpoint;
@@ -34,6 +36,7 @@ const resolveEndpoint = (ruleSetObject, options) => {
         catch (e) {
         }
     }
+    (_f = (_e = options.logger) === null || _e === void 0 ? void 0 : _e.debug) === null || _f === void 0 ? void 0 : _f.call(_e, debug_1.debugId, `Resolved endpoint: ${(0, debug_1.toDebugString)(endpoint)}`);
     return endpoint;
 };
 exports.resolveEndpoint = resolveEndpoint;

package/dist-cjs/utils/evaluateCondition.js

@@ -1,13 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.evaluateCondition = void 0;
+const debug_1 = require("../debug");
 const types_1 = require("../types");
 const callFunction_1 = require("./callFunction");
 const evaluateCondition = ({ assign, ...fnArgs }, options) => {
+    var _a, _b;
     if (assign && assign in options.referenceRecord) {
         throw new types_1.EndpointError(`'${assign}' is already defined in Reference Record.`);
     }
     const value = (0, callFunction_1.callFunction)(fnArgs, options);
+    (_b = (_a = options.logger) === null || _a === void 0 ? void 0 : _a.debug) === null || _b === void 0 ? void 0 : _b.call(_a, debug_1.debugId, `evaluateCondition: ${(0, debug_1.toDebugString)(fnArgs)} = ${(0, debug_1.toDebugString)(value)}`);
     return {
         result: value === "" ? true : !!value,
         ...(assign != null && { toAssign: { name: assign, value } }),

package/dist-cjs/utils/evaluateConditions.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.evaluateConditions = void 0;
+const debug_1 = require("../debug");
 const evaluateCondition_1 = require("./evaluateCondition");
 const evaluateConditions = (conditions = [], options) => {
+    var _a, _b;
     const conditionsReferenceRecord = {};
     for (const condition of conditions) {
         const { result, toAssign } = (0, evaluateCondition_1.evaluateCondition)(condition, {
@@ -17,6 +19,7 @@ const evaluateConditions = (conditions = [], options) => {
         }
         if (toAssign) {
             conditionsReferenceRecord[toAssign.name] = toAssign.value;
+            (_b = (_a = options.logger) === null || _a === void 0 ? void 0 : _a.debug) === null || _b === void 0 ? void 0 : _b.call(_a, debug_1.debugId, `assign: ${toAssign.name} := ${(0, debug_1.toDebugString)(toAssign.value)}`);
         }
     }
     return { result: true, referenceRecord: conditionsReferenceRecord };

package/dist-cjs/utils/evaluateEndpointRule.js

@@ -1,11 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.evaluateEndpointRule = void 0;
+const debug_1 = require("../debug");
 const evaluateConditions_1 = require("./evaluateConditions");
 const getEndpointHeaders_1 = require("./getEndpointHeaders");
 const getEndpointProperties_1 = require("./getEndpointProperties");
 const getEndpointUrl_1 = require("./getEndpointUrl");
 const evaluateEndpointRule = (endpointRule, options) => {
+    var _a, _b;
     const { conditions, endpoint } = endpointRule;
     const { result, referenceRecord } = (0, evaluateConditions_1.evaluateConditions)(conditions, options);
     if (!result) {
@@ -16,6 +18,7 @@ const evaluateEndpointRule = (endpointRule, options) => {
         referenceRecord: { ...options.referenceRecord, ...referenceRecord },
     };
     const { url, properties, headers } = endpoint;
+    (_b = (_a = options.logger) === null || _a === void 0 ? void 0 : _a.debug) === null || _b === void 0 ? void 0 : _b.call(_a, debug_1.debugId, `Resolving endpoint from template: ${(0, debug_1.toDebugString)(endpoint)}`);
     return {
         ...(headers != undefined && {
             headers: (0, getEndpointHeaders_1.getEndpointHeaders)(headers, endpointRuleOptions),

package/dist-es/debug/debugId.js

@@ -0,0 +1 @@
+export const debugId = "endpoints";

package/dist-es/debug/index.js

@@ -0,0 +1,2 @@
+export * from "./debugId";
+export * from "./toDebugString";

package/dist-es/debug/toDebugString.js

@@ -0,0 +1,12 @@
+export function toDebugString(input) {
+    if (typeof input !== "object" || input == null) {
+        return input;
+    }
+    if ("ref" in input) {
+        return `$${toDebugString(input.ref)}`;
+    }
+    if ("fn" in input) {
+        return `${input.fn}(${(input.argv || []).map(toDebugString).join(", ")})`;
+    }
+    return JSON.stringify(input, null, 2);
+}

package/dist-es/resolveEndpoint.js

@@ -1,8 +1,10 @@
+import { debugId, toDebugString } from "./debug";
 import { EndpointError } from "./types";
 import { evaluateRules } from "./utils";
 export const resolveEndpoint = (ruleSetObject, options) => {
     const { endpointParams, logger } = options;
     const { parameters, rules } = ruleSetObject;
+    options.logger?.debug?.(debugId, `Initial EndpointParams: ${toDebugString(endpointParams)}`);
     const paramsWithDefault = Object.entries(parameters)
         .filter(([, v]) => v.default != null)
         .map(([k, v]) => [k, v.default]);
@@ -30,5 +32,6 @@ export const resolveEndpoint = (ruleSetObject, options) => {
         catch (e) {
         }
     }
+    options.logger?.debug?.(debugId, `Resolved endpoint: ${toDebugString(endpoint)}`);
     return endpoint;
 };

package/dist-es/utils/evaluateCondition.js

@@ -1,3 +1,4 @@
+import { debugId, toDebugString } from "../debug";
 import { EndpointError } from "../types";
 import { callFunction } from "./callFunction";
 export const evaluateCondition = ({ assign, ...fnArgs }, options) => {
@@ -5,6 +6,7 @@ export const evaluateCondition = ({ assign, ...fnArgs }, options) => {
         throw new EndpointError(`'${assign}' is already defined in Reference Record.`);
     }
     const value = callFunction(fnArgs, options);
+    options.logger?.debug?.(debugId, `evaluateCondition: ${toDebugString(fnArgs)} = ${toDebugString(value)}`);
     return {
         result: value === "" ? true : !!value,
         ...(assign != null && { toAssign: { name: assign, value } }),

package/dist-es/utils/evaluateConditions.js

@@ -1,3 +1,4 @@
+import { debugId, toDebugString } from "../debug";
 import { evaluateCondition } from "./evaluateCondition";
 export const evaluateConditions = (conditions = [], options) => {
     const conditionsReferenceRecord = {};
@@ -14,6 +15,7 @@ export const evaluateConditions = (conditions = [], options) => {
         }
         if (toAssign) {
             conditionsReferenceRecord[toAssign.name] = toAssign.value;
+            options.logger?.debug?.(debugId, `assign: ${toAssign.name} := ${toDebugString(toAssign.value)}`);
         }
     }
     return { result: true, referenceRecord: conditionsReferenceRecord };

package/dist-es/utils/evaluateEndpointRule.js

@@ -1,3 +1,4 @@
+import { debugId, toDebugString } from "../debug";
 import { evaluateConditions } from "./evaluateConditions";
 import { getEndpointHeaders } from "./getEndpointHeaders";
 import { getEndpointProperties } from "./getEndpointProperties";
@@ -13,6 +14,7 @@ export const evaluateEndpointRule = (endpointRule, options) => {
         referenceRecord: { ...options.referenceRecord, ...referenceRecord },
     };
     const { url, properties, headers } = endpoint;
+    options.logger?.debug?.(debugId, `Resolving endpoint from template: ${toDebugString(endpoint)}`);
     return {
         ...(headers != undefined && {
             headers: getEndpointHeaders(headers, endpointRuleOptions),

package/dist-types/debug/debugId.d.ts

@@ -0,0 +1 @@
+export declare const debugId = "endpoints";

package/dist-types/debug/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./debugId";
+export * from "./toDebugString";

package/dist-types/debug/toDebugString.d.ts

@@ -0,0 +1,9 @@
+import { EndpointParameters, EndpointV2 } from "@aws-sdk/types";
+import { GetAttrValue } from "../lib";
+import { EndpointObject, FunctionObject, FunctionReturn } from "../types";
+export declare function toDebugString(input: EndpointParameters): string;
+export declare function toDebugString(input: EndpointV2): string;
+export declare function toDebugString(input: GetAttrValue): string;
+export declare function toDebugString(input: FunctionObject): string;
+export declare function toDebugString(input: FunctionReturn): string;
+export declare function toDebugString(input: EndpointObject): string;

package/dist-types/ts3.4/debug/debugId.d.ts

@@ -0,0 +1 @@
+export declare const debugId = "endpoints";

package/dist-types/ts3.4/debug/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./debugId";
+export * from "./toDebugString";

package/dist-types/ts3.4/debug/toDebugString.d.ts

@@ -0,0 +1,9 @@
+import { EndpointParameters, EndpointV2 } from "@aws-sdk/types";
+import { GetAttrValue } from "../lib";
+import { EndpointObject, FunctionObject, FunctionReturn } from "../types";
+export declare function toDebugString(input: EndpointParameters): string;
+export declare function toDebugString(input: EndpointV2): string;
+export declare function toDebugString(input: GetAttrValue): string;
+export declare function toDebugString(input: FunctionObject): string;
+export declare function toDebugString(input: FunctionReturn): string;
+export declare function toDebugString(input: EndpointObject): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/util-endpoints",
-  "version": "3.197.0",
+  "version": "3.200.0",
   "description": "Utilities to help with endpoint resolution",
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
@@ -21,7 +21,7 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@aws-sdk/types": "3.197.0",
+    "@aws-sdk/types": "3.200.0",
     "tslib": "^2.3.1"
   },
   "engines": {