feat(types): update identity types

Author: Steven Yuan

packages/types/src/credentials.ts

@@ -1,31 +1,14 @@
+import { AwsCredentialIdentity } from "./identity";
 import { Provider } from "./util";
 
-export interface AwsCredentialIdentity {
-  /**
-   * A {Date} when the identity or credential will no longer be accepted.
-   */
-  readonly expiration?: Date;
-}
-
 /**
  * An object representing temporary or permanent AWS credentials.
+ *
+ * @deprecated Use {@AwsCredentialIdentity}
  */
-export interface Credentials extends AwsCredentialIdentity {
-  /**
-   * AWS access key ID
-   */
-  readonly accessKeyId: string;
-
-  /**
-   * AWS secret access key
-   */
-  readonly secretAccessKey: string;
-
-  /**
-   * A security or session token to use with these credentials. Usually
-   * present for temporary credentials.
-   */
-  readonly sessionToken?: string;
-}
+export interface Credentials extends AwsCredentialIdentity { }
 
+/**
+ * @deprecated Use {@AwsCredentialIdentityProvider}
+ */
 export type CredentialProvider = Provider<Credentials>;

packages/types/src/identity/AnonymousIdentity.ts

@@ -0,0 +1,3 @@
+import { Identity } from "./Identity";
+
+export interface AnonymousIdentity extends Identity { }

packages/types/src/identity/AwsCredentialIdentity.ts

@@ -0,0 +1,21 @@
+import { Identity, IdentityProvider } from "./Identity";
+
+export interface AwsCredentialIdentity extends Identity {
+  /**
+   * AWS access key ID
+   */
+  readonly accessKeyId: string;
+
+  /**
+   * AWS secret access key
+   */
+  readonly secretAccessKey: string;
+
+  /**
+   * A security or session token to use with these credentials. Usually
+   * present for temporary credentials.
+   */
+  readonly sessionToken?: string;
+}
+
+export type AwsCredentialIdentityProvider = IdentityProvider<AwsCredentialIdentity>;

packages/types/src/identity/Identity.ts

@@ -0,0 +1,10 @@
+export interface Identity {
+  /**
+   * A {Date} when the identity or credential will no longer be accepted.
+   */
+  readonly expiration?: Date;
+}
+
+export type IdentityProvider<IdentityT extends Identity> = {
+  (identityProperties?: Record<string, any>): Promise<IdentityT>;
+};

packages/types/src/identity/LoginIdentity.ts

@@ -0,0 +1,15 @@
+import { Identity, IdentityProvider } from "./Identity";
+
+export interface LoginIdentity extends Identity {
+  /**
+   * Identity username
+   */
+  readonly username: string;
+
+  /**
+   * Identity password
+   */
+  readonly password: string;
+}
+
+export type LoginIdentityProvider = IdentityProvider<LoginIdentity>;

packages/types/src/identity/TokenIdentity.ts

@@ -0,0 +1,10 @@
+import { Identity, IdentityProvider } from "./Identity";
+
+export interface TokenIdentity extends Identity {
+  /**
+   * The literal token string
+   */
+  readonly token: string;
+}
+
+export type TokenIdentityProvider = IdentityProvider<TokenIdentity>;

packages/types/src/identity/index.ts

@@ -0,0 +1,5 @@
+export * from "./AnonymousIdentity";
+export * from "./AwsCredentialIdentity";
+export * from "./Identity";
+export * from "./LoginIdentity";
+export * from "./TokenIdentity";

packages/types/src/index.ts

@@ -7,6 +7,7 @@ export * from "./crypto";
 export * from "./endpoint";
 export * from "./eventStream";
 export * from "./http";
+export * from "./identity";
 export * from "./logger";
 export * from "./middleware";
 export * from "./pagination";

packages/types/src/token.ts

@@ -1,18 +1,14 @@
+import { TokenIdentity } from "./identity";
 import { Provider } from "./util";
 
 /**
  * An object representing temporary or permanent AWS token.
+ *
+ * @deprecated Use {@TokenIdentity}
  */
-export interface Token {
-  /**
-   *The literal token string
-   */
-  readonly token: string;
-  /**
-   * A {Date} when these token will no longer be accepted.
-   * When expiration is not defined, the token is assumed to be permanent.
-   */
-  readonly expiration?: Date;
-}
+export interface Token extends TokenIdentity { }
 
+/**
+ * @deprecated Use {@TokenIdentityProvider}
+ */
 export type TokenProvider = Provider<Token>;