@smithy/shared-ini-file-loader 3.1.12 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,15 @@
1
+ /**
2
+ * @internal
3
+ */
1
4
  export declare const ENV_PROFILE = "AWS_PROFILE";
5
+ /**
6
+ * @internal
7
+ */
2
8
  export declare const DEFAULT_PROFILE = "default";
9
+ /**
10
+ * Returns profile with priority order code - ENV - default.
11
+ * @internal
12
+ */
3
13
  export declare const getProfileName: (init: {
4
14
  profile?: string;
5
15
  }) => string;
@@ -1,4 +1,5 @@
1
1
  /**
2
2
  * Returns the filepath of the file where SSO token is stored.
3
+ * @internal
3
4
  */
4
5
  export declare const getSSOTokenFilepath: (id: string) => string;
@@ -1,5 +1,6 @@
1
1
  /**
2
2
  * Cached SSO token retrieved from SSO login flow.
3
+ * @public
3
4
  */
4
5
  export interface SSOToken {
5
6
  /**
@@ -38,6 +39,7 @@ export interface SSOToken {
38
39
  startUrl?: string;
39
40
  }
40
41
  /**
42
+ * @internal
41
43
  * @param id - can be either a start URL or the SSO session name.
42
44
  * Returns the SSO token from the file system.
43
45
  */
@@ -1,4 +1,7 @@
1
1
  import { Logger, SharedConfigFiles } from "@smithy/types";
2
+ /**
3
+ * @public
4
+ */
2
5
  export interface SharedConfigInit {
3
6
  /**
4
7
  * The path at which to locate the ini credentials file. Defaults to the
@@ -22,5 +25,12 @@ export interface SharedConfigInit {
22
25
  */
23
26
  logger?: Logger;
24
27
  }
28
+ /**
29
+ * @internal
30
+ */
25
31
  export declare const CONFIG_PREFIX_SEPARATOR = ".";
32
+ /**
33
+ * Loads the config and credentials files.
34
+ * @internal
35
+ */
26
36
  export declare const loadSharedConfigFiles: (init?: SharedConfigInit) => Promise<SharedConfigFiles>;
@@ -1,4 +1,8 @@
1
1
  import { ParsedIniData } from "@smithy/types";
2
+ /**
3
+ * Subset of {@link SharedConfigInit}.
4
+ * @internal
5
+ */
2
6
  export interface SsoSessionInit {
3
7
  /**
4
8
  * The path at which to locate the ini config file. Defaults to the value of
@@ -7,4 +11,7 @@ export interface SsoSessionInit {
7
11
  */
8
12
  configFilepath?: string;
9
13
  }
14
+ /**
15
+ * @internal
16
+ */
10
17
  export declare const loadSsoSessionData: (init?: SsoSessionInit) => Promise<ParsedIniData>;
@@ -1,5 +1,8 @@
1
1
  import { ParsedIniData } from "@smithy/types";
2
2
  import { SharedConfigInit } from "./loadSharedConfigFiles";
3
+ /**
4
+ * @public
5
+ */
3
6
  export interface SourceProfileInit extends SharedConfigInit {
4
7
  /**
5
8
  * The configuration profile to use.
@@ -1,5 +1,15 @@
1
+ /**
2
+ * @internal
3
+ */
1
4
  export declare const ENV_PROFILE = "AWS_PROFILE";
5
+ /**
6
+ * @internal
7
+ */
2
8
  export declare const DEFAULT_PROFILE = "default";
9
+ /**
10
+ * Returns profile with priority order code - ENV - default.
11
+ * @internal
12
+ */
3
13
  export declare const getProfileName: (init: {
4
14
  profile?: string;
5
15
  }) => string;
@@ -1,4 +1,5 @@
1
1
  /**
2
2
  * Returns the filepath of the file where SSO token is stored.
3
+ * @internal
3
4
  */
4
5
  export declare const getSSOTokenFilepath: (id: string) => string;
@@ -1,5 +1,6 @@
1
1
  /**
2
2
  * Cached SSO token retrieved from SSO login flow.
3
+ * @public
3
4
  */
4
5
  export interface SSOToken {
5
6
  /**
@@ -38,6 +39,7 @@ export interface SSOToken {
38
39
  startUrl?: string;
39
40
  }
40
41
  /**
42
+ * @internal
41
43
  * @param id - can be either a start URL or the SSO session name.
42
44
  * Returns the SSO token from the file system.
43
45
  */
@@ -1,4 +1,7 @@
1
1
  import { Logger, SharedConfigFiles } from "@smithy/types";
2
+ /**
3
+ * @public
4
+ */
2
5
  export interface SharedConfigInit {
3
6
  /**
4
7
  * The path at which to locate the ini credentials file. Defaults to the
@@ -22,5 +25,12 @@ export interface SharedConfigInit {
22
25
  */
23
26
  logger?: Logger;
24
27
  }
28
+ /**
29
+ * @internal
30
+ */
25
31
  export declare const CONFIG_PREFIX_SEPARATOR = ".";
32
+ /**
33
+ * Loads the config and credentials files.
34
+ * @internal
35
+ */
26
36
  export declare const loadSharedConfigFiles: (init?: SharedConfigInit) => Promise<SharedConfigFiles>;
@@ -1,4 +1,8 @@
1
1
  import { ParsedIniData } from "@smithy/types";
2
+ /**
3
+ * Subset of {@link SharedConfigInit}.
4
+ * @internal
5
+ */
2
6
  export interface SsoSessionInit {
3
7
  /**
4
8
  * The path at which to locate the ini config file. Defaults to the value of
@@ -7,4 +11,7 @@ export interface SsoSessionInit {
7
11
  */
8
12
  configFilepath?: string;
9
13
  }
14
+ /**
15
+ * @internal
16
+ */
10
17
  export declare const loadSsoSessionData: (init?: SsoSessionInit) => Promise<ParsedIniData>;
@@ -1,5 +1,8 @@
1
1
  import { ParsedIniData } from "@smithy/types";
2
2
  import { SharedConfigInit } from "./loadSharedConfigFiles";
3
+ /**
4
+ * @public
5
+ */
3
6
  export interface SourceProfileInit extends SharedConfigInit {
4
7
  /**
5
8
  * The configuration profile to use.
@@ -1,13 +1,16 @@
1
1
  import { ParsedIniData as __ParsedIniData, Profile as __Profile, SharedConfigFiles as __SharedConfigFiles } from "@smithy/types";
2
2
  /**
3
- * @deprecated Use Profile from "@smithy/types" instead
3
+ * @internal
4
+ * @deprecated Use Profile from "\@smithy/types" instead
4
5
  */
5
6
  export type Profile = __Profile;
6
7
  /**
7
- * @deprecated Use ParsedIniData from "@smithy/types" instead
8
+ * @internal
9
+ * @deprecated Use ParsedIniData from "\@smithy/types" instead
8
10
  */
9
11
  export type ParsedIniData = __ParsedIniData;
10
12
  /**
11
- * @deprecated Use SharedConfigFiles from "@smithy/types" instead
13
+ * @internal
14
+ * @deprecated Use SharedConfigFiles from "\@smithy/types" instead
12
15
  */
13
16
  export type SharedConfigFiles = __SharedConfigFiles;
@@ -1,13 +1,16 @@
1
1
  import { ParsedIniData as __ParsedIniData, Profile as __Profile, SharedConfigFiles as __SharedConfigFiles } from "@smithy/types";
2
2
  /**
3
- * @deprecated Use Profile from "@smithy/types" instead
3
+ * @internal
4
+ * @deprecated Use Profile from "\@smithy/types" instead
4
5
  */
5
6
  export type Profile = __Profile;
6
7
  /**
7
- * @deprecated Use ParsedIniData from "@smithy/types" instead
8
+ * @internal
9
+ * @deprecated Use ParsedIniData from "\@smithy/types" instead
8
10
  */
9
11
  export type ParsedIniData = __ParsedIniData;
10
12
  /**
11
- * @deprecated Use SharedConfigFiles from "@smithy/types" instead
13
+ * @internal
14
+ * @deprecated Use SharedConfigFiles from "\@smithy/types" instead
12
15
  */
13
16
  export type SharedConfigFiles = __SharedConfigFiles;
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@smithy/shared-ini-file-loader",
3
- "version": "3.1.12",
3
+ "version": "4.0.0",
4
4
  "dependencies": {
5
- "@smithy/types": "^3.7.2",
5
+ "@smithy/types": "^4.0.0",
6
6
  "tslib": "^2.6.2"
7
7
  },
8
8
  "devDependencies": {
9
- "@types/node": "^16.18.96",
9
+ "@types/node": "^18.11.9",
10
10
  "concurrently": "7.0.0",
11
11
  "downlevel-dts": "0.10.1",
12
12
  "rimraf": "3.0.2",
@@ -45,7 +45,7 @@
45
45
  "./dist-es/slurpFile": false
46
46
  },
47
47
  "engines": {
48
- "node": ">=16.0.0"
48
+ "node": ">=18.0.0"
49
49
  },
50
50
  "typesVersions": {
51
51
  "<4.0": {