ibm-cloud-sdk-core 3.2.2-beta-5 → 3.2.2

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

@@ -0,0 +1,483 @@
+## API Report File for "ibm-cloud-sdk-core"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+/// <reference types="node" />
+
+import { AxiosInstance } from 'axios';
+import type { CookieJar } from 'tough-cookie';
+import { Debugger } from 'debug';
+import { OutgoingHttpHeaders } from 'http';
+import { Stream } from 'stream';
+
+// @public
+export function atLeastOne(a: any, b: any): boolean;
+
+// @public
+export function atMostOne(a: any, b: any): boolean;
+
+// @public
+export class Authenticator implements AuthenticatorInterface {
+    constructor();
+    // Warning: (ae-forgotten-export) The symbol "AuthenticateOptions" needs to be exported by the entry point index.d.ts
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
+    authenticationType(): string;
+    static AUTHTYPE_BASIC: string;
+    // (undocumented)
+    static AUTHTYPE_BEARERTOKEN: string;
+    // (undocumented)
+    static AUTHTYPE_CONTAINER: string;
+    // (undocumented)
+    static AUTHTYPE_CP4D: string;
+    // (undocumented)
+    static AUTHTYPE_IAM: string;
+    // (undocumented)
+    static AUTHTYPE_NOAUTH: string;
+    // (undocumented)
+    static AUTHTYPE_UNKNOWN: string;
+    // (undocumented)
+    static AUTHTYPE_VPC: string;
+}
+
+// @public
+export interface AuthenticatorInterface {
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
+    authenticationType(): string;
+}
+
+// @public
+export class BaseService {
+    constructor(userOptions: UserOptions);
+    // Warning: (ae-forgotten-export) The symbol "BaseServiceOptions" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    protected baseOptions: BaseServiceOptions;
+    protected configureService(serviceName: string): void;
+    protected createRequest(parameters: any): Promise<any>;
+    // (undocumented)
+    static DEFAULT_SERVICE_NAME: string;
+    // (undocumented)
+    static DEFAULT_SERVICE_URL: string;
+    disableRetries(): void;
+    // Warning: (ae-forgotten-export) The symbol "RetryOptions" needs to be exported by the entry point index.d.ts
+    enableRetries(retryOptions?: RetryOptions): void;
+    getAuthenticator(): any;
+    getHttpClient(): AxiosInstance;
+    setDefaultHeaders(headers: OutgoingHttpHeaders): void;
+    setEnableGzipCompression(setting: boolean): void;
+    setServiceUrl(url: string): void;
+}
+
+// @public
+export class BasicAuthenticator extends Authenticator {
+    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    constructor(options: Options);
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
+    authenticationType(): string;
+    // (undocumented)
+    protected authHeader: {
+        Authorization: string;
+    };
+    // (undocumented)
+    protected requiredOptions: string[];
+}
+
+// @public
+export class BearerTokenAuthenticator extends Authenticator {
+    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_2);
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
+    authenticationType(): string;
+    // (undocumented)
+    protected requiredOptions: string[];
+    setBearerToken(bearerToken: string): void;
+}
+
+// @public
+export function buildRequestFileObject(fileParam: FileWithMetadata): Promise<FileObject>;
+
+// @public
+export function checkCredentials(obj: any, credsToCheck: string[]): Error | null;
+
+// @public
+function checkForSuccessfulExecution(createRequestMock: any): void;
+
+// @public
+function checkMediaHeaders(createRequestMock: any, accept: string, contentType: string): void;
+
+// @public
+function checkUrlAndMethod(options: any, url: string, method: any): void;
+
+// @public
+function checkUserHeader(createRequestMock: any, userHeaderName: string, userHeaderValue: string): void;
+
+// @public
+export class CloudPakForDataAuthenticator extends TokenRequestBasedAuthenticator {
+    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_4);
+    authenticationType(): string;
+    // (undocumented)
+    protected requiredOptions: string[];
+    // (undocumented)
+    protected tokenManager: Cp4dTokenManager;
+}
+
+// @public
+export function computeBasicAuthHeader(username: string, password: string): string;
+
+// @public (undocumented)
+export function constructFilepath(filepath: string): string;
+
+// @public
+export function constructServiceUrl(parameterizedUrl: string, defaultUrlVariables: Map<string, string>, providedUrlVariables: Map<string, string> | null): string;
+
+// @public
+export class ContainerAuthenticator extends IamRequestBasedAuthenticator {
+    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_8);
+    authenticationType(): string;
+    setCrTokenFilename(crTokenFilename: string): void;
+    setIamProfileId(iamProfileId: string): void;
+    setIamProfileName(iamProfileName: string): void;
+    // (undocumented)
+    protected tokenManager: ContainerTokenManager;
+}
+
+// @public
+export class ContainerTokenManager extends IamRequestBasedTokenManager {
+    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_7);
+    protected requestToken(): Promise<any>;
+    setCrTokenFilename(crTokenFilename: string): void;
+    setIamProfileId(iamProfileId: string): void;
+    setIamProfileName(iamProfileName: string): void;
+}
+
+// @public (undocumented)
+export const contentType: {
+    fromFilename: (file: String | File | FileObject | NodeJS.ReadableStream | Buffer) => string;
+    fromHeader: (buffer: Buffer) => string;
+};
+
+// @public
+export class Cp4dTokenManager extends JwtTokenManager {
+    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_3);
+    // (undocumented)
+    protected requestToken(): Promise<any>;
+    // (undocumented)
+    protected requiredOptions: string[];
+}
+
+// @public
+function expectToBePromise(sdkPromise: any): void;
+
+// @public (undocumented)
+export function fileExistsAtPath(filepath: string): boolean;
+
+// @public
+export interface FileObject {
+    // (undocumented)
+    options?: FileOptions;
+    // (undocumented)
+    value: NodeJS.ReadableStream | Buffer | string;
+}
+
+// @public (undocumented)
+export interface FileOptions {
+    // (undocumented)
+    contentType?: string;
+    // (undocumented)
+    filename?: string;
+}
+
+// @public (undocumented)
+export interface FileStream extends NodeJS.ReadableStream {
+    // (undocumented)
+    path: string | Buffer;
+}
+
+// @public (undocumented)
+export interface FileWithMetadata {
+    // (undocumented)
+    contentType: string;
+    // (undocumented)
+    data: NodeJS.ReadableStream | Buffer;
+    // (undocumented)
+    filename: string;
+}
+
+// @public
+export function getAuthenticatorFromEnvironment(serviceName: string): Authenticator;
+
+// @public
+export function getContentType(inputData: NodeJS.ReadableStream | Buffer): Promise<string>;
+
+// @public
+export function getCurrentTime(): number;
+
+// @public
+export function getFormat(params: {
+    [key: string]: any;
+}, formats: string[]): string;
+
+// @public
+export function getMissingParams(params: {
+    [key: string]: any;
+}, requires: string[]): null | Error;
+
+// @public
+export function getNewLogger(moduleName: string): SDKLogger;
+
+// @public
+function getOptions(createRequestMock: any): any;
+
+// @public
+export function getQueryParam(urlStr: string, param: string): string;
+
+// @public
+export class IamAuthenticator extends IamRequestBasedAuthenticator {
+    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_6);
+    authenticationType(): string;
+    // (undocumented)
+    protected requiredOptions: string[];
+    // (undocumented)
+    protected tokenManager: IamTokenManager;
+}
+
+// @public
+export class IamRequestBasedAuthenticator extends TokenRequestBasedAuthenticator {
+    // Warning: (ae-forgotten-export) The symbol "IamRequestOptions" 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;
+    setClientIdAndSecret(clientId: string, clientSecret: string): void;
+    setScope(scope: string): void;
+    // (undocumented)
+    protected tokenManager: IamRequestBasedTokenManager;
+}
+
+// @public
+export class IamRequestBasedTokenManager extends JwtTokenManager {
+    constructor(options: IamRequestOptions);
+    // (undocumented)
+    protected formData: any;
+    getRefreshToken(): string;
+    // (undocumented)
+    protected refreshToken: string;
+    protected requestToken(): Promise<any>;
+    protected saveTokenInfo(tokenResponse: any): void;
+    setClientIdAndSecret(clientId: string, clientSecret: string): void;
+    setScope(scope: string): void;
+}
+
+// @public
+export interface IamRequestOptions extends JwtTokenManagerOptions {
+    // (undocumented)
+    clientId?: string;
+    // (undocumented)
+    clientSecret?: string;
+    // (undocumented)
+    scope?: string;
+}
+
+// @public
+export class IamTokenManager extends IamRequestBasedTokenManager {
+    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_5);
+    // (undocumented)
+    protected requiredOptions: string[];
+}
+
+// @public (undocumented)
+export function isEmptyObject(obj: any): boolean;
+
+// @public (undocumented)
+export function isFileData(obj: any): obj is NodeJS.ReadableStream | Buffer;
+
+// @public (undocumented)
+export function isFileWithMetadata(obj: any): obj is FileWithMetadata;
+
+// @public
+export function isHTML(text: string): boolean;
+
+// @public
+export class JwtTokenManager extends TokenManager {
+    constructor(options: JwtTokenManagerOptions);
+    protected requestToken(): Promise<any>;
+    protected saveTokenInfo(tokenResponse: any): void;
+    // (undocumented)
+    protected tokenInfo: any;
+    // (undocumented)
+    protected tokenName: string;
+}
+
+// @public
+export type JwtTokenManagerOptions = TokenManagerOptions;
+
+// @public
+export class NoAuthAuthenticator extends Authenticator {
+    // (undocumented)
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
+    authenticationType(): string;
+}
+
+// @public
+export function onlyOne(a: any, b: any): boolean;
+
+// @public
+export const qs: {
+    stringify: (queryParams: Object) => string;
+};
+
+// @public
+export function readCredentialsFile(): any;
+
+// @public (undocumented)
+export function readCrTokenFile(filepath: string): string;
+
+// @public
+export function readExternalSources(serviceName: string): any;
+
+// @public
+export function removeSuffix(str: string, suffix: string): string;
+
+// @public (undocumented)
+export interface SDKLogger {
+    // (undocumented)
+    debug: Debugger;
+    // (undocumented)
+    error: Debugger;
+    // (undocumented)
+    info: Debugger;
+    // (undocumented)
+    verbose: Debugger;
+    // (undocumented)
+    warn: Debugger;
+}
+
+// @public
+export function streamToPromise(stream: Stream): Promise<any>;
+
+// @public (undocumented)
+export function stripTrailingSlash(url: string): string;
+
+// @public
+export class TokenManager {
+    constructor(options: TokenManagerOptions);
+    // (undocumented)
+    protected accessToken: string;
+    // (undocumented)
+    protected disableSslVerification: boolean;
+    // (undocumented)
+    protected expireTime: number;
+    getToken(): Promise<any>;
+    // (undocumented)
+    protected headers: OutgoingHttpHeaders;
+    protected pacedRequestToken(): Promise<any>;
+    // (undocumented)
+    protected refreshTime: number;
+    protected requestToken(): Promise<any>;
+    // Warning: (ae-forgotten-export) The symbol "RequestWrapper" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    protected requestWrapperInstance: RequestWrapper;
+    protected saveTokenInfo(tokenResponse: any): void;
+    setDisableSslVerification(value: boolean): void;
+    setHeaders(headers: OutgoingHttpHeaders): void;
+    // (undocumented)
+    protected url: string;
+}
+
+// @public
+export type TokenManagerOptions = {
+    url?: string;
+    headers?: OutgoingHttpHeaders;
+    disableSslVerification?: boolean;
+    [propName: string]: any;
+};
+
+// @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;
+    setDisableSslVerification(value: boolean): void;
+    setHeaders(headers: OutgoingHttpHeaders): void;
+    // (undocumented)
+    protected tokenManager: JwtTokenManager;
+    // (undocumented)
+    protected url: string;
+}
+
+// @public
+export function toLowerKeys(obj: Object): Object;
+
+declare namespace unitTestUtils {
+    export {
+        checkUrlAndMethod,
+        checkMediaHeaders,
+        checkUserHeader,
+        checkForSuccessfulExecution,
+        getOptions,
+        expectToBePromise
+    }
+}
+export { unitTestUtils }
+
+// @public
+export interface UserOptions {
+    [propName: string]: any;
+    authenticator?: AuthenticatorInterface;
+    disableSslVerification?: boolean;
+    headers?: OutgoingHttpHeaders;
+    jar?: CookieJar | boolean;
+    serviceUrl?: string;
+    url?: string;
+    version?: string;
+}
+
+// @public (undocumented)
+export function validateInput(options: any, requiredOptions: string[]): void;
+
+// @public
+export function validateParams(params: {
+    [key: string]: any;
+}, requiredParams: string[], allParams: string[]): null | Error;
+
+// @public
+export class VpcInstanceAuthenticator extends TokenRequestBasedAuthenticator {
+    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_10);
+    authenticationType(): string;
+    setIamProfileCrn(iamProfileCrn: string): void;
+    setIamProfileId(iamProfileId: string): void;
+    // (undocumented)
+    protected tokenManager: VpcInstanceTokenManager;
+}
+
+// @public
+export class VpcInstanceTokenManager extends JwtTokenManager {
+    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_9);
+    // (undocumented)
+    protected requestToken(): Promise<any>;
+    setIamProfileCrn(iamProfileCrn: string): void;
+    setIamProfileId(iamProfileId: string): void;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/iamtest.env

@@ -0,0 +1,3 @@
+IAMTEST_AUTH_URL=https://iam.cloud.ibm.com
+IAMTEST_AUTH_TYPE=iam
+IAMTEST_APIKEY=Aea-n2GyXIX0UpURAbsfdpEdEkLsWn1uoF5gK7wDbaIQ

package/index.js

@@ -14,50 +14,30 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
+    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
+    result["default"] = mod;
     return result;
 };
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getNewLogger = exports.unitTestUtils = exports.contentType = exports.qs = exports.BaseService = void 0;
 /**
  * @module ibm-cloud-sdk-core
  */
 var unitTestUtils = __importStar(require("./lib/sdk-test-helpers"));
 exports.unitTestUtils = unitTestUtils;
 var base_service_1 = require("./lib/base-service");
-Object.defineProperty(exports, "BaseService", { enumerable: true, get: function () { return base_service_1.BaseService; } });
-__exportStar(require("./auth"), exports);
-__exportStar(require("./lib/helper"), exports);
+exports.BaseService = base_service_1.BaseService;
+__export(require("./auth"));
+__export(require("./lib/helper"));
 var querystring_1 = require("./lib/querystring");
-Object.defineProperty(exports, "qs", { enumerable: true, get: function () { return __importDefault(querystring_1).default; } });
+exports.qs = querystring_1.default;
 var content_type_1 = require("./lib/content-type");
-Object.defineProperty(exports, "contentType", { enumerable: true, get: function () { return __importDefault(content_type_1).default; } });
-__exportStar(require("./lib/stream-to-promise"), exports);
+exports.contentType = content_type_1.default;
+__export(require("./lib/stream-to-promise"));
 var get_new_logger_1 = require("./lib/get-new-logger");
-Object.defineProperty(exports, "getNewLogger", { enumerable: true, get: function () { return get_new_logger_1.getNewLogger; } });
+exports.getNewLogger = get_new_logger_1.getNewLogger;

package/lib/base-service.js

@@ -29,7 +29,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseService = void 0;
 var auth_1 = require("../auth");
 var helper_1 = require("./helper");
 var logger_1 = __importDefault(require("./logger"));
@@ -57,7 +56,7 @@ var BaseService = /** @class */ (function () {
     function BaseService(userOptions) {
         if (!(this instanceof BaseService)) {
             var err = 'the "new" keyword is required to create service instances';
-            logger_1.default.error("Error creating an instance of BaseService: ".concat(err));
+            logger_1.default.error("Error creating an instance of BaseService: " + err);
             throw new Error(err);
         }
         var baseServiceOptions = {};
@@ -67,10 +66,10 @@ var BaseService = /** @class */ (function () {
             options.serviceUrl = options.url;
         }
         if (options.serviceUrl) {
-            baseServiceOptions.serviceUrl = (0, helper_1.stripTrailingSlash)(options.serviceUrl);
+            baseServiceOptions.serviceUrl = helper_1.stripTrailingSlash(options.serviceUrl);
         }
         // check serviceUrl for common user errors
-        var credentialProblems = (0, auth_1.checkCredentials)(options, ['serviceUrl']);
+        var credentialProblems = auth_1.checkCredentials(options, ['serviceUrl']);
         if (credentialProblems) {
             logger_1.default.error(credentialProblems.message);
             throw credentialProblems;
@@ -104,7 +103,7 @@ var BaseService = /** @class */ (function () {
      */
     BaseService.prototype.setServiceUrl = function (url) {
         if (url) {
-            this.baseOptions.serviceUrl = (0, helper_1.stripTrailingSlash)(url);
+            this.baseOptions.serviceUrl = helper_1.stripTrailingSlash(url);
         }
     };
     /**
@@ -202,7 +201,7 @@ var BaseService = /** @class */ (function () {
     // eslint-disable-next-line class-methods-use-this
     BaseService.prototype.readOptionsFromExternalConfig = function (serviceName) {
         var results = {};
-        var properties = (0, auth_1.readExternalSources)(serviceName);
+        var properties = auth_1.readExternalSources(serviceName);
         if (properties !== null) {
             // the user can define the following client-level variables in the credentials file:
             // - url
@@ -210,7 +209,7 @@ var BaseService = /** @class */ (function () {
             // - enableGzip
             var url = properties.url, disableSsl = properties.disableSsl, enableGzip = properties.enableGzip, enableRetries = properties.enableRetries, maxRetries = properties.maxRetries, retryInterval = properties.retryInterval;
             if (url) {
-                results.serviceUrl = (0, helper_1.stripTrailingSlash)(url);
+                results.serviceUrl = helper_1.stripTrailingSlash(url);
             }
             if (disableSsl === true) {
                 results.disableSslVerification = disableSsl;

package/lib/content-type.js

@@ -62,7 +62,7 @@ var fromHeader = function (buffer) {
  * @return {String|undefined}
  */
 var fromFilename = function (file) {
-    var ext = (0, path_1.extname)(
+    var ext = path_1.extname(
     // eslint-disable-next-line @typescript-eslint/dot-notation
     (typeof file === 'string' && file) || file['name'] || '');
     return filenameContentTypes[ext];

package/lib/get-new-logger.js

@@ -18,7 +18,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getNewLogger = void 0;
 var debug_1 = __importDefault(require("debug"));
 /**
  * Return a new logger, formatted with a particular name. The logging functions, in
@@ -36,11 +35,11 @@ var debug_1 = __importDefault(require("debug"));
  * @returns {SDKLogger} the new logger
  */
 function getNewLogger(moduleName) {
-    var debug = (0, debug_1.default)("".concat(moduleName, ":debug"));
-    var error = (0, debug_1.default)("".concat(moduleName, ":error"));
-    var info = (0, debug_1.default)("".concat(moduleName, ":info"));
-    var verbose = (0, debug_1.default)("".concat(moduleName, ":verbose"));
-    var warn = (0, debug_1.default)("".concat(moduleName, ":warning"));
+    var debug = debug_1.default(moduleName + ":debug");
+    var error = debug_1.default(moduleName + ":error");
+    var info = debug_1.default(moduleName + ":info");
+    var verbose = debug_1.default(moduleName + ":verbose");
+    var warn = debug_1.default(moduleName + ":warning");
     // enable loggers if axios flag is set & mimic log levels severity
     if (process.env.NODE_DEBUG === 'axios') {
         debug.enabled = true;