@aws-sdk/util-endpoints 3.290.0 → 3.293.0

package/dist-cjs/lib/aws/partition.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.partition = void 0;
+exports.getUserAgentPrefix = exports.useDefaultPartitionInfo = exports.setPartitionInfo = exports.partition = void 0;
 const tslib_1 = require("tslib");
 const partitions_json_1 = tslib_1.__importDefault(require("./partitions.json"));
-const { partitions } = partitions_json_1.default;
-const DEFAULT_PARTITION = partitions.find((partition) => partition.id === "aws");
+let selectedPartitionsInfo = partitions_json_1.default;
+let selectedUserAgentPrefix = "";
 const partition = (value) => {
+    const { partitions } = selectedPartitionsInfo;
     for (const partition of partitions) {
         const { regions, outputs } = partition;
         for (const [region, regionData] of Object.entries(regions)) {
@@ -25,6 +26,7 @@ const partition = (value) => {
             };
         }
     }
+    const DEFAULT_PARTITION = partitions.find((partition) => partition.id === "aws");
     if (!DEFAULT_PARTITION) {
         throw new Error("Provided region was not found in the partition array or regex," +
             " and default partition with id 'aws' doesn't exist.");
@@ -34,3 +36,14 @@ const partition = (value) => {
     };
 };
 exports.partition = partition;
+const setPartitionInfo = (partitionsInfo, userAgentPrefix = "") => {
+    selectedPartitionsInfo = partitionsInfo;
+    selectedUserAgentPrefix = userAgentPrefix;
+};
+exports.setPartitionInfo = setPartitionInfo;
+const useDefaultPartitionInfo = () => {
+    (0, exports.setPartitionInfo)(partitions_json_1.default, "");
+};
+exports.useDefaultPartitionInfo = useDefaultPartitionInfo;
+const getUserAgentPrefix = () => selectedUserAgentPrefix;
+exports.getUserAgentPrefix = getUserAgentPrefix;

package/dist-es/lib/aws/partition.js

@@ -1,7 +1,8 @@
 import partitionsInfo from "./partitions.json";
-const { partitions } = partitionsInfo;
-const DEFAULT_PARTITION = partitions.find((partition) => partition.id === "aws");
+let selectedPartitionsInfo = partitionsInfo;
+let selectedUserAgentPrefix = "";
 export const partition = (value) => {
+    const { partitions } = selectedPartitionsInfo;
     for (const partition of partitions) {
         const { regions, outputs } = partition;
         for (const [region, regionData] of Object.entries(regions)) {
@@ -21,6 +22,7 @@ export const partition = (value) => {
             };
         }
     }
+    const DEFAULT_PARTITION = partitions.find((partition) => partition.id === "aws");
     if (!DEFAULT_PARTITION) {
         throw new Error("Provided region was not found in the partition array or regex," +
             " and default partition with id 'aws' doesn't exist.");
@@ -29,3 +31,11 @@ export const partition = (value) => {
         ...DEFAULT_PARTITION.outputs,
     };
 };
+export const setPartitionInfo = (partitionsInfo, userAgentPrefix = "") => {
+    selectedPartitionsInfo = partitionsInfo;
+    selectedUserAgentPrefix = userAgentPrefix;
+};
+export const useDefaultPartitionInfo = () => {
+    setPartitionInfo(partitionsInfo, "");
+};
+export const getUserAgentPrefix = () => selectedUserAgentPrefix;

package/dist-types/lib/aws/partition.d.ts

@@ -1,4 +1,20 @@
 import { EndpointPartition } from "@aws-sdk/types";
+export declare type PartitionsInfo = {
+    partitions: Array<{
+        id: string;
+        outputs: {
+            dnsSuffix: string;
+            dualStackDnsSuffix: string;
+            name: string;
+            supportsDualStack: boolean;
+            supportsFIPS: boolean;
+        };
+        regionRegex: string;
+        regions: Record<string, {
+            description?: string;
+        } | undefined>;
+    }>;
+};
 /**
  * Evaluates a single string argument value as a region, and matches the
  * string value to an AWS partition.
@@ -6,3 +22,17 @@ import { EndpointPartition } from "@aws-sdk/types";
  * that the region has been determined to be a part of.
  */
 export declare const partition: (value: string) => EndpointPartition;
+/**
+ * Set custom partitions.json data.
+ * @internal
+ */
+export declare const setPartitionInfo: (partitionsInfo: PartitionsInfo, userAgentPrefix?: string) => void;
+/**
+ * Reset to the default partitions.json data.
+ * @internal
+ */
+export declare const useDefaultPartitionInfo: () => void;
+/**
+ * @internal
+ */
+export declare const getUserAgentPrefix: () => string;

package/dist-types/ts3.4/lib/aws/partition.d.ts

@@ -1,2 +1,28 @@
 import { EndpointPartition } from "@aws-sdk/types";
+export declare type PartitionsInfo = {
+  partitions: Array<{
+    id: string;
+    outputs: {
+      dnsSuffix: string;
+      dualStackDnsSuffix: string;
+      name: string;
+      supportsDualStack: boolean;
+      supportsFIPS: boolean;
+    };
+    regionRegex: string;
+    regions: Record<
+      string,
+      | {
+          description?: string;
+        }
+      | undefined
+    >;
+  }>;
+};
 export declare const partition: (value: string) => EndpointPartition;
+export declare const setPartitionInfo: (
+  partitionsInfo: PartitionsInfo,
+  userAgentPrefix?: string
+) => void;
+export declare const useDefaultPartitionInfo: () => void;
+export declare const getUserAgentPrefix: () => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/util-endpoints",
-  "version": "3.290.0",
+  "version": "3.293.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.290.0",
+    "@aws-sdk/types": "3.292.0",
     "tslib": "^2.3.1"
   },
   "engines": {
@@ -48,7 +48,10 @@
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2",
-    "typedoc": "0.19.2",
+    "typedoc": "0.23.23",
     "typescript": "~4.6.2"
+  },
+  "typedoc": {
+    "entryPoint": "src/index.ts"
   }
 }