ibm-cloud-sdk-core 5.0.2 → 5.1.0

package/es/auth/token-managers/index.js

@@ -16,8 +16,8 @@
 /**
  * @module token-managers
  * The ibm-cloud-sdk-core module supports the following types of token authentication:
- *
- * Identity and Access Management (IAM)
+ * Identity and Access Management (IAM, grant type: apikey)
+ * Identity and Access Management (IAM, grant type: assume)
  * Cloud Pak for Data
  * Container (IKS, etc)
  * VPC Instance
@@ -28,6 +28,7 @@
  *
  * classes:
  *   IamTokenManager: Token Manager of IAM via apikey.
+ *   IamAssumeTokenManager: Token Manager of IAM via apikey and trusted profile.
  *   Cp4dTokenManager: Token Manager of CloudPak for data.
  *   ContainerTokenManager: Token manager of IAM via compute resource token.
  *   VpcInstanceTokenManager: Token manager of VPC Instance Metadata Service API tokens.
@@ -42,3 +43,4 @@ export { JwtTokenManager } from './jwt-token-manager';
 export { TokenManager } from './token-manager';
 export { VpcInstanceTokenManager } from './vpc-instance-token-manager';
 export { McspTokenManager } from './mcsp-token-manager';
+export { IamAssumeTokenManager } from './iam-assume-token-manager';

package/es/auth/utils/get-authenticator-from-environment.js

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Authenticator, BasicAuthenticator, BearerTokenAuthenticator, CloudPakForDataAuthenticator, IamAuthenticator, ContainerAuthenticator, NoAuthAuthenticator, VpcInstanceAuthenticator, McspAuthenticator, } from '../authenticators';
+import { Authenticator, BasicAuthenticator, BearerTokenAuthenticator, CloudPakForDataAuthenticator, IamAuthenticator, IamAssumeAuthenticator, ContainerAuthenticator, NoAuthAuthenticator, VpcInstanceAuthenticator, McspAuthenticator, } from '../authenticators';
 import { readExternalSources } from './read-external-sources';
 /**
  * Look for external configuration of authenticator.
@@ -78,6 +78,9 @@ export function getAuthenticatorFromEnvironment(serviceName) {
     else if (authType === Authenticator.AUTHTYPE_IAM.toLowerCase()) {
         authenticator = new IamAuthenticator(credentials);
     }
+    else if (authType === Authenticator.AUTHTYPE_IAM_ASSUME.toLowerCase()) {
+        authenticator = new IamAssumeAuthenticator(credentials);
+    }
     else if (authType === Authenticator.AUTHTYPE_CONTAINER.toLowerCase()) {
         authenticator = new ContainerAuthenticator(credentials);
     }

package/es/auth/utils/helpers.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019, 2022.
+ * (C) Copyright IBM Corp. 2019, 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -43,17 +43,6 @@ export declare function validateInput(options: any, requiredOptions: string[]):
  * @returns the current time in seconds.
  */
 export declare function getCurrentTime(): number;
-/**
- * Checks for only one of two elements being defined.
- * Returns true if a is defined and b is undefined,
- * or vice versa. Returns false if both are defined
- * or both are undefined.
- *
- * @param a - The first object
- * @param b - The second object
- * @returns true if and only if exactly one of a or b is defined
- */
-export declare function onlyOne(a: any, b: any): boolean;
 /**
  * Removes a given suffix if it exists.
  *
@@ -64,20 +53,26 @@ export declare function onlyOne(a: any, b: any): boolean;
  */
 export declare function removeSuffix(str: string, suffix: string): string;
 /**
- * Checks for at least one of two elements being defined.
+ * Checks that exactly one of the arguments provided is defined.
+ * Returns true if one argument is defined. Returns false if no
+ * argument are defined or if 2 or more are defined.
  *
- * @param a - the first object
- * @param b - the second object
- * @returns true if a or b is defined; false if both are undefined
+ * @param args - The spread of arguments to check
+ * @returns true if and only if exactly one argument is defined
  */
-export declare function atLeastOne(a: any, b: any): boolean;
+export declare function onlyOne(...args: any): boolean;
 /**
- * Verifies that both properties are not specified.
+ * Checks for at least one of the given elements being defined.
  *
- * @param a - The first object
- * @param b - The second object
+ * @param args - The spread of arguments to check
+ * @returns true if one or more are defined; false if all are undefined
+ */
+export declare function atLeastOne(...args: any): boolean;
+/**
+ * Verifies that no more than one of the given elements are defined.
+ * Returns true if one or none are defined, and false otherwise.
  *
- * @returns  false if a and b are both defined, true otherwise
-
+ * @param args - The spread of arguments to check
+ * @returns  false if more than one elements are defined, true otherwise
  */
-export declare function atMostOne(a: any, b: any): boolean;
+export declare function atMostOne(...args: any): boolean;

package/es/auth/utils/helpers.js

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019, 2022.
+ * (C) Copyright IBM Corp. 2019, 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -80,19 +80,6 @@ export function validateInput(options, requiredOptions) {
 export function getCurrentTime() {
     return Math.floor(Date.now() / 1000);
 }
-/**
- * Checks for only one of two elements being defined.
- * Returns true if a is defined and b is undefined,
- * or vice versa. Returns false if both are defined
- * or both are undefined.
- *
- * @param a - The first object
- * @param b - The second object
- * @returns true if and only if exactly one of a or b is defined
- */
-export function onlyOne(a, b) {
-    return Boolean((a && !b) || (b && !a));
-}
 /**
  * Removes a given suffix if it exists.
  *
@@ -108,24 +95,45 @@ export function removeSuffix(str, suffix) {
     return str;
 }
 /**
- * Checks for at least one of two elements being defined.
+ * Checks that exactly one of the arguments provided is defined.
+ * Returns true if one argument is defined. Returns false if no
+ * argument are defined or if 2 or more are defined.
  *
- * @param a - the first object
- * @param b - the second object
- * @returns true if a or b is defined; false if both are undefined
+ * @param args - The spread of arguments to check
+ * @returns true if and only if exactly one argument is defined
  */
-export function atLeastOne(a, b) {
-    return Boolean(a || b);
+export function onlyOne(...args) {
+    return countDefinedArgs(args) === 1;
 }
 /**
- * Verifies that both properties are not specified.
+ * Checks for at least one of the given elements being defined.
  *
- * @param a - The first object
- * @param b - The second object
+ * @param args - The spread of arguments to check
+ * @returns true if one or more are defined; false if all are undefined
+ */
+export function atLeastOne(...args) {
+    return countDefinedArgs(args) >= 1;
+}
+/**
+ * Verifies that no more than one of the given elements are defined.
+ * Returns true if one or none are defined, and false otherwise.
  *
- * @returns  false if a and b are both defined, true otherwise
-
+ * @param args - The spread of arguments to check
+ * @returns  false if more than one elements are defined, true otherwise
  */
-export function atMostOne(a, b) {
-    return Boolean(!(a && b));
+export function atMostOne(...args) {
+    return countDefinedArgs(args) <= 1;
+}
+/**
+ * Takes a list of anything (intended to be the arguments passed to one of the
+ * argument checking functions above) and returns how many elements in that
+ * list are not undefined.
+ */
+function countDefinedArgs(args) {
+    return args.reduce((total, arg) => {
+        if (arg) {
+            total += 1;
+        }
+        return total;
+    }, 0);
 }

package/etc/ibm-cloud-sdk-core.api.md

@@ -13,10 +13,10 @@ import { OutgoingHttpHeaders } from 'http';
 import { Stream } from 'stream';
 
 // @public
-export function atLeastOne(a: any, b: any): boolean;
+export function atLeastOne(...args: any): boolean;
 
 // @public
-export function atMostOne(a: any, b: any): boolean;
+export function atMostOne(...args: any): boolean;
 
 // @public
 export class Authenticator implements AuthenticatorInterface {
@@ -34,6 +34,8 @@ export class Authenticator implements AuthenticatorInterface {
     // (undocumented)
     static AUTHTYPE_IAM: string;
     // (undocumented)
+    static AUTHTYPE_IAM_ASSUME: string;
+    // (undocumented)
     static AUTHTYPE_MCSP: string;
     // (undocumented)
     static AUTHTYPE_NOAUTH: string;
@@ -130,6 +132,7 @@ export class ContainerAuthenticator extends IamRequestBasedAuthenticator {
     // Warning: (ae-forgotten-export) The symbol "Options_8" needs to be exported by the entry point index.d.ts
     constructor(options: Options_8);
     authenticationType(): string;
+    getRefreshToken(): string;
     setCrTokenFilename(crTokenFilename: string): void;
     setIamProfileId(iamProfileId: string): void;
     setIamProfileName(iamProfileName: string): void;
@@ -142,6 +145,7 @@ export class ContainerTokenManager extends IamRequestBasedTokenManager {
     // Warning: (ae-forgotten-export) The symbol "Options_7" needs to be exported by the entry point index.d.ts
     constructor(options: Options_7);
     protected getCrToken(): string;
+    getRefreshToken(): string;
     protected requestToken(): Promise<any>;
     setCrTokenFilename(crTokenFilename: string): void;
     setIamProfileId(iamProfileId: string): void;
@@ -224,11 +228,37 @@ export function getNewLogger(moduleName: string): SDKLogger;
 // @public
 export function getQueryParam(urlStr: string, param: string): string;
 
+// Warning: (ae-forgotten-export) The symbol "IamRequestBasedAuthenticatorImmutable" needs to be exported by the entry point index.d.ts
+//
+// @public
+export class IamAssumeAuthenticator extends IamRequestBasedAuthenticatorImmutable {
+    // Warning: (ae-forgotten-export) The symbol "Options_14" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_14);
+    authenticationType(): string;
+    // (undocumented)
+    protected tokenManager: IamAssumeTokenManager;
+}
+
+// @public
+export class IamAssumeTokenManager extends IamRequestBasedTokenManager {
+    // Warning: (ae-forgotten-export) The symbol "Options_13" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_13);
+    protected requestToken(): Promise<any>;
+    // (undocumented)
+    protected requiredOptions: string[];
+    protected saveTokenInfo(tokenResponse: any): void;
+    setClientIdAndSecret(clientId: string, clientSecret: string): void;
+    setDisableSslVerification(value: boolean): void;
+    setHeaders(headers: OutgoingHttpHeaders): void;
+    setScope(scope: string): void;
+}
+
 // @public
 export class IamAuthenticator extends IamRequestBasedAuthenticator {
     // Warning: (ae-forgotten-export) The symbol "Options_6" needs to be exported by the entry point index.d.ts
     constructor(options: Options_6);
     authenticationType(): string;
+    getRefreshToken(): string;
     // (undocumented)
     protected requiredOptions: string[];
     // (undocumented)
@@ -236,33 +266,29 @@ export class IamAuthenticator extends IamRequestBasedAuthenticator {
 }
 
 // @public
-export class IamRequestBasedAuthenticator extends TokenRequestBasedAuthenticator {
-    // Warning: (ae-forgotten-export) The symbol "IamRequestOptions_2" needs to be exported by the entry point index.d.ts
-    constructor(options: IamRequestOptions_2);
-    // (undocumented)
-    protected clientId: string;
-    // (undocumented)
-    protected clientSecret: string;
-    getRefreshToken(): string;
-    // (undocumented)
-    protected scope: string;
+export class IamRequestBasedAuthenticator extends IamRequestBasedAuthenticatorImmutable {
     setClientIdAndSecret(clientId: string, clientSecret: string): void;
+    setDisableSslVerification(value: boolean): void;
+    setHeaders(headers: OutgoingHttpHeaders): void;
     setScope(scope: string): void;
-    // (undocumented)
-    protected tokenManager: IamRequestBasedTokenManager;
 }
 
 // @public
 export class IamRequestBasedTokenManager extends JwtTokenManager {
     constructor(options: IamRequestOptions);
     // (undocumented)
+    protected clientId: string;
+    // (undocumented)
+    protected clientSecret: string;
+    // (undocumented)
     protected formData: any;
-    getRefreshToken(): string;
     protected isTokenExpired(): boolean;
     // (undocumented)
     protected refreshToken: string;
     protected requestToken(): Promise<any>;
     protected saveTokenInfo(tokenResponse: any): void;
+    // (undocumented)
+    protected scope: string;
     setClientIdAndSecret(clientId: string, clientSecret: string): void;
     setScope(scope: string): void;
 }
@@ -281,6 +307,7 @@ export interface IamRequestOptions extends JwtTokenManagerOptions {
 export class IamTokenManager extends IamRequestBasedTokenManager {
     // Warning: (ae-forgotten-export) The symbol "Options_5" needs to be exported by the entry point index.d.ts
     constructor(options: Options_5);
+    getRefreshToken(): string;
     // (undocumented)
     protected requiredOptions: string[];
 }
@@ -343,7 +370,7 @@ export class NoAuthAuthenticator extends Authenticator {
 }
 
 // @public
-export function onlyOne(a: any, b: any): boolean;
+export function onlyOne(...args: any): boolean;
 
 // @public
 export const qs: {
@@ -420,21 +447,12 @@ export type TokenManagerOptions = {
     [propName: string]: any;
 };
 
+// Warning: (ae-forgotten-export) The symbol "TokenRequestBasedAuthenticatorImmutable" needs to be exported by the entry point index.d.ts
+//
 // @public
-export class TokenRequestBasedAuthenticator extends Authenticator {
-    // Warning: (ae-forgotten-export) The symbol "BaseOptions" needs to be exported by the entry point index.d.ts
-    constructor(options: BaseOptions);
-    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
-    // (undocumented)
-    protected disableSslVerification: boolean;
-    // (undocumented)
-    protected headers: OutgoingHttpHeaders;
+export class TokenRequestBasedAuthenticator extends TokenRequestBasedAuthenticatorImmutable {
     setDisableSslVerification(value: boolean): void;
     setHeaders(headers: OutgoingHttpHeaders): void;
-    // (undocumented)
-    protected tokenManager: JwtTokenManager;
-    // (undocumented)
-    protected url: string;
 }
 
 // @public