@lumjs/encode 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -6,10 +6,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.0] - 2022-10-18
+### Changed
+- Added a link to the PHP version in the README.
+- Bumped `@lumjs/core` to `1.7.1`.
+- Refactored default module to use `ModuleBuilder` and lazy-loading.
+### Fixed
+- A typo in a DocBlock.
+
 ## [1.0.0] - 2022-09-30
 ### Added
 - Initial release.
 
-[Unreleased]: https://github.com/supernovus/lum.encode.js/compare/v1.0.0...HEAD
+[Unreleased]: https://github.com/supernovus/lum.encode.js/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/supernovus/lum.encode.js/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/supernovus/lum.encode.js/releases/tag/v1.0.0
-

package/README.md

@@ -2,6 +2,10 @@
 
 A bunch of encoding libraries.
 
+Among other things, it offers a pure JS implementation of my 
+[Safe64](https://github.com/supernovus/lum.encode.php)
+data serialization and encoding format.
+
 ## Official URLs
 
 This library can be found in two places:

package/lib/base64.js

@@ -44,7 +44,7 @@ exports.encode = function(rawdata, stringFormat=Utf8)
  * 
  * If this is `false`, we'll return a `WordArray` object.
  *
- * @return {(string|WordArray))} The decoded output.
+ * @return {(string|WordArray)} The decoded output.
  */
 exports.decode = function(string, stringFormat=Utf8)
 {

package/lib/index.js

@@ -3,6 +3,8 @@
  * @module @lumjs/encode
  */
 
+const {can,from} = require('@lumjs/core').buildModule(module);
+
 /**
  * @name module:@lumjs/encode.ord
  * @function
@@ -14,40 +16,34 @@
  * @function
  * @see {@link module:@lumjs/encode/util.numByteArray}
  */
-
-const {ord, numByteArray} = require('./util');
+from('./util', 'ord', 'numByteArray');
 
 /**
+ * @name module:@lumjs/encode.Base64
  * @see {@link module:@lumjs/encode/base64}
- * @alias module:@lumjs/encode.Base64
  */
-const Base64 = require('./base64');
+can('Base64', true);
 
 /**
+ * @name module:@lumjs/encode.Base91
  * @see {@link module:@lumjs/encode/base91}
- * @alias module:@lumjs/encode.Base91
  */
-const Base91 = require('./base91');
+can('Base91', true);
 
 /**
+ * @name module:@lumjs/encode.Safe64
  * @see {@link module:@lumjs/encode/safe64}
- * @alias module:@lumjs/encode.Safe64
  */
-const Safe64 = require('./safe64');
+can('Safe64', true);
 
 /**
+ * @name module:@lumjs/encode.Hash
  * @see {@link module:@lumjs/encode/hash}
- * @alias module:@lumjs/encode.Hash
  */
-const Hash = require('./hash');
+can('Hash', true);
 
 /**
+ * @name module:@lumjs/encode.Crypto
  * @see {@link module:@lumjs/encode/crypto}
- * @alias module:@lumjs/encode.Crypto
  */
-const Crypto = require('./crypto');
-
-module.exports = exports = 
-{
-  ord, numByteArray, Base64, Safe64, Base91, Hash, Crypto,
-}
+can('Crypto', true);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lumjs/encode",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "main": "lib/index.js",
   "exports":
   {
@@ -22,7 +22,7 @@
     "url": "https://github.com/supernovus/lum.encode.js.git"
   },
   "dependencies": {
-    "@lumjs/core": "^1.5.1",
+    "@lumjs/core": "^1.7.1",
     "crypto-js": "^4.1.1",
     "php-serialize": "^4.0.2",
     "@shelacek/ubjson": "^1.1.1"

package/ub-dev.js

@@ -1,11 +0,0 @@
-#!/usr/bin/env node
-
-const UB = require('@shelacek/ubjson');
-
-const data = {hello:["world","darkness my old friend"]};
-const ubj = UB.encode(data);
-
-console.log("Size:", ubj.byteLength);
-const utf8 = new TextDecoder().decode(ubj);
-console.log("UTF-8:", utf8);
-console.log("JSON:", JSON.stringify(utf8));