ibm-cloud-sdk-core 4.3.2 → 5.0.0

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

@@ -1,85 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [unitTestUtils](./ibm-cloud-sdk-core.unittestutils.md) &gt; [checkUserHeader](./ibm-cloud-sdk-core.unittestutils.checkuserheader.md)
-
-## unitTestUtils.checkUserHeader() function
-
-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.
-
-**Signature:**
-
-```typescript
-export declare function checkUserHeader(createRequestMock: any, userHeaderName: string, userHeaderValue: string): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-createRequestMock
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-the jest mock object for the `createRequest` method in the `RequestWrapper` class
-
-
-</td></tr>
-<tr><td>
-
-userHeaderName
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-the name of the header passed by the user, e.g. `Contained-Content-Type`
-
-
-</td></tr>
-<tr><td>
-
-userHeaderValue
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-the expected value for the header passed by the user
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-void
-

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

@@ -1,53 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [unitTestUtils](./ibm-cloud-sdk-core.unittestutils.md) &gt; [expectToBePromise](./ibm-cloud-sdk-core.unittestutils.expecttobepromise.md)
-
-## unitTestUtils.expectToBePromise() function
-
-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.
-
-**Signature:**
-
-```typescript
-export declare function expectToBePromise(sdkPromise: any): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-sdkPromise
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-the Promise returned by an SDK method
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-void
-

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

@@ -1,55 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [unitTestUtils](./ibm-cloud-sdk-core.unittestutils.md) &gt; [getOptions](./ibm-cloud-sdk-core.unittestutils.getoptions.md)
-
-## unitTestUtils.getOptions() function
-
-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.
-
-**Signature:**
-
-```typescript
-export declare function getOptions(createRequestMock: any): any;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-createRequestMock
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-the jest mock object for the `createRequest` method in the `RequestWrapper` class
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-any
-
-Object
-

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

@@ -1,86 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [unitTestUtils](./ibm-cloud-sdk-core.unittestutils.md)
-
-## unitTestUtils namespace
-
-## Functions
-
-<table><thead><tr><th>
-
-Function
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[checkForSuccessfulExecution(createRequestMock)](./ibm-cloud-sdk-core.unittestutils.checkforsuccessfulexecution.md)
-
-
-</td><td>
-
-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.
-
-
-</td></tr>
-<tr><td>
-
-[checkMediaHeaders(createRequestMock, accept, contentType)](./ibm-cloud-sdk-core.unittestutils.checkmediaheaders.md)
-
-
-</td><td>
-
-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.
-
-
-</td></tr>
-<tr><td>
-
-[checkUrlAndMethod(options, url, method)](./ibm-cloud-sdk-core.unittestutils.checkurlandmethod.md)
-
-
-</td><td>
-
-Takes the request options constructed by the SDK and checks that the `url` and `method` properties were set to their correct values.
-
-
-</td></tr>
-<tr><td>
-
-[checkUserHeader(createRequestMock, userHeaderName, userHeaderValue)](./ibm-cloud-sdk-core.unittestutils.checkuserheader.md)
-
-
-</td><td>
-
-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.
-
-
-</td></tr>
-<tr><td>
-
-[expectToBePromise(sdkPromise)](./ibm-cloud-sdk-core.unittestutils.expecttobepromise.md)
-
-
-</td><td>
-
-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.
-
-
-</td></tr>
-<tr><td>
-
-[getOptions(createRequestMock)](./ibm-cloud-sdk-core.unittestutils.getoptions.md)
-
-
-</td><td>
-
-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.
-
-
-</td></tr>
-</tbody></table>

package/es/lib/sdk-test-helpers.browser.d.ts

@@ -1,21 +0,0 @@
-/**
- * Copyright 2021 IBM Corp. All Rights Reserved.
- *
- * 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.
- */
-export declare function checkUrlAndMethod(options: any, url: string, method: any): void;
-export declare function checkMediaHeaders(createRequestMock: any, accept: string, contentType: string): void;
-export declare function checkUserHeader(createRequestMock: any, userHeaderName: string, userHeaderValue: string): void;
-export declare function checkForSuccessfulExecution(createRequestMock: any): void;
-export declare function getOptions(createRequestMock: any): void;
-export declare function expectToBePromise(sdkPromise: any): void;

package/es/lib/sdk-test-helpers.browser.js

@@ -1,23 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
-/**
- * Copyright 2021 IBM Corp. All Rights Reserved.
- *
- * 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.
- */
-// Dummy for browser
-export function checkUrlAndMethod(options, url, method) { }
-export function checkMediaHeaders(createRequestMock, accept, contentType) { }
-export function checkUserHeader(createRequestMock, userHeaderName, userHeaderValue) { }
-export function checkForSuccessfulExecution(createRequestMock) { }
-export function getOptions(createRequestMock) { }
-export function expectToBePromise(sdkPromise) { }

package/es/lib/sdk-test-helpers.d.ts

@@ -1,72 +0,0 @@
-/**
- * (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
- */
-export 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 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
- */
-export declare function checkMediaHeaders(createRequestMock: any, accept: string, contentType: string): 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
- */
-export declare function checkUserHeader(createRequestMock: any, userHeaderName: string, userHeaderValue: string): void;
-/**
- * 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 declare function checkForSuccessfulExecution(createRequestMock: any): void;
-/**
- * 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
- */
-export declare function getOptions(createRequestMock: any): 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
- */
-export declare function expectToBePromise(sdkPromise: any): void;

package/lib/sdk-test-helpers.browser.d.ts

@@ -1,21 +0,0 @@
-/**
- * Copyright 2021 IBM Corp. All Rights Reserved.
- *
- * 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.
- */
-export declare function checkUrlAndMethod(options: any, url: string, method: any): void;
-export declare function checkMediaHeaders(createRequestMock: any, accept: string, contentType: string): void;
-export declare function checkUserHeader(createRequestMock: any, userHeaderName: string, userHeaderValue: string): void;
-export declare function checkForSuccessfulExecution(createRequestMock: any): void;
-export declare function getOptions(createRequestMock: any): void;
-export declare function expectToBePromise(sdkPromise: any): void;

package/lib/sdk-test-helpers.browser.js

@@ -1,32 +0,0 @@
-"use strict";
-/* eslint-disable @typescript-eslint/no-unused-vars */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.expectToBePromise = exports.getOptions = exports.checkForSuccessfulExecution = exports.checkUserHeader = exports.checkMediaHeaders = exports.checkUrlAndMethod = void 0;
-/**
- * Copyright 2021 IBM Corp. All Rights Reserved.
- *
- * 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.
- */
-// Dummy for browser
-function checkUrlAndMethod(options, url, method) { }
-exports.checkUrlAndMethod = checkUrlAndMethod;
-function checkMediaHeaders(createRequestMock, accept, contentType) { }
-exports.checkMediaHeaders = checkMediaHeaders;
-function checkUserHeader(createRequestMock, userHeaderName, userHeaderValue) { }
-exports.checkUserHeader = checkUserHeader;
-function checkForSuccessfulExecution(createRequestMock) { }
-exports.checkForSuccessfulExecution = checkForSuccessfulExecution;
-function getOptions(createRequestMock) { }
-exports.getOptions = getOptions;
-function expectToBePromise(sdkPromise) { }
-exports.expectToBePromise = expectToBePromise;

package/lib/sdk-test-helpers.d.ts

@@ -1,72 +0,0 @@
-/**
- * (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
- */
-export 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 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
- */
-export declare function checkMediaHeaders(createRequestMock: any, accept: string, contentType: string): 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
- */
-export declare function checkUserHeader(createRequestMock: any, userHeaderName: string, userHeaderValue: string): void;
-/**
- * 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 declare function checkForSuccessfulExecution(createRequestMock: any): void;
-/**
- * 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
- */
-export declare function getOptions(createRequestMock: any): 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
- */
-export declare function expectToBePromise(sdkPromise: any): void;

package/lib/sdk-test-helpers.js

@@ -1,100 +0,0 @@
-"use strict";
-/**
- * (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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.expectToBePromise = exports.getOptions = exports.checkForSuccessfulExecution = exports.checkUserHeader = exports.checkMediaHeaders = exports.checkUrlAndMethod = void 0;
-// eslint-disable-next-line import/no-extraneous-dependencies
-var globals_1 = require("@jest/globals");
-/**
- * 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
- */
-function checkUrlAndMethod(options, url, method) {
-    (0, globals_1.expect)(options.url).toEqual(url);
-    (0, globals_1.expect)(options.method).toEqual(method);
-}
-exports.checkUrlAndMethod = checkUrlAndMethod;
-/**
- * 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
- */
-function checkMediaHeaders(createRequestMock, accept, contentType) {
-    var headers = createRequestMock.mock.calls[0][0].defaultOptions.headers;
-    (0, globals_1.expect)(headers.Accept).toEqual(accept);
-    (0, globals_1.expect)(headers['Content-Type']).toEqual(contentType);
-}
-exports.checkMediaHeaders = checkMediaHeaders;
-/**
- * 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
- */
-function checkUserHeader(createRequestMock, userHeaderName, userHeaderValue) {
-    var headers = createRequestMock.mock.calls[0][0].defaultOptions.headers;
-    (0, globals_1.expect)(headers[userHeaderName]).toEqual(userHeaderValue);
-}
-exports.checkUserHeader = checkUserHeader;
-/**
- * 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
- */
-function checkForSuccessfulExecution(createRequestMock) {
-    var sdkParams = createRequestMock.mock.calls[0][0];
-    (0, globals_1.expect)(typeof sdkParams).toEqual('object');
-}
-exports.checkForSuccessfulExecution = checkForSuccessfulExecution;
-/**
- * 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
- */
-function getOptions(createRequestMock) {
-    return createRequestMock.mock.calls[0][0].options;
-}
-exports.getOptions = getOptions;
-/**
- * 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
- */
-function expectToBePromise(sdkPromise) {
-    (0, globals_1.expect)(typeof sdkPromise.then).toBe('function');
-}
-exports.expectToBePromise = expectToBePromise;