@ibm-cloud/secrets-manager 2.0.0 → 2.0.2

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [2.0.2](https://github.com/IBM/secrets-manager-node-sdk/compare/v2.0.1...v2.0.2) (2023-12-11)
+
+## [2.0.1](https://github.com/IBM/secrets-manager-node-sdk/compare/v2.0.0...v2.0.1) (2023-09-19)
+
 # [2.0.0](https://github.com/IBM/secrets-manager-node-sdk/compare/v1.0.44...v2.0.0) (2023-04-17)
 
 

package/README.md

@@ -1,6 +1,6 @@
 ![tests](https://github.com/IBM/secrets-manager-node-sdk/workflows/run-tests/badge.svg)
 
-# IBM Cloud Secrets Manager Node.js SDK v2
+# 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).
@@ -28,7 +28,7 @@ services:
 
 | Service name                                                     | Import path                                   |
 |------------------------------------------------------------------|-----------------------------------------------|
-| [Secrets Manager](https://cloud.ibm.com/apidocs/secrets-manager) | @ibm-cloud/secrets-manager/secrets-manager/v1 |
+| [Secrets Manager](https://cloud.ibm.com/apidocs/secrets-manager) | @ibm-cloud/secrets-manager/secrets-manager/v2 |
 
 ## Prerequisites
 
@@ -98,7 +98,7 @@ the [IBM Node.js SDK Core documentation](https://github.com/IBM/node-sdk-core/bl
 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/v1');
+const SecretsManager = require('@ibm-cloud/secrets-manager/secrets-manager/v2');
 const { IamAuthenticator } = require('@ibm-cloud/secrets-manager/auth');
 
 
@@ -117,46 +117,40 @@ async function secretsManagerSdkExample() {
 
   // Use the Secrets Manager API to create a secret
   let res = await secretsManager.createSecret({
-    secretType: 'username_password',
-    'metadata': {
-      'collection_type': 'application/vnd.ibm.secrets-manager.secret+json',
-      'collection_total': 1,
-    },
-    'resources': [
-      {
-        'name': 'example-username-password-secret',
-        'description': 'Extended description for this secret.',
-        'username': 'user123',
-        'password': '123456789',
-        'labels': ['label1', 'label2'],
-        'expiration_date': '2030-04-01T09:30:00Z',
-      },
-    ],
+    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.resources[0], null, 2));
+  console.log('Secret created:\n' + JSON.stringify(res.result, null, 2));
 
   // Get the ID of the newly created secret
-  const secretId = res.result.resources[0].id;
+  const secretId = res.result.id;
 
   // Use the Secrets Manager API to get the secret using the secret ID
   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, null, 2));
 }
 
 secretsManagerSdkExample();
 
 ```
 
-To delete a secret, specify the `secretType` and its `id`.
+To delete a secret, specify its `id`.
 
 ```js
   res = await secretsManager.deleteSecret({
-    secretType: 'username_password',
     id: secretId,
   });
 
@@ -168,26 +162,14 @@ Create a secret group, and then add a new secret to this group.
 
 ```js
  // Create a secret group
-    const createGroupParams = {
-      metadata: {
-        collection_type: 'application/vnd.ibm.secrets-manager.secret.group+json',
-        collection_total: 1,
-      },
-      resources: [{ name: 'Test Group', description: 'Group my test secrets' }],
-    };
+    const createGroupParams = { name: 'Test Group', description: 'Group my test secrets' };
 
     let res = await secretsManager.createSecretGroup(createGroupParams);
-    const secretGroupId = res.result.resources[0].id;
+    const secretGroupId = res.result.id;
 
     // Create a secret and associate it with your secret group
     res = await secretsManager.createSecret({
-      metadata: {
-        collection_type: 'application/vnd.ibm.secrets-manager.secret+json',
-        collection_total: 1,
-      },
-      secretType: 'username_password',
-      resources: [
-        {
+      secretPrototype: {
           secret_group_id: secretGroupId,
           name: "Test secret",
           description: 'Secret used for testing.',
@@ -195,31 +177,31 @@ Create a secret group, and then add a new secret to this group.
           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.putPolicy({
-      metadata: {
-        collection_type: 'application/vnd.ibm.secrets-manager.secret.policy+json',
-        collection_total: 1,
-      },
-      secretType: 'username_password',
-      id: secretId,
-      resources: [
-        {
-          type: 'application/vnd.ibm.secrets-manager.secret.policy+json',
-          rotation: {
-            interval: 1,
-            unit: 'month',
-          },
-        },
-      ],
-    });
+    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
@@ -264,5 +246,3 @@ 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).
-
-dummy PR #1

package/examples/secrets-manager.v2.test.js

@@ -64,6 +64,7 @@ describe('SecretsManagerV2', () => {
   let secretIdForGetSecretVersionLink;
   let secretIdForListSecretLocksLink;
   let secretIdForListSecretVersionLocksLink;
+  let secretNameLink;
   let secretVersionIdForCreateSecretVersionLocksLink;
   let secretVersionIdForDeleteSecretVersionLocksLink;
   let secretVersionIdForGetSecretVersionLink;
@@ -131,7 +132,7 @@ describe('SecretsManagerV2', () => {
     const secretPrototypeModel = {
       custom_metadata: { metadata_custom_key: 'metadata_custom_value' },
       description: 'Description of my arbitrary secret.',
-      expiration_date: '2023-10-05T11:49:42Z',
+      expiration_date: '2030-10-05T11:49:42Z',
       labels: ['dev', 'us-south'],
       name: 'example-arbitrary-secret',
       secret_group_id: 'default',
@@ -158,6 +159,47 @@ describe('SecretsManagerV2', () => {
     secretIdForGetSecretVersionLink = responseBody.id;
   });
 
+  test('updateSecretMetadata request example', async () => {
+    consoleLogMock.mockImplementation((output) => {
+      originalLog(output);
+    });
+    consoleWarnMock.mockImplementation((output) => {
+      // if an error occurs, display the message and then fail the test
+      originalWarn(output);
+      expect(true).toBeFalsy();
+    });
+
+    originalLog('updateSecretMetadata() result:');
+    // begin-update_secret_metadata
+
+    // Request models needed by this operation.
+
+    // ArbitrarySecretMetadataPatch
+    const secretMetadataPatchModel = {
+      name: 'updated-arbitrary-secret-name-example',
+      description: 'updated Arbitrary Secret description',
+      labels: ['dev', 'us-south'],
+      custom_metadata: { metadata_custom_key: 'metadata_custom_value' },
+    };
+
+    const params = {
+      id: secretIdForGetSecretLink,
+      secretMetadataPatch: secretMetadataPatchModel,
+    };
+
+    let res;
+    try {
+      res = await secretsManagerService.updateSecretMetadata(params);
+      console.log(JSON.stringify(res.result, null, 2));
+    } catch (err) {
+      console.warn(err);
+    }
+
+    // end-update_secret_metadata
+    const responseBody = res.result;
+    secretNameLink = responseBody.name;
+  });
+
   test('listSecretVersions request example', async () => {
     consoleLogMock.mockImplementation((output) => {
       originalLog(output);
@@ -388,7 +430,7 @@ describe('SecretsManagerV2', () => {
       limit: 10,
       sort: 'created_at',
       search: 'example',
-      groups: ['default'],
+      groups: ['default', 'cac40995-c37a-4dcb-9506-472869077634'],
     };
 
     const allResults = [];
@@ -463,7 +505,7 @@ describe('SecretsManagerV2', () => {
     // end-get_secret_metadata
   });
 
-  test('updateSecretMetadata request example', async () => {
+  test('createSecretAction request example', async () => {
     consoleLogMock.mockImplementation((output) => {
       originalLog(output);
     });
@@ -473,36 +515,33 @@ describe('SecretsManagerV2', () => {
       expect(true).toBeFalsy();
     });
 
-    originalLog('updateSecretMetadata() result:');
-    // begin-update_secret_metadata
+    originalLog('createSecretAction() result:');
+    // begin-create_secret_action
 
     // Request models needed by this operation.
 
-    // ArbitrarySecretMetadataPatch
-    const secretMetadataPatchModel = {
-      name: 'updated-arbitrary-secret-name',
-      description: 'updated Arbitrary Secret description',
-      labels: ['dev', 'us-south'],
-      custom_metadata: { metadata_custom_key: 'metadata_custom_value' },
+    // PrivateCertificateActionRevokePrototype
+    const secretActionPrototypeModel = {
+      action_type: 'private_cert_action_revoke_certificate',
     };
 
     const params = {
       id: secretIdForGetSecretLink,
-      secretMetadataPatch: secretMetadataPatchModel,
+      secretActionPrototype: secretActionPrototypeModel,
     };
 
     let res;
     try {
-      res = await secretsManagerService.updateSecretMetadata(params);
+      res = await secretsManagerService.createSecretAction(params);
       console.log(JSON.stringify(res.result, null, 2));
     } catch (err) {
       console.warn(err);
     }
 
-    // end-update_secret_metadata
+    // end-create_secret_action
   });
 
-  test('createSecretAction request example', async () => {
+  test('getSecretByNameType request example', async () => {
     consoleLogMock.mockImplementation((output) => {
       originalLog(output);
     });
@@ -512,30 +551,24 @@ describe('SecretsManagerV2', () => {
       expect(true).toBeFalsy();
     });
 
-    originalLog('createSecretAction() result:');
-    // begin-create_secret_action
-
-    // Request models needed by this operation.
-
-    // PublicCertificateActionValidateManualDNSPrototype
-    const secretActionPrototypeModel = {
-      action_type: 'private_cert_action_revoke_certificate',
-    };
+    originalLog('getSecretByNameType() result:');
+    // begin-get_secret_by_name_type
 
     const params = {
-      id: secretIdForGetSecretLink,
-      secretActionPrototype: secretActionPrototypeModel,
+      secretType: 'arbitrary',
+      name: secretNameLink,
+      secretGroupName: 'default',
     };
 
     let res;
     try {
-      res = await secretsManagerService.createSecretAction(params);
+      res = await secretsManagerService.getSecretByNameType(params);
       console.log(JSON.stringify(res.result, null, 2));
     } catch (err) {
       console.warn(err);
     }
 
-    // end-create_secret_action
+    // end-get_secret_by_name_type
   });
 
   test('createSecretVersion request example', async () => {
@@ -561,7 +594,7 @@ describe('SecretsManagerV2', () => {
     };
 
     const params = {
-      secretId: secretIdForCreateSecretVersionLink,
+      secretId: secretIdForGetSecretLink,
       secretVersionPrototype: secretVersionPrototypeModel,
     };
 
@@ -590,7 +623,7 @@ describe('SecretsManagerV2', () => {
     // begin-get_secret_version
 
     const params = {
-      secretId: secretIdForGetSecretVersionLink,
+      secretId: secretIdForGetSecretLink,
       id: secretVersionIdForGetSecretVersionLink,
     };
 
@@ -620,7 +653,7 @@ describe('SecretsManagerV2', () => {
 
     const params = {
       secretId: secretIdForGetSecretLink,
-      id: secretVersionIdForGetSecretVersionMetadataLink,
+      id: secretVersionIdForGetSecretVersionLink,
     };
 
     let res;
@@ -649,7 +682,7 @@ describe('SecretsManagerV2', () => {
 
     const params = {
       secretId: secretIdForGetSecretLink,
-      id: secretVersionIdForUpdateSecretVersionMetadataLink,
+      id: secretVersionIdForGetSecretVersionLink,
     };
 
     let res;
@@ -685,7 +718,7 @@ describe('SecretsManagerV2', () => {
 
     const params = {
       secretId: secretIdForGetSecretLink,
-      id: secretIdForGetSecretLink,
+      id: secretVersionIdForGetSecretVersionLink,
       secretVersionActionPrototype: secretVersionActionPrototypeModel,
     };
 
@@ -716,7 +749,7 @@ describe('SecretsManagerV2', () => {
     const params = {
       limit: 10,
       search: 'example',
-      groups: ['default'],
+      groups: ['default', 'cac40995-c37a-4dcb-9506-472869077634'],
     };
 
     const allResults = [];
@@ -749,7 +782,7 @@ describe('SecretsManagerV2', () => {
     // begin-list_secret_locks
 
     const params = {
-      id: secretIdForListSecretLocksLink,
+      id: secretIdForGetSecretLink,
       limit: 10,
       sort: 'name',
       search: 'example',
@@ -794,8 +827,8 @@ describe('SecretsManagerV2', () => {
     };
 
     const params = {
-      secretId: secretIdForCreateSecretVersionLocksLink,
-      id: secretVersionIdForCreateSecretVersionLocksLink,
+      secretId: secretIdForGetSecretLink,
+      id: secretVersionIdForGetSecretVersionLink,
       locks: [secretLockPrototypeModel],
     };
 
@@ -824,8 +857,8 @@ describe('SecretsManagerV2', () => {
     // begin-list_secret_version_locks
 
     const params = {
-      secretId: secretIdForListSecretVersionLocksLink,
-      id: secretVersionIdForListSecretVersionLocksLink,
+      secretId: secretIdForGetSecretLink,
+      id: secretVersionIdForGetSecretVersionLink,
       limit: 10,
       sort: 'name',
       search: 'example',
@@ -1099,7 +1132,7 @@ describe('SecretsManagerV2', () => {
 
     const params = {
       secretId: secretIdForGetSecretLink,
-      id: secretIdForGetSecretLink,
+      id: secretVersionIdForGetSecretVersionLink,
     };
 
     try {
@@ -1155,7 +1188,7 @@ describe('SecretsManagerV2', () => {
 
     const params = {
       secretId: secretIdForGetSecretLink,
-      id: secretVersionIdForDeleteSecretVersionLocksLink,
+      id: secretVersionIdForGetSecretVersionLink,
       name: ['lock-example-1'],
     };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ibm-cloud/secrets-manager",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "Client library for IBM Cloud Secrets Manager",
   "repository": {
     "type": "git",
@@ -32,11 +32,11 @@
   },
   "license": "Apache-2.0",
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=14.0.0"
   },
   "dependencies": {
     "extend": "^3.0.2",
-    "ibm-cloud-sdk-core": "^4.0.2"
+    "ibm-cloud-sdk-core": "^4.1.2"
   },
   "jest": {
     "collectCoverage": true,