@ibm-cloud/secrets-manager 2.0.18 → 2.1.0

package/.releaserc

@@ -3,12 +3,7 @@
   "branches": [
     "main"
   ],
-  "verifyConditions": [
-    "@semantic-release/changelog",
-    "@semantic-release/npm",
-    "@semantic-release/git"
-  ],
-  "analyzeCommits":[
+  "plugins": [
     ["@semantic-release/commit-analyzer", {
         "preset": "angular",
         "releaseRules": [
@@ -17,24 +12,22 @@
             {"type": "minor","release": "minor"},
             {"type": "patch","release": "patch"}
     ]}],
-  ],
-   "generateNotes": [
-      "@semantic-release/release-notes-generator"
-  ],
-  "prepare": [
-    "@semantic-release/changelog",
+    "@semantic-release/release-notes-generator",
     "@semantic-release/npm",
-    "@semantic-release/git"
-  ],
-  "publish": [
     [
-      "@semantic-release/npm",
+      "@semantic-release/git",
       {
-        "pkgRoot": "dist"
+        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}",
+        "assets": ["package.json", "package-lock.json"]
       }
     ],
-    {
-      "path": "@semantic-release/github"
-    }
+    [
+      "@semantic-release/github",
+      {
+        "successComment": false,
+        "failComment": false,
+        "releasedLabels": false
+      }
+    ]
   ]
 }

package/dist/.gitattributes

@@ -0,0 +1 @@
+*.enc binary

package/dist/.prettierrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+    trailingComma: 'es5',
+    singleQuote: true,
+    printWidth: 100,
+    quoteProps: 'preserve'
+};

package/dist/.releaserc

@@ -0,0 +1,33 @@
+{
+  "debug": true,
+  "branches": [
+    "main"
+  ],
+  "plugins": [
+    ["@semantic-release/commit-analyzer", {
+        "preset": "angular",
+        "releaseRules": [
+            {"type": "release","release": "patch"},
+            {"type": "major","release": "major"},
+            {"type": "minor","release": "minor"},
+            {"type": "patch","release": "patch"}
+    ]}],
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/npm",
+    [
+      "@semantic-release/git",
+      {
+        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}",
+        "assets": ["package.json", "package-lock.json"]
+      }
+    ],
+    [
+      "@semantic-release/github",
+      {
+        "successComment": false,
+        "failComment": false,
+        "releasedLabels": false
+      }
+    ]
+  ]
+}

package/dist/CODE_OF_CONDUCT.md

@@ -0,0 +1,62 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making
+participation in our project and our community a harassment-free experience for everyone, regardless of age, body size,
+disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education,
+socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take
+appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
+issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the
+project or its community. Examples of representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed representative at an online or offline
+event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at
+phil_adams@us.ibm.com. All complaints will be reviewed and investigated and will result in a response that is deemed
+necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to
+the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent
+repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available
+at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

package/dist/CONTRIBUTING.MD

@@ -0,0 +1,23 @@
+# Contributing
+
+Review the following guidelines for submitting questions, issues, or changes to this repository.
+
+## Questions
+
+If you have questions about using the IBM Cloud Secrets Manager SDKs, you can ask questions in [Stack Overflow](https://stackoverflow.com/questions/tagged/ibm-secrets-manager). Be sure to include the `ibm-cloud` and `ibm-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 this project, you're welcome to submit
+a [bug report](https://github.com/IBM/secrets-manager-node-sdk/issues) to help us improve. Before you create a new
+issue, please search for similar issues in case someone has already reported the same problem.
+
+## Changes
+
+Thank you for contributing to IBM Cloud SDK projects! To learn more about submitting changes to this repository, check
+out
+the [IBM Cloud SDK Common contribution guidelines](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/CONTRIBUTING_nodejs.md)
+.

package/dist/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/dist/README.md

@@ -0,0 +1,240 @@
+![tests](https://github.com/IBM/secrets-manager-node-sdk/workflows/run-tests/badge.svg)
+
+# IBM Cloud Secrets Manager Node SDK
+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>
+
+* [Overview](#overview)
+* [Prerequisites](#prerequisites)
+* [Installation](#installation)
+* [Authentication](#authentication)
+* [Using the SDK](#using-the-sdk)
+* [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 the following IBM Cloud
+services:
+
+| Service name                                                     | Import path                                   |
+|------------------------------------------------------------------|-----------------------------------------------|
+| [Secrets Manager](https://cloud.ibm.com/apidocs/secrets-manager) | @ibm-cloud/secrets-manager/secrets-manager/v2 |
+
+## Prerequisites
+
+- 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 16 or above.
+
+  This SDK is tested with Node versions 14 and up. The SDK may work on previous versions, but this is not supported
+  officially.
+
+## Installation
+
+```sh
+npm install @ibm-cloud/secrets-manager
+```
+
+## Authentication
+Secrets Manager uses token-based Identity and Access Management (IAM) authentication.
+
+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 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';
+
+const authenticator = new IamAuthenticator({
+  apikey: '{apikey}',
+});
+```
+
+#### External configuration
+
+```js
+import { getAuthenticatorFromEnvironment } from '@ibm-cloud/secrets-manager/auth';
+
+// env vars
+// SECRETS_MANAGER_API_APIKEY==<apikey>
+const iamAuthenticator = getAuthenticatorFromEnvironment('SECRETS_MANAGER_API');
+```
+
+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.
+- 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
+Construct a service client and use it to create and retrieve a secret from your Secrets Manager instance.
+
+```js
+const SecretsManager = require('@ibm-cloud/secrets-manager/secrets-manager/v2');
+const { IamAuthenticator } = require('@ibm-cloud/secrets-manager/auth');
+
+
+async function secretsManagerSdkExample() {
+  // Authenticate with IAM using your IBM Cloud API key
+  const authenticator = new IamAuthenticator({
+    apikey: process.env.SECRETS_MANAGER_API_APIKEY,
+  });
+
+  // Create an instance of the SDK by providing an authentication mechanism and your Secrets Manager instance URL
+  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 secretsManager.createSecret({
+    secretPrototype:  {
+      custom_metadata: { metadata_custom_key: 'metadata_custom_value' },
+      description: 'Description of my arbitrary secret.',
+      expiration_date: '2023-10-05T11:49:42Z',
+      labels: ['dev', 'us-south'],
+      name: 'example-arbitrary-secret',
+      secret_group_id: 'default',
+      secret_type: 'arbitrary',
+      payload: 'secret-data',
+      version_custom_metadata: { custom_version_key: 'custom_version_value' },
+    }
+  });
+
+  console.log('Secret created:\n' + JSON.stringify(res.result, null, 2));
+
+  // Get the ID of the newly created secret
+  const secretId = res.result.id;
+
+  // Use the Secrets Manager API to get the secret using the secret ID
+  res = await secretsManager.getSecret({
+    id: secretId,
+  });
+
+  console.log('Get secret:\n', JSON.stringify(res.result, null, 2));
+}
+
+secretsManagerSdkExample();
+
+```
+
+To delete a secret, specify its `id`.
+
+```js
+  res = await secretsManager.deleteSecret({
+    id: secretId,
+  });
+
+  console.log('Secret deleted.');
+
+```
+
+Create a secret group, and then add a new secret to this group.
+
+```js
+ // Create a secret group
+    const createGroupParams = { name: 'Test Group', description: 'Group my test secrets' };
+
+    let res = await secretsManager.createSecretGroup(createGroupParams);
+    const secretGroupId = res.result.id;
+
+    // Create a secret and associate it with your secret group
+    res = await secretsManager.createSecret({
+      secretPrototype: {
+          secret_group_id: secretGroupId,
+          name: "Test secret",
+          description: 'Secret used for testing.',
+          username: 'test_user',
+          password: 'test_password',
+          labels: ['label1'],
+          expiration_date: '2030-04-01T09:30:00Z',
+        }
+    });
+```
+
+Create a rotation policy of one month for a secret.
+
+```js
+    let res = await secretsManager.createSecret({
+  secretPrototype:  {
+    custom_metadata: { metadata_custom_key: 'metadata_custom_value' },
+    description: 'Description of my arbitrary secret.',
+    expiration_date: '2023-10-05T11:49:42Z',
+    labels: ['dev', 'us-south'],
+    name: 'example-arbitrary-secret',
+    secret_group_id: 'default',
+    secret_type: 'arbitrary',
+    payload: 'secret-data',
+    version_custom_metadata: { custom_version_key: 'custom_version_value' },
+    rotation: {
+      auto_rotate: true,
+      interval: 1,
+      unit: month,
+    }
+  }
+});
+```
+
+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 tests are run against an actual Secrets Manager instance and require the following environment variables
+to be set:
+
+```
+SECRETS_MANAGER_API_APIKEY=<API_KEY>
+SERVICE_URL=<SECRETS_MANAGER_ENDPOINT_URL>
+```
+
+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-secrets-manager). Be sure to include
+the `ibm-cloud` and `ibm-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-node-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).
+