@es-joy/jsoe 0.5.0 → 0.6.0

package/CHANGES.md

@@ -1,5 +1,15 @@
 # CHANGES TO `@es-joy/jsoe`
 
+## 0.6.0
+
+- feat: add `set`, `map`, `error`, and special error types
+- fix: ensure `Types.getTypeForRoot` always returns a string
+- fix: ensure Blob textarea is independent per instance
+
+## 0.5.1
+
+- fix: TS types
+
 ## 0.5.0
 
 - chore: update `jamilih`, `typeson-registry`, devDeps.;

package/README.md

@@ -12,6 +12,8 @@ app using this tool.
 
 Formats are a collection of allowed types.
 
+Supported formats include:
+
 - Structured Cloning (using [typeson](https://github.com/dfahlander/typeson)) (e.g., IndexedDB)
 - JSON
 - IndexedDB keys
@@ -20,17 +22,24 @@ Formats are a collection of allowed types.
 
 These are generally atomic types which correlate to JavaScript language structures.
 
+Supported types include:
+
 - Array reference (for cyclic arrays)
 - Array
 - `BigInt`
 - `Boolean` object
 - `Date`
+- `Error`
+- `TypeError`, `RangeError`, `SyntaxError`, `ReferenceError`, `EvalError`,
+    `URIError`, `AggregateError`, `InternalError`
+- `Map`
 - `null`
 - `Number` object
 - number
 - Object reference (for cyclic objects)
 - Object
 - `RegExp`
+- `Set`
 - `String` object
 - string
 - `undefined`
@@ -39,6 +48,8 @@ These are generally atomic types which correlate to JavaScript language structur
 
 These map to a subset of JavaScript language structures. Note that false and true were common and limited enough in number to justify their own subtype for the sake of having a quick pull-down entry.
 
+Supported subtypes include:
+
 - Blob (text/html)
 - `false`
 - `true`
@@ -48,9 +59,20 @@ These map to a subset of JavaScript language structures. Note that false and tru
 These are collections of individual types, justified by the subitems not being so frequent as to necessitate their own
 separate enumeration.
 
+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
 
+## Known issues
+
+- Cannot provide maps with object keys pointing to the same objects as used
+    as map values; likewise with Sets?
+- Certain cyclical structures may have issues
+- `typeson-registry`'s structured cloning should throw on more objects, so
+   bad data doesn't end up stored
+- Lacks support for certain Structured Cloning types. See to-dos below.
+
 ## To-dos
 
 1. Add tests of demo (lower priority as have tests in `idb-manager`)
@@ -58,28 +80,32 @@ separate enumeration.
 1. Expand fundamental types
     1. Not in typeson-registry
         1. Structured Cloning
-            1. arraybufferview
+            1. Web/API types (besides those listed below)
+                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. map, set,
-            1. blob, file, filelist
-            1. arraybuffer
-            1. dataview, imagedata, imagebitmap
-            1. error, errors
-            1. Typed Arrays
-                1. int8array
-                1. uint8array
-                1. uint8clampedarray
-                1. int16array
-                1. uint16array
-                1. int32array
-                1. uint32array
-                1. float32array
-                1. float64array
-            1. Intl (imperfect)
-                1. IntlCollator
-                1. IntlDateTimeFormat
-                1. IntlNumberFormat
+            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. Web/API types
+                1. blob (besides HTML), file, filelist
+                1. imagedata, imagebitmap
 1. Expand subtypes
     1. As supported by Zod, JSON Schema, etc. (e.g., email addresses as
-        subtype of `string`)
+        subtype of `string`, color as a subtype of string)
+1. Might put views and data into separate repos
+1. Implement as Custom Elements?

package/cypress.config.ts

@@ -0,0 +1,13 @@
+import {defineConfig} from 'cypress';
+import plugins from './cypress/plugins/index.js';
+
+export default defineConfig({
+  defaultCommandTimeout: 8000,
+  video: false,
+  e2e: {
+    baseUrl: 'http://127.0.0.1:8087',
+    setupNodeEvents (on, config) {
+      return plugins(on, config);
+    }
+  }
+});

package/demo/index-instrumented.html

@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>JSOE Demo</title>
+    <link rel="shortcut icon" href="data:image/x-icon;," type="image/x-icon" />
+    <link rel="stylesheet" href="../src/jsoe.css" />
+    <!-- SCEditor (CKEditor was appealing for features but won't support unrecognized tags:
+        https://github.com/ckeditor/ckeditor5/issues/592 )
+        Filed https://github.com/samclarke/SCEditor/issues/584 to be able to import as ES6 module
+    -->
+    <link rel="stylesheet" href="../node_modules/sceditor/minified/themes/default.min.css" />
+
+    <script src="../node_modules/sceditor/minified/sceditor.min.js"></script>
+    <script src="../node_modules/sceditor/minified/formats/bbcode.js"></script>
+    <script src="../node_modules/sceditor/minified/formats/xhtml.js"></script>
+    <script type="importmap">
+      {
+        "imports": {
+          "jamilih": "../vendor/jamilih/dist/jml-es.js",
+          "typeson-registry": "../vendor/typeson-registry/dist/index.js"
+        }
+      }
+    </script>
+    <script type="module" src="../instrumented/demo/index.js"></script>
+  </head>
+  <body>
+  </body>
+</html>

package/demo/index.html

@@ -1,10 +1,19 @@
 <!DOCTYPE html>
-<html>
+<html lang="en">
   <head>
     <meta charset="utf-8" />
     <title>JSOE Demo</title>
     <link rel="shortcut icon" href="data:image/x-icon;," type="image/x-icon" />
     <link rel="stylesheet" href="../src/jsoe.css" />
+    <!-- SCEditor (CKEditor was appealing for features but won't support unrecognized tags:
+        https://github.com/ckeditor/ckeditor5/issues/592 )
+        Filed https://github.com/samclarke/SCEditor/issues/584 to be able to import as ES6 module
+    -->
+    <link rel="stylesheet" href="../node_modules/sceditor/minified/themes/default.min.css" />
+
+    <script src="../node_modules/sceditor/minified/sceditor.min.js"></script>
+    <script src="../node_modules/sceditor/minified/formats/bbcode.js"></script>
+    <script src="../node_modules/sceditor/minified/formats/xhtml.js"></script>
     <script type="importmap">
       {
         "imports": {