encoding-tools 0.0.1 → 0.0.2

package/README.md

@@ -0,0 +1,85 @@
+[comment]: <> (SPDX-License-Identifier: AGPL-3.0)
+
+[comment]: <> (------------------------------------------------------)
+[comment]: <> (Copyright © 2024, 2025, 2026  Pellegrino Prevete)
+[comment]: <> (All rights reserved)
+[comment]: <> (------------------------------------------------------)
+
+[comment]: <> (This program is free software: you can redistribute)
+[comment]: <> (it and/or modify it under the terms of the GNU Affero)
+[comment]: <> (General Public License as published by the Free)
+[comment]: <> (Software Foundation, either version 3 of the License.)
+
+[comment]: <> (This program is distributed in the hope that it will be)
+[comment]: <> (useful, but WITHOUT ANY WARRANTY; without even the)
+[comment]: <> (implied warranty of MERCHANTABILITY or FITNESS FOR)
+[comment]: <> (A PARTICULAR PURPOSE. See the)
+[comment]: <> (See the GNU Affero General Public License for)
+[comment]: <> (more details.)
+
+[comment]: <> (You should have received a copy of the GNU Affero)
+[comment]: <> (General Public License along with this program.)
+[comment]: <> (If not, see <https://www.gnu.org/licenses/>.)
+
+# Encoding Tools (`encoding-tools.js`)
+
+Simple, easy to read and use collection of Javascript
+encoding tools.
+
+This collection is the Javascript programming
+language implementation of
+[Encoding Tools](
+  https://github.com/themartiancompany/encoding-tools),
+in which it is included.
+
+The tools are a dependency for the
+[Ethereum Virtual Machine File System](
+  https://github.com/themartiancompany/evmfs)
+and for the uncensorable Twitter.
+
+They depend on the `base64` encoding tool
+and the
+[Crash Javascript](
+  https://github.com/themartiancompany/crash-js)
+library.
+
+## Installation
+
+The tools in this source repo
+can be installed from source using GNU Make.
+
+```bash
+make \
+  install
+```
+
+The collection has been officially published
+on the the uncensorable
+[Ur](
+  https://github.com/themartiancompany/ur)
+user repository and application store as
+`encoding-tools`.
+The source code is published on the
+[Ethereum Virtual Machine File System](
+  https://github.com/themartiancompany/evmfs)
+so it can't possibly be taken down.
+
+To install it from there just type
+
+```bash
+ur \
+  encoding-tools
+```
+
+A censorable HTTP Github mirror of the recipe published there,
+containing a full list of the software dependencies needed to run the
+tools is hosted on
+[encoding-tools-ur](
+  https://github.com/themartiancompany/encoding-tools-ur).
+Be aware the mirror could go offline any time as Github and more
+in general all HTTP resources are inherently unstable and censorable.
+
+## License
+
+This program is released by Pellegrino Prevete under the terms
+of the GNU Affero General Public License version 3.

package/bin2txt

@@ -2,56 +2,110 @@
 
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
-//    ----------------------------------------------------------------------
-//    Copyright © 2024, 2025  Pellegrino Prevete
-//
-//    All rights reserved
-//    ----------------------------------------------------------------------
-//
-//    This program is free software: you can redistribute it and/or modify
-//    it under the terms of the GNU Affero General Public License as published by
-//    the Free Software Foundation, either version 3 of the License, or
-//    (at your option) any later version.
-//
-//    This program is distributed in the hope that it will be useful,
-//    but WITHOUT ANY WARRANTY; without even the implied warranty of
-//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//    GNU Affero General Public License for more details.
-//
-//    You should have received a copy of the GNU Affero General Public License
-//    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+/**    ----------------------------------------------------------------
+ *     bin2txt
+ *     ----------------------------------------------------------------
+ *     Copyright ©
+ *       Pellegrino Prevete
+ *         2024, 2025, 2026
+ * 
+ *     All rights reserved
+ *     ----------------------------------------------------------------
+ * 
+ *     This program is free software: you can redistribute it and/or
+ *     modify it under the terms of the GNU General Public License as
+ *     published by the Free Software Foundation, either version 3 of
+ *     the License, or (at your option) any later version.
+ * 
+ *     This program is distributed in the hope that it will be useful,
+ *     but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *     GNU General Public License for more details.
+ * 
+ *     You should have received a copy of the GNU General Public License
+ *     along with this program.
+ *     If not, see <https://www.gnu.org/licenses/>.
+ */
 
 const
   _libcrash =
   require(
     'crash-js');
-_cmdline_check =
-  _libcrash._cmdline_check;
-_msg_info =
-  _libcrash._msg_info;
-_msg_error =
-  _libcrash._msg_error;
+/* global
+     _cmdline_check */
+const
+  _cmdline_check =
+    _libcrash._cmdline_check;
+/* global
+     _msg_info */
+const
+  _msg_info =
+    _libcrash._msg_info;
+/* global
+     _msg_error */
+const
+  _msg_error =
+    _libcrash._msg_error;
+/* global
+     _argv_get */
+const
+_argv_get =
+  _libcrash._argv_get;
+
 const
   _encoding_tools =
     require(
       "./encoding-tools");
+/* global
+     _bin2txt */
 _bin2txt =
   _encoding_tools._bin2txt;
 
 function
   _global_variables() {
+  /* global
+       app_name:
+         writable */
   app_name =
     "bin2txt";
+  /* global
+       app_opts:
+         writable */
+  app_opts =
+    [];
+  /* global
+       encoding_format:
+         writable */
   encoding_format =
     "";
+  /* global
+       buffer_size:
+         writable */
   buffer_size =
     "";
+  /* global
+       string_length:
+         writable */
   string_length =
     "";
+  /* global
+       in_file:
+         writable */
   in_file =
     "";
+  /* global
+       out_txt_prefix:
+         writable */
   out_txt_prefix =
     "";
+  /* global
+       amount_only:
+         writable */
+  amount_only =
+    "";
+  /* global
+       quiet:
+         writable */
   quiet =
     "";
 }
@@ -137,7 +191,7 @@ function
     "     -v --verbose                    Enable verbose output."
   ];
   for ( _line of _text ) {
-    _msg_info(
+    console.log(
       _line);
   }
   process.exit(
@@ -148,25 +202,29 @@ function
   _cmdline_parse() {
   let
     _argv,
+    _help_display,
     _msg;
   _argv =
-    _yargv_get();
+    _argv_get();
   quiet = 
     "y";
   runtime_environment =
     "node";
-  help_display =
-    _argv[
-      "help"] ||
-    _argv[
-      "h"];
-  if ( help_display ) {
+  if ( "help" in _argv ||
+       "h" in _argv) {
+    _help_display =
+      true;
+  }
+  if ( _help_display ) {
     quiet =
       "n";
     _usage(
       0);
   }
-  if ( _argv[
+  console.log(_argv);
+  if ( typeof(
+         _argv) == "undefined" ||
+       _argv[
          "_"].length < 1 ) {
     _msg =
       "Input file argument required.";
@@ -183,7 +241,8 @@ function
   if ( _argv[
          "_"].length < 2 ) {
     out_txt_prefix =
-      in_file + ".base64"
+      in_file +
+      ".base64";
   }
   if ( "s" in _argv ) {
     string_length =
@@ -238,12 +297,9 @@ function
 
 _global_variables();
 if ( _cmdline_check(
-       "bin2txt") == true ) {
+       "bin2txt.js") == true ) {
   _cmdline_parse();
 }
-else {
-  _url_parse();
-}
 _config_show();
 app_opts = [
   in_file,

package/fs-worker.js

@@ -0,0 +1 @@
+(()=>{var e={816(e,o,n){function t(){let e;return"undefined"==typeof window&&void 0!==n.g&&n.g.global===n.g&&"function"!=typeof n||(e=function(){let e;try{e=n(816)}catch(e){console.log(e);const o="Error importing the '@themartiancompany/opfs' module as 'opfs'. If you got this error while bundling a webpack for a project depending on this module double check its 'webpack.config.js' file or whether the 'opfs' module is listed in developer dependencies and install them.I'm sorry for this inconvenience but Node packagement system does not currently distinguish 'development' from 'build' dependencies.";throw console.error(o),e}return e}()),e}const r=t();e.exports=r,e.exports.getModule=function(e){let o;if(""==_module_name||"undefined"==typeof _module_name)o=t();else if("opfs"==_module_name)o=n(816);else{if("fs"!=_module_name){const e="Unknown file system module "+`'${_module_name}'.`.const;throw _error={msg:e},console.error(e),_error}o=n(816)}return o}},314(e,o,n){const t=n(816);_sync_agent=t.startSyncAgent,e.exports={_sync_agent},_sync_agent()}},o={};function n(t){var r=o[t];if(void 0!==r)return r.exports;var s=o[t]={exports:{}};return e[t](s,s.exports,n),s.exports}n.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),n(314)})();

package/libbin2txt

@@ -2,51 +2,112 @@
 
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
-//    ----------------------------------------------------------------------
-//    Copyright © 2024, 2025  Pellegrino Prevete
-//
-//    All rights reserved
-//    ----------------------------------------------------------------------
-//
-//    This program is free software: you can redistribute it and/or modify
-//    it under the terms of the GNU Affero General Public License as
-//    published by the Free Software Foundation, either version 3 of
-//    the License, or (at your option) any later version.
-//
-//    This program is distributed in the hope that it will be useful,
-//    but WITHOUT ANY WARRANTY; without even the implied warranty of
-//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//    GNU Affero General Public License for more details.
-//
-//    You should have received a copy of the GNU Affero General Public License
-//    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+/**    ----------------------------------------------------------------
+ *     libbin2txt
+ *     ----------------------------------------------------------------
+ *     Copyright ©
+ *       Pellegrino Prevete
+ *         2024, 2025, 2026
+ * 
+ *     All rights reserved
+ *     ----------------------------------------------------------------
+ * 
+ *     This program is free software: you can redistribute it and/or
+ *     modify it under the terms of the GNU General Public License as
+ *     published by the Free Software Foundation, either version 3 of
+ *     the License, or (at your option) any later version.
+ * 
+ *     This program is distributed in the hope that it will be useful,
+ *     but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *     GNU General Public License for more details.
+ * 
+ *     You should have received a copy of the GNU General Public License
+ *     along with this program.
+ *     If not, see <https://www.gnu.org/licenses/>.
+ */
 
 const
   _libcrash =
   require(
     'crash-js');
-_error_display =
-  _libcrash._error_display;
-_ext_rm =
-  _libcrash._ext_rm;
-_file_read =
-  _libcrash._file_read;
-_file_write =
-  _libcrash._file_write;
-_fs_worker_start =
-  _libcrash._fs_worker_start;
-_json_read =
-  _libcrash._json_read;
-_ls =
-  _libcrash._ls;
-_mkdir =
-  _libcrash._mkdir;
-_msg_info =
-  _libcrash._msg_info;
-_msg_error =
-  _libcrash._msg_error;
-_split =
-  _libcrash._split;
+const
+  _error_display =
+    _libcrash._error_display;
+const
+  _ext_rm =
+    _libcrash._ext_rm;
+const
+  _file_read =
+    _libcrash._file_read;
+const
+  _file_write =
+    _libcrash._file_write;
+const
+  _fs_worker_start =
+    _libcrash._fs_worker_start;
+const
+  _json_read =
+    _libcrash._json_read;
+const
+  _ls =
+    _libcrash._ls;
+const
+  _mkdir =
+    _libcrash._mkdir;
+const
+  _msg_info =
+    _libcrash._msg_info;
+const
+  _msg_error =
+    _libcrash._msg_error;
+const
+  _split =
+    _libcrash._split;
+const
+  _stat =
+    _libcrash._stat;
+
+async function
+  _buffer_prepare(
+    _in,
+    _out,
+    _buffer_size_bytes) {
+  let
+    _in_size_bytes,
+    _split_opts,
+    _msg;
+  _split_opts =
+    [];
+  console.log(
+    _stat);
+  console.log(
+    _in);
+  console.log(
+    _out);
+  // _in_size_bytes="$( \
+  //   du \
+  //     -bs \
+  //     "${_in}" | \
+  //     awk \
+  //       '{print $1}')"
+  // _msg=(
+  //   "File '${_in}' has size"
+  //   "'${_in_size_bytes}' bytes."
+  // )
+  // _msg_info \
+  //   "${_msg[*]}"
+  // _blocks_total="$(( \
+  //   _in_size_bytes / _buffer_size_bytes + 1))"
+  // split \
+  //   -n \
+  //     "l/${_blocks_total}" \
+  //   --numeric-suffixes="1" \
+  //   "${_in}" \
+  //   "${_out}.block."
+  // _blocks_find \
+  //   "${_out}.block"
+}
 
 async function
   _bin2txt(
@@ -76,13 +137,21 @@ async function
     await _fs_worker_start(
         "fs-worker.js");
   }
-  _split(
-    "red-sun-in-the-sky.mp4",
-    2,
-
-  console.log(
-    _split
-  );
+  _buffer_prepare(
+    _in,
+    _out,
+    _buffer_size_bytes);
+  // _split(
+  //   "",
+  //   2);
+  // _split(
+  //   _input_file,
+  //   _output_prefix,
+  //   _chunks_amount,
+  //   _size_max) {
+  // console.log(
+  //   _split
+  // );
   // _msg =
   //   `Creating directory '${_dir}':`;
   // _msg_info(

package/libtxt2bin

@@ -2,24 +2,30 @@
 
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
-//    ----------------------------------------------------------------------
-//    Copyright © 2024, 2025  Pellegrino Prevete
-//
-//    All rights reserved
-//    ----------------------------------------------------------------------
-//
-//    This program is free software: you can redistribute it and/or modify
-//    it under the terms of the GNU Affero General Public License as published by
-//    the Free Software Foundation, either version 3 of the License, or
-//    (at your option) any later version.
-//
-//    This program is distributed in the hope that it will be useful,
-//    but WITHOUT ANY WARRANTY; without even the implied warranty of
-//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//    GNU Affero General Public License for more details.
-//
-//    You should have received a copy of the GNU Affero General Public License
-//    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+/**    ----------------------------------------------------------------
+ *     libtxt2bin
+ *     ----------------------------------------------------------------
+ *     Copyright ©
+ *       Pellegrino Prevete
+ *         2024, 2025, 2026
+ * 
+ *     All rights reserved
+ *     ----------------------------------------------------------------
+ * 
+ *     This program is free software: you can redistribute it and/or
+ *     modify it under the terms of the GNU General Public License as
+ *     published by the Free Software Foundation, either version 3 of
+ *     the License, or (at your option) any later version.
+ * 
+ *     This program is distributed in the hope that it will be useful,
+ *     but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *     GNU General Public License for more details.
+ * 
+ *     You should have received a copy of the GNU General Public License
+ *     along with this program.
+ *     If not, see <https://www.gnu.org/licenses/>.
+ */
 
 const
   _libcrash =

package/package.json

@@ -2,7 +2,7 @@
   "name":
     "encoding-tools",
   "version":
-    "0.0.1",
+    "0.0.2",
   "description":
     "A multi-language collection of encoding tools.",
   "funding": {
@@ -11,16 +11,18 @@
     "url":
       "https://patreon.com/tallero"
   },
-  "man":
-    "./man/ahsi.1",
+  "man": [
+    "./man/bin2txt.js.1",
+    "./man/txt2bin.js.1"
+  ],
   "files": [
     "AUTHORS.rst",
     "COPYING",
     "README.md",
     "bin2txt",
+    "encoding-tools",
     "libbin2txt",
     "libtxt2bin",
-    "ahsi",
     "fs-worker.js",
     "fs-worker.webpack.config.js",
     "index.html",
@@ -57,8 +59,14 @@
       "https://github.com/tallero"
   },
   "devDependencies": {
+    "crash-js-webpack":
+      "^0.0.3",
     "eslint":
-      "^9.32.0",
+      "^10.0.3",
+    "globals":
+      "^17.3.0",
+    "@eslint/js":
+      "^10.0.1",
     "safely-serve":
       "^0.0.9",
     "webpack":
@@ -68,9 +76,9 @@
   },
   "dependencies": {
     "crash-js":
-      "^0.1.51",
+      "^0.1.76",
     "tmcsplit":
-      "^0.0.2",
+      "^0.0.4",
     "yargs":
       "18.0.0"
   },
@@ -78,15 +86,24 @@
     "commonjs",
   "main":
     "encoding-tools",
+  "bin":
+    { "bin2txt.js":
+        "bin2txt" },
   "scripts": {
+    "build-fs-worker":
+      "npx webpack --mode 'production' --config 'fs-worker.webpack.config.cjs' --stats-error-details",
+    "build-lib":
+      "npx webpack --mode 'production' --config 'libbin2txt.webpack.config.cjs' --stats-error-details && npx webpack --mode 'production' --config 'libtxt2bin.webpack.config.cjs' --stats-error-details",
+    "build-bin":
+      "npx webpack --mode 'production' --config 'bin2txt.webpack.config.cjs' --stats-error-details && npx webpack --mode 'production' --config 'txt2bin.webpack.config.cjs' --stats-error-details",
     "build":
-      "cd ../.. && make build-npm && encoding-tools/nodejs",
+      "npm run lint && npm run build-fs-worker && npm run build-lib && npm run build-bin",
     "lint":
       "npx eslint .",
-    "publish-npm":
+    "publish-pnm":
       "npm run build && npm publish --access public",
     "start":
-      "serve -c 'serve.json'",
+      "npx safely-serve --help # index.html --port 3000 --https --no-cache",
     "test":
       "echo \"Error: no test specified\" && exit 1"
   }

package/txt2bin

@@ -2,24 +2,30 @@
 
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
-//    ----------------------------------------------------------------------
-//    Copyright © 2024, 2025  Pellegrino Prevete
-//
-//    All rights reserved
-//    ----------------------------------------------------------------------
-//
-//    This program is free software: you can redistribute it and/or modify
-//    it under the terms of the GNU Affero General Public License as published by
-//    the Free Software Foundation, either version 3 of the License, or
-//    (at your option) any later version.
-//
-//    This program is distributed in the hope that it will be useful,
-//    but WITHOUT ANY WARRANTY; without even the implied warranty of
-//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//    GNU Affero General Public License for more details.
-//
-//    You should have received a copy of the GNU Affero General Public License
-//    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+/**    ----------------------------------------------------------------
+ *     txt2bin
+ *     ----------------------------------------------------------------
+ *     Copyright ©
+ *       Pellegrino Prevete
+ *         2024, 2025, 2026
+ * 
+ *     All rights reserved
+ *     ----------------------------------------------------------------
+ * 
+ *     This program is free software: you can redistribute it and/or
+ *     modify it under the terms of the GNU General Public License as
+ *     published by the Free Software Foundation, either version 3 of
+ *     the License, or (at your option) any later version.
+ * 
+ *     This program is distributed in the hope that it will be useful,
+ *     but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *     GNU General Public License for more details.
+ * 
+ *     You should have received a copy of the GNU General Public License
+ *     along with this program.
+ *     If not, see <https://www.gnu.org/licenses/>.
+ */
 
 const
   _libcrash =