@smithy/shared-ini-file-loader 1.0.1 → 1.0.3

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

@@ -0,0 +1,2 @@
+export declare const ENV_CONFIG_PATH = "AWS_CONFIG_FILE";
+export declare const getConfigFilepath: () => string;

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

@@ -0,0 +1,2 @@
+export declare const ENV_CREDENTIALS_PATH = "AWS_SHARED_CREDENTIALS_FILE";
+export declare const getCredentialsFilepath: () => string;

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

@@ -0,0 +1,6 @@
+/**
+ * Get the HOME directory for the current runtime.
+ *
+ * @internal
+ */
+export declare const getHomeDir: () => string;

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

@@ -0,0 +1,7 @@
+import { ParsedIniData } from "@smithy/types";
+/**
+ * Returns the profile data from parsed ini data.
+ * * Returns data for `default`
+ * * Reads profileName after profile prefix including/excluding quotes
+ */
+export declare const getProfileData: (data: ParsedIniData) => ParsedIniData;

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

@@ -0,0 +1,5 @@
+export declare const ENV_PROFILE = "AWS_PROFILE";
+export declare const DEFAULT_PROFILE = "default";
+export declare const getProfileName: (init: {
+    profile?: string;
+}) => string;

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

@@ -0,0 +1,4 @@
+/**
+ * Returns the filepath of the file where SSO token is stored.
+ */
+export declare const getSSOTokenFilepath: (id: string) => string;

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

@@ -0,0 +1,44 @@
+/**
+ * Cached SSO token retrieved from SSO login flow.
+ */
+export interface SSOToken {
+    /**
+     * A base64 encoded string returned by the sso-oidc service.
+     */
+    accessToken: string;
+    /**
+     * The expiration time of the accessToken as an RFC 3339 formatted timestamp.
+     */
+    expiresAt: string;
+    /**
+     * The token used to obtain an access token in the event that the accessToken is invalid or expired.
+     */
+    refreshToken?: string;
+    /**
+     * The unique identifier string for each client. The client ID generated when performing the registration
+     * portion of the OIDC authorization flow. This is used to refresh the accessToken.
+     */
+    clientId?: string;
+    /**
+     * A secret string generated when performing the registration portion of the OIDC authorization flow.
+     * This is used to refresh the accessToken.
+     */
+    clientSecret?: string;
+    /**
+     * The expiration time of the client registration (clientId and clientSecret) as an RFC 3339 formatted timestamp.
+     */
+    registrationExpiresAt?: string;
+    /**
+     * The configured sso_region for the profile that credentials are being resolved for.
+     */
+    region?: string;
+    /**
+     * The configured sso_start_url for the profile that credentials are being resolved for.
+     */
+    startUrl?: string;
+}
+/**
+ * @param id - can be either a start URL or the SSO session name.
+ * Returns the SSO token from the file system.
+ */
+export declare const getSSOTokenFromFile: (id: string) => Promise<SSOToken>;

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

@@ -0,0 +1,6 @@
+import { ParsedIniData } from "@smithy/types";
+/**
+ * Returns the sso-session data from parsed ini data by reading
+ * ssoSessionName after sso-session prefix including/excluding quotes
+ */
+export declare const getSsoSessionData: (data: ParsedIniData) => ParsedIniData;

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

@@ -0,0 +1,8 @@
+export * from "./getHomeDir";
+export * from "./getProfileName";
+export * from "./getSSOTokenFilepath";
+export * from "./getSSOTokenFromFile";
+export * from "./loadSharedConfigFiles";
+export * from "./loadSsoSessionData";
+export * from "./parseKnownFiles";
+export * from "./types";

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

@@ -0,0 +1,21 @@
+import { SharedConfigFiles } from "@smithy/types";
+export interface SharedConfigInit {
+    /**
+     * The path at which to locate the ini credentials file. Defaults to the
+     * value of the `AWS_SHARED_CREDENTIALS_FILE` environment variable (if
+     * defined) or `~/.aws/credentials` otherwise.
+     */
+    filepath?: string;
+    /**
+     * The path at which to locate the ini config file. Defaults to the value of
+     * the `AWS_CONFIG_FILE` environment variable (if defined) or
+     * `~/.aws/config` otherwise.
+     */
+    configFilepath?: string;
+    /**
+     * Configuration files are normally cached after the first time they are loaded. When this
+     * property is set, the provider will always reload any configuration files loaded before.
+     */
+    ignoreCache?: boolean;
+}
+export declare const loadSharedConfigFiles: (init?: SharedConfigInit) => Promise<SharedConfigFiles>;

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

@@ -0,0 +1,10 @@
+import { ParsedIniData } from "@smithy/types";
+export interface SsoSessionInit {
+    /**
+     * The path at which to locate the ini config file. Defaults to the value of
+     * the `AWS_CONFIG_FILE` environment variable (if defined) or
+     * `~/.aws/config` otherwise.
+     */
+    configFilepath?: string;
+}
+export declare const loadSsoSessionData: (init?: SsoSessionInit) => Promise<ParsedIniData>;

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

@@ -0,0 +1,7 @@
+import { ParsedIniData } from "@smithy/types";
+/**
+ * Merge multiple profile config files such that settings each file are kept together
+ *
+ * @internal
+ */
+export declare const mergeConfigFiles: (...files: ParsedIniData[]) => ParsedIniData;

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

@@ -0,0 +1,2 @@
+import { ParsedIniData } from "@smithy/types";
+export declare const parseIni: (iniData: string) => ParsedIniData;

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

@@ -0,0 +1,15 @@
+import { ParsedIniData } from "@smithy/types";
+import { SharedConfigInit } from "./loadSharedConfigFiles";
+export interface SourceProfileInit extends SharedConfigInit {
+    /**
+     * The configuration profile to use.
+     */
+    profile?: string;
+}
+/**
+ * Load profiles from credentials and config INI files and normalize them into a
+ * single profile list.
+ *
+ * @internal
+ */
+export declare const parseKnownFiles: (init: SourceProfileInit) => Promise<ParsedIniData>;

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

@@ -0,0 +1,5 @@
+interface SlurpFileOptions {
+    ignoreCache?: boolean;
+}
+export declare const slurpFile: (path: string, options?: SlurpFileOptions) => Promise<string>;
+export {};

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

@@ -0,0 +1,13 @@
+import { ParsedIniData as __ParsedIniData, Profile as __Profile, SharedConfigFiles as __SharedConfigFiles } from "@smithy/types";
+/**
+ * @deprecated Use Profile from "@smithy/types" instead
+ */
+export type Profile = __Profile;
+/**
+ * @deprecated Use ParsedIniData from "@smithy/types" instead
+ */
+export type ParsedIniData = __ParsedIniData;
+/**
+ * @deprecated Use SharedConfigFiles from "@smithy/types" instead
+ */
+export type SharedConfigFiles = __SharedConfigFiles;

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@smithy/shared-ini-file-loader",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "dependencies": {
-    "@smithy/types": "^1.1.0",
+    "@smithy/types": "^2.0.0",
     "tslib": "^2.5.0"
   },
   "devDependencies": {
@@ -16,7 +16,7 @@
     "typescript": "~4.9.5"
   },
   "scripts": {
-    "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
+    "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types && yarn build:types:downlevel'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "build:es": "tsc -p tsconfig.es.json",
     "build:types": "tsc -p tsconfig.types.json",