@es-joy/jsoe 0.5.1 → 0.6.0

package/src/typeChoices.js

@@ -41,7 +41,7 @@ import dialogs from './utils/dialogs.js';
 
 /**
  * @callback GetType
- * @returns {string|null|undefined}
+ * @returns {string}
  */
 
 /**
@@ -64,6 +64,7 @@ import dialogs from './utils/dialogs.js';
  *   value?: import('./formats.js').StructuredCloneValue,
  *   setValue?: boolean,
  *   state?: string,
+ *   arrayState?: string,
  *   keySelectClass?: string,
  *   requireObject?: boolean,
  *   objectHasValue?: boolean,
@@ -103,6 +104,22 @@ export const buildTypeChoices = ({
     : Types.getTypeOptionsForFormatAndState(format, state);
 
   let editUI;
+
+  /** @type {GetValue} */
+  const $getValue = (stateObj, currentPath) => {
+    const root = /** @type {HTMLDivElement} */ (
+      $e(typeContainer, 'div[data-type]')
+    );
+    return Types.getValueForRoot(
+      root,
+      /** @type {import('./types.js').StateObject} */ ({
+        typeNamespace,
+        format,
+        ...stateObj
+      }),
+      currentPath
+    );
+  };
   const sel = /** @type {HTMLSelectElement} */ (jml('select', {
     hidden: requireObject,
     class: `typeChoices-${typeNamespace}${keySelectClass
@@ -111,6 +128,7 @@ export const buildTypeChoices = ({
     }`,
     // is: 'type-choices',
     $custom: {
+      $getValue,
       /** @type {SetType} */
       $setType ({type, baseValue, bringIntoFocus}) {
         this.value = type;
@@ -150,7 +168,9 @@ export const buildTypeChoices = ({
       $addAndValidateEditUI ({baseValue, bringIntoFocus} = {}) {
         const {value: type} = this;
 
-        if (!type) { return; }
+        if (!type) {
+          return;
+        }
         let topRoot = this.$getTopRoot();
 
         // Todo (low): Try to avoid need for `baseValue`
@@ -250,12 +270,11 @@ export const buildTypeChoices = ({
             schemaContent
           }
         );
-        const type = /** @type {string} */ (
+        const type =
           Types.getTypeForRoot(/** @type {HTMLDivElement} */ (
             rootEditUI
-          ))
-        );
-        // eslint-disable-next-line max-len -- Long
+          ));
+        // eslint-disable-next-line @stylistic/max-len -- Long
         /** @type {HTMLSelectElement & {$addTypeAndEditUI: AddTypeAndEditUI}} */ (
           sel
         ).$addTypeAndEditUI({type, editUI: rootEditUI});
@@ -282,19 +301,7 @@ export const buildTypeChoices = ({
     ],
 
     /** @type {GetValue} */
-    getValue (stateObj, currentPath) {
-      const root = /** @type {HTMLDivElement} */ (
-        $e(typeContainer, 'div[data-type]')
-      );
-      return Types.getValueForRoot(
-        root,
-        /** @type {import('./types.js').StateObject} */ ({
-          typeNamespace,
-          format,
-          ...stateObj
-        }), currentPath
-      );
-    },
+    getValue: $getValue,
 
     /** @type {GetType} */
     getType () {
@@ -320,7 +327,7 @@ export const buildTypeChoices = ({
           format, value, stateObj
         )
       );
-      const type = /** @type {string} */ (Types.getTypeForRoot(rootEditUI));
+      const type = Types.getTypeForRoot(rootEditUI);
       /** @type {HTMLSelectElement & {$addTypeAndEditUI: AddTypeAndEditUI}} */ (
         sel
       ).$addTypeAndEditUI({type, editUI: rootEditUI});

package/src/types.js

@@ -21,15 +21,19 @@ import objectReferenceType from './fundamentalTypes/objectReferenceType.js';
 import arrayType from './fundamentalTypes/arrayType.js';
 import objectType from './fundamentalTypes/objectType.js';
 import dateType from './fundamentalTypes/dateType.js';
+import setType from './fundamentalTypes/setType.js';
+import mapType from './fundamentalTypes/mapType.js';
 import undefinedType from './fundamentalTypes/undefinedType.js';
 import regexpType from './fundamentalTypes/regexpType.js';
 import BooleanObjectType from './fundamentalTypes/BooleanObjectType.js';
 import NumberObjectType from './fundamentalTypes/NumberObjectType.js';
 import StringObjectType from './fundamentalTypes/StringObjectType.js';
-import sparseUndefinedType from './fundamentalTypes/sparseUndefinedType.js';
+// import sparseUndefinedType from './fundamentalTypes/sparseUndefinedType.js';
 import SpecialRealNumberSuperType from
-  './superTypes/SpecialRealNumberSuperType.js';
-import SpecialNumberSuperType from './superTypes/SpecialNumberSuperType.js';
+  './superTypes/SpecialRealNumberType.js';
+import SpecialNumberSuperType from './superTypes/SpecialNumberType.js';
+import errorType from './fundamentalTypes/errorType.js';
+import errorsSpecialType from './superTypes/errorsSpecialType.js';
 
 /**
  * Utility to retrieve the property value given a legend element.
@@ -59,7 +63,7 @@ export const getPropertyValueFromLegend = (legend) => {
  * Utility to retrieve the type out of a type root element.
  * @callback GetTypeForRoot
  * @param {?RootElement} root
- * @returns {string|undefined|null} Why would it not exist?
+ * @returns {string} Why would it not exist?
  */
 
 /**
@@ -196,8 +200,7 @@ export const getPropertyValueFromLegend = (legend) => {
 /**
  * @type {{
  *   availableTypes: {
- *     [key in AvailableType]: Partial<TypeObject>|string[]|
- *       {valid: true}|{sparse: true}
+ *     [key in AvailableType]: Partial<TypeObject>|string[]
  *   },
  *   getTypeForRoot: GetTypeForRoot,
  *   getValueForRoot: GetValueForRoot,
@@ -234,6 +237,7 @@ const Types = {};
 /**
  * @typedef {{
  *   format: import('./formats.js').AvailableFormat,
+ *   match: boolean|RegExpMatchArray|null
  *   endMatchTypeObjs: TypeObject[],
  *   remnant: string,
  *   rootHolder: [
@@ -247,6 +251,15 @@ const Types = {};
  * }} RootInfo
  */
 
+/**
+ * @typedef {(
+ *   info: {
+*     root: HTMLDivElement,
+*     value: StructuredCloneValue
+*   }
+* ) => void} TypeObjectSetValue
+ */
+
 /**
  * @typedef {object} TypeObject
  * @property {[
@@ -254,6 +267,14 @@ const Types = {};
  * ]} option Creates the option HTML. May set an option `title` or `value`
  * @property {boolean} [array] Private context variable. Whether or not
  *   it is an array. Do not use in other types.
+ * @property {boolean} [map] Private context variable. Whether or not
+ *   it is a Map. Do not use in other types.
+ * @property {boolean} [set] Private context variable. Whether or not
+ *   it is a set. Do not use in other types.
+ * @property {boolean} [sparse] Private context variable. Whether or not
+ *   it is a sparse array. Do not use in other types.
+ * @property {boolean} [valid] Private context variable. Whether or not
+ *   it is a valid date. Do not use in other types.
  * @property {string[]} [regexEndings] Used for string parsing.
  * @property {RegExp|((nonGrouping?: boolean) => RegExp)} [stringRegex] Used
  *   for string parsing. If not present, use `stringRegexBegin` and
@@ -268,7 +289,11 @@ const Types = {};
  *   the type belongs
  * @property {(
  *   s: string, info?: RootInfo
- * ) => StructuredCloneValue} toValue Converts from string to value. May use
+ * ) => {
+ *   value?: StructuredCloneValue,
+ *   remnant?: string,
+ *   assign?: false
+ * }} toValue Converts from string to value. May use
  *   `stringRegex` to find components.
  * @property {(info: {
  *   root: HTMLDivElement,
@@ -277,12 +302,8 @@ const Types = {};
  * }) =>
  *  StructuredCloneValue
  * } getValue Gets the value for the type
- * @property {(
- *   info: {
- *     root: HTMLDivElement,
- *     value: StructuredCloneValue
- *   }
- * ) => void} [setValue] Should set the value of the form's `getInput` element
+ * @property {TypeObjectSetValue} [setValue] Should set the value of the
+ *   form's `getInput` element
  * @property {(info: {
  *   value?: StructuredCloneValue,
  *   typeNamespace?: string,
@@ -298,6 +319,7 @@ const Types = {};
  *   format?: import('./formats.js').AvailableFormat,
  *   resultType?: "keys"|"values"|"both",
  *   type?: AvailableType,
+ *   arrayState?: string,
  *   buildTypeChoices?: import('./typeChoices.js').BuildTypeChoices,
  *   topRoot?: HTMLDivElement
  * }) => JamilihArray} editUI
@@ -350,17 +372,16 @@ Types.availableTypes = {
   SpecialRealNumber: SpecialRealNumberSuperType,
   SpecialNumber: SpecialNumberSuperType,
 
+  error: errorType,
+  errors: errorsSpecialType,
+
   regexp: regexpType,
   BooleanObject: BooleanObjectType,
   NumberObject: NumberObjectType,
   StringObject: StringObjectType,
 
-  map: {
-    option: ['Map']
-  },
-  set: {
-    option: ['Set']
-  },
+  map: mapType,
+  set: setType,
 
   file: {
     option: ['File']
@@ -426,7 +447,7 @@ Types.availableTypes = {
   },
 
   // We're catching this instead of using this
-  sparseUndefined: sparseUndefinedType,
+  // sparseUndefined: sparseUndefinedType,
 
   ValidDate: {
     valid: true
@@ -449,8 +470,8 @@ Types.availableTypes = {
 *   "arraybuffer"|"arraybufferview"|"dataview"|"imagedata"|"imagebitmap"|
 *   "int8array"|"uint8array"|"uint8clampedarray"|"int16array"|"uint16array"|
 *   "int32array"|"uint32array"|"float32array"|"float64array"|"IntlCollator"|
-*   "IntlDateTimeFormat"|"IntlNumberFormat"|"sparseUndefined"|"ValidDate"|
-*   "arrayNonindexKeys"} AvailableType
+*   "IntlDateTimeFormat"|"IntlNumberFormat"|"ValidDate"|
+*   "arrayNonindexKeys"|"error"|"errors"} AvailableType
 */
 
 /**
@@ -484,7 +505,7 @@ copyTypeObjs(
 );
 
 Types.getTypeForRoot = (root) => {
-  return root && root.dataset.type;
+  return String(root ? root.dataset.type : root);
 };
 
 /**
@@ -726,8 +747,8 @@ Types.setValue = ({type, root, value}) => {
  * @returns {string}
  */
 function escapeRegex (str) {
-  return String(str)
-    .replace(/[.\\+*?^[\]$(){}=!<>|:-]/gu, '\\$&');
+  return String(str).
+    replaceAll(/[.\\+*?^[\]$(){}=!<>|:-]/gu, '\\$&');
 }
 
 // Todo (low): Should really add real parser
@@ -771,7 +792,7 @@ Types.getValueForString = (s, {
    * @type {RegExpMatchArray|boolean|null}
    */
   let match = null;
-  let found = allowedTypeObjs.find(([_type, typObj]) => {
+  let found = allowedTypeObjs.find(([/* _type */, typObj]) => {
     const typeObj = /** @type {TypeObject} */ (typObj);
     let {stringRegex} = typeObj;
     if (typeof typeObj.stringRegex === 'function') {
@@ -794,7 +815,7 @@ Types.getValueForString = (s, {
 
   let beginOnly = false;
   if (found === undefined) {
-    found = allowedTypeObjs.find(([_type, typObj]) => {
+    found = allowedTypeObjs.find(([/* _type */, typObj]) => {
       const typeObj = /** @type {TypeObject} */ (typObj);
       const {stringRegexBegin} = typeObj;
       match = Boolean(stringRegexBegin && s) && s.match(
@@ -809,23 +830,32 @@ Types.getValueForString = (s, {
   }
   let assign = true;
   if (found !== undefined) {
-    // @ts-ignore The `found` is evaluated again, so sets `match` to non-null
-    const [content, innerContent] = /** @type {RegExpMatchArray} */ (match);
+    // The `found` is evaluated again, so sets `match` to non-null
+    const mtch = /** @type {RegExpMatchArray} */ (
+      /** @type {unknown} */ (match)
+    );
+    const [content, innerContent] = mtch;
     let remnant = s.slice(content.length);
     s = s.slice(0, content.length);
     // console.log('s0', s, '::', remnant, match);
     let valObj;
     try {
-      valObj = /** @type {TypeObject} */ (found[1]).toValue(innerContent || s, {
-        format,
-        endMatchTypeObjs,
-        remnant,
-        rootHolder,
-        parent,
-        parentPath
-      });
+      valObj = /** @type {TypeObject} */ (found[1]).toValue(
+        mtch.groups?.innerContent || innerContent || s, {
+          format,
+          match,
+          endMatchTypeObjs,
+          remnant,
+          rootHolder,
+          parent,
+          parentPath
+        }
+      );
+    /* istanbul ignore next -- Good regexes should prevent */
     } catch (e) {
+      /* istanbul ignore next -- Good regexes should prevent */
       console.log('eee', e);
+      /* istanbul ignore next -- Good regexes should prevent */
       throw e;
     }
     if (valObj.assign === false) {
@@ -838,7 +868,9 @@ Types.getValueForString = (s, {
 
     if (beginOnly && endMatchTypeObjs.length) {
       const endMatch = remnant.match(
-        /** @type {RegExp} */ (endMatchTypeObjs.slice(-1)[0].stringRegexEnd)
+        /** @type {RegExp} */ (/** @type {TypeObject} */ (
+          endMatchTypeObjs.at(-1)
+        ).stringRegexEnd)
       );
       if (endMatch) {
         endMatchTypeObjs.pop(); // Safe now to extract
@@ -859,7 +891,7 @@ Types.getValueForString = (s, {
           // @ts-expect-error Reference method exists
           const val = typeObject.resolveReference(path, topRoot);
           const basicType = getJSONType(val);
-          // eslint-disable-next-line max-len -- Long
+          // eslint-disable-next-line @stylistic/max-len -- Long
           /* istanbul ignore else -- Successful reference always an object/array? */
           if (
             ['array', 'object'].includes(type) && basicType === type

package/src/utils/dialogs.js

@@ -18,7 +18,7 @@ const dialogs = {
   /** @type {Locale} */
   localeStrings: {},
   /**
-   * @param {Locale} [locale={}]
+   * @param {Locale} [locale]
    * @returns {void}
    */
   setLocale (locale = {}) {
@@ -29,7 +29,7 @@ const dialogs = {
    * @typedef {object} MakeDialogArgs
    * @property {import('jamilih').JamilihAttributes} [atts={}]
    * @property {import('jamilih').JamilihChildren} [children=[]]
-   * @property {import('jamilih').EventHandler} [close]
+   * @property {import('jamilih').EventHandler|boolean} [close]
    * @property {boolean} [remove=true]
    */
   /**
@@ -42,7 +42,7 @@ const dialogs = {
         atts.$on = {};
       }
       if (!('close' in atts.$on)) {
-        atts.$on.close = close;
+        atts.$on.close = /** @type {import('jamilih').EventHandler} */ (close);
       }
     }
     const dialog = /** @type {HTMLDialogElement} */ (
@@ -60,10 +60,10 @@ const dialogs = {
    * @typedef {object} MakeCancelArgs
    * @property {(
    *   info: {e: Event, dialog: HTMLDialogElement}
-   * ) => boolean} cancel
-   * @property {string} cancelClass
-   * @property {string} submitClass
-   * @property {...MakeDialogArgs} args
+   * ) => boolean} [cancel]
+   * @property {string} [cancelClass]
+   * @property {string} [submitClass]
+   * @property {...MakeDialogArgs} [args]
    */
   /**
    * @param {MakeCancelArgs} cfg
@@ -78,7 +78,6 @@ const dialogs = {
     jml('div', {class: submitClass}, [
       ['br'], ['br'],
       ['button', {class: cancelClass, $on: {
-        // @ts-ignore Erring out of IDE
         click (e) {
           e.preventDefault();
           if (cancel) {
@@ -100,7 +99,7 @@ const dialogs = {
   /**
    * @param {object} cfg
    * @param {(info: {e: Event, dialog: HTMLDialogElement}) => void} cfg.submit
-   * @param {string} [cfg.submitClass="submit"]
+   * @param {string} [cfg.submitClass]
    * @param {MakeCancelArgs} [cfg.args]
    * @returns {HTMLDialogElement}
    */
@@ -133,7 +132,7 @@ const dialogs = {
     message = typeof message === 'string' ? {message} : message;
     const {submitClass = 'submit'} = message;
     const {message: outputMessage} = message;
-    return new Promise((resolve, _reject) => {
+    return new Promise((resolve /* , _reject */) => {
       const dialog = /** @type {HTMLDialogElement} */ (jml('dialog', [
         /** @type {string|import('jamilih').JamilihArray} */ (outputMessage),
         ['br'], ['br'],
@@ -149,9 +148,9 @@ const dialogs = {
   },
   /**
    * @param {object} cfg
-   * @param {import('jamilih').JamilihAttributes} [cfg.atts={}]
+   * @param {import('jamilih').JamilihAttributes} [cfg.atts]
    * @param {string|{message: string}} cfg.message
-   * @param {string} [cfg.submitClass="submit"]
+   * @param {string} [cfg.submitClass]
    */
   confirm ({atts = {}, message, submitClass = 'submit'}) {
     ({message} = typeof message === 'string' ? {message} : message);

package/src/utils/jsonPointer.js

@@ -13,7 +13,7 @@ const makeJSONPointer = (...args) => {
  * @returns {string}
  */
 const escapeJSONPointer = (path) => {
-  return path.replace(/~/gu, '~0').replace(/\//gu, '~1');
+  return path.replaceAll('~', '~0').replaceAll('/', '~1');
 };
 
 /**
@@ -21,7 +21,7 @@ const escapeJSONPointer = (path) => {
  * @returns {string}
  */
 const unescapeJSONPointerPart = (pathPart) => {
-  return pathPart.replace(/~([01])/gu, (_n0, n1) => {
+  return pathPart.replaceAll(/~([01])/gu, (_n0, n1) => {
     if (n1 === '0') {
       return '~';
     }
@@ -81,7 +81,7 @@ const typesonPathToJSONPointer = (path) => {
     // Keep `~0` (representing tilde) escaped as same sequence in
     //   JSONPointer (that's why we don't just use
     //   Typeson's `unescapeKeyPathComponent` + `escapeJSONPointer` here)
-    return keyPathComponent.replace(/~1/gu, '.').replace(/\//gu, '~1');
+    return keyPathComponent.replaceAll('~1', '.').replaceAll('/', '~1');
   }).join('/');
 };
 

package/src/utils/templateUtils.js

@@ -1,4 +1,3 @@
-
 const nbsp = '\u00A0';
 const upArrow = '\u2191';
 const downArrow = '\u2193';
@@ -19,7 +18,7 @@ const $$ = (sel) => [...(/** @type {NodeListOf<HTMLElement>} */ (
 ))];
 
 /**
- * @param {HTMLElement|string} el
+ * @param {Element|HTMLElement|string} el
  * @param {string} descendentsSel
  * @returns {HTMLElement|null}
  */
@@ -47,7 +46,7 @@ const $$e = (el, descendentsSel) => {
 };
 
 /**
- * @param {Node} node
+ * @param {Node|string} node
  * @returns {void}
  */
 const removeChildren = (node) => {
@@ -72,7 +71,7 @@ const removeIfExists = (sel) => {
 };
 
 /**
- * @param {HTMLElement} el
+ * @param {HTMLElement|string} el
  * @param {string|string[]} selectors
  * @returns {HTMLElement[]}
  */
@@ -97,6 +96,7 @@ const filterChildElements = (el, selectors) => {
   selectors = Array.isArray(selectors) ? selectors : [selectors];
   selectors.forEach((sel) => {
     filtered = filtered.reduce((els, childElement) => {
+      /* istanbul ignore if -- Guard */
       if (!childElement) {
         return els;
       }

package/src/vendor-imports.js

@@ -1,5 +1,5 @@
-export {jml, body, nbsp} from 'jamilih';
-// export {jml, body, nbsp} from '../node_modules/jamilih/dist/jml-es.js';
+export {jml, body, nbsp, $} from 'jamilih';
+// export {jml, body, nbsp, $} from '../node_modules/jamilih/dist/jml-es.js';
 
 export {
   getJSONType,

package/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "lib": ["es2022", "DOM"],
+    "lib": ["es2023", "DOM"],
     "moduleResolution": "nodenext",
     "module": "NodeNext",
     "allowJs": true,

package/typings/CypressPlugins.d.ts

@@ -0,0 +1,10 @@
+declare namespace Cypress {
+  interface Chainable {
+    clearAndType(sel: string, content: string): Chainable
+    clickAndType(sel: string, content: string): Chainable
+    typeAndBlur(sel: string, content: string): Chainable
+    clearTypeAndBlur(sel: string, content: string): Chainable
+    checkAccessibility(): void
+    visitURLAndCheckAccessibility(url: string, CypressVisitOptions?: object): void
+  }
+}