@aws-amplify/core
Version:
Core category of aws-amplify
60 lines (58 loc) • 2.54 kB
JavaScript
;
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
Object.defineProperty(exports, "__esModule", { value: true });
exports.getCustomUserAgent = exports.setCustomUserAgent = void 0;
// Maintains custom user-agent state set by external consumers.
const customUserAgentState = {};
/**
* Sets custom user agent state which will be appended to applicable requests. Returns a function that can be used to
* clean up any custom state set with this API.
*
* @note
* This API operates globally. Calling this API multiple times will result in the most recently set values for a
* particular API being used.
*
* @note
* This utility IS NOT compatible with SSR.
*
* @param input - SetCustomUserAgentInput that defines custom state to apply to the specified APIs.
*/
const setCustomUserAgent = (input) => {
// Save custom user-agent state & increment reference counter
// TODO Remove `any` when we upgrade to TypeScript 5.2, see: https://github.com/microsoft/TypeScript/issues/44373
customUserAgentState[input.category] = input.apis.reduce((acc, api) => ({
...acc,
[api]: {
refCount: acc[api]?.refCount ? acc[api].refCount + 1 : 1,
additionalDetails: input.additionalDetails,
},
}), customUserAgentState[input.category] ?? {});
// Callback that cleans up state for APIs recorded by this call
let cleanUpCallbackCalled = false;
const cleanUpCallback = () => {
// Only allow the cleanup callback to be called once
if (cleanUpCallbackCalled) {
return;
}
cleanUpCallbackCalled = true;
input.apis.forEach(api => {
const apiRefCount = customUserAgentState[input.category][api].refCount;
if (apiRefCount > 1) {
customUserAgentState[input.category][api].refCount = apiRefCount - 1;
}
else {
delete customUserAgentState[input.category][api];
// Clean up category if no more APIs set
if (!Object.keys(customUserAgentState[input.category]).length) {
delete customUserAgentState[input.category];
}
}
});
};
return cleanUpCallback;
};
exports.setCustomUserAgent = setCustomUserAgent;
const getCustomUserAgent = (category, api) => customUserAgentState[category]?.[api]?.additionalDetails;
exports.getCustomUserAgent = getCustomUserAgent;
//# sourceMappingURL=customUserAgent.js.map