docusign-click - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0-rc1

CHANGELOG.md

@@ -5,2 +5,8 @@ # DocuSign Click Node Client Changelog
 
+## [1.1.0-rc1] - Click API v1-21.4.00 - 2021-11-19
+### Changed
+- Added support for version v1-21.4.00 of the DocuSign Click API.
+- Updated the SDK release version.
+
+
 ## [v1.0.0] - DocuSign Click API v1 - 02/11/2021
@@ -7,0 +13,0 @@ ### Changed

package.json

 {
   "name": "docusign-click",
-  "version": "1.0.0",
+  "version": "1.1.0-rc1",
   "description": "DocuSign Node.js API client.",
@@ -56,3 +56,3 @@ "license": "MIT",
     "jsonwebtoken": "8.2.0",
-    "passport-oauth2": "1.4.0",
+    "passport-oauth2": "^1.6.1",
     "safe-buffer": "^5.1.2",
@@ -59,0 +59,0 @@ "superagent": "3.8.2"

README.md

@@ -1,2 +0,2 @@
-# The Official DocuSign Click Node Client
+# The Official DocuSign Click Node Client SDK
 
@@ -8,3 +8,3 @@ [![NPM version][npm-image]][npm-url]
 
-[NPM module](https://www.npmjs.com/package/docusign-click) that wraps the <a href="https://www.docusign.com">DocuSign</a> Click API
+[NPM module](https://www.npmjs.com/package/docusign-click)
 
@@ -27,8 +27,6 @@ [Documentation about the DocuSign Click API](https://developers.docusign.com/docs/click-api)
 
-## Note:
+## Installation
 
-This SDK will soon be provided as open-source for cases where you would like to make additional changes that the SDK does not provide out-of-the-box. If you simply want to use the SDK with any of the examples shown in the [Developer Center](https://developers.docusign.com/docs/click-api/how-to/), follow the installation instructions below.
+This SDK is provided as open source, which enables you to customize its functionality to suit your particular use case. To do so, download or clone the repository. If the SDK’s given functionality meets your integration needs, or if you simply want to use the SDK with any of the examples shown in the [Developer Center](https://developers.docusign.com/docs/click-api/how-to/), you merely need to install it by following the instructions below.
 
-## Installation
-
 ## NPM:
@@ -56,17 +54,12 @@
 
-## Code Examples
+## Code examples
 
-### Launchers
+DocuSign provides a sample application code referred to as a [Launcher](https://github.com/docusign/code-examples-node). The Launcher includes, besides a full set of eSignature code examples, a set of code examples and associated source files for five common Click use cases. These examples can use either the [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) or [JSON Web Token (JWT) Grant](https://developers.docusign.com/platform/auth/jwt/) authentication flow.
 
-DocuSign provides a sample application referred to as a [Launcher](https://github.com/docusign/code-examples-node/). The Launcher contains a set of 6 common use cases and associated source files. These examples use DocuSign&#39;s [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/authcode-get-token/) flow.
+## OAuth implementations
 
-## OAuth Implementations
+For details regarding which type of OAuth grant will work best for your DocuSign integration, see the [Choose OAuth Type](https://developers.docusign.com/platform/auth/choose/) guide located on the [DocuSign Developer Center](https://developers.docusign.com/).
 
-For details regarding which type of OAuth grant will work best for your DocuSign integration, see the [Click API Authentication Overview](https://developers.docusign.com/docs/click-api/click101/auth/) guide located on the [DocuSign Developer Center](https://developers.docusign.com/).
+For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) flow.
 
-For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/authcode-get-token/) or [JWT](https://developers.docusign.com/platform/auth/jwt/) flow.
-
-There are other use-case scenarios, such as **single-page applications** (SPA) that use **Cross-Origin Resource Sharing** (CORS), or where there may not be a user to interact with your Service Account. For these use cases, DocuSign also supports [JWT](https://developers.docusign.com/platform/auth/jwt/jwt-get-token/) and [Implicit](https://developers.docusign.com/platform/auth/implicit/implicit-get-token/) grants. For Code eExamples, see the links below:
-
-
 ## Support
@@ -88,1 +81,7 @@
 [coveralls-url]: https://coveralls.io/github/docusign/DocuSign-Node-Client?branch=master
+
+### Additional resources
+* [DocuSign Developer Center](https://developers.docusign.com)
+* [DocuSign API on Twitter](https://twitter.com/docusignapi)
+* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
+* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)

src/index.js

@@ -14,8 +14,8 @@ /**
     // AMD. Register as an anonymous module.
-    define(['Configuration', 'ApiClient', 'model/ClickwrapAgreementsResponse', 'model/ClickwrapDeleteResponse', 'model/ClickwrapRequest', 'model/ClickwrapScheduledReacceptance', 'model/ClickwrapTransferRequest', 'model/ClickwrapVersion', 'model/ClickwrapVersionDeleteResponse', 'model/ClickwrapVersionResponse', 'model/ClickwrapVersionSummaryResponse', 'model/ClickwrapVersionsDeleteResponse', 'model/ClickwrapVersionsPagedResponse', 'model/ClickwrapVersionsResponse', 'model/ClickwrapsDeleteResponse', 'model/DisplaySettings', 'model/Document', 'model/ErrorDetails', 'model/ServiceInformation', 'model/ServiceVersion', 'model/UserAgreementRequest', 'model/UserAgreementResponse', 'api/AccountsApi'], factory);
+    define(['Configuration', 'ApiClient', 'model/ClickwrapAgreementsResponse', 'model/ClickwrapDeleteResponse', 'model/ClickwrapRequest', 'model/ClickwrapScheduledReacceptance', 'model/ClickwrapTransferRequest', 'model/ClickwrapVersion', 'model/ClickwrapVersionDeleteResponse', 'model/ClickwrapVersionResponse', 'model/ClickwrapVersionSummaryResponse', 'model/ClickwrapVersionsDeleteResponse', 'model/ClickwrapVersionsPagedResponse', 'model/ClickwrapVersionsResponse', 'model/ClickwrapsDeleteResponse', 'model/DisplaySettings', 'model/Document', 'model/DocumentData', 'model/ErrorDetails', 'model/ServiceInformation', 'model/ServiceVersion', 'model/UserAgreementRequest', 'model/UserAgreementResponse', 'api/AccountsApi'], factory);
   } else if (typeof module === 'object' && module.exports) {
     // CommonJS-like environments that support module.exports, like Node.
-    module.exports = factory(require('./Configuration'), require('./ApiClient'), require('./model/ClickwrapAgreementsResponse'), require('./model/ClickwrapDeleteResponse'), require('./model/ClickwrapRequest'), require('./model/ClickwrapScheduledReacceptance'), require('./model/ClickwrapTransferRequest'), require('./model/ClickwrapVersion'), require('./model/ClickwrapVersionDeleteResponse'), require('./model/ClickwrapVersionResponse'), require('./model/ClickwrapVersionSummaryResponse'), require('./model/ClickwrapVersionsDeleteResponse'), require('./model/ClickwrapVersionsPagedResponse'), require('./model/ClickwrapVersionsResponse'), require('./model/ClickwrapsDeleteResponse'), require('./model/DisplaySettings'), require('./model/Document'), require('./model/ErrorDetails'), require('./model/ServiceInformation'), require('./model/ServiceVersion'), require('./model/UserAgreementRequest'), require('./model/UserAgreementResponse'), require('./api/AccountsApi'));
+    module.exports = factory(require('./Configuration'), require('./ApiClient'), require('./model/ClickwrapAgreementsResponse'), require('./model/ClickwrapDeleteResponse'), require('./model/ClickwrapRequest'), require('./model/ClickwrapScheduledReacceptance'), require('./model/ClickwrapTransferRequest'), require('./model/ClickwrapVersion'), require('./model/ClickwrapVersionDeleteResponse'), require('./model/ClickwrapVersionResponse'), require('./model/ClickwrapVersionSummaryResponse'), require('./model/ClickwrapVersionsDeleteResponse'), require('./model/ClickwrapVersionsPagedResponse'), require('./model/ClickwrapVersionsResponse'), require('./model/ClickwrapsDeleteResponse'), require('./model/DisplaySettings'), require('./model/Document'), require('./model/DocumentData'), require('./model/ErrorDetails'), require('./model/ServiceInformation'), require('./model/ServiceVersion'), require('./model/UserAgreementRequest'), require('./model/UserAgreementResponse'), require('./api/AccountsApi'));
   }
-}(function(Configuration, ApiClient, ClickwrapAgreementsResponse, ClickwrapDeleteResponse, ClickwrapRequest, ClickwrapScheduledReacceptance, ClickwrapTransferRequest, ClickwrapVersion, ClickwrapVersionDeleteResponse, ClickwrapVersionResponse, ClickwrapVersionSummaryResponse, ClickwrapVersionsDeleteResponse, ClickwrapVersionsPagedResponse, ClickwrapVersionsResponse, ClickwrapsDeleteResponse, DisplaySettings, Document, ErrorDetails, ServiceInformation, ServiceVersion, UserAgreementRequest, UserAgreementResponse, AccountsApi) {
+}(function(Configuration, ApiClient, ClickwrapAgreementsResponse, ClickwrapDeleteResponse, ClickwrapRequest, ClickwrapScheduledReacceptance, ClickwrapTransferRequest, ClickwrapVersion, ClickwrapVersionDeleteResponse, ClickwrapVersionResponse, ClickwrapVersionSummaryResponse, ClickwrapVersionsDeleteResponse, ClickwrapVersionsPagedResponse, ClickwrapVersionsResponse, ClickwrapsDeleteResponse, DisplaySettings, Document, DocumentData, ErrorDetails, ServiceInformation, ServiceVersion, UserAgreementRequest, UserAgreementResponse, AccountsApi) {
   'use strict';
@@ -140,2 +140,7 @@
     /**
+     * The DocumentData model constructor.
+     * @property {module:model/DocumentData}
+     */
+    DocumentData: DocumentData,
+    /**
      * The ErrorDetails model constructor.
@@ -142,0 +147,0 @@ * @property {module:model/ErrorDetails}

src/model/DisplaySettings.js

@@ -93,5 +93,2 @@ /**
       }
-      if (data.hasOwnProperty('hostOrigin')) {
-        obj['hostOrigin'] = ApiClient.convertToType(data['hostOrigin'], 'String');
-      }
       if (data.hasOwnProperty('mustRead')) {
@@ -178,7 +175,2 @@ obj['mustRead'] = ApiClient.convertToType(data['mustRead'], 'Boolean');
    * 
-   * @member {String} hostOrigin
-   */
-  exports.prototype['hostOrigin'] = undefined;
-  /**
-   * 
    * @member {Boolean} mustRead
@@ -185,0 +177,0 @@ */

src/model/UserAgreementRequest.js

@@ -15,6 +15,6 @@ /**
     // AMD. Register as an anonymous module.
-    define(['ApiClient'], factory);
+    define(['ApiClient', 'model/DocumentData'], factory);
   } else if (typeof module === 'object' && module.exports) {
     // CommonJS-like environments that support module.exports, like Node.
-    module.exports = factory(require('../ApiClient'));
+    module.exports = factory(require('../ApiClient'), require('./DocumentData'));
   } else {
@@ -25,5 +25,5 @@ // Browser globals (root is window)
     }
-    root.DocusignClick.UserAgreementRequest = factory(root.DocusignClick.ApiClient);
+    root.DocusignClick.UserAgreementRequest = factory(root.DocusignClick.ApiClient, root.DocusignClick.DocumentData);
   }
-}(this, function(ApiClient) {
+}(this, function(ApiClient, DocumentData) {
   'use strict';
@@ -62,4 +62,4 @@
       }
-      if (data.hasOwnProperty('hostOrigin')) {
-        obj['hostOrigin'] = ApiClient.convertToType(data['hostOrigin'], 'String');
+      if (data.hasOwnProperty('documentData')) {
+        obj['documentData'] = DocumentData.constructFromObject(data['documentData']);
       }
@@ -79,6 +79,5 @@ if (data.hasOwnProperty('metadata')) {
   /**
-   * 
-   * @member {String} hostOrigin
+   * @member {module:model/DocumentData} documentData
    */
-  exports.prototype['hostOrigin'] = undefined;
+  exports.prototype['documentData'] = undefined;
   /**
@@ -85,0 +84,0 @@ *

src/model/UserAgreementResponse.js

@@ -15,6 +15,6 @@ /**
     // AMD. Register as an anonymous module.
-    define(['ApiClient', 'model/DisplaySettings', 'model/Document'], factory);
+    define(['ApiClient', 'model/DisplaySettings', 'model/Document', 'model/DocumentData'], factory);
   } else if (typeof module === 'object' && module.exports) {
     // CommonJS-like environments that support module.exports, like Node.
-    module.exports = factory(require('../ApiClient'), require('./DisplaySettings'), require('./Document'));
+    module.exports = factory(require('../ApiClient'), require('./DisplaySettings'), require('./Document'), require('./DocumentData'));
   } else {
@@ -25,5 +25,5 @@ // Browser globals (root is window)
     }
-    root.DocusignClick.UserAgreementResponse = factory(root.DocusignClick.ApiClient, root.DocusignClick.DisplaySettings, root.DocusignClick.Document);
+    root.DocusignClick.UserAgreementResponse = factory(root.DocusignClick.ApiClient, root.DocusignClick.DisplaySettings, root.DocusignClick.Document, root.DocusignClick.DocumentData);
   }
-}(this, function(ApiClient, DisplaySettings, Document) {
+}(this, function(ApiClient, DisplaySettings, Document, DocumentData) {
   'use strict';
@@ -86,2 +86,5 @@
       }
+      if (data.hasOwnProperty('documentData')) {
+        obj['documentData'] = DocumentData.constructFromObject(data['documentData']);
+      }
       if (data.hasOwnProperty('documents')) {
@@ -158,2 +161,6 @@ obj['documents'] = ApiClient.convertToType(data['documents'], [Document]);
   /**
+   * @member {module:model/DocumentData} documentData
+   */
+  exports.prototype['documentData'] = undefined;
+  /**
    * 
@@ -160,0 +167,0 @@ * @member {Array.<module:model/Document>} documents

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Number of package files

52

increased by1.96%

Worsened metrics

Total package byte prevSize

228933

decreased by-3.15%

Lines of code

5703

decreased by-2.33%

Number of low quality alerts

2

increased by100%

Number of lines in readme file

83

decreased by-2.35%

Dependency changes

• + Addedbase64url@3.0.1(transitive)

• + Addedoauth@0.10.0(transitive)

• + Addedpassport-oauth2@1.8.0(transitive)

• - Removedoauth@0.9.15(transitive)

• - Removedpassport-oauth2@1.4.0(transitive)

• Updatedpassport-oauth2@^1.6.1