@es-joy/jsoe 0.0.1

package/.editorconfig

@@ -0,0 +1,15 @@
+; EditorConfig file: https://EditorConfig.org
+; Install the "EditorConfig" plugin into your editor to use
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+
+[*.md]
+indent_size = 4

package/.eslintignore

@@ -0,0 +1,7 @@
+node_modules
+coverage
+instrumented
+ignore
+src/deepEqual.js
+src/main-pages.js
+!.*.js

package/.eslintrc.cjs

@@ -0,0 +1,120 @@
+'use strict';
+
+module.exports = {
+  extends: ['ash-nazg/sauron-node-overrides', 'plugin:cypress/recommended'],
+  parserOptions: {
+    ecmaVersion: 2021
+  },
+  settings: {
+    jsdoc: {
+      mode: 'typescript'
+    },
+    polyfills: [
+      'Array.isArray',
+      'Array.filter',
+      'Array.forEach',
+      'Array.from',
+      'Array.includes',
+      'Array.map',
+      'Array.reduce',
+      'ArrayBuffer',
+      'BigInt',
+      'Blob',
+      'btoa',
+      'console',
+      'Date.toISOString',
+      'document.body',
+      'document.querySelector',
+      'document.querySelectorAll',
+      'Error',
+      'fetch',
+      'FileReader',
+      'history',
+      'IDBKeyRange',
+      'indexedDB',
+      'JSON',
+      'location.hash',
+      'location.href',
+      'location.pathname',
+      'MutationObserver',
+      'Number.isNaN',
+      'Number.parseFloat',
+      'Number.parseInt',
+      'Object.assign',
+      'Object.keys',
+      'Object.entries',
+      'Object.values',
+      'Promise',
+      'Set',
+      'Uint8Array',
+      'URL',
+      'URLSearchParams',
+      'WeakMap'
+    ],
+    coverage: true
+  },
+  env: {
+    node: false,
+    browser: true
+  },
+  overrides: [
+    {
+      files: '*.md/*.js',
+      rules: {
+        'import/unambiguous': 'off'
+      }
+    },
+    {
+      files: 'cypress/**',
+      rules: {
+        'import/unambiguous': 'off'
+      }
+    }
+  ],
+  rules: {
+    'no-console': 0,
+    'no-shadow': 0,
+    // 'jsdoc/require-jsdoc': ['error', {
+    //   require: {
+    //     ArrowFunctionExpression: true,
+    //     ClassDeclaration: true,
+    //     ClassExpression: true,
+    //     FunctionDeclaration: true,
+    //     FunctionExpression: true,
+    //     MethodDefinition: true
+    //   }
+    // }],
+    quotes: ['error', 'single', {
+      avoidEscape: true, allowTemplateLiterals: true
+    }],
+
+    'jsdoc/require-jsdoc': ['warn', {
+      contexts: [
+        'Program > VariableDeclaration > ' +
+          'VariableDeclarator > ArrowFunctionExpression',
+        'Program > VariableDeclaration > ' +
+          'VariableDeclarator > FunctionExpression',
+        'ExportNamedDeclaration > VariableDeclaration > ' +
+          'VariableDeclarator > ArrowFunctionExpression',
+        'ExportNamedDeclaration > VariableDeclaration > ' +
+          'VariableDeclarator > FunctionExpression',
+        'ExportDefaultDeclaration > ArrowFunctionExpression',
+        'ExportDefaultDeclaration > FunctionExpression',
+
+        'ClassDeclaration',
+        'ClassExpression',
+        'FunctionDeclaration', // Default is true
+        'MethodDefinition'
+      ]
+    }],
+
+    // Disable until find time
+    'prefer-named-capture-group': 0,
+    'eslint-comments/require-description': 0,
+    // Disable until rule improved?
+    'require-atomic-updates': 0,
+    // Disable; waiting on https://github.com/mysticatea/eslint-plugin-node/issues/162
+    'n/no-unpublished-import': 0,
+    'unicorn/no-this-assignment': 0
+  }
+};

package/CHANGES.md

@@ -0,0 +1,5 @@
+# CHANGES TO `@es-joy/jsoe`
+
+## 0.0.1
+
+- initial commit

package/LICENSE-MIT.txt

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2023 Brett Zamir
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,82 @@
+# @es-joy/jsoe
+
+JavaScript Object Editor.
+
+Editing of arbitrary JavaScript objects.
+
+## Formats
+
+Formats are a collection of allowed types.
+
+- Structured Cloning (using [typeson](https://github.com/dfahlander/typeson)) (e.g., IndexedDB)
+- JSON
+- IndexedDB keys
+
+## Fundamental types
+
+These are generally atomic types which correlate to JavaScript language structures.
+
+- Array reference (for cyclic arrays)
+- Array
+- `BigInt`
+- `Boolean` object
+- `Date`
+- `null`
+- `Number` object
+- number
+- Object reference (for cyclic objects)
+- Object
+- `RegExp`
+- `String` object
+- string
+- `undefined`
+
+## Subtypes
+
+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.
+
+- Blob (text/html)
+- `false`
+- `true`
+
+## Supertypes
+
+These are collections of individual types, justified by the subitems not being so frequent as to necessitate their own
+separate enumeration.
+
+- Infinities (`Infinity`, `-Infinity`) - Used with IndexedDB keys
+- Special Number (`Infinity`, `-Infinity`, `NaN`) - Used with Structured Cloning values
+
+## To-dos
+
+1. Create demo
+1. Add tests of demo (lower priority as have tests in `idb-manager`)
+1. Support Schemas based on a JSON serialization of Zod
+1. Expand fundamental types
+    1. Not in typeson-registry
+        1. Structured Cloning
+            1. arraybufferview
+    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. Expand subtypes
+    1. As supported by Zod, JSON Schema, etc. (e.g., email addresses as
+        subtype of `string`)

package/package.json

@@ -0,0 +1,101 @@
+{
+  "name": "@es-joy/jsoe",
+  "version": "0.0.1",
+  "type": "module",
+  "exports": {
+    ".": "./src/index.js"
+  },
+  "description": "Editing of arbitrary JavaScript objects",
+  "browserslist": [
+    "cover 100%"
+  ],
+  "nyc": {
+    "exclude": [
+      "node_modules/**"
+    ]
+  },
+  "dependencies": {
+    "@brettz9/node-static": "^0.1.1",
+    "jamilih": "0.55.0",
+    "sceditor": "3.2.0",
+    "typeson-registry": "5.0.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.21.4",
+    "@babel/plugin-transform-modules-commonjs": "^7.21.2",
+    "@babel/preset-env": "^7.21.4",
+    "@babel/register": "^7.21.0",
+    "@brettz9/eslint-plugin": "^1.0.4",
+    "@cypress/code-coverage": "^3.10.4",
+    "@rollup/plugin-babel": "^6.0.3",
+    "@rollup/plugin-commonjs": "^24.1.0",
+    "@rollup/plugin-node-resolve": "^15.0.2",
+    "axe-core": "^4.6.3",
+    "cypress": "^12.9.0",
+    "cypress-axe": "^1.4.0",
+    "eslint": "^8.38.0",
+    "eslint-config-ash-nazg": "^34.10.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-array-func": "^3.1.8",
+    "eslint-plugin-compat": "^4.1.4",
+    "eslint-plugin-cypress": "^2.13.2",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-html": "^7.1.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jsdoc": "^41.1.1",
+    "eslint-plugin-markdown": "^3.0.0",
+    "eslint-plugin-n": "^15.7.0",
+    "eslint-plugin-no-unsanitized": "^4.0.2",
+    "eslint-plugin-no-use-extend-native": "^0.5.0",
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-sonarjs": "^0.19.0",
+    "eslint-plugin-standard": "^4.1.0",
+    "eslint-plugin-unicorn": "^46.0.0",
+    "fast-deep-equal": "^3.1.3",
+    "npm-run-all": "^4.1.5",
+    "nyc": "^15.1.0",
+    "open-cli": "^7.2.0",
+    "rimraf": "^5.0.0",
+    "rollup": "3.20.2",
+    "rollup-plugin-istanbul": "^4.0.0",
+    "rollup-plugin-node-builtins": "^2.1.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:es-joy/jsoe.git"
+  },
+  "keywords": [
+    "JSON",
+    "structured-cloning",
+    "indexeddb"
+  ],
+  "author": "Brett Zamir",
+  "contributors": [],
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "bugs": "https://github.com/es-joy/jsoe/issues",
+  "license": "MIT",
+  "homepage": "https://github.com/es-joy/jsoe#readme",
+  "scripts": {
+    "eslint": "eslint --ext=js,cjs,md,html .",
+    "lint": "npm run eslint --",
+    "coverage": "open-cli http://localhost:8086/coverage/lcov-report/",
+    "open": "open-cli http://localhost:8086/",
+    "start": "node server 8086",
+    "start-instrumented": "node server 8086 instrumented",
+    "cypress:open": "cypress open",
+    "rollup": "rollup -c",
+    "instrument-add": "nyc instrument src instrumented",
+    "instrument-remove-cache": "rimraf node_modules/.cache",
+    "instrument-remove-instrumented": "rimraf instrumented",
+    "instrument-remove": "run-p -c instrument-remove-cache instrument-remove-instrumented",
+    "copy-pages": "cp node_modules/sceditor/minified/themes/default.min.css vendor/sceditor/minified/themes/default.min.css && cp node_modules/sceditor/minified/sceditor.min.js vendor/sceditor/minified/sceditor.min.js && cp node_modules/sceditor/minified/formats/bbcode.js vendor/sceditor/minified/formats/bbcode.js && cp node_modules/sceditor/minified/formats/xhtml.js vendor/sceditor/minified/formats/xhtml.js",
+    "copy-index": "cp src/index-instrumented.html instrumented/index.html",
+    "copy": "run-p copy-pages copy-index",
+    "instrument": "run-s -c instrument-remove instrument-add copy-index",
+    "cypress:log": "ELECTRON_ENABLE_LOGGING=1 cypress run; nyc report",
+    "cypress": "cypress run; nyc report",
+    "test": "npm run eslint && npm run rollup && npm run cypress"
+  }
+}

package/rollup.config.js

@@ -0,0 +1,29 @@
+import builtins from 'rollup-plugin-node-builtins';
+import {nodeResolve} from '@rollup/plugin-node-resolve';
+import commonjs from '@rollup/plugin-commonjs';
+// import babel from 'rollup-plugin-babel';
+// import {terser} from 'rollup-plugin-terser';
+
+export default {
+  input: 'node_modules/fast-deep-equal/es6/index.js',
+  output: {
+    file: 'src/deepEqual.js',
+    format: 'es',
+    name: 'deepEqual'
+  },
+  plugins: [
+    /*
+        babel(),
+        terser({
+            // Needed for Typeson's `Undefined` and other constructor detection
+            keep_fnames: true,
+            keep_classnames: true // Keep in case implementing above as classes
+        }),
+        */
+    builtins(),
+    nodeResolve(),
+    commonjs({
+      include: 'node_modules/**'
+    })
+  ]
+};

package/server.js

@@ -0,0 +1,25 @@
+import http from 'http';
+import statik from '@brettz9/node-static';
+
+const port = process.argv[2];
+
+const instrumented = process.argv[3];
+
+const fileServer = new statik.Server();
+
+http.createServer(function (request, response) {
+  request.addListener('end', function () {
+    fileServer.serve(request, response, function (e, res) {
+      if (e && (e.status === 404)) { // If the file wasn't found
+        fileServer.serveFile(
+          instrumented === 'instrumented'
+            ? '/instrumented/index.html'
+            : '/index.html',
+          200, {}, request, response
+        );
+      }
+    });
+  }).resume();
+}).listen(port);
+
+console.log(`Listening on port ${port}`);

package/src/deepEqual.js

@@ -0,0 +1,72 @@
+function getDefaultExportFromCjs (x) {
+	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
+}
+
+var es6 = function equal(a, b) {
+  if (a === b) return true;
+
+  if (a && b && typeof a == 'object' && typeof b == 'object') {
+    if (a.constructor !== b.constructor) return false;
+
+    var length, i, keys;
+    if (Array.isArray(a)) {
+      length = a.length;
+      if (length != b.length) return false;
+      for (i = length; i-- !== 0;)
+        if (!equal(a[i], b[i])) return false;
+      return true;
+    }
+
+
+    if ((a instanceof Map) && (b instanceof Map)) {
+      if (a.size !== b.size) return false;
+      for (i of a.entries())
+        if (!b.has(i[0])) return false;
+      for (i of a.entries())
+        if (!equal(i[1], b.get(i[0]))) return false;
+      return true;
+    }
+
+    if ((a instanceof Set) && (b instanceof Set)) {
+      if (a.size !== b.size) return false;
+      for (i of a.entries())
+        if (!b.has(i[0])) return false;
+      return true;
+    }
+
+    if (ArrayBuffer.isView(a) && ArrayBuffer.isView(b)) {
+      length = a.length;
+      if (length != b.length) return false;
+      for (i = length; i-- !== 0;)
+        if (a[i] !== b[i]) return false;
+      return true;
+    }
+
+
+    if (a.constructor === RegExp) return a.source === b.source && a.flags === b.flags;
+    if (a.valueOf !== Object.prototype.valueOf) return a.valueOf() === b.valueOf();
+    if (a.toString !== Object.prototype.toString) return a.toString() === b.toString();
+
+    keys = Object.keys(a);
+    length = keys.length;
+    if (length !== Object.keys(b).length) return false;
+
+    for (i = length; i-- !== 0;)
+      if (!Object.prototype.hasOwnProperty.call(b, keys[i])) return false;
+
+    for (i = length; i-- !== 0;) {
+      var key = keys[i];
+
+      if (!equal(a[key], b[key])) return false;
+    }
+
+    return true;
+  }
+
+  // true if both NaN, false otherwise
+  return a!==a && b!==b;
+};
+
+var index = /*@__PURE__*/getDefaultExportFromCjs(es6);
+
+export { index as default };

package/src/formats/indexedDBKey.js

@@ -0,0 +1,66 @@
+import * as structuredCloning from './structuredCloning.js';
+
+// Todo (low): Support ArrayBuffer
+/**
+ * @returns {string[]}
+ */
+export const types = () => [
+  'number', 'Infinities', 'string', 'ValidDate', 'array'
+];
+
+// A hack until we simply pass in our own types or do own parsing
+
+/**
+ * @param {string} newType
+ * @param {Date|GenericArray} value
+ * @returns {boolean}
+ */
+export const testInvalid = (newType, value) => {
+  switch (newType) {
+  /* istanbul ignore next -- Shouldn't occur as it is a preset */
+  case 'Infinities':
+    /* istanbul ignore next -- Shouldn't occur as it is a preset */
+    return Number.isNaN(value);
+  case 'ValidDate':
+    return Number.isNaN(value.getTime());
+  case 'array':
+    return Object.keys(value).length !== value.length;
+  /* istanbul ignore next -- Shouldn't occur */
+  default:
+    /* istanbul ignore next -- Shouldn't occur */
+    return undefined; // Todo: Should this throw?
+  }
+};
+
+/**
+ * @param {string} typesonType
+ * @returns {string}
+ */
+export const convertFromTypeson = (typesonType) => {
+  return {
+    SpecialNumber: 'Infinities', // This shouldn't occur as it is a preset
+    date: 'ValidDate',
+    // sparseArrays: 'array',
+    arrayNonindexKeys: 'array'
+  }[typesonType];
+};
+
+/**
+ * @type {FormatIterator}
+ */
+export const iterate = (records, stateObj) => {
+  stateObj.format = 'indexedDBKey';
+  return structuredCloning.iterate(records, stateObj);
+};
+
+/**
+ * @param {"array"|undefined} state
+ * @returns {undefined|string[]}
+ */
+export const getTypesForState = function (state) {
+  if (!state || ['array'].includes(state)) {
+    return this.types();
+  }
+  /* istanbul ignore next -- Can't be object, so shouldn't reach here */
+  return undefined; // Todo: Should this throw?
+};

package/src/formats/json.js

@@ -0,0 +1,64 @@
+import * as structuredCloning from './structuredCloning.js';
+
+/**
+ * @returns {string[]}
+ */
+export const types = () => [
+  'null', 'true', 'false', 'number', 'string', 'array', 'object'
+];
+
+/**
+ * @type {FormatIterator}
+ */
+export const iterate = (records, stateObj) => {
+  // Todo (low): Add a more optimal (`JSON.stringify`-based iterator)
+  const recs = records;
+  // I believe this escaping should be by Typeson itself
+  // if (records && typeof records === 'object' && records.$types) {
+  //   recs = {$: records, $types: true};
+  // }
+  stateObj.format = 'json';
+  return structuredCloning.iterate(recs, stateObj);
+};
+
+// A hack until we simply pass in our own types or do own parsing
+/**
+ * @param {string} typesonType
+ * @returns {string}
+ */
+export const convertFromTypeson = (typesonType) => {
+  return {
+    // sparseArrays: 'array',
+    arrayNonindexKeys: 'array'
+  }[typesonType];
+};
+
+/**
+ * @param {string} newType
+ * @param {GenericArray} value
+ * @returns {boolean|undefined}
+ */
+export const testInvalid = (newType, value) => {
+  switch (newType) {
+  case 'array':
+    return Object.keys(value).length !== value.length;
+  /* istanbul ignore next -- Shouldn't occur */
+  default:
+    /* istanbul ignore next -- Shouldn't occur */
+    return undefined; // Todo: Fix?
+  }
+};
+
+/**
+ * @param {string} state
+ * @returns {string[]|undefined}
+ */
+export const getTypesForState = function (state) {
+  /* istanbul ignore else -- No other states apparently */
+  if (!state || ['array', 'object'].includes(state)) {
+    return this.types();
+  }
+  // Todo: Should this throw?
+  /* istanbul ignore next -- No other states apparently */
+  return undefined;
+};

package/src/formats/schemaAndArbitrary.js

@@ -0,0 +1,20 @@
+import * as structuredCloning from './structuredCloning.js';
+
+/**
+ * @type {FormatIterator}
+ */
+export const iterate = (records, stateObj) => {
+  console.log('records', records, stateObj);
+  stateObj.format = 'schemaAndArbitrary';
+  return structuredCloning.iterate(records, stateObj);
+};
+
+/**
+ * @param {string} state
+ * @returns {string[]}
+ */
+export const getTypesForState = (state) => {
+  return structuredCloning.getTypesForState.call(
+    this, state
+  );
+};