textbrowser 0.41.2 → 0.42.0

package/.eslintignore

@@ -1,4 +1,3 @@
 files-to-incorporate-and-delete
 node_modules
 dist
-server/main-cjs.js

package/CHANGES.md

@@ -1,5 +1,11 @@
 # textbrowser CHANGES
 
+## 0.42.0
+
+- BREAKING CHANGE: refactor: Native ESM (plugins must be ESM also)
+- chore: removes babel/register, `url-search-params-polyfill` and dialog-polyfill
+- chore: bumps @babel/core (patch) and `simple-get-json` (minor), pins rtl-detect
+
 ## 0.41.2
 
 - fix: fix dialog polyfill CSS link

package/README.md

@@ -1,8 +1,12 @@
 # TextBrowser
 
 *Please note that this project, while now preliminarily functional,
-is in its early stages. There are some bugs to iron out such as
-with localization.*
+is in its early stages. It is currently unstyled, Chromium-only, and
+potentially intimidating to those unfamiliar with how to work it. There are
+also some bugs to iron out such as with localization.*
+
+See the [web app within an app using TextBrowser](https://bahai-browser.org/)
+or see some videos [introducing the app](https://bahai-library.com/zamir_textbrowser_bahaiwritings_browser).
 
 *TextBrowser* supports power-user browsing of arbitrary multi-linear
 texts following the "offline first" motto.
@@ -172,15 +176,15 @@ project.
 
 Projects derivative to *TextBrowser* will need to adhere to the following:
 
-1.  Add the *TextBrowser* dependency per the [Installation](#Installation)
+1.  Add the *TextBrowser* dependency per the [Installation](#installation)
     section.
 
 1.  Prepare JSON data files, JSON Schema files, and JSON meta-data files
     to represent your texts. See the section
-    [JSON Formats](#JSON Formats).
+    [JSON Formats](#json-formats).
     To provide a common naming mechanism across projects and to avoid
     the need to tweak the default `TextBrowser` JavaScript class set-up, a
-    [specific directory structure](#Recommended Project Directory Structure)
+    [specific directory structure](#recommended-project-directory-structure)
     is recommended for hosting these files.
 
 1.  Prepare JSON files to indicate the specific grouping of files you wish
@@ -188,13 +192,13 @@ Projects derivative to *TextBrowser* will need to adhere to the following:
     make available (and for which you have locales), and after it may be
     ready, and if you wish, the JSON files to indicate your site hierarchy.
     See the
-    [recommended directory structure](#Recommended Project Directory Structure)
+    [recommended directory structure](#recommended-project-directory-structure)
     section for more.
 
 1.  Create an HTML page (see `index-sample.html` for an example) which includes
     *TextBrowser*'s own project scripts and your own script to instantiate
     the `TextBrowser` class (and if you did not follow the
-    [recommended directory structure](#Recommended Project Directory Structure),
+    [recommended directory structure](#recommended-project-directory-structure),
     you will need to point to the above-mentioned JSON
     files). Page titles are set dynamically for each page, so there is no
     need to provide a `<title>`.
@@ -225,9 +229,9 @@ The recommended project directory structure (which are used by default by the
     service worker
 -   ***plugins/*** - While *not yet in use*, this is the convention we wish
     to begin enforcing for hosting plugins (e.g., for automated columns).
-    See [Plugin Format](#Plugin Format).
+    See [Plugin Format](#plugin-format).
 -   ***sw.js*** - Although you can change the name of this file via
-    `serviceWorkerPath` (see [JavaScript API](#JavaScript API)), this
+    `serviceWorkerPath` (see [JavaScript API](#javascript-api)), this
     file should be at or higher than the files you are caching (including
     *TextBrowser*'s). Copying `sw-sample.js` as `sw.js` at your project
     root is the recommended approach.
@@ -236,18 +240,18 @@ The recommended project directory structure (which are used by default by the
     file group, and within each file group, have the JSON data files
     as well as "schema" and "metadata" subdirectories containing the
     specific JSON schemas for each data file and the
-    *TextBrowser*-specific meta-data files. See [JSON Formats](#JSON Formats).
--   ***files.json*** - See [JSON Formats](#JSON Formats).
--   ***site.json*** - See [JSON Formats](#JSON Formats).
+    *TextBrowser*-specific meta-data files. See [JSON Formats](#json-formats).
+-   ***files.json*** - See [JSON Formats](#json-formats).
+-   ***site.json*** - See [JSON Formats](#json-formats).
 -   ***locales/*** - Only needed if providing an alternate to *TextBrowser*'s
     own built-in `locales/`. It is recommended to rely on the default
     files and not add any custom files (contributing back here any
     localization fixes or additions you may have done!). See
-    [JSON Formats](#JSON Formats).
+    [JSON Formats](#json-formats).
 -   ***languages.json*** - As with `locales/`, only needed if providing an
     alternate to *TextBrowser*'s own built-in `appdata/languages.json` file.
     It is recommended to rely on the default and not add any custom file. See
-    [JSON Formats](#JSON Formats).
+    [JSON Formats](#json-formats).
 
 ## JSON Formats
 
@@ -280,9 +284,9 @@ and its simple
 to which they adhere):
 
 1. A `schema` JSON reference pointer to your data's JSON schema.
-    See [JSON Schema](#JSON Schema).
+    See [JSON Schema](#json-schema).
 2. A `metadata` JSON reference pointer to your data's JSON metadata.
-    See [JSON Metadata](#JSON Metadata).
+    See [JSON Metadata](#json-metadata).
 3. A `data` property which is an an array of arrays containing your tabular
     text itself. This property must adhere to the specific JSON schema
     referenced in the `schema` property above for this file.
@@ -433,7 +437,7 @@ Its keys are plug-in names and whose value objects have the required property
 code string. There may also be a `meta` key which is used to pass data to the
 plug-in. This object currently only allows string keys.
 
-See [Plugin Format](#Plugin Format) for the structure of the plug-in pointed
+See [Plugin Format](#plugin-format) for the structure of the plug-in pointed
 to by the path.
 
 The `plugin-field-mapping` object property has keys which act as groups and
@@ -458,7 +462,7 @@ changes you may need of the generic localizations within `locales/` and
 `appdata/languages.json`, if you need to provide your own interface
 localization, you may supply a `languages` property when creating the
 `TextBrowser` object to point to a languages JSON file of your own
-choosing (see the [JavaScript API](#JavaScript API)).
+choosing (see the [JavaScript API](#javascript-api)).
 
 *TextBrowser* comes with the `languages.json` file at
 [`appdata/languages.json`](https://github.com/brettz9/textbrowser/blob/master/appdata/languages.json) which, as mentioned, is used by default. It adheres to
@@ -725,7 +729,7 @@ The properties are:
 - `userStaticFiles` - Array of files additional to those of
     *TextBrowser* which you will need offline. Defaults to the minimum
     recommended files:
-    `['/',  'index.html', 'files.json', 'site.json', 'resources/user.js', 'resources/user.css']`
+    `['/',  'index.html', 'files.json', 'site.json', 'resources/user.js']`
 
 ## Server API
 

package/dist/WorkInfo-es.js

@@ -4400,14 +4400,6 @@ class PluginsForWork {
   }
 }
 
-let path, babelRegister;
-if (typeof process !== 'undefined') {
-  /* eslint-disable node/global-require */
-  path = require('path');
-  babelRegister = require('@babel/register');
-  /* eslint-enable node/global-require */
-}
-
 const getWorkFiles = async function getWorkFiles (files = this.files) {
   const filesObj = await getJSON$1(files);
   const dataFiles = [];
@@ -4532,20 +4524,6 @@ const getWorkData = async function ({
     getPlugins
       ? Promise.all(
         pluginPaths.map((pluginPath) => {
-          if (typeof process !== 'undefined') {
-            pluginPath = path.resolve(path.join(
-              process.cwd(), 'node_modules/textbrowser/server', pluginPath
-            ));
-            babelRegister({
-              presets: ['@babel/env']
-            });
-            return Promise.resolve().then(() => {
-              return require(pluginPath); // eslint-disable-line node/global-require, import/no-dynamic-require
-            }).catch((err) => {
-              // E.g., with tooltips plugin
-              console.log('err', err);
-            });
-          }
           // eslint-disable-next-line no-unsanitized/method
           return import(pluginPath);
         })