Skip to content

chore(types): move profile types from other packages #3414

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Mar 14, 2022
Merged
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { CredentialsProviderError } from "@aws-sdk/property-provider";
import { ParsedIniData, Profile } from "@aws-sdk/shared-ini-file-loader";
import { ParsedIniData, Profile } from "@aws-sdk/types";
import { getMasterProfileName } from "@aws-sdk/util-credentials";

import { FromIniInit } from "./fromIni";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import { CredentialsProviderError } from "@aws-sdk/property-provider";
import { ParsedIniData } from "@aws-sdk/shared-ini-file-loader";
import { Credentials } from "@aws-sdk/types";
import { Credentials, ParsedIniData } from "@aws-sdk/types";

import { FromIniInit } from "./fromIni";
import { isAssumeRoleProfile, resolveAssumeRoleCredentials } from "./resolveAssumeRoleCredentials";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { Profile } from "@aws-sdk/shared-ini-file-loader";
import { Credentials } from "@aws-sdk/types";
import { Credentials, Profile } from "@aws-sdk/types";

export interface StaticCredsProfile extends Profile {
aws_access_key_id: string;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import { fromTokenFile } from "@aws-sdk/credential-provider-web-identity";
import { Profile } from "@aws-sdk/shared-ini-file-loader";
import { Credentials } from "@aws-sdk/types";
import { Credentials, Profile } from "@aws-sdk/types";

import { FromIniInit } from "./fromIni";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import { CredentialsProviderError } from "@aws-sdk/property-provider";
import { ParsedIniData } from "@aws-sdk/shared-ini-file-loader";
import { Credentials } from "@aws-sdk/types";
import { Credentials, ParsedIniData } from "@aws-sdk/types";
import { exec } from "child_process";
import { promisify } from "util";

Expand Down
2 changes: 1 addition & 1 deletion packages/credential-provider-sso/src/isSsoProfile.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Profile } from "@aws-sdk/shared-ini-file-loader";
import { Profile } from "@aws-sdk/types";

import { SsoProfile } from "./types";

Expand Down
2 changes: 1 addition & 1 deletion packages/credential-provider-sso/src/types.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Profile } from "@aws-sdk/shared-ini-file-loader";
import { Profile } from "@aws-sdk/types";

/**
* Cached SSO token retrieved from SSO login flow.
Expand Down
2 changes: 1 addition & 1 deletion packages/node-config-provider/src/configLoader.spec.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { chain, fromStatic, memoize } from "@aws-sdk/property-provider";
import { Profile } from "@aws-sdk/shared-ini-file-loader/src";
import { Profile } from "@aws-sdk/types";

import { loadConfig } from "./configLoader";
import { fromEnv } from "./fromEnv";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { CredentialsProviderError } from "@aws-sdk/property-provider";
import { loadSharedConfigFiles, ParsedIniData, Profile } from "@aws-sdk/shared-ini-file-loader";
import { loadSharedConfigFiles } from "@aws-sdk/shared-ini-file-loader";
import { ParsedIniData, Profile } from "@aws-sdk/types";

import { ENV_PROFILE, fromSharedConfigFiles, GetterFromConfig, SharedConfigInit } from "./fromSharedConfigFiles";

Expand Down
9 changes: 2 additions & 7 deletions packages/node-config-provider/src/fromSharedConfigFiles.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
import { CredentialsProviderError } from "@aws-sdk/property-provider";
import {
loadSharedConfigFiles,
Profile,
SharedConfigFiles,
SharedConfigInit as BaseSharedConfigInit,
} from "@aws-sdk/shared-ini-file-loader";
import { Provider } from "@aws-sdk/types";
import { loadSharedConfigFiles, SharedConfigInit as BaseSharedConfigInit } from "@aws-sdk/shared-ini-file-loader";
import { Profile, Provider, SharedConfigFiles } from "@aws-sdk/types";

const DEFAULT_PROFILE = "default";
export const ENV_PROFILE = "AWS_PROFILE";
Expand Down
1 change: 1 addition & 0 deletions packages/shared-ini-file-loader/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"tslib": "^2.3.0"
},
"devDependencies": {
"@aws-sdk/types": "*",
"@tsconfig/recommended": "1.0.1",
"@types/node": "^10.0.0",
"concurrently": "7.0.0",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import { SharedConfigFiles } from "@aws-sdk/types";
import { join } from "path";

import { getHomeDir } from "./getHomeDir";
import { normalizeConfigFile } from "./normalizeConfigFile";
import { parseIni } from "./parseIni";
import { slurpFile } from "./slurpFile";
import { SharedConfigFiles } from "./types";

export const ENV_CREDENTIALS_PATH = "AWS_SHARED_CREDENTIALS_FILE";
export const ENV_CONFIG_PATH = "AWS_CONFIG_FILE";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { ParsedIniData } from "./types";
import { ParsedIniData } from "@aws-sdk/types";

const profileKeyRegex = /^profile\s(["'])?([^\1]+)\1$/;

Expand Down
2 changes: 1 addition & 1 deletion packages/shared-ini-file-loader/src/parseIni.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { ParsedIniData } from "./types";
import { ParsedIniData } from "@aws-sdk/types";

const profileNameBlockList = ["__proto__", "profile __proto__"];

Expand Down
28 changes: 18 additions & 10 deletions packages/shared-ini-file-loader/src/types.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
export interface Profile {
[key: string]: string | undefined;
}
import {
ParsedIniData as __ParsedIniData,
Profile as __Profile,
SharedConfigFiles as __SharedConfigFiles,
} from "@aws-sdk/types";

export interface ParsedIniData {
[key: string]: Profile;
}
/**
* @deprecated Use Profile from "@aws-sdk/types" instead
*/
export type Profile = __Profile;

export interface SharedConfigFiles {
credentialsFile: ParsedIniData;
configFile: ParsedIniData;
}
/**
* @deprecated Use ParsedIniData from "@aws-sdk/types" instead
*/
export type ParsedIniData = __ParsedIniData;

/**
* @deprecated Use SharedConfigFiles from "@aws-sdk/types" instead
*/
export type SharedConfigFiles = __SharedConfigFiles;
1 change: 1 addition & 0 deletions packages/types/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ export * from "./http";
export * from "./logger";
export * from "./middleware";
export * from "./pagination";
export * from "./profile";
export * from "./response";
export * from "./serde";
export * from "./shapes";
Expand Down
21 changes: 21 additions & 0 deletions packages/types/src/profile.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/**
* @internal
*/
export interface Profile {
[key: string]: string | undefined;
}

/**
* @internal
*/
export interface ParsedIniData {
[key: string]: Profile;
}

/**
* @internal
*/
export interface SharedConfigFiles {
credentialsFile: ParsedIniData;
configFile: ParsedIniData;
}
1 change: 1 addition & 0 deletions packages/util-credentials/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
"tslib": "^2.3.0"
},
"devDependencies": {
"@aws-sdk/types": "*",
"@tsconfig/recommended": "1.0.1",
"@types/node": "^10.0.0",
"concurrently": "7.0.0",
Expand Down
8 changes: 2 additions & 6 deletions packages/util-credentials/src/parse-known-profiles.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
import {
loadSharedConfigFiles,
ParsedIniData,
SharedConfigFiles,
SharedConfigInit,
} from "@aws-sdk/shared-ini-file-loader";
import { loadSharedConfigFiles, SharedConfigInit } from "@aws-sdk/shared-ini-file-loader";
import { ParsedIniData, SharedConfigFiles } from "@aws-sdk/types";

export interface SourceProfileInit extends SharedConfigInit {
/**
Expand Down