@smithy/credential-provider-imds 4.2.12 → 4.2.14

package/README.md

@@ -3,9 +3,18 @@
 [![NPM version](https://img.shields.io/npm/v/@smithy/credential-provider-imds/latest.svg)](https://www.npmjs.com/package/@smithy/credential-provider-imds)
 [![NPM downloads](https://img.shields.io/npm/dm/@smithy/credential-provider-imds.svg)](https://www.npmjs.com/package/@smithy/credential-provider-imds)
 
-> An internal package
+### :warning: Internal API :warning:
 
-## Usage
+> This is an internal package.
+> That means this is used as a dependency for other, public packages, but
+> should not be taken directly as a dependency in your application's `package.json`.
 
-You probably shouldn't, at least directly. Please use [@smithy/credential-providers](https://www.npmjs.com/package/@smithy/credential-providers)
+> If you are updating the version of this package, for example to bring in a
+> bug-fix, you should do so by updating your application lockfile with
+> e.g. `npm up @scope/package` or equivalent command in another
+> package manager, rather than taking a direct dependency.
+
+---
+
+Please use [@smithy/credential-providers](https://www.npmjs.com/package/@smithy/credential-providers)
 instead.

package/package.json

@@ -1,19 +1,18 @@
 {
   "name": "@smithy/credential-provider-imds",
-  "version": "4.2.12",
+  "version": "4.2.14",
   "description": "AWS credential provider that sources credentials from the EC2 instance metadata service and ECS container metadata service",
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
   "scripts": {
-    "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types && yarn build:types:downlevel'",
-    "build:cjs": "node ../../scripts/inline credential-provider-imds",
-    "build:es": "yarn g:tsc -p tsconfig.es.json",
+    "build": "concurrently 'yarn:build:types' 'yarn:build:es:cjs'",
+    "build:es:cjs": "yarn g:tsc -p tsconfig.es.json && node ../../scripts/inline credential-provider-imds",
     "build:types": "yarn g:tsc -p tsconfig.types.json",
     "build:types:downlevel": "premove dist-types/ts3.4 && downlevel-dts dist-types dist-types/ts3.4",
-    "stage-release": "premove .release && yarn pack && mkdir ./.release && tar zxvf ./package.tgz --directory ./.release && rm ./package.tgz",
     "clean": "premove dist-cjs dist-es dist-types tsconfig.cjs.tsbuildinfo tsconfig.es.tsbuildinfo tsconfig.types.tsbuildinfo",
-    "lint": "eslint -c ../../.eslintrc.js \"src/**/*.ts\"",
     "format": "prettier --config ../../prettier.config.js --ignore-path ../../.prettierignore --write \"**/*.{ts,md,json}\"",
+    "lint": "eslint -c ../../.eslintrc.js \"src/**/*.ts\"",
+    "stage-release": "premove .release && yarn pack && mkdir ./.release && tar zxvf ./package.tgz --directory ./.release && rm ./package.tgz",
     "test": "yarn g:vitest run",
     "test:watch": "yarn g:vitest watch"
   },
@@ -28,10 +27,10 @@
   "license": "Apache-2.0",
   "sideEffects": false,
   "dependencies": {
-    "@smithy/node-config-provider": "^4.3.12",
-    "@smithy/property-provider": "^4.2.12",
-    "@smithy/types": "^4.13.1",
-    "@smithy/url-parser": "^4.2.12",
+    "@smithy/node-config-provider": "^4.3.14",
+    "@smithy/property-provider": "^4.2.14",
+    "@smithy/types": "^4.14.1",
+    "@smithy/url-parser": "^4.2.14",
     "tslib": "^2.6.2"
   },
   "devDependencies": {

package/dist-types/ts3.4/config/Endpoint.d.ts

@@ -1,7 +0,0 @@
-/**
- * @internal
- */
-export declare enum Endpoint {
-    IPv4 = "http://169.254.169.254",
-    IPv6 = "http://[fd00:ec2::254]"
-}

package/dist-types/ts3.4/config/EndpointConfigOptions.d.ts

@@ -1,13 +0,0 @@
-import { LoadedConfigSelectors } from "@smithy/node-config-provider";
-/**
- * @internal
- */
-export declare const ENV_ENDPOINT_NAME = "AWS_EC2_METADATA_SERVICE_ENDPOINT";
-/**
- * @internal
- */
-export declare const CONFIG_ENDPOINT_NAME = "ec2_metadata_service_endpoint";
-/**
- * @internal
- */
-export declare const ENDPOINT_CONFIG_OPTIONS: LoadedConfigSelectors<string | undefined>;

package/dist-types/ts3.4/config/EndpointMode.d.ts

@@ -1,7 +0,0 @@
-/**
- * @internal
- */
-export declare enum EndpointMode {
-    IPv4 = "IPv4",
-    IPv6 = "IPv6"
-}

package/dist-types/ts3.4/config/EndpointModeConfigOptions.d.ts

@@ -1,13 +0,0 @@
-import { LoadedConfigSelectors } from "@smithy/node-config-provider";
-/**
- * @internal
- */
-export declare const ENV_ENDPOINT_MODE_NAME = "AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE";
-/**
- * @internal
- */
-export declare const CONFIG_ENDPOINT_MODE_NAME = "ec2_metadata_service_endpoint_mode";
-/**
- * @internal
- */
-export declare const ENDPOINT_MODE_CONFIG_OPTIONS: LoadedConfigSelectors<string | undefined>;

package/dist-types/ts3.4/error/InstanceMetadataV1FallbackError.d.ts

@@ -1,12 +0,0 @@
-import { CredentialsProviderError } from "@smithy/property-provider";
-/**
- * @public
- *
- * A specific sub-case of CredentialsProviderError, when the IMDSv1 fallback
- * has been attempted but shut off by SDK configuration.
- */
-export declare class InstanceMetadataV1FallbackError extends CredentialsProviderError {
-    readonly tryNextLink: boolean;
-    name: string;
-    constructor(message: string, tryNextLink?: boolean);
-}

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

@@ -1,21 +0,0 @@
-import { AwsCredentialIdentityProvider } from "@smithy/types";
-import { RemoteProviderInit } from "./remoteProvider/RemoteProviderInit";
-/**
- * @internal
- */
-export declare const ENV_CMDS_FULL_URI = "AWS_CONTAINER_CREDENTIALS_FULL_URI";
-/**
- * @internal
- */
-export declare const ENV_CMDS_RELATIVE_URI = "AWS_CONTAINER_CREDENTIALS_RELATIVE_URI";
-/**
- * @internal
- */
-export declare const ENV_CMDS_AUTH_TOKEN = "AWS_CONTAINER_AUTHORIZATION_TOKEN";
-/**
- * @internal
- *
- * Creates a credential provider that will source credentials from the ECS
- * Container Metadata Service
- */
-export declare const fromContainerMetadata: (init?: RemoteProviderInit) => AwsCredentialIdentityProvider;

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

@@ -1,10 +0,0 @@
-import { Provider } from "@smithy/types";
-import { RemoteProviderInit } from "./remoteProvider/RemoteProviderInit";
-import { InstanceMetadataCredentials } from "./types";
-/**
- * @internal
- *
- * Creates a credential provider that will source credentials from the EC2
- * Instance Metadata Service
- */
-export declare const fromInstanceMetadata: (init?: RemoteProviderInit) => Provider<InstanceMetadataCredentials>;

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

@@ -1,28 +0,0 @@
-/**
- * @internal
- */
-export * from "./fromContainerMetadata";
-/**
- * @internal
- */
-export * from "./fromInstanceMetadata";
-/**
- * @internal
- */
-export * from "./remoteProvider/RemoteProviderInit";
-/**
- * @internal
- */
-export * from "./types";
-/**
- * @internal
- */
-export { httpRequest } from "./remoteProvider/httpRequest";
-/**
- * @internal
- */
-export { getInstanceMetadataEndpoint } from "./utils/getInstanceMetadataEndpoint";
-/**
- * @internal
- */
-export { Endpoint } from "./config/Endpoint";

package/dist-types/ts3.4/remoteProvider/ImdsCredentials.d.ts

@@ -1,19 +0,0 @@
-import { AwsCredentialIdentity } from "@smithy/types";
-/**
- * @internal
- */
-export interface ImdsCredentials {
-    AccessKeyId: string;
-    SecretAccessKey: string;
-    Token: string;
-    Expiration: string;
-    AccountId?: string;
-}
-/**
- * @internal
- */
-export declare const isImdsCredentials: (arg: any) => arg is ImdsCredentials;
-/**
- * @internal
- */
-export declare const fromImdsCredentials: (creds: ImdsCredentials) => AwsCredentialIdentity;

package/dist-types/ts3.4/remoteProvider/RemoteProviderInit.d.ts

@@ -1,40 +0,0 @@
-import { Logger } from "@smithy/types";
-/**
- * @internal
- */
-export declare const DEFAULT_TIMEOUT = 1000;
-/**
- * @internal
- */
-export declare const DEFAULT_MAX_RETRIES = 0;
-/**
- * @public
- */
-export interface RemoteProviderConfig {
-    /**
-     * The connection timeout (in milliseconds)
-     */
-    timeout: number;
-    /**
-     * The maximum number of times the HTTP connection should be retried
-     */
-    maxRetries: number;
-}
-/**
- * @public
- */
-export interface RemoteProviderInit extends Partial<RemoteProviderConfig> {
-    logger?: Logger;
-    /**
-     * Only used in the IMDS credential provider.
-     */
-    ec2MetadataV1Disabled?: boolean;
-    /**
-     * AWS_PROFILE.
-     */
-    profile?: string;
-}
-/**
- * @internal
- */
-export declare const providerConfigFromInit: ({ maxRetries, timeout, }: RemoteProviderInit) => RemoteProviderConfig;

package/dist-types/ts3.4/remoteProvider/httpRequest.d.ts

@@ -1,6 +0,0 @@
-import { Buffer } from "buffer";
-import { RequestOptions } from "http";
-/**
- * @internal
- */
-export declare function httpRequest(options: RequestOptions): Promise<Buffer>;

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

@@ -1,8 +0,0 @@
-/**
- * @internal
- */
-export * from "./ImdsCredentials";
-/**
- * @internal
- */
-export * from "./RemoteProviderInit";

package/dist-types/ts3.4/remoteProvider/retry.d.ts

@@ -1,10 +0,0 @@
-/**
- * @internal
- */
-export interface RetryableProvider<T> {
-    (): Promise<T>;
-}
-/**
- * @internal
- */
-export declare const retry: <T>(toRetry: RetryableProvider<T>, maxRetries: number) => Promise<T>;

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

@@ -1,7 +0,0 @@
-import { AwsCredentialIdentity } from "@smithy/types";
-/**
- * @internal
- */
-export interface InstanceMetadataCredentials extends AwsCredentialIdentity {
-    readonly originalExpiration?: Date;
-}

package/dist-types/ts3.4/utils/getExtendedInstanceMetadataCredentials.d.ts

@@ -1,6 +0,0 @@
-import { Logger } from "@smithy/types";
-import { InstanceMetadataCredentials } from "../types";
-/**
- * @internal
- */
-export declare const getExtendedInstanceMetadataCredentials: (credentials: InstanceMetadataCredentials, logger: Logger) => InstanceMetadataCredentials;

package/dist-types/ts3.4/utils/getInstanceMetadataEndpoint.d.ts

@@ -1,21 +0,0 @@
-import { Endpoint } from "@smithy/types";
-/**
- * Returns the host to use for instance metadata service call.
- *
- * The host is read from endpoint which can be set either in
- * {@link ENV_ENDPOINT_NAME} environment variable or {@link CONFIG_ENDPOINT_NAME}
- * configuration property.
- *
- * If endpoint is not set, then endpoint mode is read either from
- * {@link ENV_ENDPOINT_MODE_NAME} environment variable or {@link CONFIG_ENDPOINT_MODE_NAME}
- * configuration property. If endpoint mode is not set, then default endpoint mode
- * {@link EndpointMode.IPv4} is used.
- *
- * If endpoint mode is set to {@link EndpointMode.IPv4}, then the host is {@link Endpoint.IPv4}.
- * If endpoint mode is set to {@link EndpointMode.IPv6}, then the host is {@link Endpoint.IPv6}.
- *
- * @returns Host to use for instance metadata service call.
- *
- * @internal
- */
-export declare const getInstanceMetadataEndpoint: () => Promise<Endpoint>;

package/dist-types/ts3.4/utils/staticStabilityProvider.d.ts

@@ -1,16 +0,0 @@
-import { Logger, Provider } from "@smithy/types";
-import { InstanceMetadataCredentials } from "../types";
-/**
- * @internal
- *
- * IMDS credential supports static stability feature. When used, the expiration
- * of recently issued credentials is extended. The server side allows using
- * the recently expired credentials. This mitigates impact when clients using
- * refreshable credentials are unable to retrieve updates.
- *
- * @param provider Credential provider
- * @returns A credential provider that supports static stability
- */
-export declare const staticStabilityProvider: (provider: Provider<InstanceMetadataCredentials>, options?: {
-    logger?: Logger;
-}) => Provider<InstanceMetadataCredentials>;