@es-joy/jsoe 0.13.8 → 0.15.0

package/CHANGES.md

@@ -1,5 +1,15 @@
 # CHANGES TO `@es-joy/jsoe`
 
+## 0.15.0
+
+- feat: `buffersource`
+
+## 0.14.0
+
+- feat: allow DOMRect, DOMPoint, DOMMatrix read-only versions
+- feat: add noneditable type to catch and transparently pass on
+    unsupported types
+
 ## 0.13.8
 
 - fix: array/object reference value-retrieval broken

package/README.md

@@ -31,15 +31,14 @@ Supported types include:
 - `Boolean` object
 - `Date`
 - `DOMException`,
-- `DOMMatrix`
-- `DOMPoint`
-- `DOMRect`
 - `Error`
 - `TypeError`, `RangeError`, `SyntaxError`, `ReferenceError`, `EvalError`,
     `URIError`, `AggregateError`, `InternalError`
 - `File`
 - `FileList`
 - `Map`
+- Non-editable type (catch-all for not-yet-supported object types; allows
+    for preexisting data to be passed on transparently)
 - `null`
 - `Number` object
 - number
@@ -70,6 +69,13 @@ Supported supertypes include:
 
 - Special Real Number (`Infinity`, `-Infinity`, `-0`) - Used with IndexedDB keys (even though -0 apparently [to be converted](https://github.com/w3c/IndexedDB/issues/375) to 0)
 - Special Number (`Infinity`, `-Infinity`, `-0`, `NaN`) - Used with Structured Cloning values
+- `DOMMatrix` (also includes `DOMMatrixReadOnly`)
+- `DOMPoint` (also includes `DOMPointReadOnly`)
+- `DOMRect` (also includes `DOMRectReadOnly`)
+- `buffersource` includes `ArrayBuffer`, `DataView`, and TypedArrays
+    (int8array, uint8array, uint8clampedarray, int16array, uint16array,
+    int32array, uint32array, float32array, float64array,
+    bigint64array, biguint64array)
 
 ## Known issues
 
@@ -91,28 +97,11 @@ Supported supertypes include:
                 1. See <https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm#webapi_types>
     1. Already in typeson-registry
         1. Structured Cloning
-            1. JavaScript types
-                1. ArrayBuffer
-                    1. arraybuffer
-                1. DataView
-                    1. dataview
-                1. TypedArray
-                    1. int8array
-                    1. uint8array
-                    1. uint8clampedarray
-                    1. int16array
-                    1. uint16array
-                    1. int32array
-                    1. uint32array
-                    1. float32array
-                    1. float64array
-                    1. bigint64arrayconstructor
-                    1. biguint64arrayconstructor
+            1. (JavaScript types already complete)
             1. Web/API types
                 1. imagedata, imagebitmap
                 1. cryptokey
                 1. domquad
-                1. dompointreadonly, dommatrixreadonly, domrectreadonly
             1. Our own custom derivative types? (e.g., MIDI using TypedArray)
 1. Expand subtypes
     1. String

package/demo/index.js

@@ -9,6 +9,26 @@ import {
 
 const types = new Types();
 
+/**
+ *
+ */
+const makeNoneditableType = () => {
+  /**
+   *
+   */
+  class NonEditableType {
+    /* eslint-disable class-methods-use-this -- `this` not needed */
+    /**
+     * @returns {string}
+     */
+    get [Symbol.toStringTag] () {
+      /* eslint-enable class-methods-use-this -- `this` not needed */
+      return 'NonEditableType';
+    }
+  }
+  return new NonEditableType();
+};
+
 const keyPathNotExpectedTypeChoices = formatAndTypeChoices({
   hasKeyPath: false,
   typeNamespace: 'demo-keypath-not-expected'
@@ -105,6 +125,40 @@ setTimeout(async function () {
       }
     }, ['Initialize with a complex value']],
 
+    ['button', {
+      id: 'initializeWithNoneditableValue',
+      $on: {
+        click () {
+          const a = makeNoneditableType();
+          const root = $(
+            '#formatAndTypeChoices div[data-type="resurrectable"]'
+          );
+          keyPathNotExpectedTypeChoices.types.setValue({
+            type: 'resurrectable',
+            root,
+            value: a
+          });
+          keyPathNotExpectedTypeChoices.types.validate({
+            type: 'resurrectable',
+            root
+          });
+
+          setTimeout(() => {
+            keyPathNotExpectedTypeChoices.types.setValue({
+              type: 'resurrectable',
+              root,
+              value: undefined
+            });
+            keyPathNotExpectedTypeChoices.types.validate({
+              type: 'resurrectable',
+              root
+            });
+          }, 3000);
+          // await keyPathNotExpectedTypeChoices.setValue(a);
+        }
+      }
+    }, ['Initialize with noneditable value then change']],
+
     ['button', {
       id: 'programmaticallySetFormatToJSON',
       $on: {
@@ -351,14 +405,21 @@ setTimeout(async function () {
           }),
           new DOMException('some message', 'someName'),
           new DOMRect(1, 2, 3, 4),
+          new DOMRectReadOnly(1, 2, 3, 4),
           new DOMPoint(1, 2, 3, 4),
+          new DOMPointReadOnly(1, 2, 3, 4),
           new DOMMatrix([1, 2, 3, 4, 5, 6]),
+          new DOMMatrixReadOnly([1, 2, 3, 4, 5, 6]),
           new DOMMatrix([
             1, 2, 3, 4,
             5, 6, 7, 8,
             9, 10, 11, 12,
             13, 14, 15, 16
-          ])
+          ]),
+          new ArrayBuffer(8),
+          new DataView(new ArrayBuffer(8), 2, 4),
+          new Uint8Array(new ArrayBuffer(8), 2, 4),
+          makeNoneditableType()
         ],
         typeNamespace: 'demo-type-choices-only-initial-value'
       });
@@ -429,6 +490,20 @@ setTimeout(async function () {
         typeNamespace: 'demo-type-choices-only-initial-value'
       });
 
+      const typeSelectionNoneditable = typeChoices({
+        format: 'structuredCloning',
+        setValue: true,
+        value: makeNoneditableType(),
+        typeNamespace: 'demo-type-choices-only-initial-value'
+      });
+
+      const typeSelectionArrayBuffer = typeChoices({
+        format: 'structuredCloning',
+        setValue: true,
+        value: new ArrayBuffer(8),
+        typeNamespace: 'demo-type-choices-only-initial-value'
+      });
+
       return ['form', [
         ...typeSelection.domArray,
         ...typeSelectionBlobHTML.domArray,
@@ -437,7 +512,9 @@ setTimeout(async function () {
         ...typeSelectionTypeErrorWithCause.domArray,
         ...typeSelectionTypeErrorWithAggregate.domArray,
         ...typeSelectionFile.domArray,
-        ...typeSelectionBlob.domArray
+        ...typeSelectionBlob.domArray,
+        ...typeSelectionNoneditable.domArray,
+        ...typeSelectionArrayBuffer.domArray
       ]];
     })(),
 

package/dist/formats/indexedDBKey.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"indexedDBKey.d.ts","sourceRoot":"","sources":["../../src/formats/indexedDBKey.js"],"names":[],"mappings":";AAEA,6CAA6C;AAC7C,4BADW,OAAO,eAAe,EAAE,MAAM,CAuCvC"}
+{"version":3,"file":"indexedDBKey.d.ts","sourceRoot":"","sources":["../../src/formats/indexedDBKey.js"],"names":[],"mappings":";AAEA,6CAA6C;AAC7C,4BADW,OAAO,eAAe,EAAE,MAAM,CAwCvC"}

package/dist/formats/structuredCloning.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"structuredCloning.d.ts","sourceRoot":"","sources":["../../src/formats/structuredCloning.js"],"names":[],"mappings":";2CAYoB;IACnB,QAAY,EAAE,MAAM,CAAC;IACrB,IAAQ,EAAE,OAAO,aAAa,EAAE,aAAa,CAAC;IAC9C,KAAS,EAAE,OAAO,eAAe,EAAE,oBAAoB,CAAC;IACxD,cAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,SAAa,CAAC,EAAE,OAAO,CAAC;IACxB,aAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,WAAe,CAAC,EAAE,OAAO,aAAa,EAAE,gCAAgC,CAAA;CACrE,KAAK,WAAW,GAAC,IAAI;kCAIZ,OAAO,kBAAkB,EAAE,mBAAmB;uCA6WhD,OAAO,eAAe,EAAE,oBAAoB,YAC5C,OAAO,aAAa,EAAE,WAAW,KAC/B,QAAQ,OAAO,CAAC;AAJ7B;;;;;GAKG;AAEH,6CAA6C;AAC7C,iCADW,OAAO,eAAe,EAAE,MAAM,CA+GvC"}
+{"version":3,"file":"structuredCloning.d.ts","sourceRoot":"","sources":["../../src/formats/structuredCloning.js"],"names":[],"mappings":";2CAsBoB;IACnB,QAAY,EAAE,MAAM,CAAC;IACrB,IAAQ,EAAE,OAAO,aAAa,EAAE,aAAa,CAAC;IAC9C,KAAS,EAAE,OAAO,eAAe,EAAE,oBAAoB,CAAC;IACxD,cAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,SAAa,CAAC,EAAE,OAAO,CAAC;IACxB,aAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,WAAe,CAAC,EAAE,OAAO,aAAa,EAAE,gCAAgC,CAAA;CACrE,KAAK,WAAW,GAAC,IAAI;kCAIZ,OAAO,kBAAkB,EAAE,mBAAmB;uCA2WhD,OAAO,eAAe,EAAE,oBAAoB,YAC5C,OAAO,aAAa,EAAE,WAAW,KAC/B,QAAQ,OAAO,CAAC;AAJ7B;;;;;GAKG;AAEH,6CAA6C;AAC7C,iCADW,OAAO,eAAe,EAAE,MAAM,CAwHvC"}

package/dist/fundamentalTypes/BooleanObjectType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BooleanObjectType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/BooleanObjectType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,iCAFU,OAAO,aAAa,EAAE,UAAU,GAAG;IAAC,EAAE,EAAE,MAAM,CAAA;CAAC,CAmDvD"}
+{"version":3,"file":"BooleanObjectType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/BooleanObjectType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,iCAFU,OAAO,aAAa,EAAE,UAAU,GAAG;IAAC,EAAE,EAAE,MAAM,CAAA;CAAC,CAqDvD"}

package/dist/fundamentalTypes/NumberObjectType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NumberObjectType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/NumberObjectType.js"],"names":[],"mappings":";AAGA;;GAEG;AACH,gCAFU,OAAO,aAAa,EAAE,UAAU,CAoCxC"}
+{"version":3,"file":"NumberObjectType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/NumberObjectType.js"],"names":[],"mappings":";AAGA;;GAEG;AACH,gCAFU,OAAO,aAAa,EAAE,UAAU,CAsCxC"}

package/dist/fundamentalTypes/StringObjectType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StringObjectType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/StringObjectType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,gCAFU,OAAO,aAAa,EAAE,UAAU,CA+BxC"}
+{"version":3,"file":"StringObjectType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/StringObjectType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,gCAFU,OAAO,aAAa,EAAE,UAAU,CAiCxC"}

package/dist/fundamentalTypes/arrayType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"arrayType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/arrayType.js"],"names":[],"mappings":";sBAWa,MAAM;;oCAQN,MAAM,gBAAgB,EAAE;+BAGxB,MAAM,CAAC,iBAAiB,GAAG;IACvC,SAAa,EAAE,OAAO,mBAAmB,EAAE,QAAQ,CAAA;CAChD,CAAC,EAAE;6BAGM,MAAM,IAAI;sCAIV,gBAAgB,EAAE;qCAKlB,IAAI;4BAGJ,MAAM,cAAc,GAAG;IACnC,sBAA0B,EAAE,qBAAqB,CAAC;IAClD,kBAAsB,EAAE,iBAAiB,CAAC;IAC1C,iBAAqB,EAAE,gBAAgB,CAAC;IACxC,iBAAqB,EAAE,gBAAgB,CAAA;CACpC;uBAGS,MAAM,QAAQ,IAAI,CAAC;2BAKrB;IAAC,WAAW,CAAC,EAAE,IAAI,CAAA;CAAC,KAClB,IAAI;+BAIJ,MAAM,gBAAgB,GAAC,SAAS;uBAIhC,GAAG;AAmBhB;;GAEG;AACH,yBAFU,OAAO,aAAa,EAAE,UAAU,GAAG;IAAC,MAAM,CAAC,EAAE,OAAO,GAAC,SAAS,CAAA;CAAC,CA2pDvE"}
+{"version":3,"file":"arrayType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/arrayType.js"],"names":[],"mappings":";sBAWa,MAAM;;oCAQN,MAAM,gBAAgB,EAAE;+BAGxB,MAAM,CAAC,iBAAiB,GAAG;IACvC,SAAa,EAAE,OAAO,mBAAmB,EAAE,QAAQ,CAAA;CAChD,CAAC,EAAE;6BAGM,MAAM,IAAI;sCAIV,gBAAgB,EAAE;qCAKlB,IAAI;4BAGJ,MAAM,cAAc,GAAG;IACnC,sBAA0B,EAAE,qBAAqB,CAAC;IAClD,kBAAsB,EAAE,iBAAiB,CAAC;IAC1C,iBAAqB,EAAE,gBAAgB,CAAC;IACxC,iBAAqB,EAAE,gBAAgB,CAAA;CACpC;uBAGS,MAAM,QAAQ,IAAI,CAAC;2BAKrB;IAAC,WAAW,CAAC,EAAE,IAAI,CAAA;CAAC,KAClB,IAAI;+BAIJ,MAAM,gBAAgB,GAAC,SAAS;uBAIhC,GAAG;AAmBhB;;GAEG;AACH,yBAFU,OAAO,aAAa,EAAE,UAAU,GAAG;IAAC,MAAM,CAAC,EAAE,OAAO,GAAC,SAAS,CAAA;CAAC,CA6pDvE"}

package/dist/fundamentalTypes/blobType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"blobType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/blobType.js"],"names":[],"mappings":";uBAMa,IAAI,GAAC;IACjB,IAAQ,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAC3B;8BAIgB,QAAQ,KAAK,IAAI;AAiIrC;;GAEG;AACH,wBAFU,OAAO,aAAa,EAAE,UAAU,CAw1BxC"}
+{"version":3,"file":"blobType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/blobType.js"],"names":[],"mappings":";uBAMa,IAAI,GAAC;IACjB,IAAQ,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAC3B;8BAIgB,QAAQ,KAAK,IAAI;AAkIrC;;GAEG;AACH,wBAFU,OAAO,aAAa,EAAE,UAAU,CA21BxC"}

package/dist/fundamentalTypes/dateType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dateType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/dateType.js"],"names":[],"mappings":";+CAKyB,IAAI,GAAC,SAAS,KAC/B,IAAI;AAHZ;;;;GAIG;AAEH;;;;;;;;;GASG;AACH;eARgB,MAAM;qBACA;QAAC,IAAI,EAAE,cAAc,CAAA;KAAC,KAAK,OAAO;4BAE1C,OAAO,eAAe,EAAE,oBAAoB,KAChD,OAAO;;EA0If"}
+{"version":3,"file":"dateType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/dateType.js"],"names":[],"mappings":";+CAKyB,IAAI,GAAC,SAAS,KAC/B,IAAI;AAHZ;;;;GAIG;AAEH;;;;;;;;;GASG;AACH;eARgB,MAAM;qBACA;QAAC,IAAI,EAAE,cAAc,CAAA;KAAC,KAAK,OAAO;4BAE1C,OAAO,eAAe,EAAE,oBAAoB,KAChD,OAAO;;EA8If"}

package/dist/fundamentalTypes/fileType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fileType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/fileType.js"],"names":[],"mappings":";uBAMa,IAAI,GAAC;IACjB,MAAU,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAC7C,YAAgB,EAAE,MAAM,CAAA;CACrB;8BAIgB,QAAQ,KAAK,IAAI;AAsJrC;;GAEG;AACH,wBAFU,OAAO,aAAa,EAAE,UAAU,CA+6BxC"}
+{"version":3,"file":"fileType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/fileType.js"],"names":[],"mappings":";uBAMa,IAAI,GAAC;IACjB,MAAU,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAC7C,YAAgB,EAAE,MAAM,CAAA;CACrB;8BAIgB,QAAQ,KAAK,IAAI;AAuJrC;;GAEG;AACH,wBAFU,OAAO,aAAa,EAAE,UAAU,CAg7BxC"}

package/dist/fundamentalTypes/filelistType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"filelistType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/filelistType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,4BAFU,OAAO,aAAa,EAAE,UAAU,CA6BxC"}
+{"version":3,"file":"filelistType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/filelistType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,4BAFU,OAAO,aAAa,EAAE,UAAU,CA+BxC"}

package/dist/fundamentalTypes/mapType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mapType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/mapType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,uBAFU,OAAO,aAAa,EAAE,UAAU,CA4BxC"}
+{"version":3,"file":"mapType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/mapType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,uBAFU,OAAO,aAAa,EAAE,UAAU,CA8BxC"}

package/dist/fundamentalTypes/noneditableType.d.ts

@@ -0,0 +1,6 @@
+export default noneditableType;
+/**
+ * @type {import('../types.js').TypeObject}
+ */
+declare const noneditableType: import('../types.js').TypeObject;
+//# sourceMappingURL=noneditableType.d.ts.map

package/dist/fundamentalTypes/noneditableType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"noneditableType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/noneditableType.js"],"names":[],"mappings":";AAGA;;GAEG;AACH,+BAFU,OAAO,aAAa,EAAE,UAAU,CAgFxC"}

package/dist/fundamentalTypes/objectReferenceType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"objectReferenceType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/objectReferenceType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,mCAFU,OAAO,aAAa,EAAE,UAAU,GAAG;IAAC,IAAI,EAAE,MAAM,CAAA;CAAC,CAgDzD"}
+{"version":3,"file":"objectReferenceType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/objectReferenceType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,mCAFU,OAAO,aAAa,EAAE,UAAU,GAAG;IAAC,IAAI,EAAE,MAAM,CAAA;CAAC,CAkDzD"}

package/dist/fundamentalTypes/objectType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"objectType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/objectType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,0BAFU,OAAO,aAAa,EAAE,UAAU,CAwBxC"}
+{"version":3,"file":"objectType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/objectType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,0BAFU,OAAO,aAAa,EAAE,UAAU,CA0BxC"}

package/dist/fundamentalTypes/setType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"setType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/setType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,uBAFU,OAAO,aAAa,EAAE,UAAU,CA4BxC"}
+{"version":3,"file":"setType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/setType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,uBAFU,OAAO,aAAa,EAAE,UAAU,CA8BxC"}

package/dist/fundamentalTypes/sparseUndefinedType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sparseUndefinedType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/sparseUndefinedType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,mCAFU,OAAO,aAAa,EAAE,UAAU,CA0CxC"}
+{"version":3,"file":"sparseUndefinedType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/sparseUndefinedType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,mCAFU,OAAO,aAAa,EAAE,UAAU,CA4CxC"}

package/dist/fundamentalTypes/undefinedType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"undefinedType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/undefinedType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,6BAFU,OAAO,aAAa,EAAE,UAAU,CA8BxC"}
+{"version":3,"file":"undefinedType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/undefinedType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,6BAFU,OAAO,aAAa,EAAE,UAAU,CAgCxC"}