@sitecore-jss/sitecore-jss-forms 16.0.0-canary.8 → 16.0.1

package/LICENSE.txt

@@ -1,202 +1,202 @@
-
-                                 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
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   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.
+
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

package/README.md

@@ -1,6 +1,6 @@
-# Sitecore JavaScript Services Forms
-
-This module is provided as a part of Sitecore JavaScript Services. It contains the APIs for Sitecore Forms integration.
-
-Consult the [Sitecore JSS documentation](https://jss.sitecore.net) for further details.
-
+# Sitecore JavaScript Services Forms
+
+This module is provided as a part of Sitecore JavaScript Services. It contains the APIs for Sitecore Forms integration.
+
+Consult the [Sitecore JSS documentation](https://jss.sitecore.net) for further details.
+

package/dist/FormField.js

@@ -1,17 +1,30 @@
 "use strict";
+/* eslint-disable @typescript-eslint/no-explicit-any */
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * @param {any} object
+ */
 function instanceOfFormField(object) {
     return 'model' in object;
 }
 exports.instanceOfFormField = instanceOfFormField;
+/**
+ * @param {FormField} object
+ */
 function instanceOfValueFormField(object) {
     return 'indexField' in object;
 }
 exports.instanceOfValueFormField = instanceOfValueFormField;
+/**
+ * @param {FormField} object
+ */
 function instanceOfButtonFormField(object) {
     return 'buttonField' in object;
 }
 exports.instanceOfButtonFormField = instanceOfButtonFormField;
+/**
+ * @param {FormField} object
+ */
 function instanceOfFormFieldSection(object) {
     return 'fields' in object;
 }

package/dist/FormTracker.js

@@ -23,10 +23,15 @@ var EventIds;
     EventIds["FieldCompleted"] = "2ca692cb-bdb2-4c9d-a3b5-917b3656c46a";
     EventIds["FieldError"] = "ea27aca5-432f-424a-b000-26ba5f8ae60a";
 })(EventIds || (EventIds = {}));
+/**
+ * @param {RequestInit} [options]
+ */
 function createFetchBasedTrackerFetcher(options) {
-    return function (formData, endpoint) { return fetch(endpoint, __assign({ body: JSON.stringify(formData), method: 'post', 
-        // IMPORTANT: Sitecore forms relies on cookies for some state management, so credentials must be included.
-        credentials: 'include' }, options)); };
+    return function (formData, endpoint) {
+        return fetch(endpoint, __assign({ body: JSON.stringify(formData), method: 'post', 
+            // IMPORTANT: Sitecore forms relies on cookies for some state management, so credentials must be included.
+            credentials: 'include' }, options));
+    };
 }
 exports.createFetchBasedTrackerFetcher = createFetchBasedTrackerFetcher;
 var FormTracker = /** @class */ (function () {
@@ -35,7 +40,12 @@ var FormTracker = /** @class */ (function () {
         this._fetcher = options.fetcher || createFetchBasedTrackerFetcher();
         this._endpoint = options.endpoint;
     }
-    /** Should be called prior to pushing any events, and again whenever new form schema data is received */
+    /**
+     * Should be called prior to pushing any events, and again whenever new form schema data is received
+     * @param {string} formId
+     * @param {string} formSessionId
+     * @param {string} enableTracking
+     */
     FormTracker.prototype.setFormData = function (formId, formSessionId, enableTracking) {
         this._formId = formId;
         this._formSessionId = formSessionId;
@@ -56,9 +66,12 @@ var FormTracker = /** @class */ (function () {
             return;
         }
         var blurredAtTick = new Date().getTime();
-        var duration = trackableField.focusedAtTick ? Math.round((blurredAtTick - trackableField.focusedAtTick) / 1000) : 0;
+        var duration = trackableField.focusedAtTick
+            ? Math.round((blurredAtTick - trackableField.focusedAtTick) / 1000)
+            : 0;
         trackableField.focusedAtTick = undefined;
-        var fieldChanged = this._currentField && this._currentField.fieldIdField.value !== trackableField.fieldIdField.value;
+        var fieldChanged = this._currentField &&
+            this._currentField.fieldIdField.value !== trackableField.fieldIdField.value;
         if (fieldChanged) {
             this._startTrackingField(field, value);
             duration = 0;

package/dist/JssFormData.js

@@ -16,16 +16,27 @@ var JssFormData = /** @class */ (function () {
     function JssFormData() {
         this.data = new Array();
     }
-    /** Appends a new key/value to the form data. Value will be added to any existing value that may exist. */
+    /**
+     * Appends a new key/value to the form data. Value will be added to any existing value that may exist.
+     * @param {string} key
+     * @param {string | File} value
+     */
     JssFormData.prototype.append = function (key, value) {
         this.data.push({ key: key, value: value });
     };
-    /** Sets a key/value, removing any existing value(s) set for that key. */
+    /**
+     * Sets a key/value, removing any existing value(s) set for that key.
+     * @param {string} key
+     * @param {string | File} value
+     */
     JssFormData.prototype.set = function (key, value) {
         this.data = this.data.filter(function (entry) { return entry.key !== key; });
         this.append(key, value);
     };
-    /** Merges form data from a client-side state store (i.e. the user-specified values), overwriting any existing values for the keys */
+    /**
+     * Merges form data from a client-side state store (i.e. the user-specified values), overwriting any existing values for the keys
+     * @param {Object} values
+     */
     JssFormData.prototype.mergeOverwritingExisting = function (values) {
         var _this = this;
         Object.keys(values).forEach(function (key) {
@@ -49,12 +60,16 @@ var JssFormData = /** @class */ (function () {
             }
         });
     };
-    /** Gets all key/values in the store. Duplicate keys with different values are possible. */
+    /**
+     * Gets all key/values in the store. Duplicate keys with different values are possible.
+     * @returns {Object} data
+     */
     JssFormData.prototype.get = function () {
         return __spreadArrays(this.data);
     };
     /**
      * Converts the store into a FormData that can be POST-ed with fetch as multipart/form-data.
+     * @returns {FormData} form data
      */
     JssFormData.prototype.toMultipartFormData = function () {
         var formData = new FormData();
@@ -63,9 +78,13 @@ var JssFormData = /** @class */ (function () {
     };
     /**
      * Converts the store into a URL-encoded string suitable to POST as application/x-www-form-urlencoded.
+     * @returns {string} url encoded form data
      */
     JssFormData.prototype.toUrlEncodedFormData = function () {
-        return this.data.map(function (entry) { return encodeURIComponent(entry.key) + "=" + encodeURIComponent(entry.value.toString()); }).join('&').replace(/%20/g, '+');
+        return this.data
+            .map(function (entry) { return encodeURIComponent(entry.key) + "=" + encodeURIComponent(entry.value.toString()); })
+            .join('&')
+            .replace(/%20/g, '+');
     };
     return JssFormData;
 }());

package/dist/ViewModel.js

@@ -1,10 +1,16 @@
 "use strict";
 /** The model for a given field's data elements */
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * @param {ViewModel} object
+ */
 function instanceOfInputViewModel(object) {
     return 'value' in object;
 }
 exports.instanceOfInputViewModel = instanceOfInputViewModel;
+/**
+ * @param {ViewModel} object
+ */
 function instanceOfListViewModel(object) {
     return 'items' in object;
 }

package/dist/getFieldValueFromModel.js

@@ -1,7 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var ViewModel_1 = require("./ViewModel");
-/** Retrieves the current value of a form field from the form model returned from the JSON API */
+/** Retrieves the current value of a form field from the form model returned from the JSON API
+ * @param {FormField} field
+ * @returns {string | string[] | boolean} field value
+ */
 function getFieldValueFromModel(field) {
     if (ViewModel_1.instanceOfListViewModel(field.model)) {
         // field state from API view-model items (list fields with possible multi-select)

package/dist/serializeForm.js

@@ -1,5 +1,4 @@
 "use strict";
-// tslint:disable:max-line-length
 Object.defineProperty(exports, "__esModule", { value: true });
 var FormField_1 = require("./FormField");
 var getFieldValueFromModel_1 = require("./getFieldValueFromModel");
@@ -7,8 +6,9 @@ var JssFormData_1 = require("./JssFormData");
 var ViewModel_1 = require("./ViewModel");
 /**
  * Serializes a Sitecore Form data into a format ready to POST to the server.
- * @param form The form schema data from the server
- * @param submitButtonName The name of the submit button that was clicked. Excludes other buttons from serialization. If not passed, all buttons are serialized.
+ * @param {SitecoreForm} form The form schema data from the server
+ * @param {SerializeFormOptions} [options]
+ * @returns {JssFormData} form data
  */
 function serializeForm(form, options) {
     if (!options) {
@@ -26,6 +26,11 @@ function serializeForm(form, options) {
     return result;
 }
 exports.serializeForm = serializeForm;
+/**
+ * @param {JssFormData} result
+ * @param {Array<FormField<any>>} fields
+ * @param {SerializeFormOptions} options
+ */
 function pushFields(result, fields, options) {
     fields.forEach(function (field) {
         if (FormField_1.instanceOfButtonFormField(field) &&
@@ -35,14 +40,14 @@ function pushFields(result, fields, options) {
             pushField(result, field.navigationStepField);
         }
         else if (FormField_1.instanceOfValueFormField(field)) {
+            pushField(result, field.indexField);
+            pushField(result, field.fieldIdField);
             if (field.valueField.name.endsWith('.Files')) {
                 var fileUploadField = field;
-                if (!fileUploadField.originalValue && !fileUploadField.model.files) {
+                if (!fileUploadField.model.files) {
                     return;
                 }
             }
-            pushField(result, field.indexField);
-            pushField(result, field.fieldIdField);
             // get stored value (i.e. if a multistep form)
             if (ViewModel_1.instanceOfInputViewModel(field.model) && options.fieldValueParser) {
                 var fieldValue = options.fieldValueParser(field);
@@ -59,10 +64,20 @@ function pushFields(result, fields, options) {
         }
     });
 }
+/**
+ * @param {JssFormData} result
+ * @param {HtmlFormField} field
+ * @param {string} [overrideValue]
+ */
 function pushField(result, field, overrideValue) {
     // the '' fallback prevents serializing 'null' as a string for empty field values ;)
     return pushFieldValue(result, field.name, overrideValue || field.value || '');
 }
+/**
+ * @param {JssFormData} result
+ * @param {string} fieldName
+ * @param {string} fieldValue
+ */
 function pushFieldValue(result, fieldName, fieldValue) {
     if (!fieldName) {
         throw new Error('Field had no name');

package/dist/submitForm.js

@@ -11,14 +11,24 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * @param {RequestInit} [options]
+ */
 function createFetchBasedFormFetcher(options) {
-    return function (formData, endpoint) { return fetch(endpoint, __assign({ body: formData.toMultipartFormData(), method: 'post', 
-        // IMPORTANT: Sitecore forms relies on cookies for some state management, so credentials must be included.
-        credentials: 'include' }, options))
-        .then(function (res) { return res.json(); })
-        .then(function (res) { return res; }); };
+    return function (formData, endpoint) {
+        return fetch(endpoint, __assign({ body: formData.toMultipartFormData(), method: 'post', 
+            // IMPORTANT: Sitecore forms relies on cookies for some state management, so credentials must be included.
+            credentials: 'include' }, options))
+            .then(function (res) { return res.json(); })
+            .then(function (res) { return res; });
+    };
 }
 exports.createFetchBasedFormFetcher = createFetchBasedFormFetcher;
+/**
+ * @param {JssFormData} formData
+ * @param {string} endpoint
+ * @param {FormSubmitOptions} [options]
+ */
 function submitForm(formData, endpoint, options) {
     options = options || {};
     if (!options.fetcher) {

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@sitecore-jss/sitecore-jss-forms",
-  "version": "16.0.0-canary.8",
+  "version": "16.0.1",
   "main": "dist/index.js",
   "scripts": {
     "build": "npm run clean && tsc",
     "clean": "del-cli dist types",
-    "lint": "tslint -p . -c ../../tslint.json \"src/**/*.ts\"",
+    "lint": "eslint ./src/**/*.ts",
     "test": "mocha --require ts-node/register \"./src/**/*.test.ts\"",
     "prepublishOnly": "npm run build",
     "coverage": "nyc --require ts-node/register npm test"
@@ -29,11 +29,12 @@
     "@types/mocha": "^5.2.5",
     "@types/node": "^10.12.0",
     "@types/url-parse": "1.1.0",
-    "axios": "^0.18.1",
+    "axios": "^0.21.1",
     "axios-mock-adapter": "^1.15.0",
     "chai": "^4.2.0",
     "chai-string": "^1.5.0",
     "del-cli": "^1.1.0",
+    "eslint": "^7.15.0",
     "mocha": "^8.1.3",
     "sinon": "^7.5.0",
     "ts-node": "^8.4.1",
@@ -41,9 +42,9 @@
     "typescript": "^3.6.3"
   },
   "dependencies": {
-    "@sitecore-jss/sitecore-jss": "^16.0.0-canary.8"
+    "@sitecore-jss/sitecore-jss": "^16.0.1"
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "be22a453049c318e28e73343974f371cc0300c7d"
+  "gitHead": "29ff3559b0c3d263ba4c84a3cfab4f1b980d9272"
 }

package/types/FormField.d.ts

@@ -3,20 +3,32 @@ import { InputViewModel, TitleFieldViewModel, ViewModel, FieldViewModel } from '
 export interface FormField<TViewModel extends ViewModel = ViewModel> {
     model: TViewModel;
 }
+/**
+ * @param {any} object
+ */
 export declare function instanceOfFormField<T extends ViewModel>(object: any): object is FormField<T>;
 export interface ValueFormField<TViewModel extends InputViewModel = InputViewModel> extends FormField<TViewModel> {
     indexField: HtmlFormField;
     fieldIdField: HtmlFormField;
     valueField: HtmlFormField;
 }
+/**
+ * @param {FormField} object
+ */
 export declare function instanceOfValueFormField(object: FormField<any>): object is ValueFormField<any>;
 export interface ButtonFormField extends FormField<TitleFieldViewModel> {
     navigationButtonsField: HtmlFormField;
     navigationStepField: HtmlFormField;
     buttonField: HtmlFormField;
 }
+/**
+ * @param {FormField} object
+ */
 export declare function instanceOfButtonFormField(object: FormField): object is ButtonFormField;
 export interface FormFieldSection extends FormField<FieldViewModel> {
     fields: FormField[];
 }
+/**
+ * @param {FormField} object
+ */
 export declare function instanceOfFormFieldSection(object: FormField): object is FormFieldSection;

package/types/FormTracker.d.ts

@@ -11,11 +11,14 @@ export interface TrackingEvent {
     duration: number;
     fieldName: string;
 }
-export declare type TrackerFetcher = (formData: TrackingEvent[], endpoint: string) => Promise<{}> | void;
+export declare type TrackerFetcher = (formData: TrackingEvent[], endpoint: string) => Promise<any> | void;
 export interface FormTrackerOptions {
     endpoint: string;
     fetcher?: TrackerFetcher;
 }
+/**
+ * @param {RequestInit} [options]
+ */
 export declare function createFetchBasedTrackerFetcher(options?: RequestInit): TrackerFetcher;
 export declare class FormTracker {
     private _currentField;
@@ -25,7 +28,12 @@ export declare class FormTracker {
     private _fetcher;
     private _endpoint;
     constructor(options: FormTrackerOptions);
-    /** Should be called prior to pushing any events, and again whenever new form schema data is received */
+    /**
+     * Should be called prior to pushing any events, and again whenever new form schema data is received
+     * @param {string} formId
+     * @param {string} formSessionId
+     * @param {string} enableTracking
+     */
     setFormData(formId: string, formSessionId: string, enableTracking: boolean): void;
     onFocusField(field: ValueFormField, value: string | string[]): void;
     onBlurField(field: ValueFormField, value: string | string[], validationErrors?: string[]): void;

package/types/JssFormData.d.ts

@@ -5,25 +5,41 @@
  */
 export declare class JssFormData {
     private data;
-    /** Appends a new key/value to the form data. Value will be added to any existing value that may exist. */
+    /**
+     * Appends a new key/value to the form data. Value will be added to any existing value that may exist.
+     * @param {string} key
+     * @param {string | File} value
+     */
     append(key: string, value: string | File): void;
-    /** Sets a key/value, removing any existing value(s) set for that key. */
+    /**
+     * Sets a key/value, removing any existing value(s) set for that key.
+     * @param {string} key
+     * @param {string | File} value
+     */
     set(key: string, value: string | File): void;
-    /** Merges form data from a client-side state store (i.e. the user-specified values), overwriting any existing values for the keys */
+    /**
+     * Merges form data from a client-side state store (i.e. the user-specified values), overwriting any existing values for the keys
+     * @param {Object} values
+     */
     mergeOverwritingExisting(values: {
         [key: string]: string | string[] | boolean | File[];
     }): void;
-    /** Gets all key/values in the store. Duplicate keys with different values are possible. */
+    /**
+     * Gets all key/values in the store. Duplicate keys with different values are possible.
+     * @returns {Object} data
+     */
     get(): {
         key: string;
         value: FormDataEntryValue;
     }[];
     /**
      * Converts the store into a FormData that can be POST-ed with fetch as multipart/form-data.
+     * @returns {FormData} form data
      */
     toMultipartFormData(): FormData;
     /**
      * Converts the store into a URL-encoded string suitable to POST as application/x-www-form-urlencoded.
+     * @returns {string} url encoded form data
      */
     toUrlEncodedFormData(): string;
 }

package/types/ViewModel.d.ts

@@ -28,6 +28,9 @@ export interface InputViewModel extends TitleFieldViewModel {
     isTrackingEnabled: boolean;
     value: string | boolean;
 }
+/**
+ * @param {ViewModel} object
+ */
 export declare function instanceOfInputViewModel(object: ViewModel): object is InputViewModel;
 export interface DateInputViewModel extends InputViewModel {
     min?: string;
@@ -54,6 +57,9 @@ export interface StringInputViewModel extends InputViewModel {
 export interface MultiLineStringInputViewModel extends StringInputViewModel {
     rows?: number;
 }
+/**
+ * @param {ViewModel} object
+ */
 export declare function instanceOfListViewModel(object: ViewModel): object is ListViewModel;
 export interface ListViewModel extends InputViewModel {
     items: ListFieldItem[];

package/types/getFieldValueFromModel.d.ts

@@ -1,3 +1,6 @@
 import { FormField } from './FormField';
-/** Retrieves the current value of a form field from the form model returned from the JSON API */
-export declare function getFieldValueFromModel(field: FormField<any>): string | boolean | string[];
+/** Retrieves the current value of a form field from the form model returned from the JSON API
+ * @param {FormField} field
+ * @returns {string | string[] | boolean} field value
+ */
+export declare function getFieldValueFromModel(field: FormField): string | boolean | string[];

package/types/index.d.ts

@@ -4,7 +4,7 @@ export { FormModel } from './FormModel';
 export { HtmlFormField } from './HtmlFormField';
 export { serializeForm, SerializeFormOptions } from './serializeForm';
 export { ViewModel, ValidationDataModel, TextViewModel, FieldViewModel, InputViewModel, FileInputViewModel, StringInputViewModel, MultiLineStringInputViewModel, DateInputViewModel, NumberInputViewModel, TitleFieldViewModel, ListFieldItem, ListViewModel, DropdownListViewModel, ListBoxViewModel, instanceOfListViewModel, instanceOfInputViewModel, } from './ViewModel';
-export { submitForm, createFetchBasedFormFetcher, FormSubmitOptions, FormFetcher } from './submitForm';
+export { submitForm, createFetchBasedFormFetcher, FormSubmitOptions, FormFetcher, } from './submitForm';
 export { getFieldValueFromModel } from './getFieldValueFromModel';
-export { FormTracker, FormTrackerOptions, TrackingEvent, createFetchBasedTrackerFetcher, TrackerFetcher } from './FormTracker';
+export { FormTracker, FormTrackerOptions, TrackingEvent, createFetchBasedTrackerFetcher, TrackerFetcher, } from './FormTracker';
 export { FormResult, FieldValidationErrors } from './FormResult';

package/types/serializeForm.d.ts

@@ -7,7 +7,8 @@ export interface SerializeFormOptions {
 }
 /**
  * Serializes a Sitecore Form data into a format ready to POST to the server.
- * @param form The form schema data from the server
- * @param submitButtonName The name of the submit button that was clicked. Excludes other buttons from serialization. If not passed, all buttons are serialized.
+ * @param {SitecoreForm} form The form schema data from the server
+ * @param {SerializeFormOptions} [options]
+ * @returns {JssFormData} form data
  */
 export declare function serializeForm(form: SitecoreForm, options?: SerializeFormOptions): JssFormData;

package/types/submitForm.d.ts

@@ -4,5 +4,13 @@ export declare type FormFetcher = (formData: JssFormData, endpoint: string) => P
 export interface FormSubmitOptions {
     fetcher?: FormFetcher;
 }
+/**
+ * @param {RequestInit} [options]
+ */
 export declare function createFetchBasedFormFetcher(options?: RequestInit): FormFetcher;
+/**
+ * @param {JssFormData} formData
+ * @param {string} endpoint
+ * @param {FormSubmitOptions} [options]
+ */
 export declare function submitForm(formData: JssFormData, endpoint: string, options?: FormSubmitOptions): Promise<FormResult>;