npm - @es-joy/jsoe - Versions diffs - 0.0.1 → 0.1.0 - Mend

@es-joy/jsoe 0.0.1 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (18) hide show

package/.eslintignore +1 -0
package/.eslintrc.cjs +1 -0
package/CHANGES.md +14 -0
package/README.md +3 -0
package/demo/index.html +11 -0
package/demo/index.js +30 -0
package/package.json +8 -6
package/src/formats/structuredCloning.js +1 -1
package/src/formats.js +1 -1
package/src/fundamentalTypes/arrayType.js +1 -1
package/src/fundamentalTypes/dateType.js +1 -1
package/src/fundamentalTypes/regexpType.js +1 -1
package/src/subTypes/blobHTMLType.js +1 -1
package/src/typeChoices.js +31 -19
package/src/types.js +2 -2
package/src/utils/dialogs.js +1 -1
package/vendor/jamilih/dist/jml-es.js +1692 -0
package/vendor/typeson-registry/dist/index.js +1262 -0

package/.eslintignore CHANGED Viewed

@@ -4,4 +4,5 @@ instrumented
 ignore
 src/deepEqual.js
 src/main-pages.js
+vendor
 !.*.js

package/.eslintrc.cjs CHANGED Viewed

@@ -24,6 +24,7 @@ module.exports = {
       'console',
       'Date.toISOString',
       'document.body',
+      'document.createDocumentFragment',
       'document.querySelector',
       'document.querySelectorAll',
       'Error',

package/CHANGES.md CHANGED Viewed

@@ -1,5 +1,19 @@
 # CHANGES TO `@es-joy/jsoe`
+## 0.1.0
+- refactor: have `getFormatAndSchemaChoices` return fragment of options
+- refactor: avoid placement dependency for return results of `typeChoices`
+- refactor: return array of return objects for easier direct embedding
+   in Jamilih
+- docs: better API docs
+- docs: add demo
+- chore: switch port for testing
+## 0.0.2
+- fix: `node_modules` paths
 ## 0.0.1
 - initial commit

package/README.md CHANGED Viewed

@@ -4,6 +4,9 @@ JavaScript Object Editor.
 Editing of arbitrary JavaScript objects.
+See a [demo](https://brettz9.github.io/idb-manager/index-pages.html) of an
+app using this tool.
 ## Formats
 Formats are a collection of allowed types.

package/demo/index.html ADDED Viewed

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title>JSOE Demo</title>
+    <link rel="shortcut icon" href="data:image/x-icon;," type="image/x-icon" />
+    <script type="module" src="index.js"></script>
+  </head>
+  <body>
+  </body>
+</html>

package/demo/index.js ADDED Viewed

@@ -0,0 +1,30 @@
+import {jml, body} from '../node_modules/jamilih/dist/jml-es-noinnerh.js';
+import {
+  typeChoices, getFormatAndSchemaChoices
+  // Types, Formats
+} from '../src/index.js';
+jml('section', {role: 'main'}, [
+  ['h2', [
+    'Key path expected (object required at root)'
+  ]],
+  ...typeChoices({
+    hasKeyPath: true,
+    typeNamespace: 'demo-keypath-expected'
+  }),
+  ['h2', [
+    'No key path expected (type can vary at root)'
+  ]],
+  ...typeChoices({
+    hasKeyPath: false,
+    typeNamespace: 'demo-keypath-not-expected'
+  }),
+  ['h2', [
+    'Format choices without type selection ' +
+      '(might use as retrieval return format)'
+  ]],
+  ['select', [
+    getFormatAndSchemaChoices()
+  ]]
+], body);

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@es-joy/jsoe",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "type": "module",
   "exports": {
     ".": "./src/index.js"
@@ -80,10 +80,10 @@
   "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",
+    "coverage": "open-cli http://localhost:8087/coverage/lcov-report/",
+    "open": "open-cli http://localhost:8087/demo/",
+    "start": "node server 8087",
+    "start-instrumented": "node server 8087 instrumented",
     "cypress:open": "cypress open",
     "rollup": "rollup -c",
     "instrument-add": "nyc instrument src instrumented",
@@ -92,7 +92,9 @@
     "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",
+    "copy-jamilih": "cp node_modules/jamilih/dist/jml-es.js vendor/jamilih/dist/jml-es.js",
+    "copy-typeson-registry": "cp node_modules/typeson-registry/dist/index.js vendor/typeson-registry/dist/index.js",
+    "copy": "run-p copy-jamilih copy-typeson-registry",
     "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",

package/src/formats/structuredCloning.js CHANGED Viewed

@@ -2,7 +2,7 @@ import Formats from '../formats.js';
 import Types from '../types.js';
 import {
   Typeson, unescapeKeyPathComponent, structuredCloningThrowing
-} from '../../node_modules/typeson-registry/dist/index.js';
+} from '../../vendor/typeson-registry/dist/index.js';
 import {
   typesonPathToJSONPointer
 } from '../utils/jsonPointer.js';

package/src/formats.js CHANGED Viewed

@@ -1,5 +1,5 @@
 import Types from './types.js';
-import {jml} from '../node_modules/jamilih/dist/jml-es.js';
+import {jml} from '../vendor/jamilih/dist/jml-es.js';
 import {$e, DOM} from './utils/templateUtils.js';
 import dialogs from './utils/dialogs.js';

package/src/fundamentalTypes/arrayType.js CHANGED Viewed

@@ -1,4 +1,4 @@
-import {jml, nbsp} from '../../node_modules/jamilih/dist/jml-es.js';
+import {jml, nbsp} from '../../vendor/jamilih/dist/jml-es.js';
 import Types, {getPropertyValueFromLegend} from '../types.js';
 import {$e, U, DOM} from '../utils/templateUtils.js';

package/src/fundamentalTypes/dateType.js CHANGED Viewed

@@ -1,5 +1,5 @@
 import {$e} from '../utils/templateUtils.js';
-import {jml} from '../../node_modules/jamilih/dist/jml-es.js';
+import {jml} from '../../vendor/jamilih/dist/jml-es.js';
 import Types from '../types.js';
 /**

package/src/fundamentalTypes/regexpType.js CHANGED Viewed

@@ -1,5 +1,5 @@
 import {$e} from '../utils/templateUtils.js';
-import {jml} from '../../node_modules/jamilih/dist/jml-es.js';
+import {jml} from '../../vendor/jamilih/dist/jml-es.js';
 import Types from '../types.js';
 /**

package/src/subTypes/blobHTMLType.js CHANGED Viewed

@@ -1,5 +1,5 @@
 /* globals sceditor */
-import {jml} from '../../node_modules/jamilih/dist/jml-es.js';
+import {jml} from '../../vendor/jamilih/dist/jml-es.js';
 import {$e} from '../utils/templateUtils.js';
 import dialogs from '../utils/dialogs.js';

package/src/typeChoices.js CHANGED Viewed

@@ -1,15 +1,18 @@
-import {jml} from '../node_modules/jamilih/dist/jml-es.js';
+import {jml} from '../vendor/jamilih/dist/jml-es.js';
 import Formats from './formats.js';
 import {$e, DOM} from './utils/templateUtils.js';
 /**
+ * Defaults to structured cloning.
  * @todo Compose from format metadata, so can make user customizable.
  * @param {object} cfg
- * @param {string} cfg.schema
- * @param {boolean} cfg.hasKeyPath
- * @returns {JamilihArray[]}
+ * @param {string} [cfg.schema] (NOT IN USE)
+ * @param {boolean} [cfg.hasKeyPath] Whether or not a key path is expected; if
+ *   true, an indexedDB key is not allowed here as a key does not support
+ *   the object type which is needed for a key path.
+ * @returns {DocumentFragment}
  */
-export const getFormatAndSchemaChoices = ({schema, hasKeyPath}) => {
+export const getFormatAndSchemaChoices = ({schema, hasKeyPath} = {}) => {
   const hasSchema = typeof schema === 'string';
   return [
     ['JSON only', {value: 'json'}],
@@ -44,24 +47,34 @@ export const getFormatAndSchemaChoices = ({schema, hasKeyPath}) => {
         }]
     */
   ].map(([optText, optAtts]) => {
-    return ['option', optAtts, [optText]];
-  });
+    return jml('option', optAtts, [optText]);
+  }).reduce((frag, option) => {
+    frag.append(option);
+    return frag;
+  }, document.createDocumentFragment());
 };
 /**
  * Builds a selector and container for types.
  * @param {object} cfg
- * @param {string} cfg.schema The schema name
- * @param {object} cfg.schemaContent The schema content
- * @param {boolean} cfg.hasValue If false and `hasKeyPath` is `true`,
- *   will initialize with an object
- * @param {boolean} cfg.singleValue
- * @param {boolean} cfg.hasKeyPath
- * @param {string} cfg.typeNamespace
- * @returns {{
+ * @param {string} [cfg.schema] The schema name (NOT IN USE)
+ * @param {object} [cfg.schemaContent] The schema content (NOT IN USE)
+ * @param {boolean} [cfg.hasValue] Set to `true` if you are supplying
+ *   your own value. If `false` and `hasKeyPath` is `true`,
+ *   will initialize with an object.
+ * @param {boolean} [cfg.singleValue] (NOT IN USE)
+ * @param {boolean} [cfg.hasKeyPath] If this is set (because there is a keyPath
+ *   to be found within the object) and `hasValue` is true, an object type
+ *   will be set and required at the root level. This option will also
+ *   prevent selection of indexedDB key at root (since a key cannot be a
+ *   plain object).
+ * @param {string} [cfg.typeNamespace] Used to prevent conflicts with other
+ *   instances of typeChoices on the page
+ * @returns {[
  *   mainTypeChoices: HTMLSelectElement,
  *   typesHolder: HTMLDivElement
- * }} The selector for types and the container for them
+ * ]} The selector for types and the container for them. Both should be
+ *   added to the page.
  */
 function typeChoices ({
   schema,
@@ -81,7 +94,6 @@ function typeChoices ({
         this.$buildTypeChoices();
       },
       $buildTypeChoices () {
-        const typesHolder = this.nextElementSibling;
         DOM.removeChildren(typesHolder);
         jml({'#': Formats.buildTypeChoices({
           topRoot: $e(typesHolder, 'div[data-type]'),
@@ -98,7 +110,7 @@ function typeChoices ({
     $on: {change () {
       this.$buildTypeChoices();
     }}
-  }, getFormatAndSchemaChoices({schema, hasKeyPath}));
+  }, [getFormatAndSchemaChoices({schema, hasKeyPath})]);
   const typesHolder = jml('div', {class: 'typesHolder', $custom: {
     $getTypeRoot () {
       return $e(this, 'div[data-type]');
@@ -119,7 +131,7 @@ function typeChoices ({
     schemaContent
   })}, typesHolder);
-  return {mainTypeChoices, typesHolder};
+  return [mainTypeChoices, typesHolder];
 }
 export default typeChoices;

package/src/types.js CHANGED Viewed

@@ -1,7 +1,7 @@
-import {jml} from '../node_modules/jamilih/dist/jml-es.js';
+import {jml} from '../vendor/jamilih/dist/jml-es.js';
 import {
   Typeson, getJSONType, structuredCloningThrowing
-} from '../node_modules/typeson-registry/dist/index.js';
+} from '../vendor/typeson-registry/dist/index.js';
 import Formats from './formats.js';

package/src/utils/dialogs.js CHANGED Viewed

@@ -1,5 +1,5 @@
 /* eslint-disable promise/avoid-new */
-import {jml, nbsp} from '../../node_modules/jamilih/dist/jml-es.js';
+import {jml, nbsp} from '../../vendor/jamilih/dist/jml-es.js';
 import {$e} from './templateUtils.js';
 const localeStrings = {