ibm-cloud-sdk-core 4.3.0 → 4.3.2-beta

package/auth/user-temp/get-authenticator-from-environment.d.ts

@@ -0,0 +1,28 @@
+/**
+ * (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.
+ */
+import { Authenticator } from '../authenticators';
+/**
+ * Look for external configuration of authenticator.
+ *
+ * Try to get authenticator from external sources, with the following priority:
+ * 1. Credentials file (ibm-credentials.env)
+ * 2. Environment variables
+ * 3. VCAP Services (Cloud Foundry)
+ *
+ * @param serviceName - the service name prefix.
+ *
+ */
+export declare function getAuthenticatorFromEnvironment(serviceName: string): Authenticator;

package/auth/user-temp/get-authenticator-from-environment.js

@@ -0,0 +1,95 @@
+"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.getAuthenticatorFromEnvironment = void 0;
+var authenticators_1 = require("../authenticators");
+var read_external_sources_1 = require("./read-external-sources");
+/**
+ * Look for external configuration of authenticator.
+ *
+ * Try to get authenticator from external sources, with the following priority:
+ * 1. Credentials file (ibm-credentials.env)
+ * 2. Environment variables
+ * 3. VCAP Services (Cloud Foundry)
+ *
+ * @param serviceName - the service name prefix.
+ *
+ */
+function getAuthenticatorFromEnvironment(serviceName) {
+    if (!serviceName) {
+        throw new Error('Service name is required.');
+    }
+    // construct the credentials object from the environment
+    var credentials = (0, read_external_sources_1.readExternalSources)(serviceName);
+    if (credentials === null) {
+        throw new Error('Unable to create an authenticator from the environment.');
+    }
+    // remove client-level properties
+    delete credentials.url;
+    delete credentials.disableSsl;
+    // convert "auth" properties to their proper keys
+    if (credentials.authUrl) {
+        credentials.url = credentials.authUrl;
+        delete credentials.authUrl;
+    }
+    if (credentials.authDisableSsl) {
+        credentials.disableSslVerification = credentials.authDisableSsl;
+        delete credentials.authDisableSsl;
+    }
+    // in the situation where the auth type is not provided:
+    // if an apikey is provided, default to IAM
+    // if not, default to container auth
+    var authType = credentials.authType;
+    if (!authType) {
+        // Support the alternate "AUTHTYPE" config property.
+        authType = credentials.authtype;
+    }
+    if (!authType || typeof authType !== 'string') {
+        authType = credentials.apikey ? authenticators_1.Authenticator.AUTHTYPE_IAM : authenticators_1.Authenticator.AUTHTYPE_CONTAINER;
+    }
+    // Create and return the appropriate authenticator.
+    var authenticator;
+    // Compare the authType against our constants case-insensitively to
+    // determine which authenticator type needs to be constructed.
+    authType = authType.toLowerCase();
+    if (authType === authenticators_1.Authenticator.AUTHTYPE_NOAUTH.toLowerCase()) {
+        authenticator = new authenticators_1.NoAuthAuthenticator();
+    }
+    else if (authType === authenticators_1.Authenticator.AUTHTYPE_BASIC.toLowerCase()) {
+        authenticator = new authenticators_1.BasicAuthenticator(credentials);
+    }
+    else if (authType === authenticators_1.Authenticator.AUTHTYPE_BEARERTOKEN.toLowerCase()) {
+        authenticator = new authenticators_1.BearerTokenAuthenticator(credentials);
+    }
+    else if (authType === authenticators_1.Authenticator.AUTHTYPE_CP4D.toLowerCase()) {
+        authenticator = new authenticators_1.CloudPakForDataAuthenticator(credentials);
+    }
+    else if (authType === authenticators_1.Authenticator.AUTHTYPE_IAM.toLowerCase()) {
+        authenticator = new authenticators_1.IamAuthenticator(credentials);
+    }
+    else if (authType === authenticators_1.Authenticator.AUTHTYPE_CONTAINER.toLowerCase()) {
+        authenticator = new authenticators_1.ContainerAuthenticator(credentials);
+    }
+    else if (authType === authenticators_1.Authenticator.AUTHTYPE_VPC.toLowerCase()) {
+        authenticator = new authenticators_1.VpcInstanceAuthenticator(credentials);
+    }
+    else {
+        throw new Error("Invalid value for AUTH_TYPE: ".concat(authType));
+    }
+    return authenticator;
+}
+exports.getAuthenticatorFromEnvironment = getAuthenticatorFromEnvironment;

package/auth/user-temp/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * (C) Copyright IBM Corp. 2019, 2021.
+ *
+ * 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.
+ */
+/**
+ * @module utils
+ * Helper functions used by generated SDKs.
+ *
+ * functions:
+ *   getAuthenticatorFromEnvironment: Get authenticator from external sources.
+ *   readExternalSources: Get config object from external sources.
+ */
+export { getAuthenticatorFromEnvironment } from './get-authenticator-from-environment';
+export { readExternalSources } from './read-external-sources';

package/auth/user-temp/index.js

@@ -0,0 +1,30 @@
+"use strict";
+/**
+ * (C) Copyright IBM Corp. 2019, 2021.
+ *
+ * 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.readExternalSources = exports.getAuthenticatorFromEnvironment = void 0;
+/**
+ * @module utils
+ * Helper functions used by generated SDKs.
+ *
+ * functions:
+ *   getAuthenticatorFromEnvironment: Get authenticator from external sources.
+ *   readExternalSources: Get config object from external sources.
+ */
+var get_authenticator_from_environment_1 = require("./get-authenticator-from-environment");
+Object.defineProperty(exports, "getAuthenticatorFromEnvironment", { enumerable: true, get: function () { return get_authenticator_from_environment_1.getAuthenticatorFromEnvironment; } });
+var read_external_sources_1 = require("./read-external-sources");
+Object.defineProperty(exports, "readExternalSources", { enumerable: true, get: function () { return read_external_sources_1.readExternalSources; } });

package/auth/user-temp/read-external-sources.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Read properties stored in external sources like Environment Variables,
+ * the credentials file, VCAP services, etc. and return them as an
+ * object. The keys of this object will have the service name prefix removed
+ * and will be converted to lower camel case.
+ *
+ * Only one source will be used at a time.
+ *
+ * @param serviceName - the service name prefix
+ */
+export declare function readExternalSources(serviceName: string): any;

package/auth/user-temp/read-external-sources.js

@@ -0,0 +1,154 @@
+"use strict";
+/* eslint-disable no-restricted-syntax */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readExternalSources = void 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.
+ */
+var camelcase_1 = __importDefault(require("camelcase"));
+var lodash_isempty_1 = __importDefault(require("lodash.isempty"));
+var logger_1 = __importDefault(require("../../lib/logger"));
+var utils_1 = require("../utils");
+/**
+ * Read properties stored in external sources like Environment Variables,
+ * the credentials file, VCAP services, etc. and return them as an
+ * object. The keys of this object will have the service name prefix removed
+ * and will be converted to lower camel case.
+ *
+ * Only one source will be used at a time.
+ *
+ * @param serviceName - the service name prefix
+ */
+function readExternalSources(serviceName) {
+    if (!serviceName) {
+        throw new Error('Service name is required.');
+    }
+    return getProperties(serviceName);
+}
+exports.readExternalSources = readExternalSources;
+function getProperties(serviceName) {
+    // Try to get properties from external sources, with the following priority:
+    // 1. Credentials file (ibm-credentials.env)
+    // 2. Environment variables
+    // 3. VCAP Services (Cloud Foundry)
+    // only get properties from one source, return null if none found
+    var properties = null;
+    properties = filterPropertiesByServiceName((0, utils_1.readCredentialsFile)(), serviceName);
+    if ((0, lodash_isempty_1.default)(properties)) {
+        properties = filterPropertiesByServiceName(process.env, serviceName);
+    }
+    if ((0, lodash_isempty_1.default)(properties)) {
+        properties = getPropertiesFromVCAP(serviceName);
+    }
+    return properties;
+}
+/**
+ * Pulls credentials from env properties
+ *
+ * Property checked is uppercase service.name suffixed by _USERNAME and _PASSWORD
+ *
+ * For example, if service.name is speech_to_text,
+ * env properties are SPEECH_TO_TEXT_USERNAME and SPEECH_TO_TEXT_PASSWORD
+ *
+ * @param envObj - the object containing the credentials keyed by environment variables
+ * @returns the set of credentials
+ */
+function filterPropertiesByServiceName(envObj, serviceName) {
+    var credentials = {};
+    var name = "".concat(serviceName.toUpperCase().replace(/-/g, '_'), "_"); // append the underscore that must follow the service name
+    // filter out properties that don't begin with the service name
+    Object.keys(envObj).forEach(function (key) {
+        if (key.startsWith(name)) {
+            var propName = (0, camelcase_1.default)(key.substring(name.length)); // remove the name from the front of the string and make camelcase
+            credentials[propName] = envObj[key];
+        }
+    });
+    // all env variables are parsed as strings, convert boolean vars as needed
+    if (typeof credentials.disableSsl === 'string') {
+        credentials.disableSsl = credentials.disableSsl === 'true';
+    }
+    if (typeof credentials.authDisableSsl === 'string') {
+        credentials.authDisableSsl = credentials.authDisableSsl === 'true';
+    }
+    if (typeof credentials.enableGzip === 'string') {
+        credentials.enableGzip = credentials.enableGzip === 'true';
+    }
+    if (typeof credentials.enableRetries === 'string') {
+        credentials.enableRetries = credentials.enableRetries === 'true';
+    }
+    if (typeof credentials.maxRetries === 'string') {
+        credentials.maxRetries = parseInt(credentials.maxRetries, 10);
+    }
+    if (typeof credentials.retryInterval === 'string') {
+        credentials.retryInterval = parseInt(credentials.retryInterval, 10);
+    }
+    return credentials;
+}
+/**
+ * Pulls credentials from VCAP_SERVICES env property that IBM Cloud sets
+ *
+ * The function will first look for a service entry whose "name" field matches
+ * the serviceKey value. If found, return its credentials.
+ *
+ * If no match against the service entry's "name" field is found, then find the
+ * service list with a key matching the serviceKey value. If found, return the
+ * credentials of the first service in the service list.
+ */
+function getVCAPCredentialsForService(name) {
+    if (process.env.VCAP_SERVICES) {
+        var services = JSON.parse(process.env.VCAP_SERVICES);
+        for (var _i = 0, _a = Object.keys(services); _i < _a.length; _i++) {
+            var serviceName = _a[_i];
+            for (var _b = 0, _c = services[serviceName]; _b < _c.length; _b++) {
+                var instance = _c[_b];
+                if (instance.name === name) {
+                    if (Object.prototype.hasOwnProperty.call(instance, 'credentials')) {
+                        return instance.credentials;
+                    }
+                    logger_1.default.debug('no data read from VCAP_SERVICES');
+                    return {};
+                }
+            }
+        }
+        for (var _d = 0, _e = Object.keys(services); _d < _e.length; _d++) {
+            var serviceName = _e[_d];
+            if (serviceName === name) {
+                if (services[serviceName].length > 0) {
+                    if (Object.prototype.hasOwnProperty.call(services[serviceName][0], 'credentials')) {
+                        return services[serviceName][0].credentials;
+                    }
+                    logger_1.default.debug('no data read from VCAP_SERVICES');
+                    return {};
+                }
+                logger_1.default.debug('no data read from VCAP_SERVICES');
+                return {};
+            }
+        }
+    }
+    logger_1.default.debug('no data read from VCAP_SERVICES');
+    return {};
+}
+function getPropertiesFromVCAP(serviceName) {
+    var credentials = getVCAPCredentialsForService(serviceName);
+    // infer authentication type from credentials in a simple manner
+    // iam is used as the default later
+    if (credentials.username || credentials.password) {
+        credentials.authType = 'basic';
+    }
+    return credentials;
+}

package/es/auth/user-temp/get-authenticator-from-environment.d.ts

@@ -0,0 +1,28 @@
+/**
+ * (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.
+ */
+import { Authenticator } from '../authenticators';
+/**
+ * Look for external configuration of authenticator.
+ *
+ * Try to get authenticator from external sources, with the following priority:
+ * 1. Credentials file (ibm-credentials.env)
+ * 2. Environment variables
+ * 3. VCAP Services (Cloud Foundry)
+ *
+ * @param serviceName - the service name prefix.
+ *
+ */
+export declare function getAuthenticatorFromEnvironment(serviceName: string): Authenticator;

package/es/auth/user-temp/get-authenticator-from-environment.js

@@ -0,0 +1,91 @@
+/**
+ * (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.
+ */
+import { Authenticator, BasicAuthenticator, BearerTokenAuthenticator, CloudPakForDataAuthenticator, IamAuthenticator, ContainerAuthenticator, NoAuthAuthenticator, VpcInstanceAuthenticator, } from '../authenticators';
+import { readExternalSources } from './read-external-sources';
+/**
+ * Look for external configuration of authenticator.
+ *
+ * Try to get authenticator from external sources, with the following priority:
+ * 1. Credentials file (ibm-credentials.env)
+ * 2. Environment variables
+ * 3. VCAP Services (Cloud Foundry)
+ *
+ * @param serviceName - the service name prefix.
+ *
+ */
+export function getAuthenticatorFromEnvironment(serviceName) {
+    if (!serviceName) {
+        throw new Error('Service name is required.');
+    }
+    // construct the credentials object from the environment
+    const credentials = readExternalSources(serviceName);
+    if (credentials === null) {
+        throw new Error('Unable to create an authenticator from the environment.');
+    }
+    // remove client-level properties
+    delete credentials.url;
+    delete credentials.disableSsl;
+    // convert "auth" properties to their proper keys
+    if (credentials.authUrl) {
+        credentials.url = credentials.authUrl;
+        delete credentials.authUrl;
+    }
+    if (credentials.authDisableSsl) {
+        credentials.disableSslVerification = credentials.authDisableSsl;
+        delete credentials.authDisableSsl;
+    }
+    // in the situation where the auth type is not provided:
+    // if an apikey is provided, default to IAM
+    // if not, default to container auth
+    let { authType } = credentials;
+    if (!authType) {
+        // Support the alternate "AUTHTYPE" config property.
+        authType = credentials.authtype;
+    }
+    if (!authType || typeof authType !== 'string') {
+        authType = credentials.apikey ? Authenticator.AUTHTYPE_IAM : Authenticator.AUTHTYPE_CONTAINER;
+    }
+    // Create and return the appropriate authenticator.
+    let authenticator;
+    // Compare the authType against our constants case-insensitively to
+    // determine which authenticator type needs to be constructed.
+    authType = authType.toLowerCase();
+    if (authType === Authenticator.AUTHTYPE_NOAUTH.toLowerCase()) {
+        authenticator = new NoAuthAuthenticator();
+    }
+    else if (authType === Authenticator.AUTHTYPE_BASIC.toLowerCase()) {
+        authenticator = new BasicAuthenticator(credentials);
+    }
+    else if (authType === Authenticator.AUTHTYPE_BEARERTOKEN.toLowerCase()) {
+        authenticator = new BearerTokenAuthenticator(credentials);
+    }
+    else if (authType === Authenticator.AUTHTYPE_CP4D.toLowerCase()) {
+        authenticator = new CloudPakForDataAuthenticator(credentials);
+    }
+    else if (authType === Authenticator.AUTHTYPE_IAM.toLowerCase()) {
+        authenticator = new IamAuthenticator(credentials);
+    }
+    else if (authType === Authenticator.AUTHTYPE_CONTAINER.toLowerCase()) {
+        authenticator = new ContainerAuthenticator(credentials);
+    }
+    else if (authType === Authenticator.AUTHTYPE_VPC.toLowerCase()) {
+        authenticator = new VpcInstanceAuthenticator(credentials);
+    }
+    else {
+        throw new Error(`Invalid value for AUTH_TYPE: ${authType}`);
+    }
+    return authenticator;
+}

package/es/auth/user-temp/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * (C) Copyright IBM Corp. 2019, 2021.
+ *
+ * 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.
+ */
+/**
+ * @module utils
+ * Helper functions used by generated SDKs.
+ *
+ * functions:
+ *   getAuthenticatorFromEnvironment: Get authenticator from external sources.
+ *   readExternalSources: Get config object from external sources.
+ */
+export { getAuthenticatorFromEnvironment } from './get-authenticator-from-environment';
+export { readExternalSources } from './read-external-sources';

package/es/auth/user-temp/index.js

@@ -0,0 +1,25 @@
+/**
+ * (C) Copyright IBM Corp. 2019, 2021.
+ *
+ * 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.
+ */
+/**
+ * @module utils
+ * Helper functions used by generated SDKs.
+ *
+ * functions:
+ *   getAuthenticatorFromEnvironment: Get authenticator from external sources.
+ *   readExternalSources: Get config object from external sources.
+ */
+export { getAuthenticatorFromEnvironment } from './get-authenticator-from-environment';
+export { readExternalSources } from './read-external-sources';

package/es/auth/user-temp/read-external-sources.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Read properties stored in external sources like Environment Variables,
+ * the credentials file, VCAP services, etc. and return them as an
+ * object. The keys of this object will have the service name prefix removed
+ * and will be converted to lower camel case.
+ *
+ * Only one source will be used at a time.
+ *
+ * @param serviceName - the service name prefix
+ */
+export declare function readExternalSources(serviceName: string): any;

package/es/auth/user-temp/read-external-sources.js

@@ -0,0 +1,144 @@
+/* eslint-disable no-restricted-syntax */
+/**
+ * (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.
+ */
+import camelcase from 'camelcase';
+import isEmpty from 'lodash.isempty';
+import logger from '../../lib/logger';
+import { readCredentialsFile } from '../utils';
+/**
+ * Read properties stored in external sources like Environment Variables,
+ * the credentials file, VCAP services, etc. and return them as an
+ * object. The keys of this object will have the service name prefix removed
+ * and will be converted to lower camel case.
+ *
+ * Only one source will be used at a time.
+ *
+ * @param serviceName - the service name prefix
+ */
+export function readExternalSources(serviceName) {
+    if (!serviceName) {
+        throw new Error('Service name is required.');
+    }
+    return getProperties(serviceName);
+}
+function getProperties(serviceName) {
+    // Try to get properties from external sources, with the following priority:
+    // 1. Credentials file (ibm-credentials.env)
+    // 2. Environment variables
+    // 3. VCAP Services (Cloud Foundry)
+    // only get properties from one source, return null if none found
+    let properties = null;
+    properties = filterPropertiesByServiceName(readCredentialsFile(), serviceName);
+    if (isEmpty(properties)) {
+        properties = filterPropertiesByServiceName(process.env, serviceName);
+    }
+    if (isEmpty(properties)) {
+        properties = getPropertiesFromVCAP(serviceName);
+    }
+    return properties;
+}
+/**
+ * Pulls credentials from env properties
+ *
+ * Property checked is uppercase service.name suffixed by _USERNAME and _PASSWORD
+ *
+ * For example, if service.name is speech_to_text,
+ * env properties are SPEECH_TO_TEXT_USERNAME and SPEECH_TO_TEXT_PASSWORD
+ *
+ * @param envObj - the object containing the credentials keyed by environment variables
+ * @returns the set of credentials
+ */
+function filterPropertiesByServiceName(envObj, serviceName) {
+    const credentials = {};
+    const name = `${serviceName.toUpperCase().replace(/-/g, '_')}_`; // append the underscore that must follow the service name
+    // filter out properties that don't begin with the service name
+    Object.keys(envObj).forEach((key) => {
+        if (key.startsWith(name)) {
+            const propName = camelcase(key.substring(name.length)); // remove the name from the front of the string and make camelcase
+            credentials[propName] = envObj[key];
+        }
+    });
+    // all env variables are parsed as strings, convert boolean vars as needed
+    if (typeof credentials.disableSsl === 'string') {
+        credentials.disableSsl = credentials.disableSsl === 'true';
+    }
+    if (typeof credentials.authDisableSsl === 'string') {
+        credentials.authDisableSsl = credentials.authDisableSsl === 'true';
+    }
+    if (typeof credentials.enableGzip === 'string') {
+        credentials.enableGzip = credentials.enableGzip === 'true';
+    }
+    if (typeof credentials.enableRetries === 'string') {
+        credentials.enableRetries = credentials.enableRetries === 'true';
+    }
+    if (typeof credentials.maxRetries === 'string') {
+        credentials.maxRetries = parseInt(credentials.maxRetries, 10);
+    }
+    if (typeof credentials.retryInterval === 'string') {
+        credentials.retryInterval = parseInt(credentials.retryInterval, 10);
+    }
+    return credentials;
+}
+/**
+ * Pulls credentials from VCAP_SERVICES env property that IBM Cloud sets
+ *
+ * The function will first look for a service entry whose "name" field matches
+ * the serviceKey value. If found, return its credentials.
+ *
+ * If no match against the service entry's "name" field is found, then find the
+ * service list with a key matching the serviceKey value. If found, return the
+ * credentials of the first service in the service list.
+ */
+function getVCAPCredentialsForService(name) {
+    if (process.env.VCAP_SERVICES) {
+        const services = JSON.parse(process.env.VCAP_SERVICES);
+        for (const serviceName of Object.keys(services)) {
+            for (const instance of services[serviceName]) {
+                if (instance.name === name) {
+                    if (Object.prototype.hasOwnProperty.call(instance, 'credentials')) {
+                        return instance.credentials;
+                    }
+                    logger.debug('no data read from VCAP_SERVICES');
+                    return {};
+                }
+            }
+        }
+        for (const serviceName of Object.keys(services)) {
+            if (serviceName === name) {
+                if (services[serviceName].length > 0) {
+                    if (Object.prototype.hasOwnProperty.call(services[serviceName][0], 'credentials')) {
+                        return services[serviceName][0].credentials;
+                    }
+                    logger.debug('no data read from VCAP_SERVICES');
+                    return {};
+                }
+                logger.debug('no data read from VCAP_SERVICES');
+                return {};
+            }
+        }
+    }
+    logger.debug('no data read from VCAP_SERVICES');
+    return {};
+}
+function getPropertiesFromVCAP(serviceName) {
+    const credentials = getVCAPCredentialsForService(serviceName);
+    // infer authentication type from credentials in a simple manner
+    // iam is used as the default later
+    if (credentials.username || credentials.password) {
+        credentials.authType = 'basic';
+    }
+    return credentials;
+}