@es-joy/jsoe 0.27.0 → 0.28.1

package/src/fundamentalTypes/fileType.js

@@ -232,7 +232,7 @@ function binaryButton (
                 ['textarea', {
                   class: 'view-binary'
                 }, [
-                  /* istanbul ignore next */
+                  /* istanbul ignore next -- Guard */
                   /** @type {string|null} */ (reader.result) ?? ''
                 ]]
               ]]
@@ -242,11 +242,11 @@ function binaryButton (
         // Seems not feasible to accurately simulate
         reader.addEventListener(
           'error',
-          /* istanbul ignore next */
+          /* istanbul ignore next -- Should not err */
           async function () {
-            /* istanbul ignore next */
+            /* istanbul ignore next -- Should not err */
             console.error(reader.error);
-            /* istanbul ignore next */
+            /* istanbul ignore next -- Should not err */
             await dialogs.alert(/** @type {string} */ (
               /** @type {DOMException} */ (reader.error).message
             ));
@@ -341,7 +341,7 @@ const fileType = {
               'Text source',
               ['br'],
               ['textarea', {class: 'view-text'}, [
-                /* istanbul ignore next */
+                /* istanbul ignore next -- Guard */
                 /** @type {string|null} */ (reader.result) ?? ''
               ]]
             ]));
@@ -349,11 +349,11 @@ const fileType = {
           // Seems not feasible to accurately simulate
           reader.addEventListener(
             'error',
-            /* istanbul ignore next */
+            /* istanbul ignore next -- Should not err */
             function () {
-              /* istanbul ignore next */
+              /* istanbul ignore next -- Should not err */
               console.error(reader.error);
-              /* istanbul ignore next */
+              /* istanbul ignore next -- Should not err */
               div.append(
                 /** @type {DOMException} */ (reader.error).message
               );
@@ -882,7 +882,7 @@ const fileType = {
 
                 if (constraints) {
                   const mediaStream = await getUserMedia(constraints);
-                  /* istanbul ignore if */
+                  /* istanbul ignore if -- Should be present */
                   if (!mediaStream) {
                     await dialogs.alert('Error getting user media');
                     return;
@@ -930,7 +930,7 @@ const fileType = {
                   const mediaStream = await startScreenCapture(
                     screenShareConstraints
                   );
-                  /* istanbul ignore if */
+                  /* istanbul ignore if -- Should not err */
                   if (!mediaStream) {
                     await dialogs.alert('Error getting user media');
                     return;
@@ -1010,7 +1010,7 @@ const fileType = {
                     'video.previewMedia'
                   ));
 
-                /* istanbul ignore if */
+                /* istanbul ignore if -- Should not err */
                 if (!previewMedia.srcObject) {
                   dialogs.alert('No stream found to record');
                   return;
@@ -1044,7 +1044,7 @@ const fileType = {
 
                 try {
                   mediaRecorder.start();
-                } catch /* istanbul ignore next */ {
+                } catch /* istanbul ignore next -- Should not err */ {
                   dialogs.alert('Error starting media recorder');
                   return;
                 }
@@ -1195,7 +1195,7 @@ const fileType = {
                   ($e(videoContainer, 'img.photo'));
 
                 canvas.toBlob((blob) => {
-                  /* istanbul ignore if */
+                  /* istanbul ignore if -- Should not err */
                   if (!blob) {
                     dialogs.alert('Error converting canvas to Blob');
                     return;

package/src/fundamentalTypes/regexpType.js

@@ -19,7 +19,7 @@ const regexpType = {
     return toStringTag(x) === 'RegExp';
   },
   toValue (s) {
-    /* istanbul ignore if */
+    /* istanbul ignore if -- TS */
     if (typeof this.stringRegex !== 'function') {
       throw new TypeError('Guard for TS');
     }

package/src/fundamentalTypes/stringType.js

@@ -128,6 +128,11 @@ const stringType = {
       }
       if (kind) {
         switch (kind) {
+        case 'currency_code':
+          if (!regexes.currencyCode.test(value)) {
+            return `Value doesn't match currency code pattern.`;
+          }
+          break;
         case 'credit_card':
           if (!regexes.creditCard.test(value)) {
             return `Value doesn't match credit card pattern.`;

package/src/jsoe.css

@@ -139,6 +139,18 @@ video.recordedMedia {
   height: 300px;
 }
 
+.jsoe-raw-editor {
+  width: 500px;
+  max-width: 100%;
+  height: 300px;
+  overflow: auto;
+  border: 1px solid;
+}
+
+.jsoe-raw-editor-error:not(:empty) {
+  color: #b00;
+}
+
 .visualizer {
   height: 60px;
 }

package/src/subTypes/blobHTMLType.js

@@ -127,7 +127,7 @@ const blobHTMLType = {
         jml('textarea', {name: `${typeNamespace}-blobHTML`})
       );
     textarea.sceditorInstance = {
-      /* istanbul ignore next */
+      /* istanbul ignore next -- Guard */
       val () {
         throw new Error('Not yet instantiated');
       }

package/src/superTypes/dommatrixType.js

@@ -348,7 +348,7 @@ const dommatrixType = {
         $on: {
           click (e) {
             const {target} = e;
-            /* istanbul ignore if */
+            /* istanbul ignore if -- Guard */
             if (/** @type {HTMLInputElement} */ (target).type !== 'radio') {
               return;
             }

package/src/superTypes/errorsSpecialType.js

@@ -36,7 +36,7 @@ if (typeof AggregateError !== 'undefined') {
   specialErrorsMap.set('AggregateError', AggregateError);
 }
 
-/* istanbul ignore next 5 */
+/* istanbul ignore next 5 -- May not exist */
 // @ts-expect-error Only use if available
 if (typeof InternalError !== 'undefined') {
   // @ts-expect-error Only use if available

package/src/typeChoices.js

@@ -66,17 +66,44 @@ import deepEqual from 'fast-deep-equal/es6/index.js';
  */
 
 /**
- * @typedef {HTMLSelectElement & {
+ * The `$`-methods every type-choices control exposes, whether it's a real
+ *   `<select>` (`TypeChoicesElementAPI`) or the `xor` radio group's
+ *   `<fieldset>` standing in for one (`TypeChoicesControl` — see its comment
+ *   for why that one is *not* typed as `HTMLSelectElement`).
+ * @typedef {{
  *   $addAndValidateEditUI: AddAndValidateEditUI,
+ *   $addTypeAndEditUI: AddTypeAndEditUI,
  *   $setStyles: SetStyles,
  *   $getTypeRoot: GetTypeRoot,
  *   $getContainer: () => HTMLElement,
  *   $getTopRoot: () => HTMLDivElement,
  *   $addEditUI: AddEditUI,
  *   $validate: Validate,
+ *   $setType: SetType,
  *   $setTypeNoEditUI: SetTypeNoEditUI,
+ *   $getValue: GetValue,
  *   $whenReady: WhenReady
- * }} TypeChoicesElementAPI
+ * }} TypeChoicesAPIMethods
+ */
+
+/**
+ * @typedef {HTMLSelectElement & TypeChoicesAPIMethods} TypeChoicesElementAPI
+ */
+
+/**
+ * The type-choices control surface downstream code actually relies on:
+ *   the `$`-methods, plus the `value`/`selectedIndex`/`selectedOptions`
+ *   surface a real `<select>` provides natively. Deliberately *not* typed as
+ *   `HTMLSelectElement`, because `buildXorTypeChoices` below returns a real
+ *   `<fieldset>` with that surface shimmed on via `Object.defineProperties`
+ *   (and the `$`-methods copied by reference from the parallel `<select>`)
+ *   rather than an actual `<select>` — asserting `HTMLSelectElement` there
+ *   would be a false claim, not just a loose one.
+ * @typedef {HTMLElement & TypeChoicesAPIMethods & {
+ *   value: string,
+ *   selectedIndex: number,
+ *   selectedOptions: ArrayLike<{value: string, dataset?: {idx?: string}}>
+ * }} TypeChoicesControl
  */
 
 /**
@@ -126,7 +153,7 @@ import deepEqual from 'fast-deep-equal/es6/index.js';
  *   schemaContent?: import('./formatAndTypeChoices.js').ZodexSchema,
  * }} cfg
  * @returns {{
- *   domArray: [select: HTMLElement, typeContainer: HTMLElement],
+ *   domArray: [select: TypeChoicesControl, typeContainer: HTMLElement],
  *   getValue: GetValue,
  *   getType: GetType,
  *   validValuesSet: ValidValuesSet,
@@ -166,9 +193,7 @@ function deriveXorBranchLabel (schemaObj, optText, idx) {
       return String(values[0]);
     }
   }
-  if (schemaObj &&
-    (schemaObj.type === 'object' || schemaObj.type === 'properties')
-  ) {
+  if (schemaObj && schemaObj.type === 'object') {
     const {properties} = /** @type {import('zodexy').SzObject} */ (schemaObj);
     const keys = properties && typeof properties === 'object'
       ? Object.keys(properties)
@@ -200,9 +225,9 @@ function deriveXorBranchLabel (schemaObj, optText, idx) {
  *   types: InstanceType<typeof import('./types.js').default>,
  *   typeContainer: HTMLElement,
  *   xorSchema: import('zodexy').SzUnion|undefined,
- *   selectEl: HTMLSelectElement
+ *   selectEl: TypeChoicesElementAPI
  * }} cfg
- * @returns {HTMLSelectElement}
+ * @returns {TypeChoicesControl}
  */
 function buildXorTypeChoices ({
   typeNamespace, keySelectClass, typeOptions, schemaObjs, types,
@@ -359,7 +384,9 @@ function buildXorTypeChoices ({
     }
   });
 
-  return /** @type {HTMLSelectElement} */ (/** @type {unknown} */ (fieldset));
+  return /** @type {TypeChoicesControl} */ (
+    /** @type {unknown} */ (fieldset)
+  );
 }
 
 /**
@@ -437,7 +464,7 @@ export const buildTypeChoices = ({
   //   match indicator to value changes inside it
   const typeContainer = jml('div', {class: 'typeContainer'});
 
-  const selectEl = /** @type {HTMLSelectElement} */ (jml('select', {
+  const selectEl = /** @type {TypeChoicesElementAPI} */ (jml('select', {
     hidden: requireObject || typeOptions.length === 1,
     class: `typeChoices-${typeNamespace}${keySelectClass
       ? ' ' + keySelectClass

package/src/types.js

@@ -438,17 +438,28 @@ class Types {
   /**
    * @param {{
    *   useZodexyErrorMessages?: boolean,
-   *   useZodexyErrorMessagesInTypes?: boolean
+   *   useZodexyErrorMessagesInTypes?: boolean,
+   *   allowUnsafeEval?: boolean,
+   *   showRawTypesonControls?: boolean
    * }} [cfg]
    */
   constructor ({
     useZodexyErrorMessages = false,
-    useZodexyErrorMessagesInTypes = false
+    useZodexyErrorMessagesInTypes = false,
+    allowUnsafeEval = false,
+    showRawTypesonControls = true
   } = {}) {
     this.formats = new Formats(); // Todo: Make customizable and test
 
     this.useZodexyErrorMessages = useZodexyErrorMessages;
     this.useZodexyErrorMessagesInTypes = useZodexyErrorMessagesInTypes;
+    // Gates the eval-mode sub-feature of the raw Typeson edit/view buttons
+    //   (`src/utils/rawTypesonEditor.js`); disabled by default since eval'ing
+    //   arbitrary user-supplied text is inherently unsafe.
+    this.allowUnsafeEval = allowUnsafeEval;
+    // Master on/off switch for the raw Typeson edit/view buttons themselves;
+    //   when `false` neither button is rendered anywhere in the tree.
+    this.showRawTypesonControls = showRawTypesonControls;
     /** @type {WeakMap<RootElement, import('./formats/schema.js').ZodexSchema>} */
     this.schemasForRoots = new WeakMap();
 
@@ -721,12 +732,6 @@ class Types {
     // `record`/`tuple` are not shown as their own pull-down entries; they render
     //   as `Object`/`Array` (their schema, incl. child descriptions, informs the
     //   layout — see `arrayType.js`).
-    // `z.properties()` likewise renders through the `object` type/UI; when the
-    //   schema supplies no label of its own, name it "Properties" so it is not
-    //   shown as an indistinguishable "Object".
-    if (type === 'object' && schemaContent?.type === 'properties') {
-      optInfo[0] = 'Properties';
-    }
 
     const schemaContentLabel = resolveSchemaMeta(schemaContent).label;
     if (schemaContentLabel) {

package/src/utils/media.js

@@ -77,9 +77,9 @@ async function getUserMedia (constraints) {
   try {
     stream = await navigator.mediaDevices.getUserMedia(constraints);
   } catch (err) {
-    /* istanbul ignore next */
+    /* istanbul ignore next -- Should be present */
     console.error('err', err);
-    /* istanbul ignore next */
+    /* istanbul ignore next -- Should be present */
     return null;
   }
   return stream;
@@ -96,7 +96,7 @@ async function startScreenCapture (displayMediaOptions) {
     captureStream =
       await navigator.mediaDevices.getDisplayMedia(displayMediaOptions);
   } catch (err) {
-    /* istanbul ignore next */
+    /* istanbul ignore next -- Should not err */
     console.error(`Error: ${err}`);
   }
   return captureStream;