@lumjs/core 1.3.0 → 1.3.1

package/docs/changelogs/1.0-beta.md

@@ -1,13 +1,8 @@
-# Changelog
-All notable changes to this project will be documented in this file.
+# Changelog → 1.0-beta.x
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+This is the changelog for the `1.0-beta.x` versions.
 
-## Note
-
-This is the *Changelog* for the `1.0.0-beta.x` releases.
-See [1.x.md](1.x.md) for the stable `1.x` *Changelog*.
+See [Changelogs](index.md) for more information on the changelogs.
 
 ## [1.0.0-beta.6]
 - This is the **final** beta version. 
@@ -96,4 +91,3 @@ See [1.x.md](1.x.md) for the stable `1.x` *Changelog*.
 [1.0.0-beta.3]: https://github.com/supernovus/lum.core.js/compare/v1.0.0-beta.2...v1.0.0-beta.3
 [1.0.0-beta.2]: https://github.com/supernovus/lum.core.js/compare/v1.0.0-beta.1...v1.0.0-beta.2
 [1.0.0-beta.1]: https://github.com/supernovus/lum.core.js/releases/tag/v1.0.0-beta.1
-

package/docs/changelogs/1.x.md

@@ -1,11 +1,21 @@
-# Changelog
-All notable changes to this project will be documented in this file.
+# Changelog → 1.x
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+This is the changelog for the `1.x` versions.
+
+See [Changelogs](index.md) for more information on the changelogs.
 
 ## [Unreleased]
 
+## [1.3.1] - 2022-09-23
+### Fixed
+- The `arrays` module exports `powerset` and `random` as it should.
+- Recursive dependency order issues with `clone`, `lock`, and `enum` resolved.
+- Custom `lock` options in `enum` module actually work now.
+### Changed
+- The `Enum()` function now has `configurable` and `enumerable` options.
+- The `configurable` property in `enums` defaults to `false` now.
+- Tweaked the *changelogs* a bit and added a new [changelog listing](index.md).
+
 ## [1.3.0] - 2022-09-11
 ### Changed
 - Overhauled the `obj.clone()` method.
@@ -62,13 +72,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Initial *stable* release.
 - See [1.0-beta.md](1.0-beta.md) for the beta versions of `1.0`
-- See [lum.js](https://github.com/supernovus/lum.js) for the original library this is replacing.
+- See [lum.js](https://github.com/supernovus/lum.js) for the original library set this is replacing.
 
-[Unreleased]: https://github.com/supernovus/lum.core.js/compare/v1.3.0...HEAD
+[Unreleased]: https://github.com/supernovus/lum.core.js/compare/v1.3.1...HEAD
+[1.3.1]: https://github.com/supernovus/lum.core.js/compare/v1.3.0...v1.3.1
 [1.3.0]: https://github.com/supernovus/lum.core.js/compare/v1.2.1...v1.3.0
 [1.2.1]: https://github.com/supernovus/lum.core.js/compare/v1.2.0...v1.2.1
 [1.2.0]: https://github.com/supernovus/lum.core.js/compare/v1.1.1...v1.2.0
 [1.1.1]: https://github.com/supernovus/lum.core.js/compare/v1.1.0...v1.1.1
 [1.1.0]: https://github.com/supernovus/lum.core.js/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/supernovus/lum.core.js/releases/tag/v1.0.0
-

package/docs/changelogs/index.md

@@ -0,0 +1,19 @@
+# Changelogs
+
+All notable changes to this project will be documented in these files.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Versions
+
+To avoid the changelogs getting too big, I'm planning on splitting them up based
+on the major version changes.
+
+Each major version will be listed here in reverse chronological order (newest first.)
+
+- [1.x](1.x.md) → The first standalone core library.
+- [1.0-beta.x](1.0-beta.md)
+  → The *pre-releases* from when this split off of the older 
+  [Lum.js](https://github.com/supernovus/lum.js) library collection.
+

package/lib/arrays.js

@@ -99,6 +99,8 @@ function powerset(array)
   return ps;
 }
 
+exports.powerset = powerset;
+
 /**
  * Get a random element from an array.
  * @param {Array} array  The array to get an item from.
@@ -109,3 +111,5 @@ function random(array)
 {
   return array[Math.floor(Math.random()*array.length)];
 }
+
+exports.random = random;

package/lib/enum.js

@@ -21,6 +21,9 @@ function Enum (spec, opts={})
 
   const anEnum = ENUM_ID.tag({});
 
+  const configurable = opts.configurable ?? false;
+  const enumerable   = opts.enumerable   ?? true;
+
   function getVal (name, def)
   {
     if (opts.symbols)
@@ -42,7 +45,7 @@ function Enum (spec, opts={})
 
   function addVal(pName, sName, inVal)
   {
-    const desc = {configurable: true, enumerable: true};
+    const desc = {configurable, enumerable};
     desc.value = getVal(sName, inVal);
     def(anEnum, pName, desc);
   }
@@ -83,25 +86,25 @@ function Enum (spec, opts={})
   }
 
   if (notNil(opts.lock))
-  { // Use lock.
+  { // Use lock() function.
     let lockOpts;
     if (Array.isArray(opts.lock))
-    {
+    { // Specified the lock parameters as an array.
       lockOpts = opts.lock;
     }
     else if (isObj(opts.lock))
-    {
+    { // An object is assumed to be the `cloneOpts` parameter.
       lockOpts = [true, opts.lock, false];
     }
     else if (typeof opts.lock === B)
-    {
+    { // Boolean is assumed to be the `cloneable` parameter.
       lockOpts = [opts.lock, null, false];
     }
     else 
-    {
-      lockOpts = [true, null, false];
+    { // Anything else we use default values.
+      lockOpts = [];
     }
-    return lock(anEnum);
+    return lock(anEnum, ...lockOpts);
   }
   else if (!opts.open) 
   { // Use Object.freeze()
@@ -138,3 +141,6 @@ def(Enum, 'is', isEnum);
 TYPES.add('ENUM', 'enum', isEnum, 'isEnum');
 
 module.exports = Enum;
+
+// Loading this at the end.
+const {lock} = require('./obj/lock');

package/lib/index.js

@@ -125,7 +125,7 @@ const def = types.def;
 
 module.exports =
 {
-  types, arrays, context, strings, flags, obj, opt, modules,
+  types, context, flags, obj, opt, modules, arrays, strings,
   def, randomNumber, InternalObjectId, Enum, lazy, observable,
-  stacktrace, AbstractClass, Functions, NYI,
+  stacktrace, AbstractClass, Functions, NYI, 
 }

package/lib/obj/clone.js

@@ -1,49 +1,7 @@
 // Import *most* required bits here.
-const {B,N,F, isObj, isComplex, def, isArray} = require('../types');
-const Enum = require('../enum');
+const {N,F, isObj, isComplex, def, isArray} = require('../types');
 const copyProps = require('./copyprops');
 const getProp = require('./getproperty');
-
-/**
- * An `enum` of supported *modes* for the `clone()` method.
- * 
- * - **P** → All properties. If unchecked, *enumerable* properties only.
- * - **A** → Uses `Array.slice()` shortcut for shallow `Array` cloning.
- * - **R** → Recursive (deep) cloning of nested objects.
- * - **D** → Uses *descriptor* cloning instead of direct assignment.
- * - **T** → Sets the `prototype` of the clone as well. 
- * 
- * | Mode | P | A | R | D | T | Notes |
- * | ---- | - | - | - | - | - | ----- |
- * | `CLONE.N` | × | × | × | × | × | Can be used to manually specify options. |
- * | `CLONE.DEF` | × | ✓ | × | × | × | Default mode for cloning functions. |
- * | `CLONE.DEEP` | × | × | ✓ | ✓ | × | |
- * | `CLONE.FULL` | ✓ | ✓ | × | ✓ | × | |
- * | `CLONE.ALL` | ✓ | × | × | ✓ | × | |
- * | `CLONE.ENTIRE` | ✓ | × | ✓ | ✓ | ✓ | |
- * | `CLONE.JSON` | - | - | ✓ | - | × | Uses JSON, so no `function` or `symbol` support. |
- * 
- * The `✓` and `×` marks signify the *default settings* in the mode.
- * In *most* cases there are options that can override the
- * defaults.
- * 
- * Any feature in the `CLONE.JSON` row marked with `-` are
- * incompatible with that mode and cannot be enabled at all.
- * 
- * @alias module:@lumjs/core/obj.CLONE
- */
- const CLONE = Enum(['N','DEF','FULL','ALL','DEEP','ENTIRE','JSON']);
-
- exports.CLONE = CLONE;
-
- // A list of modes that should use the array.slice shallow shortcut.
- const SLICE_ARRAYS = [CLONE.DEF, CLONE.FULL];
-
- // A list of modes that should get *all* properties.
- const ALL_PROPS = [CLONE.FULL, CLONE.ALL, CLONE.ENTIRE];
-
- // A list of modes that should do recursive cloning of objects.
- const RECURSIVE = [CLONE.DEEP, CLONE.ENTIRE];
  
  /**
   * Clone an object or function.
@@ -295,9 +253,6 @@ function clone(obj, opts={})
   return copy;
 }
 
-// Alias the CLONE enum as clone.MODE
-def(clone, 'MODE', CLONE);
-
 // Export the clone here.
 exports.clone = clone;
  
@@ -371,3 +326,50 @@ exports.cloneIfLocked = cloneIfLocked;
 
 // Import `addLock()` here *after* assigning the clone methods.
 const {addLock} = require('./lock');
+
+// And setting all the Enum definitions at the very end.
+const Enum = require('../enum');
+
+/**
+ * An `enum` of supported *modes* for the `clone()` method.
+ * 
+ * - **P** → All properties. If unchecked, *enumerable* properties only.
+ * - **A** → Uses `Array.slice()` shortcut for shallow `Array` cloning.
+ * - **R** → Recursive (deep) cloning of nested objects.
+ * - **D** → Uses *descriptor* cloning instead of direct assignment.
+ * - **T** → Sets the `prototype` of the clone as well. 
+ * 
+ * | Mode | P | A | R | D | T | Notes |
+ * | ---- | - | - | - | - | - | ----- |
+ * | `CLONE.N` | × | × | × | × | × | Can be used to manually specify options. |
+ * | `CLONE.DEF` | × | ✓ | × | × | × | Default mode for cloning functions. |
+ * | `CLONE.DEEP` | × | × | ✓ | ✓ | × | |
+ * | `CLONE.FULL` | ✓ | ✓ | × | ✓ | × | |
+ * | `CLONE.ALL` | ✓ | × | × | ✓ | × | |
+ * | `CLONE.ENTIRE` | ✓ | × | ✓ | ✓ | ✓ | |
+ * | `CLONE.JSON` | - | - | ✓ | - | × | Uses JSON, so no `function` or `symbol` support. |
+ * 
+ * The `✓` and `×` marks signify the *default settings* in the mode.
+ * In *most* cases there are options that can override the
+ * defaults.
+ * 
+ * Any feature in the `CLONE.JSON` row marked with `-` are
+ * incompatible with that mode and cannot be enabled at all.
+ * 
+ * @alias module:@lumjs/core/obj.CLONE
+ */
+ const CLONE = Enum(['N','DEF','FULL','ALL','DEEP','ENTIRE','JSON']);
+
+ exports.CLONE = CLONE;
+
+ // A list of modes that should use the array.slice shallow shortcut.
+ const SLICE_ARRAYS = [CLONE.DEF, CLONE.FULL];
+
+ // A list of modes that should get *all* properties.
+ const ALL_PROPS = [CLONE.FULL, CLONE.ALL, CLONE.ENTIRE];
+
+ // A list of modes that should do recursive cloning of objects.
+ const RECURSIVE = [CLONE.DEEP, CLONE.ENTIRE];
+
+// Alias the CLONE enum as clone.MODE
+def(clone, 'MODE', CLONE);

package/lib/strings.js

@@ -2,7 +2,7 @@
  * String and locale related functions.
  * @module @lumjs/core/strings
  */
-const {S,B,F,isObj,root,isArray,needType,needObj} = require('./types')
+const {S,B,F,isObj,root,isArray,needType,needObj} = require('./types');
 
 /**
  * Get the locale/language string.
@@ -189,4 +189,3 @@ function replaceItems(string, replacements, useAll)
 }
 
 exports.replaceItems = replaceItems;
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lumjs/core",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "main": "lib/index.js",
   "exports":
   {