@ibm-cloud/secrets-manager 0.0.4 → 0.1.1

package/auth/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019.
+ * (C) Copyright IBM Corp. 2019, 2020.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export { NoAuthAuthenticator, BasicAuthenticator, BearerTokenAuthenticator, IamAuthenticator, CloudPakForDataAuthenticator, IamTokenManager, Cp4dTokenManager, getAuthenticatorFromEnvironment, } from 'ibm-cloud-sdk-core';
+export { NoAuthAuthenticator, BasicAuthenticator, BearerTokenAuthenticator, IamAuthenticator, CloudPakForDataAuthenticator, IamTokenManager, Cp4dTokenManager, getAuthenticatorFromEnvironment } from 'ibm-cloud-sdk-core';

package/auth/index.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * (C) Copyright IBM Corp. 2019.
+ * (C) Copyright IBM Corp. 2019, 2020.
  *
  * 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,12 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 var ibm_cloud_sdk_core_1 = require("ibm-cloud-sdk-core");
-exports.NoAuthAuthenticator = ibm_cloud_sdk_core_1.NoAuthAuthenticator;
-exports.BasicAuthenticator = ibm_cloud_sdk_core_1.BasicAuthenticator;
-exports.BearerTokenAuthenticator = ibm_cloud_sdk_core_1.BearerTokenAuthenticator;
-exports.IamAuthenticator = ibm_cloud_sdk_core_1.IamAuthenticator;
-exports.CloudPakForDataAuthenticator = ibm_cloud_sdk_core_1.CloudPakForDataAuthenticator;
-exports.IamTokenManager = ibm_cloud_sdk_core_1.IamTokenManager;
-exports.Cp4dTokenManager = ibm_cloud_sdk_core_1.Cp4dTokenManager;
-exports.getAuthenticatorFromEnvironment = ibm_cloud_sdk_core_1.getAuthenticatorFromEnvironment;
+Object.defineProperty(exports, "NoAuthAuthenticator", { enumerable: true, get: function () { return ibm_cloud_sdk_core_1.NoAuthAuthenticator; } });
+Object.defineProperty(exports, "BasicAuthenticator", { enumerable: true, get: function () { return ibm_cloud_sdk_core_1.BasicAuthenticator; } });
+Object.defineProperty(exports, "BearerTokenAuthenticator", { enumerable: true, get: function () { return ibm_cloud_sdk_core_1.BearerTokenAuthenticator; } });
+Object.defineProperty(exports, "IamAuthenticator", { enumerable: true, get: function () { return ibm_cloud_sdk_core_1.IamAuthenticator; } });
+Object.defineProperty(exports, "CloudPakForDataAuthenticator", { enumerable: true, get: function () { return ibm_cloud_sdk_core_1.CloudPakForDataAuthenticator; } });
+Object.defineProperty(exports, "IamTokenManager", { enumerable: true, get: function () { return ibm_cloud_sdk_core_1.IamTokenManager; } });
+Object.defineProperty(exports, "Cp4dTokenManager", { enumerable: true, get: function () { return ibm_cloud_sdk_core_1.Cp4dTokenManager; } });
+Object.defineProperty(exports, "getAuthenticatorFromEnvironment", { enumerable: true, get: function () { return ibm_cloud_sdk_core_1.getAuthenticatorFromEnvironment; } });
 //# sourceMappingURL=index.js.map

package/auth/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../auth/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;AAEH,yDAS4B;AAR1B,mDAAA,mBAAmB,CAAA;AACnB,kDAAA,kBAAkB,CAAA;AAClB,wDAAA,wBAAwB,CAAA;AACxB,gDAAA,gBAAgB,CAAA;AAChB,4DAAA,4BAA4B,CAAA;AAC5B,+CAAA,eAAe,CAAA;AACf,gDAAA,gBAAgB,CAAA;AAChB,+DAAA,+BAA+B,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../auth/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;AAEH,yDAS4B;AAR1B,yHAAA,mBAAmB,OAAA;AACnB,wHAAA,kBAAkB,OAAA;AAClB,8HAAA,wBAAwB,OAAA;AACxB,sHAAA,gBAAgB,OAAA;AAChB,kIAAA,4BAA4B,OAAA;AAC5B,qHAAA,eAAe,OAAA;AACf,sHAAA,gBAAgB,OAAA;AAChB,qIAAA,+BAA+B,OAAA"}

package/lib/common.d.ts

@@ -16,4 +16,7 @@
 export declare type SdkHeaders = {
     'User-Agent': string;
 };
+/**
+ * Get the request headers to be sent in requests by the SDK.
+ */
 export declare function getSdkHeaders(serviceName: string, serviceVersion: string, operationId: string): SdkHeaders | {};

package/lib/common.js

@@ -15,9 +15,13 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSdkHeaders = void 0;
 var os = require("os");
 // tslint:disable-next-line:no-var-requires
-var pkg = require('../../package.json');
+var pkg = require('../package.json');
+/**
+ * Get the request headers to be sent in requests by the SDK.
+ */
 function getSdkHeaders(serviceName, serviceVersion, operationId) {
     var sdkName = 'secrets-manager-nodejs-sdk';
     var sdkVersion = pkg.version;
@@ -25,7 +29,7 @@ function getSdkHeaders(serviceName, serviceVersion, operationId) {
     var osVersion = os.release();
     var nodeVersion = process.version;
     var headers = {
-        'User-Agent': sdkName + "/" + sdkVersion + " (lang=node.js; os.name=" + osName + " os.version=" + osVersion + " node.version=" + nodeVersion + ")",
+        'User-Agent': sdkName + "/" + sdkVersion + " (lang=node.js; os.name=" + osName + " os.version=" + osVersion + " node.version=" + nodeVersion + ")"
     };
     return headers;
 }

package/lib/common.js.map

@@ -1 +1 @@
-{"version":3,"file":"common.js","sourceRoot":"","sources":["../../lib/common.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;AAEH,uBAA0B;AAE1B,2CAA2C;AAC3C,IAAM,GAAG,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAM1C,SAAgB,aAAa,CAAC,WAAmB,EAAE,cAAsB,EAAE,WAAmB;IAC5F,IAAM,OAAO,GAAG,4BAA4B,CAAC;IAC7C,IAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC;IAC/B,IAAM,MAAM,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;IAC7B,IAAM,SAAS,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;IAC/B,IAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAEpC,IAAM,OAAO,GAAG;QACd,YAAY,EAAK,OAAO,SAAI,UAAU,gCAA2B,MAAM,oBAAe,SAAS,sBAAiB,WAAW,MAAG;KAC/H,CAAC;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC;AAZD,sCAYC"}
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../lib/common.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,uBAA0B;AAE1B,2CAA2C;AAC3C,IAAM,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAMvC;;GAEG;AACH,SAAgB,aAAa,CAAC,WAAmB,EAAE,cAAsB,EAAE,WAAmB;IAC5F,IAAM,OAAO,GAAG,4BAA4B,CAAC;IAC7C,IAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC;IAC/B,IAAM,MAAM,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;IAC7B,IAAM,SAAS,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;IAC/B,IAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAEpC,IAAM,OAAO,GAAG;QACd,YAAY,EAAK,OAAO,SAAI,UAAU,gCAA2B,MAAM,oBAAe,SAAS,sBAAiB,WAAW,MAAG;KAC/H,CAAC;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC;AAZD,sCAYC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ibm-cloud/secrets-manager",
-  "version": "0.0.4",
+  "version": "0.1.1",
   "description": "Client library for IBM Cloud Secrets Manager",
   "repository": {
     "type": "git",
@@ -18,51 +18,57 @@
     "tslint:check": "tslint -p . -c ./tslint.json",
     "lint": "npm run eslint:check && npm run tslint:check",
     "lint-fix": "npm run eslint:fix && npm run tslint:fix",
+    "build": "tsc && cp package.json dist/ && cp README.md dist/",
+    "postversion": "tsc-publish --no-checks --dry-run",
+    "publishDist": "npm run build && cd dist && npm publish --access public",
     "jest": "jest",
     "test": "npm run build && npm run lint && jest test/",
     "test-unit": "npm run build && jest test/unit/",
     "test-integration": "npm run build && jest test/integration",
+    "test-examples": "npm run build && jest examples/",
+    "test-travis": "jest --runInBand --testNamePattern='^((?!@slow).)*$' test/",
+    "test-unit-travis": "jest --runInBand test/unit/",
+    "test-integration-travis": "jest --runInBand --no-colors --testNamePattern='^((?!@slow).)*$' --json test/integration > test-output.log",
     "report-coverage": "codecov",
-    "check-packages": "installed-check -e -d -v",
-    "build": "tsc",
-    "prepublishOnly": "npm run build",
-    "postversion": "tsc-publish --no-checks --dry-run",
-    "publishDist": "cp {package.json,readme.md} dist/ && cd dist && npm publish --access public"
+    "check-packages": "installed-check -e -d -v"
   },
   "license": "Apache-2.0",
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=10.0.0"
   },
   "dependencies": {
     "@types/node": "^12.0.8",
     "extend": "^3.0.2",
-    "ibm-cloud-sdk-core": "^2.0.3",
-    "tsc-publish": "^0.5.2"
+    "ibm-cloud-sdk-core": "^2.8.0"
   },
   "devDependencies": {
-    "axios": "^0.19.0",
-    "codecov": "^3.7.1",
+    "@semantic-release/changelog": "5.0.1",
+    "@semantic-release/git": "9.0.0",
+    "axios": "^0.21.1",
+    "codecov": "^3.7.0",
+    "dotenv": "^8.2.0",
     "eslint": "^5.16.0",
     "eslint-config-google": "^0.12.0",
     "eslint-config-prettier": "^4.2.0",
     "eslint-plugin-node": "^9.0.0",
     "eslint-plugin-prettier": "^3.0.1",
     "installed-check": "^2.2.0",
-    "jest": "^24.8.0",
+    "jest": "^25.4.0",
     "prettier": "^1.17.1",
-    "semantic-release": "^15.13.25",
+    "tsc-publish": "^0.5.2",
     "tslint": "^5.16.0",
     "tslint-config-prettier": "^1.18.0",
     "tslint-eslint-rules": "^5.4.0",
     "typedoc": "^0.15.0",
-    "typescript": "^3.4.5"
+    "typescript": "^3.8.3"
   },
   "jest": {
     "collectCoverage": true,
     "coverageDirectory": "./coverage/",
     "coveragePathIgnorePatterns": [
-      "<rootDir>/test/"
+      "<rootDir>/test/",
+      "<rootDir>/examples/"
     ],
     "testEnvironment": "node"
   }
-}
+}

package/readme.md

@@ -2,7 +2,8 @@
 
 # IBM Cloud Secrets Manager Node.js SDK
 
-A Node.js client library to use the IBM Cloud® Secrets Manager APIs.
+A Node.js client library to interact with
+the [IBM Cloud® Secrets Manager APIs](https://cloud.ibm.com/apidocs/secrets-manager).
 
 <details>
 <summary>Table of Contents</summary>
@@ -12,18 +13,32 @@ A Node.js client library to use the IBM Cloud® Secrets Manager APIs.
 * [Installation](#installation)
 * [Authentication](#authentication)
 * [Using the SDK](#using-the-sdk)
-* [Documentation](#documentation)
 * [Tests](#tests)
+* [Questions](#questions)
+* [Issues](#issues)
+* [Contributing](#contributing)
+* [License](#license)
+
 </details>
 
 ## Overview
 
-The IBM Cloud Secrets Manager Node.js SDK allows developers to programmatically interact with IBM Cloud Secrets Manager.
+The IBM Cloud Secrets Manager Node.js SDK allows developers to programmatically interact with the following IBM Cloud
+services:
+
+Service name | Import path
+--- | ---
+[Secrets Manager](https://cloud.ibm.com/apidocs/secrets-manager) | @ibm-cloud/secrets-manager/secrets-manager/v1
 
 ## Prerequisites
-- You need an [IBM Cloud account](https://cloud.ibm.com/registration).
 
-- **Node >=12**: This SDK is tested with Node versions 12 and up. It may work on previous versions but this is not officially supported.
+- An [IBM Cloud account](https://cloud.ibm.com/registration).
+- A [Secrets Manager service instance](https://cloud.ibm.com/catalog/services/secrets-manager).
+- An [IBM Cloud API key](https://cloud.ibm.com/iam/apikeys) that allows the SDK to access your account.
+- Node.js version 12 or above.
+
+  This SDK is tested with Node versions 12 and up. The SDK may work on previous versions, but this is not supported
+  officially.
 
 ## Installation
 
@@ -33,15 +48,20 @@ npm install @ibm-cloud/secrets-manager
 
 ## Authentication
 
-IBM Cloud Secrets Manager uses token-based Identity and Access Management (IAM) authentication.
+Secrets Manager uses token-based Identity and Access Management (IAM) authentication.
 
-IAM authentication uses a service API key to get an access token that is passed with the call.
-Access tokens are valid for a limited amount of time and must be regenerated.
+With IAM authentication, you supply an API key that is used to generate an access token. Then, the access token is
+included in each API request to Secrets Manager. Access tokens are valid for a limited amount of time and must be
+regenerated.
 
-Authentication is accomplished using dedicated Authenticators for each authentication scheme. Import authenticators from `@ibm-cloud/secrets-manager/auth`.
+Authentication for this SDK is accomplished by
+using [IAM authenticators](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md#authentication). Import
+authenticators from `@ibm-cloud/secrets-manager/auth`.
 
 ### Examples
+
 #### Programmatic credentials
+
 ```js
 import { IamAuthenticator } from '@ibm-cloud/secrets-manager/auth';
 
@@ -51,6 +71,7 @@ const authenticator = new IamAuthenticator({
 ```
 
 #### External configuration
+
 ```js
 import { getAuthenticatorFromEnvironment } from '@ibm-cloud/secrets-manager/auth';
 
@@ -60,20 +81,25 @@ import { getAuthenticatorFromEnvironment } from '@ibm-cloud/secrets-manager/auth
 const iamAuthenticator = getAuthenticatorFromEnvironment('SECRETS_MANAGER_API');
 ```
 
-To learn more about the Authenticators and how to use them with your services, see [the detailed documentation](https://github.com/IBM/node-sdk-core/blob/master/AUTHENTICATION.md).
+To learn more about IAM authenticators and how to use them in your Node.js application, see
+the [IBM Node.js SDK Core documentation](https://github.com/IBM/node-sdk-core/blob/master/Authentication.md).
 
 ## Using the SDK
-### Basic usage
 
-- All methods return a Promise that either resolves with the response from the service or rejects with an Error. The response contains the body, the headers, the status code, and the status text.
-If using async/await, use try/catch for handling errors.
+### Basic usage
 
-- Use the `serviceUrl` parameter to pass the URL of your Secrets Manager to `IbmCloudSecretsManagerApiV1`.
+- All methods return a Promise that either resolves with the response from the service or rejects with an Error. The
+  response contains the body, the headers, the status code, and the status text. If using async/await, use try/catch for
+  handling errors.
+- Use the `serviceUrl` parameter to set the endpoint URL that is specific to your Secrets Manager service instance. To
+  find your endpoint URL, you can copy it from the **Endpoints** page in the Secrets Manager UI.
 
 #### Examples
-Create an instance of the Secrets Manager API and then use it to create and retrieve a secret.
+
+Construct a service client and use it to create and retrieve a secret from your Secrets Manager instance.
+
 ```js
-const IbmCloudSecretsManagerApiV1 =  require('@ibm-cloud/secrets-manager/ibm-cloud-secrets-manager-api/v1');
+const SecretsManager = require('@ibm-cloud/secrets-manager/secrets-manager/v1');
 const { IamAuthenticator } = require('@ibm-cloud/secrets-manager/auth');
 
 
@@ -84,14 +110,14 @@ async function secretsManagerSdkExample() {
   });
 
   // Create an instance of the SDK by providing an authentication mechanism and your Secrets Manager instance URL
-  const secretsManagerApi = new IbmCloudSecretsManagerApiV1({
+  const secretsManager = new SecretsManager({
     authenticator,
     serviceUrl:
       'https://example-instance.us-south.secrets-manager.appdomain.cloud',
   });
 
   // Use the Secrets Manager API to create a secret
-  let res = await secretsManagerApi.createSecret({
+  let res = await secretsManager.createSecret({
     secretType: 'username_password',
     'metadata': {
       'collection_type': 'application/vnd.ibm.secrets-manager.secret+json',
@@ -100,7 +126,7 @@ async function secretsManagerSdkExample() {
     'resources': [
       {
         'name': 'example-username-password-secret',
-        'description': 'text describing the secret',
+        'description': 'Extended description for this secret.',
         'username': 'user123',
         'password': '123456789',
         'labels': ['label1', 'label2'],
@@ -115,12 +141,12 @@ async function secretsManagerSdkExample() {
   const secretId = res.result.resources[0].id;
 
   // Use the Secrets Manager API to get the secret using the secret ID
-  res = await secretsManagerApi.getSecret({
+  res = await secretsManager.getSecret({
     secretType: 'username_password',
     id: secretId,
   });
 
-  console.log('Get Secret:\n', JSON.stringify(res.result.resources, null, 2));
+  console.log('Get secret:\n', JSON.stringify(res.result.resources, null, 2));
 }
 
 secretsManagerSdkExample();
@@ -128,6 +154,7 @@ secretsManagerSdkExample();
 ```
 
 To delete a secret, specify the `secretType` and its `id`.
+
 ```js
   res = await secretsManagerApi.deleteSecret({
     secretType: 'username_password',
@@ -139,6 +166,7 @@ To delete a secret, specify the `secretType` and its `id`.
 ```
 
 Create a secret group, and then add a new secret to this group.
+
 ```js
  // Create a secret group
     const createGroupParams = {
@@ -163,7 +191,7 @@ Create a secret group, and then add a new secret to this group.
         {
           secret_group_id: secretGroupId,
           name: "Test secret",
-          description: 'Secret used for testing',
+          description: 'Secret used for testing.',
           username: 'test_user',
           password: 'test_password',
           labels: ['label1'],
@@ -174,6 +202,7 @@ Create a secret group, and then add a new secret to this group.
 ```
 
 Create a rotation policy of one month for a secret.
+
 ```js
     let res = await ibmCloudSecretsManagerApiService.putPolicy({
       metadata: {
@@ -194,23 +223,46 @@ Create a rotation policy of one month for a secret.
     });
 ```
 
-## Documentation
-
-For more information about Secrets Manager, check out the [Secrets Manager documentation](https://cloud.ibm.com/docs/secrets-manager) and [API reference](https://cloud.ibm.com/apidocs/secrets-manager). 
+For more information and IBM Cloud SDK usage examples for Node.js, see
+the [IBM Cloud SDK Common documentation](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md)
 
 ## Tests
 
 This project includes unit tests `test/unit` and integration tests `test/integration`.
 
-The integration test are running against an actual instance of a Secrets Manager and require the following environment variables to be set:
+The integration tests are run against an actual Secrets Manager instance and require the following environment variables
+to be set:
+
 ```
 SECRETS_MANAGER_API_AUTH_TYPE=iam;
-SECRETS_MANAGER_API_APIKEY=<api key>
-SERVICE_URL=<url to a secrets manager instance>
+SECRETS_MANAGER_API_APIKEY=<API_KEY>
+SERVICE_URL=<SECRETS_MANAGER_ENDPOINT_URL>
 ```
 
-Running all the tests:
+To run the tests:
+
 ```sh
 npm test
 ```
 
+## Questions
+
+If you're having difficulties using this SDK, you can ask questions about this project by
+using [Stack Overflow](https://stackoverflow.com/questions/tagged/ibm-cloud+secrets-manager). Be sure to include
+the `ibm-cloud` and `secrets-manager` tags.
+
+You can also check out the [Secrets Manager documentation](https://cloud.ibm.com/docs/secrets-manager)
+and [API reference](https://cloud.ibm.com/apidocs/secrets-manager) for more information about the service.
+
+## Issues
+
+If you encounter an issue with the project, you're welcome to submit
+a [bug report](https://github.com/IBM/secrets-manager-nodejs-sdk/issues) to help us improve.
+
+## Contributing
+
+For general contribution guidelines, see [CONTRIBUTING](CONTRIBUTING.md).
+
+## License
+
+This SDK project is released under the Apache 2.0 license. The license's full text can be found in [LICENSE](LICENSE).