@sitecore-jss/sitecore-jss-forms 22.3.0 → 22.3.1-canary.2

package/dist/cjs/FormField.js

@@ -1,31 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.instanceOfFormFieldSection = exports.instanceOfButtonFormField = exports.instanceOfValueFormField = exports.instanceOfFormField = void 0;
+exports.instanceOfFormField = instanceOfFormField;
+exports.instanceOfValueFormField = instanceOfValueFormField;
+exports.instanceOfButtonFormField = instanceOfButtonFormField;
+exports.instanceOfFormFieldSection = instanceOfFormFieldSection;
 /**
  * @param {object} 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;
 }
-exports.instanceOfFormFieldSection = instanceOfFormFieldSection;

package/dist/cjs/FormTracker.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FormTracker = exports.createFetchBasedTrackerFetcher = void 0;
+exports.FormTracker = void 0;
+exports.createFetchBasedTrackerFetcher = createFetchBasedTrackerFetcher;
 var EventIds;
 (function (EventIds) {
     EventIds["FieldCompleted"] = "2ca692cb-bdb2-4c9d-a3b5-917b3656c46a";
@@ -14,7 +15,6 @@ function createFetchBasedTrackerFetcher(options) {
         // IMPORTANT: Sitecore forms relies on cookies for some state management, so credentials must be included.
         credentials: 'include' }, options));
 }
-exports.createFetchBasedTrackerFetcher = createFetchBasedTrackerFetcher;
 class FormTracker {
     constructor(options) {
         this._currentField = null;

package/dist/cjs/JssFormData.js

@@ -36,7 +36,7 @@ class JssFormData {
     }
     /**
      * 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
+     * @param {object} values
      */
     mergeOverwritingExisting(values) {
         Object.keys(values).forEach((key) => {
@@ -68,7 +68,7 @@ class JssFormData {
     }
     /**
      * Gets all key/values in the store. Duplicate keys with different values are possible.
-     * @returns {Object} data
+     * @returns {object} data
      */
     get() {
         return [...this.data];

package/dist/cjs/ViewModel.js

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

package/dist/cjs/getFieldValueFromModel.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFieldValueFromModel = void 0;
+exports.getFieldValueFromModel = getFieldValueFromModel;
 const 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
  */
@@ -24,4 +25,3 @@ function getFieldValueFromModel(field) {
     // the model cannot be null or undefined as in React a controlled field must be bound to a non-null value
     return '';
 }
-exports.getFieldValueFromModel = getFieldValueFromModel;

package/dist/cjs/serializeForm.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeForm = void 0;
+exports.serializeForm = serializeForm;
 const FormField_1 = require("./FormField");
 const getFieldValueFromModel_1 = require("./getFieldValueFromModel");
 const JssFormData_1 = require("./JssFormData");
@@ -26,7 +26,6 @@ function serializeForm(form, options) {
     pushFields(result, form.fields, options);
     return result;
 }
-exports.serializeForm = serializeForm;
 /**
  * @param {JssFormData} result
  * @param {Array<FormField>} fields

package/dist/cjs/submitForm.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.submitForm = exports.createFetchBasedFormFetcher = void 0;
+exports.createFetchBasedFormFetcher = createFetchBasedFormFetcher;
+exports.submitForm = submitForm;
 /**
  * @param {RequestInit} [options]
  */
@@ -11,7 +12,6 @@ function createFetchBasedFormFetcher(options) {
         .then((res) => res.json())
         .then((res) => res);
 }
-exports.createFetchBasedFormFetcher = createFetchBasedFormFetcher;
 /**
  * @param {JssFormData} formData
  * @param {string} endpoint
@@ -24,4 +24,3 @@ function submitForm(formData, endpoint, options) {
     }
     return options.fetcher(formData, endpoint);
 }
-exports.submitForm = submitForm;

package/dist/esm/JssFormData.js

@@ -33,7 +33,7 @@ export class JssFormData {
     }
     /**
      * 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
+     * @param {object} values
      */
     mergeOverwritingExisting(values) {
         Object.keys(values).forEach((key) => {
@@ -65,7 +65,7 @@ export class JssFormData {
     }
     /**
      * Gets all key/values in the store. Duplicate keys with different values are possible.
-     * @returns {Object} data
+     * @returns {object} data
      */
     get() {
         return [...this.data];

package/dist/esm/getFieldValueFromModel.js

@@ -1,5 +1,6 @@
 import { instanceOfInputViewModel, instanceOfListViewModel } from './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
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-forms",
-  "version": "22.3.0",
+  "version": "22.3.1-canary.2",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -11,10 +11,10 @@
     "test": "mocha --require ts-node/register \"./src/**/*.test.ts\"",
     "prepublishOnly": "npm run build",
     "coverage": "nyc npm test",
-    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-forms src/index.ts --githubPages false"
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/sitecore-jss-forms src/index.ts --githubPages false"
   },
   "engines": {
-    "node": ">=20"
+    "node": ">=22"
   },
   "author": {
     "name": "Sitecore Corporation",
@@ -30,24 +30,24 @@
     "@types/chai-string": "^1.4.2",
     "@types/lodash.unescape": "^4.0.7",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^20.14.2",
+    "@types/node": "^22.9.0",
     "axios": "^1.3.0",
     "chai": "^4.3.7",
     "chai-string": "^1.5.0",
     "del-cli": "^5.0.0",
-    "eslint": "^8.33.0",
+    "eslint": "^8.56.0",
     "mocha": "^10.2.0",
     "nyc": "^15.1.0",
     "ts-node": "^10.9.1",
     "tslib": "^2.5.0",
-    "typescript": "~4.9.5"
+    "typescript": "~5.6.3"
   },
   "dependencies": {
-    "@sitecore-jss/sitecore-jss": "22.3.0"
+    "@sitecore-jss/sitecore-jss": "^22.3.1-canary.2"
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "81b0239517966b6d0debdf6da3f12a98228c4d0c",
+  "gitHead": "5b35bbbe22b6ea21a1829950e371d54422ebf8fd",
   "files": [
     "dist",
     "types"

package/types/JssFormData.d.ts

@@ -24,14 +24,14 @@ export declare class JssFormData {
     remove(key: string): void;
     /**
      * 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
+     * @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.
-     * @returns {Object} data
+     * @returns {object} data
      */
     get(): {
         key: string;

package/types/getFieldValueFromModel.d.ts

@@ -1,5 +1,6 @@
 import { FormField } from './FormField';
-/** 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
  */