ibm-cloud-sdk-core 4.3.2 → 5.0.0

package/.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "package-lock.json|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2024-04-16T16:00:48Z",
+  "generated_at": "2024-06-06T19:22:54Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -96,7 +96,7 @@
         "hashed_secret": "bc2f74c22f98f7b6ffbc2f67453dbfa99bce9a32",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 146,
+        "line_number": 174,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -334,7 +334,7 @@
         "hashed_secret": "45c43fe97e3a06ab078b0eeff6fbe622cc417a25",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 284,
+        "line_number": 266,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -582,7 +582,7 @@
       }
     ]
   },
-  "version": "0.13.1+ibm.62.dss",
+  "version": "0.13.1+ibm.56.dss",
   "word_list": {
     "file": null,
     "hash": null

package/CHANGELOG.md

@@ -1,3 +1,35 @@
+# [5.0.0](https://github.com/IBM/node-sdk-core/compare/v4.3.3...v5.0.0) (2024-06-18)
+
+
+### Bug Fixes
+
+* remove test utilities and dependency from package ([901ece0](https://github.com/IBM/node-sdk-core/commit/901ece06d6f7897164b54d58f316da94ae1fc5da))
+
+
+### Build System
+
+* bump minimum node version to v18 ([3d8fef5](https://github.com/IBM/node-sdk-core/commit/3d8fef5cf6a1b4d01cfa2c132f186bf16cec1a56))
+
+
+### BREAKING CHANGES
+
+* SDK test helpers are no longer exposed in this package.
+
+To continue using the test helpers, which SDK unit tests still rely on, install
+the new "@ibm-cloud/sdk-test-utilities" package as a development dependency.
+
+Signed-off-by: Dustin Popp <dustinpopp@ibm.com>
+* Node v18 or above is now required to use this package.
+
+Signed-off-by: Dustin Popp <dustinpopp@ibm.com>
+
+## [4.3.3](https://github.com/IBM/node-sdk-core/compare/v4.3.2...v4.3.3) (2024-06-04)
+
+
+### Bug Fixes
+
+* revert "fix(deps): remove `expect` as redundant development dependency" ([362e20a](https://github.com/IBM/node-sdk-core/commit/362e20aad22172bc6db0a3458743809b0cdefe3a))
+
 ## [4.3.2](https://github.com/IBM/node-sdk-core/compare/v4.3.1...v4.3.2) (2024-06-03)
 
 

package/MIGRATION-V5.md

@@ -0,0 +1,15 @@
+# Migration Guide for v5
+
+## Breaking Changes
+
+### Node Version
+Node version 16 is no longer supported - 18 is the minimum version supported.
+
+### SDK Unit Test Helpers
+The formerly available helper functions exposed in this package have been removed. These
+functions were intended for use in the unit tests of a generated SDK project.
+
+The functions are now present in a new package called `@ibm-cloud/sdk-test-utilities`.
+To continue using the helper functions in SDK test code, install this new package as a
+development dependency and import the functions from there. The interface and functions
+remain completely identical to the functions formerly exposed in this package.

package/build/docs/ibm-cloud-sdk-core.md

@@ -712,30 +712,6 @@ Configuration options for IAM token retrieval.
 Configuration values for a service.
 
 
-</td></tr>
-</tbody></table>
-
-## Namespaces
-
-<table><thead><tr><th>
-
-Namespace
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[unitTestUtils](./ibm-cloud-sdk-core.unittestutils.md)
-
-
-</td><td>
-
-
 </td></tr>
 </tbody></table>
 

package/docs/ibm-cloud-sdk-core.api.json

@@ -7405,384 +7405,6 @@
           ],
           "name": "toLowerKeys"
         },
-        {
-          "kind": "Namespace",
-          "canonicalReference": "ibm-cloud-sdk-core!unitTestUtils:namespace",
-          "docComment": "",
-          "excerptTokens": [],
-          "fileUrlPath": "dist/es/index.d.ts",
-          "releaseTag": "None",
-          "name": "unitTestUtils",
-          "preserveMemberOrder": false,
-          "members": [
-            {
-              "kind": "Function",
-              "canonicalReference": "ibm-cloud-sdk-core!unitTestUtils.checkForSuccessfulExecution:function(1)",
-              "docComment": "/**\n * 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.\n *\n * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "export declare function checkForSuccessfulExecution(createRequestMock: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "any"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "void"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "fileUrlPath": "dist/es/lib/sdk-test-helpers.d.ts",
-              "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
-              },
-              "releaseTag": "Public",
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "createRequestMock",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                }
-              ],
-              "name": "checkForSuccessfulExecution"
-            },
-            {
-              "kind": "Function",
-              "canonicalReference": "ibm-cloud-sdk-core!unitTestUtils.checkMediaHeaders:function(1)",
-              "docComment": "/**\n * 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.\n *\n * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class\n *\n * @param accept - the expected value for the `Accept` header\n *\n * @param contentType - the expected value for the `Content-Type` header\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "export declare function checkMediaHeaders(createRequestMock: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "any"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", accept: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", contentType: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "void"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "fileUrlPath": "dist/es/lib/sdk-test-helpers.d.ts",
-              "returnTypeTokenRange": {
-                "startIndex": 7,
-                "endIndex": 8
-              },
-              "releaseTag": "Public",
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "createRequestMock",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "accept",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 3,
-                    "endIndex": 4
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "contentType",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 5,
-                    "endIndex": 6
-                  },
-                  "isOptional": false
-                }
-              ],
-              "name": "checkMediaHeaders"
-            },
-            {
-              "kind": "Function",
-              "canonicalReference": "ibm-cloud-sdk-core!unitTestUtils.checkUrlAndMethod:function(1)",
-              "docComment": "/**\n * Takes the request options constructed by the SDK and checks that the `url` and `method` properties were set to their correct values.\n *\n * @param options - the options object put together by the SDK, retrieved from the createRequest mock\n *\n * @param url - The URL path of the service endpoint, from the paths section of the API definition\n *\n * @param method - The HTTP method for the request, from the API definition\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "export declare function checkUrlAndMethod(options: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "any"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", url: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", method: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "any"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "void"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "fileUrlPath": "dist/es/lib/sdk-test-helpers.d.ts",
-              "returnTypeTokenRange": {
-                "startIndex": 7,
-                "endIndex": 8
-              },
-              "releaseTag": "Public",
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "options",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "url",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 3,
-                    "endIndex": 4
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "method",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 5,
-                    "endIndex": 6
-                  },
-                  "isOptional": false
-                }
-              ],
-              "name": "checkUrlAndMethod"
-            },
-            {
-              "kind": "Function",
-              "canonicalReference": "ibm-cloud-sdk-core!unitTestUtils.checkUserHeader:function(1)",
-              "docComment": "/**\n * 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.\n *\n * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class\n *\n * @param userHeaderName - the name of the header passed by the user, e.g. `Contained-Content-Type`\n *\n * @param userHeaderValue - the expected value for the header passed by the user\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "export declare function checkUserHeader(createRequestMock: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "any"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", userHeaderName: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", userHeaderValue: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "void"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "fileUrlPath": "dist/es/lib/sdk-test-helpers.d.ts",
-              "returnTypeTokenRange": {
-                "startIndex": 7,
-                "endIndex": 8
-              },
-              "releaseTag": "Public",
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "createRequestMock",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "userHeaderName",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 3,
-                    "endIndex": 4
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "userHeaderValue",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 5,
-                    "endIndex": 6
-                  },
-                  "isOptional": false
-                }
-              ],
-              "name": "checkUserHeader"
-            },
-            {
-              "kind": "Function",
-              "canonicalReference": "ibm-cloud-sdk-core!unitTestUtils.expectToBePromise:function(1)",
-              "docComment": "/**\n * 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.\n *\n * @param sdkPromise - the Promise returned by an SDK method\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "export declare function expectToBePromise(sdkPromise: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "any"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "void"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "fileUrlPath": "dist/es/lib/sdk-test-helpers.d.ts",
-              "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
-              },
-              "releaseTag": "Public",
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "sdkPromise",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                }
-              ],
-              "name": "expectToBePromise"
-            },
-            {
-              "kind": "Function",
-              "canonicalReference": "ibm-cloud-sdk-core!unitTestUtils.getOptions:function(1)",
-              "docComment": "/**\n * 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.\n *\n * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class\n *\n * @returns Object\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "export declare function getOptions(createRequestMock: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "any"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "any"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "fileUrlPath": "dist/es/lib/sdk-test-helpers.d.ts",
-              "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
-              },
-              "releaseTag": "Public",
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "createRequestMock",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                }
-              ],
-              "name": "getOptions"
-            }
-          ]
-        },
         {
           "kind": "Interface",
           "canonicalReference": "ibm-cloud-sdk-core!UserOptions:interface",

package/es/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/es/index.js

@@ -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 } 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 } from './lib/get-new-logger';

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

@@ -105,18 +105,6 @@ export function buildRequestFileObject(fileParam: FileWithMetadata): Promise<Fil
 // @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_4" needs to be exported by the entry point index.d.ts
@@ -176,9 +164,6 @@ export class Cp4dTokenManager extends JwtTokenManager {
     protected requiredOptions: string[];
 }
 
-// @public
-function expectToBePromise(sdkPromise: any): void;
-
 // @public (undocumented)
 export function fileExistsAtPath(filepath: string): boolean;
 
@@ -236,9 +221,6 @@ export function getMissingParams(params: {
 // @public
 export function getNewLogger(moduleName: string): SDKLogger;
 
-// @public
-function getOptions(createRequestMock: any): any;
-
 // @public
 export function getQueryParam(urlStr: string, param: string): string;
 
@@ -458,18 +440,6 @@ export class TokenRequestBasedAuthenticator extends Authenticator {
 // @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;