ibm-cloud-sdk-core 5.0.2 → 5.1.0

package/auth/token-managers/iam-request-based-token-manager.d.ts

@@ -28,9 +28,9 @@ export interface IamRequestOptions extends JwtTokenManagerOptions {
  * class be extended with specific implementations.
  */
 export declare class IamRequestBasedTokenManager extends JwtTokenManager {
-    private clientId;
-    private clientSecret;
-    private scope;
+    protected clientId: string;
+    protected clientSecret: string;
+    protected scope: string;
     protected refreshToken: string;
     protected formData: any;
     /**
@@ -70,12 +70,6 @@ export declare class IamRequestBasedTokenManager extends JwtTokenManager {
      * @param clientSecret - the client secret.
      */
     setClientIdAndSecret(clientId: string, clientSecret: string): void;
-    /**
-     * Returns the most recently stored refresh token.
-     *
-     * @returns the refresh token
-     */
-    getRefreshToken(): string;
     /**
      * Extend this method from the parent class to extract the refresh token from
      * the request and save it.

package/auth/token-managers/iam-request-based-token-manager.js

@@ -120,14 +120,6 @@ var IamRequestBasedTokenManager = /** @class */ (function (_super) {
             logger_1.default.warn(CLIENT_ID_SECRET_WARNING);
         }
     };
-    /**
-     * Returns the most recently stored refresh token.
-     *
-     * @returns the refresh token
-     */
-    IamRequestBasedTokenManager.prototype.getRefreshToken = function () {
-        return this.refreshToken;
-    };
     /**
      * Extend this method from the parent class to extract the refresh token from
      * the request and save it.

package/auth/token-managers/iam-token-manager.d.ts

@@ -19,8 +19,8 @@ interface Options extends IamRequestOptions {
     apikey: string;
 }
 /**
- * The IAMTokenManager takes an api key and performs the necessary interactions with
- * the IAM token service to obtain and store a suitable bearer token. Additionally, the IAMTokenManager
+ * The IamTokenManager takes an api key and performs the necessary interactions with
+ * the IAM token service to obtain and store a suitable bearer token. Additionally, the IamTokenManager
  * will retrieve bearer tokens via basic auth using a supplied "clientId" and "clientSecret" pair.
  */
 export declare class IamTokenManager extends IamRequestBasedTokenManager {
@@ -46,5 +46,11 @@ export declare class IamTokenManager extends IamRequestBasedTokenManager {
      * @throws Error: the configuration options are not valid.
      */
     constructor(options: Options);
+    /**
+     * Returns the most recently stored refresh token.
+     *
+     * @returns the refresh token
+     */
+    getRefreshToken(): string;
 }
 export {};

package/auth/token-managers/iam-token-manager.js

@@ -35,8 +35,8 @@ var helpers_1 = require("../utils/helpers");
 var build_user_agent_1 = require("../../lib/build-user-agent");
 var iam_request_based_token_manager_1 = require("./iam-request-based-token-manager");
 /**
- * The IAMTokenManager takes an api key and performs the necessary interactions with
- * the IAM token service to obtain and store a suitable bearer token. Additionally, the IAMTokenManager
+ * The IamTokenManager takes an api key and performs the necessary interactions with
+ * the IAM token service to obtain and store a suitable bearer token. Additionally, the IamTokenManager
  * will retrieve bearer tokens via basic auth using a supplied "clientId" and "clientSecret" pair.
  */
 var IamTokenManager = /** @class */ (function (_super) {
@@ -72,6 +72,14 @@ var IamTokenManager = /** @class */ (function (_super) {
         _this.userAgent = (0, build_user_agent_1.buildUserAgent)('iam-authenticator');
         return _this;
     }
+    /**
+     * Returns the most recently stored refresh token.
+     *
+     * @returns the refresh token
+     */
+    IamTokenManager.prototype.getRefreshToken = function () {
+        return this.refreshToken;
+    };
     return IamTokenManager;
 }(iam_request_based_token_manager_1.IamRequestBasedTokenManager));
 exports.IamTokenManager = IamTokenManager;

package/auth/token-managers/index.d.ts

@@ -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, JwtTokenManagerOptions } from './jwt-token-manager';
 export { TokenManager, TokenManagerOptions } from './token-manager';
 export { VpcInstanceTokenManager } from './vpc-instance-token-manager';
 export { McspTokenManager } from './mcsp-token-manager';
+export { IamAssumeTokenManager } from './iam-assume-token-manager';

package/auth/token-managers/index.js

@@ -15,12 +15,12 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.McspTokenManager = exports.VpcInstanceTokenManager = exports.TokenManager = exports.JwtTokenManager = exports.IamRequestBasedTokenManager = exports.ContainerTokenManager = exports.Cp4dTokenManager = exports.IamTokenManager = void 0;
+exports.IamAssumeTokenManager = exports.McspTokenManager = exports.VpcInstanceTokenManager = exports.TokenManager = exports.JwtTokenManager = exports.IamRequestBasedTokenManager = exports.ContainerTokenManager = exports.Cp4dTokenManager = exports.IamTokenManager = void 0;
 /**
  * @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
@@ -31,6 +31,7 @@ exports.McspTokenManager = exports.VpcInstanceTokenManager = exports.TokenManage
  *
  * 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.
@@ -53,3 +54,5 @@ var vpc_instance_token_manager_1 = require("./vpc-instance-token-manager");
 Object.defineProperty(exports, "VpcInstanceTokenManager", { enumerable: true, get: function () { return vpc_instance_token_manager_1.VpcInstanceTokenManager; } });
 var mcsp_token_manager_1 = require("./mcsp-token-manager");
 Object.defineProperty(exports, "McspTokenManager", { enumerable: true, get: function () { return mcsp_token_manager_1.McspTokenManager; } });
+var iam_assume_token_manager_1 = require("./iam-assume-token-manager");
+Object.defineProperty(exports, "IamAssumeTokenManager", { enumerable: true, get: function () { return iam_assume_token_manager_1.IamAssumeTokenManager; } });

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

@@ -81,6 +81,9 @@ function getAuthenticatorFromEnvironment(serviceName) {
     else if (authType === authenticators_1.Authenticator.AUTHTYPE_IAM.toLowerCase()) {
         authenticator = new authenticators_1.IamAuthenticator(credentials);
     }
+    else if (authType === authenticators_1.Authenticator.AUTHTYPE_IAM_ASSUME.toLowerCase()) {
+        authenticator = new authenticators_1.IamAssumeAuthenticator(credentials);
+    }
     else if (authType === authenticators_1.Authenticator.AUTHTYPE_CONTAINER.toLowerCase()) {
         authenticator = new authenticators_1.ContainerAuthenticator(credentials);
     }

package/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/auth/utils/helpers.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * (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.
@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.atMostOne = exports.atLeastOne = exports.removeSuffix = exports.onlyOne = exports.getCurrentTime = exports.validateInput = exports.checkCredentials = exports.computeBasicAuthHeader = void 0;
+exports.atMostOne = exports.atLeastOne = exports.onlyOne = exports.removeSuffix = exports.getCurrentTime = exports.validateInput = exports.checkCredentials = exports.computeBasicAuthHeader = void 0;
 var helper_1 = require("../../lib/helper");
 /**
  * Compute and return a Basic Authorization header from a username and password.
@@ -87,20 +87,6 @@ function getCurrentTime() {
     return Math.floor(Date.now() / 1000);
 }
 exports.getCurrentTime = getCurrentTime;
-/**
- * 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
- */
-function onlyOne(a, b) {
-    return Boolean((a && !b) || (b && !a));
-}
-exports.onlyOne = onlyOne;
 /**
  * Removes a given suffix if it exists.
  *
@@ -117,26 +103,60 @@ function removeSuffix(str, suffix) {
 }
 exports.removeSuffix = removeSuffix;
 /**
- * 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
  */
-function atLeastOne(a, b) {
-    return Boolean(a || b);
+function onlyOne() {
+    var args = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        args[_i] = arguments[_i];
+    }
+    return countDefinedArgs(args) === 1;
 }
-exports.atLeastOne = atLeastOne;
+exports.onlyOne = onlyOne;
 /**
- * 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
+ */
+function atLeastOne() {
+    var args = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        args[_i] = arguments[_i];
+    }
+    return countDefinedArgs(args) >= 1;
+}
+exports.atLeastOne = atLeastOne;
+/**
+ * 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
  */
-function atMostOne(a, b) {
-    return Boolean(!(a && b));
+function atMostOne() {
+    var args = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        args[_i] = arguments[_i];
+    }
+    return countDefinedArgs(args) <= 1;
 }
 exports.atMostOne = atMostOne;
+/**
+ * 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(function (total, arg) {
+        if (arg) {
+            total += 1;
+        }
+        return total;
+    }, 0);
+}