@aws-sdk/util-endpoints 3.292.0 → 3.295.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 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/lib/getAttr.d.ts

@@ -1,4 +1,4 @@
-export declare type GetAttrValue = string | boolean | {
+export type GetAttrValue = string | boolean | {
     [key: string]: GetAttrValue;
 } | Array<GetAttrValue>;
 /**

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

@@ -1,2 +1,28 @@
 import { EndpointPartition } from "@aws-sdk/types";
+export 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/dist-types/ts3.4/lib/getAttr.d.ts

@@ -1,4 +1,4 @@
-export declare type GetAttrValue =
+export type GetAttrValue =
   | string
   | boolean
   | {

package/dist-types/ts3.4/types/EndpointRuleObject.d.ts

@@ -1,16 +1,13 @@
 import { EndpointObjectProperty } from "@aws-sdk/types";
 import { ConditionObject, Expression } from "./shared";
-export declare type EndpointObjectProperties = Record<
-  string,
-  EndpointObjectProperty
->;
-export declare type EndpointObjectHeaders = Record<string, Expression[]>;
-export declare type EndpointObject = {
+export type EndpointObjectProperties = Record<string, EndpointObjectProperty>;
+export type EndpointObjectHeaders = Record<string, Expression[]>;
+export type EndpointObject = {
   url: Expression;
   properties?: EndpointObjectProperties;
   headers?: EndpointObjectHeaders;
 };
-export declare type EndpointRuleObject = {
+export type EndpointRuleObject = {
   type: "endpoint";
   conditions?: ConditionObject[];
   endpoint: EndpointObject;

package/dist-types/ts3.4/types/ErrorRuleObject.d.ts

@@ -1,5 +1,5 @@
 import { ConditionObject, Expression } from "./shared";
-export declare type ErrorRuleObject = {
+export type ErrorRuleObject = {
   type: "error";
   conditions?: ConditionObject[];
   error: Expression;

package/dist-types/ts3.4/types/RuleSetObject.d.ts

@@ -1,9 +1,9 @@
 import { RuleSetRules } from "./TreeRuleObject";
-export declare type DeprecatedObject = {
+export type DeprecatedObject = {
   message?: string;
   since?: string;
 };
-export declare type ParameterObject = {
+export type ParameterObject = {
   type: "String" | "Boolean";
   default?: string | boolean;
   required?: boolean;
@@ -11,7 +11,7 @@ export declare type ParameterObject = {
   builtIn?: string;
   deprecated?: DeprecatedObject;
 };
-export declare type RuleSetObject = {
+export type RuleSetObject = {
   version: string;
   serviceId?: string;
   parameters: Record<string, ParameterObject>;

package/dist-types/ts3.4/types/TreeRuleObject.d.ts

@@ -1,10 +1,10 @@
 import { EndpointRuleObject } from "./EndpointRuleObject";
 import { ErrorRuleObject } from "./ErrorRuleObject";
 import { ConditionObject } from "./shared";
-export declare type RuleSetRules = Array<
+export type RuleSetRules = Array<
   EndpointRuleObject | ErrorRuleObject | TreeRuleObject
 >;
-export declare type TreeRuleObject = {
+export type TreeRuleObject = {
   type: "tree";
   conditions?: ConditionObject[];
   rules: RuleSetRules;

package/dist-types/ts3.4/types/shared.d.ts

@@ -1,29 +1,29 @@
 import { Logger } from "@aws-sdk/types";
-export declare type ReferenceObject = {
+export type ReferenceObject = {
   ref: string;
 };
-export declare type FunctionObject = {
+export type FunctionObject = {
   fn: string;
   argv: FunctionArgv;
 };
-export declare type FunctionArgv = Array<Expression | boolean | number>;
-export declare type FunctionReturn =
+export type FunctionArgv = Array<Expression | boolean | number>;
+export type FunctionReturn =
   | string
   | boolean
   | number
   | {
       [key: string]: FunctionReturn;
     };
-export declare type ConditionObject = FunctionObject & {
+export type ConditionObject = FunctionObject & {
   assign?: string;
 };
-export declare type Expression = string | ReferenceObject | FunctionObject;
-export declare type EndpointParams = Record<string, string | boolean>;
-export declare type EndpointResolverOptions = {
+export type Expression = string | ReferenceObject | FunctionObject;
+export type EndpointParams = Record<string, string | boolean>;
+export type EndpointResolverOptions = {
   endpointParams: EndpointParams;
   logger?: Logger;
 };
-export declare type ReferenceRecord = Record<string, FunctionReturn>;
-export declare type EvaluateOptions = EndpointResolverOptions & {
+export type ReferenceRecord = Record<string, FunctionReturn>;
+export type EvaluateOptions = EndpointResolverOptions & {
   referenceRecord: ReferenceRecord;
 };

package/dist-types/types/EndpointRuleObject.d.ts

@@ -1,13 +1,13 @@
 import { EndpointObjectProperty } from "@aws-sdk/types";
 import { ConditionObject, Expression } from "./shared";
-export declare type EndpointObjectProperties = Record<string, EndpointObjectProperty>;
-export declare type EndpointObjectHeaders = Record<string, Expression[]>;
-export declare type EndpointObject = {
+export type EndpointObjectProperties = Record<string, EndpointObjectProperty>;
+export type EndpointObjectHeaders = Record<string, Expression[]>;
+export type EndpointObject = {
     url: Expression;
     properties?: EndpointObjectProperties;
     headers?: EndpointObjectHeaders;
 };
-export declare type EndpointRuleObject = {
+export type EndpointRuleObject = {
     type: "endpoint";
     conditions?: ConditionObject[];
     endpoint: EndpointObject;

package/dist-types/types/ErrorRuleObject.d.ts

@@ -1,5 +1,5 @@
 import { ConditionObject, Expression } from "./shared";
-export declare type ErrorRuleObject = {
+export type ErrorRuleObject = {
     type: "error";
     conditions?: ConditionObject[];
     error: Expression;

package/dist-types/types/RuleSetObject.d.ts

@@ -1,9 +1,9 @@
 import { RuleSetRules } from "./TreeRuleObject";
-export declare type DeprecatedObject = {
+export type DeprecatedObject = {
     message?: string;
     since?: string;
 };
-export declare type ParameterObject = {
+export type ParameterObject = {
     type: "String" | "Boolean";
     default?: string | boolean;
     required?: boolean;
@@ -11,7 +11,7 @@ export declare type ParameterObject = {
     builtIn?: string;
     deprecated?: DeprecatedObject;
 };
-export declare type RuleSetObject = {
+export type RuleSetObject = {
     version: string;
     serviceId?: string;
     parameters: Record<string, ParameterObject>;

package/dist-types/types/TreeRuleObject.d.ts

@@ -1,8 +1,8 @@
 import { EndpointRuleObject } from "./EndpointRuleObject";
 import { ErrorRuleObject } from "./ErrorRuleObject";
 import { ConditionObject } from "./shared";
-export declare type RuleSetRules = Array<EndpointRuleObject | ErrorRuleObject | TreeRuleObject>;
-export declare type TreeRuleObject = {
+export type RuleSetRules = Array<EndpointRuleObject | ErrorRuleObject | TreeRuleObject>;
+export type TreeRuleObject = {
     type: "tree";
     conditions?: ConditionObject[];
     rules: RuleSetRules;

package/dist-types/types/shared.d.ts

@@ -1,25 +1,25 @@
 import { Logger } from "@aws-sdk/types";
-export declare type ReferenceObject = {
+export type ReferenceObject = {
     ref: string;
 };
-export declare type FunctionObject = {
+export type FunctionObject = {
     fn: string;
     argv: FunctionArgv;
 };
-export declare type FunctionArgv = Array<Expression | boolean | number>;
-export declare type FunctionReturn = string | boolean | number | {
+export type FunctionArgv = Array<Expression | boolean | number>;
+export type FunctionReturn = string | boolean | number | {
     [key: string]: FunctionReturn;
 };
-export declare type ConditionObject = FunctionObject & {
+export type ConditionObject = FunctionObject & {
     assign?: string;
 };
-export declare type Expression = string | ReferenceObject | FunctionObject;
-export declare type EndpointParams = Record<string, string | boolean>;
-export declare type EndpointResolverOptions = {
+export type Expression = string | ReferenceObject | FunctionObject;
+export type EndpointParams = Record<string, string | boolean>;
+export type EndpointResolverOptions = {
     endpointParams: EndpointParams;
     logger?: Logger;
 };
-export declare type ReferenceRecord = Record<string, FunctionReturn>;
-export declare type EvaluateOptions = EndpointResolverOptions & {
+export type ReferenceRecord = Record<string, FunctionReturn>;
+export type EvaluateOptions = EndpointResolverOptions & {
     referenceRecord: ReferenceRecord;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/util-endpoints",
-  "version": "3.292.0",
+  "version": "3.295.0",
   "description": "Utilities to help with endpoint resolution",
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
@@ -21,8 +21,8 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@aws-sdk/types": "3.292.0",
-    "tslib": "^2.3.1"
+    "@aws-sdk/types": "3.295.0",
+    "tslib": "^2.5.0"
   },
   "engines": {
     "node": ">=14.0.0"
@@ -49,7 +49,7 @@
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2",
     "typedoc": "0.23.23",
-    "typescript": "~4.6.2"
+    "typescript": "~4.9.5"
   },
   "typedoc": {
     "entryPoint": "src/index.ts"