ibm-cloud-sdk-core 4.3.3 → 5.0.0

package/ibm-cloud-sdk-core.d.ts

@@ -345,66 +345,6 @@ export declare function buildRequestFileObject(fileParam: FileWithMetadata): Pro
  */
 export declare function checkCredentials(obj: any, credsToCheck: string[]): Error | null;
 
-/**
- * This method simply ensures that the method executed without any issues by extracting
- * the argument from the mock object for the `createRequest` method and verifying that it is an object.
- *
- * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- */
-declare function checkForSuccessfulExecution(createRequestMock: any): void;
-
-/**
- * Takes the mock object for the `createRequest` method, extracts the headers that were sent with the call,
- * and checks for the expected values for `Accept` and `Content-Type`. This to verify that the SDK sets
- * the correct values in the code.
- *
- * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @param accept - the expected value for the `Accept` header
- * @param contentType - the expected value for the `Content-Type` header
- */
-declare function checkMediaHeaders(createRequestMock: any, accept: string, contentType: string): void;
-
-/**
- * (C) Copyright IBM Corp. 2019, 2022.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-/**
- * This module provides a set of helper methods used to reduce code duplication in the generated unit tests
- * for the SDKs that depend on this core package. Note that these methods are not used by the tests for this
- * package - they are meant to be exported and made available to dependent libraries.
- */
-/**
- * Takes the request options constructed by the SDK and checks that the `url` and `method` properties
- * were set to their correct values.
- *
- * @param options - the options object put together by the SDK, retrieved from the createRequest mock
- * @param url - The URL path of the service endpoint, from the paths section of the API definition
- * @param method - The HTTP method for the request, from the API definition
- */
-declare function checkUrlAndMethod(options: any, url: string, method: any): void;
-
-/**
- * Takes the mock object for the `createRequest` method, extracts the headers that were sent with the call,
- * and checks for the expected value for a user-defined header. This is verify that the SDK accepts header
- * parameters and sends them as headers in the request.
- *
- * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @param userHeaderName - the name of the header passed by the user, e.g. `Contained-Content-Type`
- * @param userHeaderValue - the expected value for the header passed by the user
- */
-declare function checkUserHeader(createRequestMock: any, userHeaderName: string, userHeaderValue: string): void;
-
 /**
  * The CloudPakForDataAuthenticator will either use a username/password pair or a username/apikey pair to obtain
  * a bearer token from a token server.  When the bearer token expires, a new token is obtained from the token server.
@@ -636,14 +576,6 @@ export declare class Cp4dTokenManager extends JwtTokenManager {
     protected requestToken(): Promise<any>;
 }
 
-/**
- * This method simply ensures that the SDK methods return Promises by checking for
- * the `then` function - common way to assess whether or not an object is a Promise.
- *
- * @param sdkPromise - the Promise returned by an SDK method
- */
-declare function expectToBePromise(sdkPromise: any): void;
-
 export declare function fileExistsAtPath(filepath: string): boolean;
 
 /**
@@ -746,16 +678,6 @@ export declare function getMissingParams(params: {
  */
 export declare function getNewLogger(moduleName: string): SDKLogger;
 
-/**
- * This method extracts the `options` property from the object passed into `createRequest`. This property is
- * an object containing all of the SDK method-specific information (like `path` and `body`) used to build a request.
- * This method is just a convenience method for the unit tests to be able to make assertions on the items in the request.
- *
- * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @returns Object
- */
-declare function getOptions(createRequestMock: any): any;
-
 /**
  * Return a query parameter value from a URL
  *
@@ -1532,18 +1454,6 @@ export declare class TokenRequestBasedAuthenticator extends Authenticator {
  */
 export declare function toLowerKeys(obj: Object): Object;
 
-declare namespace unitTestUtils {
-    export {
-        checkUrlAndMethod,
-        checkMediaHeaders,
-        checkUserHeader,
-        checkForSuccessfulExecution,
-        getOptions,
-        expectToBePromise
-    }
-}
-export { unitTestUtils }
-
 /**
  * Configuration values for a service.
  */

package/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (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.
@@ -16,12 +16,10 @@
 /**
  * @module ibm-cloud-sdk-core
  */
-import * as unitTestUtils from './lib/sdk-test-helpers';
 export { BaseService, UserOptions } from './lib/base-service';
 export * from './auth';
 export * from './lib/helper';
 export { default as qs } from './lib/querystring';
 export { default as contentType } from './lib/content-type';
 export * from './lib/stream-to-promise';
-export { unitTestUtils };
 export { getNewLogger, SDKLogger } from './lib/get-new-logger';

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (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.
@@ -25,18 +25,6 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     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;
-});
-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);
-    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);
 };
@@ -44,12 +32,10 @@ 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;
+exports.getNewLogger = 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);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ibm-cloud-sdk-core",
-  "version": "4.3.3",
+  "version": "5.0.0",
   "description": "Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.",
   "main": "index.js",
   "typings": "./es/index.d.ts",
@@ -41,7 +41,6 @@
     "camelcase": "^6.3.0",
     "debug": "^4.3.4",
     "dotenv": "^16.4.5",
-    "expect": "^27.5.1",
     "extend": "3.0.2",
     "file-type": "16.5.4",
     "form-data": "4.0.0",
@@ -55,11 +54,10 @@
     "semver": "^7.5.3"
   },
   "browser": {
-    "./auth/utils/read-credentials-file": "./auth/utils/read-credentials-file.browser",
-    "./lib/sdk-test-helpers": "./lib/sdk-test-helpers.browser"
+    "./auth/utils/read-credentials-file": "./auth/utils/read-credentials-file.browser"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=18"
   },
   "scripts": {
     "clean": "rm -fr node_modules",

package/sdk-test-utilities/README.md

@@ -0,0 +1,8 @@
+# SDK Test Utilities
+
+A set of utility methods for unit tests in IBM Cloud SDKs.
+
+This package is published separately from `ibm-cloud-sdk-core`. It includes `expect`
+as a dependency, which is not intended for inclusion in production packages. This
+utility package should only be installed as a _development_ dependency and the logic
+it contains will only ever be needed for tests.

package/{es/lib/sdk-test-helpers.js → sdk-test-utilities/index.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.
@@ -13,12 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import expect from 'expect';
+
+const { expect } = require('expect');
+
 /**
- * This module provides a set of helper methods used to reduce code duplication in the generated unit tests
+ * This module provides a set of utility methods used to reduce code duplication in the generated unit tests
  * for the SDKs that depend on this core package. Note that these methods are not used by the tests for this
  * package - they are meant to be exported and made available to dependent libraries.
  */
+
 /**
  * Takes the request options constructed by the SDK and checks that the `url` and `method` properties
  * were set to their correct values.
@@ -27,10 +30,11 @@ import expect from 'expect';
  * @param url - The URL path of the service endpoint, from the paths section of the API definition
  * @param method - The HTTP method for the request, from the API definition
  */
-export function checkUrlAndMethod(options, url, method) {
-    expect(options.url).toEqual(url);
-    expect(options.method).toEqual(method);
+function checkUrlAndMethod(options, url, method) {
+  expect(options.url).toEqual(url);
+  expect(options.method).toEqual(method);
 }
+
 /**
  * Takes the mock object for the `createRequest` method, extracts the headers that were sent with the call,
  * and checks for the expected values for `Accept` and `Content-Type`. This to verify that the SDK sets
@@ -40,11 +44,12 @@ export function checkUrlAndMethod(options, url, method) {
  * @param accept - the expected value for the `Accept` header
  * @param contentType - the expected value for the `Content-Type` header
  */
-export function checkMediaHeaders(createRequestMock, accept, contentType) {
-    const { headers } = createRequestMock.mock.calls[0][0].defaultOptions;
-    expect(headers.Accept).toEqual(accept);
-    expect(headers['Content-Type']).toEqual(contentType);
+function checkMediaHeaders(createRequestMock, accept, contentType) {
+  const { headers } = createRequestMock.mock.calls[0][0].defaultOptions;
+  expect(headers.Accept).toEqual(accept);
+  expect(headers['Content-Type']).toEqual(contentType);
 }
+
 /**
  * Takes the mock object for the `createRequest` method, extracts the headers that were sent with the call,
  * and checks for the expected value for a user-defined header. This is verify that the SDK accepts header
@@ -54,20 +59,26 @@ export function checkMediaHeaders(createRequestMock, accept, contentType) {
  * @param userHeaderName - the name of the header passed by the user, e.g. `Contained-Content-Type`
  * @param userHeaderValue - the expected value for the header passed by the user
  */
-export function checkUserHeader(createRequestMock, userHeaderName, userHeaderValue) {
-    const { headers } = createRequestMock.mock.calls[0][0].defaultOptions;
-    expect(headers[userHeaderName]).toEqual(userHeaderValue);
+function checkUserHeader(
+  createRequestMock,
+  userHeaderName,
+  userHeaderValue
+) {
+  const { headers } = createRequestMock.mock.calls[0][0].defaultOptions;
+  expect(headers[userHeaderName]).toEqual(userHeaderValue);
 }
+
 /**
  * This method simply ensures that the method executed without any issues by extracting
  * the argument from the mock object for the `createRequest` method and verifying that it is an object.
  *
  * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
  */
-export function checkForSuccessfulExecution(createRequestMock) {
-    const sdkParams = createRequestMock.mock.calls[0][0];
-    expect(typeof sdkParams).toEqual('object');
+function checkForSuccessfulExecution(createRequestMock) {
+  const sdkParams = createRequestMock.mock.calls[0][0];
+  expect(typeof sdkParams).toEqual('object');
 }
+
 /**
  * This method extracts the `options` property from the object passed into `createRequest`. This property is
  * an object containing all of the SDK method-specific information (like `path` and `body`) used to build a request.
@@ -76,15 +87,25 @@ export function checkForSuccessfulExecution(createRequestMock) {
  * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
  * @returns Object
  */
-export function getOptions(createRequestMock) {
-    return createRequestMock.mock.calls[0][0].options;
+function getOptions(createRequestMock) {
+  return createRequestMock.mock.calls[0][0].options;
 }
+
 /**
  * This method simply ensures that the SDK methods return Promises by checking for
  * the `then` function - common way to assess whether or not an object is a Promise.
  *
  * @param sdkPromise - the Promise returned by an SDK method
  */
-export function expectToBePromise(sdkPromise) {
-    expect(typeof sdkPromise.then).toBe('function');
+function expectToBePromise(sdkPromise) {
+  expect(typeof sdkPromise.then).toBe('function');
 }
+
+module.exports = {
+  checkUrlAndMethod,
+  checkMediaHeaders,
+  checkUserHeader,
+  checkForSuccessfulExecution,
+  getOptions,
+  expectToBePromise,
+};