js-build-tools 2.3.1 → 3.0.0

package/dist/partials/runOnChange.js

@@ -1,14 +1,15 @@
-"use strict";
-
-const gulpConfig = require('../../gulp.config.js');
-const bundle = require('../bundle');
-const distSeries = require('./distSeries');
-const {
-  parallel,
-  series
-} = require('gulp');
-const testQuick = require('../testQuick');
-
+"use strict";
+
+require("core-js/modules/es.string.replace.js");
+const gulpConfig = require('../../gulp.config.js');
+const bundle = require('../bundle');
+const distSeries = require('./distSeries');
+const {
+  parallel,
+  series
+} = require('gulp');
+const testQuick = require('../testQuick');
+
 /**
  * Run this function when the watched files are modified.
  * 1. Find the sub-folders within src path
@@ -30,15 +31,14 @@ const testQuick = require('../testQuick');
  *
  * // The resulting replaced path for the destination folder
  * distPathResult = 'dist/some/path/'
- * @function
  * @memberOf module:partials
  * @param {string} path
  * @returns {stream.Stream}
- */
-const runOnChange = path => {
-  const useTs = gulpConfig.get('useTsConfig');
-  const distPath = gulpConfig.get('distPath');
-  const srcPath = gulpConfig.get('srcPath');
+ */
+const runOnChange = path => {
+  const useTs = gulpConfig.get('typescript.enabled');
+  const distPath = gulpConfig.get('dist.to');
+  const srcPath = gulpConfig.get('srcPath');
   /**
    * 1. The original path comes in from src and is a .ts
    * 2. Discover the outgoing dist path where that file should go
@@ -46,14 +46,14 @@ const runOnChange = path => {
    * 4. Take the original path, convert to full file path in dist
    * 5. Use the dist path found previously in #2
    * 6. Use the full dist path and the dist outgoing path in distFor
-   */
-  const pathRegex = new RegExp(`^${srcPath}(.*\\/)(.+)\\.(js|ts)$`, 'i');
-  const distPathResult = path.replace(pathRegex, `${distPath}$1`);
-  let distSrcPath = path;
-  if (useTs) {
-    distSrcPath = path.replace(pathRegex, `${distPath}$1$2.js`);
-  }
-  const runSeries = distSeries(distSrcPath, distPathResult, path);
-  return gulpConfig.get('nodeOnly') ? series(testQuick, runSeries)() : parallel(testQuick, series(runSeries, bundle))();
-};
+   */
+  const pathRegex = new RegExp("^".concat(srcPath, "(.*\\/)(.+)\\.(js|ts)$"), 'i');
+  const distPathResult = path.replace(pathRegex, "".concat(distPath, "$1"));
+  let distSrcPath = path;
+  if (useTs) {
+    distSrcPath = path.replace(pathRegex, "".concat(distPath, "$1$2.js"));
+  }
+  const runSeries = distSeries(distSrcPath, distPathResult, path);
+  return gulpConfig.get('browser.enabled') ? parallel(testQuick, series(runSeries, bundle))() : series(testQuick, runSeries)();
+};
 module.exports = runOnChange;

package/dist/partials/sassFor.js

@@ -11,15 +11,14 @@ const sass = require('gulp-sass')(require('sass'));
 
 /**
  * Build the CSS for a given source pattern.
- * @function
  * @memberOf module:partials
  * @param {string|array} [srcSearch='src/config/path/sass/for']
  * @param {string} [cssPath='css/config/path']
  * @returns {stream.Stream}
  */
 const sassFor = function () {
-  let srcSearch = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : gulpConfig.get('sassSearch');
-  let cssPath = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : gulpConfig.get('cssPath');
+  let srcSearch = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : gulpConfig.get('sass.from');
+  let cssPath = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : gulpConfig.get('sass.to');
   return src(srcSearch).pipe(sass().on('error', sass.logError)) // Passes it through a gulp-sass, log errors to console
   .pipe(dest(cssPath)).pipe(cssnano()).pipe(rename({
     extname: '.min.css'

package/dist/partials/tsFor.js

@@ -1,29 +1,28 @@
-"use strict";
-
-const {
-  dest,
-  parallel,
-  src
-} = require('gulp');
-const gulpConfig = require('../../gulp.config.js');
-const ts = require('gulp-typescript');
-
+"use strict";
+
+const {
+  dest,
+  parallel,
+  src
+} = require('gulp');
+const gulpConfig = require('../../gulp.config.js');
+const ts = require('gulp-typescript');
+
 /**
  * Starting at the source directory, find all the ts files and convert them into the distribution directory.
- * @function
  * @memberOf module:partials
  * @param {string|array} [srcPath='']
  * @param {string} [distPath='']
  * @returns {Function}
  * @see `https://www.typescriptlang.org/docs/handbook/gulp.html` for more info
- */
-const tsFor = function () {
-  let srcPath = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : gulpConfig.get('tsSearch');
-  let distPath = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : gulpConfig.get('distPath');
-  const declarationProject = ts.createProject(gulpConfig.get('useTsConfig'));
-  const tsProject = ts.createProject(gulpConfig.get('useTsConfig'));
-  const makeDeclarations = () => src(srcPath).pipe(declarationProject()).dts.pipe(dest(distPath));
-  const compileJS = () => src(srcPath).pipe(tsProject()).js.pipe(dest(distPath));
-  return parallel(makeDeclarations, compileJS);
-};
+ */
+const tsFor = function () {
+  let srcPath = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : gulpConfig.get('typescript.from');
+  let distPath = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : gulpConfig.get('typescript.to');
+  const declarationProject = ts.createProject(gulpConfig.get('typescript.config'));
+  const tsProject = ts.createProject(gulpConfig.get('typescript.config'));
+  const makeDeclarations = () => src(srcPath).pipe(declarationProject()).dts.pipe(dest(distPath));
+  const compileJS = () => src(srcPath).pipe(tsProject()).js.pipe(dest(distPath));
+  return parallel(makeDeclarations, compileJS);
+};
 module.exports = tsFor;

package/dist/partials.js

@@ -4,7 +4,7 @@
  * Micro-functions used as components for the main gulp functions.
  * @file
  * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 2.0.0
+ * @version 3.0.0
  * @module partials
  * @memberOf module:js-build-tools
  */
@@ -12,9 +12,11 @@
 const addToReadme = require('./partials/addToReadme')
 const beginWatcher = require('./partials/beginWatcher')
 const clean = require('./partials/clean')
+const copyFor = require('./partials/copyFor')
 const distFor = require('./partials/distFor')
 const distForSrc = require('./partials/distForSrc')
 const distSeries = require('./partials/distSeries')
+const imagesFor = require('./partials/imagesFor.js')
 const minifyFor = require('./partials/minifyFor')
 const readmeTemplate = require('./partials/readmeTemplate')
 const removeDirectory = require('./partials/removeDirectory')
@@ -25,9 +27,11 @@ module.exports = {
   addToReadme,
   beginWatcher,
   clean,
+  copyFor,
   distFor,
   distForSrc,
   distSeries,
+  imagesFor,
   minifyFor,
   readmeTemplate,
   removeDirectory,

package/dist/partials.min.js

@@ -1 +1 @@
-"use strict";const addToReadme=require("./partials/addToReadme"),beginWatcher=require("./partials/beginWatcher"),clean=require("./partials/clean"),distFor=require("./partials/distFor"),distForSrc=require("./partials/distForSrc"),distSeries=require("./partials/distSeries"),minifyFor=require("./partials/minifyFor"),readmeTemplate=require("./partials/readmeTemplate"),removeDirectory=require("./partials/removeDirectory"),runOnChange=require("./partials/runOnChange"),sassFor=require("./partials/sassFor"),tsFor=require("./partials/tsFor");module.exports={addToReadme:addToReadme,beginWatcher:beginWatcher,clean:clean,distFor:distFor,distForSrc:distForSrc,distSeries:distSeries,minifyFor:minifyFor,readmeTemplate:readmeTemplate,removeDirectory:removeDirectory,runOnChange:runOnChange,sassFor:sassFor,tsFor:tsFor};
+"use strict";const addToReadme=require("./partials/addToReadme"),beginWatcher=require("./partials/beginWatcher"),clean=require("./partials/clean"),copyFor=require("./partials/copyFor"),distFor=require("./partials/distFor"),distForSrc=require("./partials/distForSrc"),distSeries=require("./partials/distSeries"),imagesFor=require("./partials/imagesFor.js"),minifyFor=require("./partials/minifyFor"),readmeTemplate=require("./partials/readmeTemplate"),removeDirectory=require("./partials/removeDirectory"),runOnChange=require("./partials/runOnChange"),sassFor=require("./partials/sassFor"),tsFor=require("./partials/tsFor");module.exports={addToReadme:addToReadme,beginWatcher:beginWatcher,clean:clean,copyFor:copyFor,distFor:distFor,distForSrc:distForSrc,distSeries:distSeries,imagesFor:imagesFor,minifyFor:minifyFor,readmeTemplate:readmeTemplate,removeDirectory:removeDirectory,runOnChange:runOnChange,sassFor:sassFor,tsFor:tsFor};

package/dist/sass.js

@@ -1,7 +1,7 @@
-'use strict'
-
-const sassFor = require('./partials/sassFor')
-
-// Compile sass into CSS & auto-inject into browsers
-const sass = () => sassFor()
-module.exports = sass
+'use strict'
+
+const sassFor = require('./partials/sassFor')
+
+// Compile sass into CSS & auto-inject into browsers
+const sass = () => sassFor()
+module.exports = sass

package/dist/test-helpers/setUp.js

@@ -1,77 +1,69 @@
 "use strict";
 
-const fs = require('fs');
-// Import the configurations and override some of them in order to direct to the temp directory.
+// Import the configurations and override some of them to direct to the temp directory.
 const gulpConfig = require('../../gulp.config.js');
 const {
-  removeDirectory
-} = require('../partials');
+  setUp
+} = require('test-filesystem');
 let tempDir = 'test-temp/';
-let srcPath = `${tempDir}src`;
+let srcPath = "".concat(tempDir, "src");
 
 /**
  * Update the gulp configurations with the test data. Set the test directory where temp files will be created for testing.
- * @function
  * @memberOf module:testHelpers
  * @param {string} testDir
  */
 const setDefaults = function () {
   let testDir = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'test-temp';
-  tempDir = `${testDir}/`;
-  srcPath = `${tempDir}src`;
-  const distPath = `${tempDir}dist`;
-  const browserPath = `${tempDir}browser`;
-  const sassPath = `${tempDir}sass`;
-  gulpConfig.set('browserPath', browserPath);
+  tempDir = "".concat(testDir, "/");
+  srcPath = "".concat(tempDir, "src");
+  setUp.setDefaults(tempDir);
+  const distPath = "".concat(tempDir, "dist");
+  const browserPath = "".concat(tempDir, "browser");
+  const sassPath = "".concat(tempDir, "sass");
+  gulpConfig.set('browser.from', "".concat(distPath, "/**/*.js"));
+  gulpConfig.set('browser.to', browserPath);
   gulpConfig.set('cleanPaths', [distPath, browserPath]);
-  gulpConfig.set('cssPath', `${browserPath}/css`);
-  gulpConfig.set('distMain', `${distPath}/main`);
-  gulpConfig.set('distPath', distPath);
-  gulpConfig.set('distSearch', `${distPath}/**/*.js`);
-  gulpConfig.set('readmeTemplate', `${tempDir}MAIN.md`);
-  gulpConfig.set('readmePath', tempDir);
-  gulpConfig.set('readmeSearch', `${srcPath}/**/!(*.test).js`);
+  gulpConfig.set('dist.from', "".concat(srcPath, "/**/!(*.test).js"));
+  gulpConfig.set('dist.main', "".concat(distPath, "/main"));
+  gulpConfig.set('dist.to', distPath);
+  gulpConfig.set('fonts.from', "".concat(srcPath, "/fonts/**/*"));
+  gulpConfig.set('fonts.to', "".concat(browserPath, "/fonts"));
+  gulpConfig.set('images.from', "".concat(srcPath, "/img/**/*.+(png|jpg|jpeg|gif|svg)"));
+  gulpConfig.set('images.to', "".concat(browserPath, "/img"));
+  gulpConfig.set('readme.template', "".concat(tempDir, "MAIN.md"));
+  gulpConfig.set('readme.to', tempDir);
+  gulpConfig.set('readme.from', "".concat(srcPath, "/**/!(*.test).js"));
   gulpConfig.set('rootPath', tempDir);
-  gulpConfig.set('sassPath', sassPath);
-  gulpConfig.set('sassSearch', `${sassPath}/**/*.+(scss|sass)`);
+  gulpConfig.set('sass.from', "".concat(sassPath, "/**/*.+(scss|sass)"));
+  gulpConfig.set('sass.path', sassPath);
+  gulpConfig.set('sass.to', "".concat(browserPath, "/css"));
   gulpConfig.set('srcPath', srcPath);
-  gulpConfig.set('srcSearch', `${srcPath}/**/!(*.test).js`);
-  gulpConfig.set('tsSearch', `${srcPath}/**/*.ts`);
-  gulpConfig.set('watchSearch', `${srcPath}/**/*.js`);
+  gulpConfig.set('typescript.from', "".concat(srcPath, "/**/*.ts"));
+  gulpConfig.set('typescript.to', distPath);
+  gulpConfig.set('test.watch', "".concat(srcPath, "/**/*.js"));
 };
 exports.setDefaults = setDefaults;
 exports.gulpConfig = gulpConfig;
 
 /**
  * Ensure that the del has completed, recursively attempt to delete and recreate
- * @function
  * @memberOf module:testHelpers
  * @param {boolean} [exists=true]
  * @returns {Promise<*|void>}
  */
-const createTempDir = async function () {
-  let exists = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
-  if (exists) {
-    return removeDirectory(tempDir).then(removedDir => createTempDir(fs.existsSync(removedDir))).catch(error => console.error('Error: ', error));
-  }
-  return fs.mkdirSync(srcPath, {
-    recursive: true
-  });
-};
-exports.createTempDir = createTempDir;
+exports.createTempDir = setUp.createTempDir;
 
 /**
  * In the Jest.beforeEach function call this one to set up the temp directory.
- * @function
  * @memberOf module:testHelpers
  * @returns {Promise<*|void>}
  */
-exports.beforeEach = () => createTempDir();
+exports.beforeEach = setUp.beforeEach;
 
 /**
  * In the Jest.afterEach function call this one to clean up and remove the temp directory.
- * @function
  * @memberOf module:testHelpers
  * @returns {Promise<*>}
  */
-exports.afterEach = () => removeDirectory(tempDir);
+exports.afterEach = setUp.afterEach;

package/dist/testFull.js

@@ -1,23 +1,22 @@
-'use strict'
-
-const gulpConfig = require('../gulp.config.js')
-const {
-  runCLI
-} = require('jest')
-
+'use strict'
+
+const gulpConfig = require('../gulp.config.js')
+const {
+  runCLI
+} = require('jest')
+
 /**
  * Run all tests with jest.
  * Configure where tests are located by using 'testPath'.
- * @function
  * @memberOf module:js-build-tools
  * @returns {Promise<*>}
- */
-const testFull = () => {
-  let testPath = gulpConfig.get('testPath')
-  if (!Array.isArray(testPath)) {
-    // The testPath must be an array of strings
-    testPath = [testPath]
-  }
-  return runCLI(gulpConfig.get('testOptions'), testPath)
-}
-module.exports = testFull
+ */
+const testFull = () => {
+  let testPath = gulpConfig.get('test.path')
+  if (!Array.isArray(testPath)) {
+    // The testPath must be an array of strings
+    testPath = [testPath]
+  }
+  return runCLI(gulpConfig.get('test.options'), testPath)
+}
+module.exports = testFull

package/dist/testFull.min.js

@@ -1 +1 @@
-"use strict";const gulpConfig=require("../gulp.config.js"),{runCLI:runCLI}=require("jest"),testFull=()=>{let t=gulpConfig.get("testPath");return Array.isArray(t)||(t=[t]),runCLI(gulpConfig.get("testOptions"),t)};module.exports=testFull;
+"use strict";const gulpConfig=require("../gulp.config.js"),{runCLI:runCLI}=require("jest"),testFull=()=>{let t=gulpConfig.get("test.path");return Array.isArray(t)||(t=[t]),runCLI(gulpConfig.get("test.options"),t)};module.exports=testFull;

package/dist/testHelpers.js

@@ -1,33 +1,15 @@
-'use strict'
-
+'use strict'
+
 /**
- * An assortment of objects that can be used in tests and some functions to help debug and write tests.
+ * Export the setUp helper.
  * @file
  * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 2.0.0
+ * @version 3.0.0
  * @module testHelpers
  * @memberOf module:js-build-tools
- */
-
-const circularObject = require('./test-helpers/circularObject')
-const countMatches = require('./test-helpers/countMatches')
-const deepReferenceObject = require('./test-helpers/deepReferenceObject')
-const domItem = require('./test-helpers/domItem')
-const jsonDom = require('./test-helpers/jsonDom')
-const linkedList = require('./test-helpers/linkedList')
-const logObject = require('./test-helpers/logObject')
-const multiReferenceObject = require('./test-helpers/multiReferenceObject')
-const nodeTree = require('./test-helpers/nodeTree')
-const setUp = require('./test-helpers/setUp')
-module.exports = {
-  circularObject,
-  countMatches,
-  deepReferenceObject,
-  domItem,
-  jsonDom,
-  linkedList,
-  logObject,
-  multiReferenceObject,
-  nodeTree,
-  setUp
-}
+ */
+
+const setUp = require('./test-helpers/setUp')
+module.exports = {
+  setUp
+}

package/dist/testHelpers.min.js

@@ -1 +1 @@
-"use strict";const circularObject=require("./test-helpers/circularObject"),countMatches=require("./test-helpers/countMatches"),deepReferenceObject=require("./test-helpers/deepReferenceObject"),domItem=require("./test-helpers/domItem"),jsonDom=require("./test-helpers/jsonDom"),linkedList=require("./test-helpers/linkedList"),logObject=require("./test-helpers/logObject"),multiReferenceObject=require("./test-helpers/multiReferenceObject"),nodeTree=require("./test-helpers/nodeTree"),setUp=require("./test-helpers/setUp");module.exports={circularObject:circularObject,countMatches:countMatches,deepReferenceObject:deepReferenceObject,domItem:domItem,jsonDom:jsonDom,linkedList:linkedList,logObject:logObject,multiReferenceObject:multiReferenceObject,nodeTree:nodeTree,setUp:setUp};
+"use strict";const setUp=require("./test-helpers/setUp");module.exports={setUp:setUp};

package/dist/testQuick.js

@@ -1,25 +1,24 @@
-'use strict'
-
-const gulpConfig = require('../gulp.config.js')
-const {
-  runCLI
-} = require('jest')
-
+'use strict'
+
+const gulpConfig = require('../gulp.config.js')
+const {
+  runCLI
+} = require('jest')
+
 /**
  * Run the Jest tests for files which have been modified (based on git status).
  * Configure where tests are located by using 'testPath'.
- * @function
  * @memberOf module:js-build-tools
  * @returns {Promise<*>}
- */
-const testQuick = () => {
-  let testPath = gulpConfig.get('testPath')
-  if (!Array.isArray(testPath)) {
-    // The testPath must be an array of strings
-    testPath = [testPath]
-  }
-  return runCLI({
-    onlyChanged: true
-  }, testPath)
-}
-module.exports = testQuick
+ */
+const testQuick = () => {
+  let testPath = gulpConfig.get('test.path')
+  if (!Array.isArray(testPath)) {
+    // The testPath must be an array of strings
+    testPath = [testPath]
+  }
+  return runCLI({
+    onlyChanged: true
+  }, testPath)
+}
+module.exports = testQuick

package/dist/testQuick.min.js

@@ -1 +1 @@
-"use strict";const gulpConfig=require("../gulp.config.js"),{runCLI:runCLI}=require("jest"),testQuick=()=>{let e=gulpConfig.get("testPath");return Array.isArray(e)||(e=[e]),runCLI({onlyChanged:!0},e)};module.exports=testQuick;
+"use strict";const gulpConfig=require("../gulp.config.js"),{runCLI:runCLI}=require("jest"),testQuick=()=>{let e=gulpConfig.get("test.path");return Array.isArray(e)||(e=[e]),runCLI({onlyChanged:!0},e)};module.exports=testQuick;

package/dist/typeScript.js

@@ -4,7 +4,6 @@ const tsFor = require('./partials/tsFor')
 
 /**
  * Simplified typescript task using tsFor.
- * @function
  * @memberOf module:js-build-tools
  * @returns {Function}
  */

package/dist/utilities/dotGet.js

@@ -0,0 +1,50 @@
+"use strict";
+
+const isObject = require('./isObject');
+const strAfter = require('common-exports/dist/utilities/strAfter').default;
+const strBefore = require('common-exports/dist/utilities/strBefore').default;
+
+/**
+ * Get a nested property value from an object.
+ * Original source concepts from {@link https://github.com/jheagle/si-funciona/blob/main/src/helpers/objects/dotGet.ts Sí, funciona}
+ * @param {Object} arrayObject - The array or object to get the property from
+ * @param {string} dotNotation - The path to the property
+ * @param {string|null} [defaultValue=null] - The default value to return if the property is not found
+ * @returns {*} The value of the property
+ */
+const dotGet = function (arrayObject, dotNotation) {
+  let defaultValue = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
+  let key = strBefore(dotNotation, '.');
+  const lastKey = !key;
+  if (lastKey) {
+    key = dotNotation;
+  }
+  if (key === '*') {
+    const result = [];
+    for (let wildKey in arrayObject) {
+      const wildValue = arrayObject[wildKey];
+      if (lastKey) {
+        result[wildKey] = wildValue;
+        continue;
+      }
+      if (!isObject(wildValue)) {
+        continue;
+      }
+      result[wildKey] = dotGet(wildValue, strAfter(dotNotation, '.'), defaultValue);
+    }
+    return result;
+  }
+  if (lastKey) {
+    var _arrayObject$dotNotat;
+    return (_arrayObject$dotNotat = arrayObject[dotNotation]) !== null && _arrayObject$dotNotat !== void 0 ? _arrayObject$dotNotat : defaultValue;
+  }
+  if (typeof arrayObject[key] === 'undefined') {
+    return defaultValue;
+  }
+  const next = arrayObject[key];
+  if (!isObject(next)) {
+    return defaultValue;
+  }
+  return dotGet(next, strAfter(dotNotation, '.'), defaultValue);
+};
+module.exports = dotGet;

package/dist/utilities/dotNotate.js

@@ -0,0 +1,77 @@
+"use strict";
+
+require("core-js/modules/es.string.replace.js");
+require("core-js/modules/esnext.async-iterator.map.js");
+require("core-js/modules/esnext.iterator.map.js");
+const isObject = require('./isObject');
+
+/**
+ * Convert an array of keys into a regex, return a function to test if incoming keys match.
+ * @param {Array.<string>} [retainObjects=[]] - An array of keys to retain as objects
+ * @returns {Function} The dot-notated array
+ */
+const handleRetainObjects = function () {
+  let retainObjects = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+  if (!retainObjects.length) {
+    /**
+     * Bypass the test function if there are no retainObjects.
+     * @returns {false}
+     */
+    return (currentKey, value, results) => false;
+  }
+  retainObjects = retainObjects.map(key => key.replace('\.', '\\.'));
+  const retainRegex = new RegExp("(".concat(retainObjects.join('|'), ")$"));
+  /**
+   * Test if a key should be retained as an object.
+   * @param {string} currentKey - The key to test
+   * @param {*} value - The value of the key
+   * @param {Object} results - The result object to add to
+   * @returns {boolean}
+   */
+  return (currentKey, value, results) => {
+    if (!currentKey.match(retainRegex)) {
+      return false;
+    }
+    results[currentKey] = value;
+    return true;
+  };
+};
+
+/**
+ * The underlying logic function for converting arrays to dot-notation.
+ * @param {Object} arrayObject - The array or object to dot-notate
+ * @param {Function} didRetain - The test function to see if a key should be retained
+ * @param {string} [prepend=''] - The path for the property being processed
+ * @param {Object<string, *>} [results={}] - The final notated object to return
+ * @returns {Object<string, *>} The dot-notated object
+ */
+const performDotNotate = function (arrayObject, didRetain) {
+  let prepend = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : '';
+  let results = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
+  for (let key in arrayObject) {
+    const value = arrayObject[key];
+    const currentKey = "".concat(prepend).concat(key);
+    if (didRetain(currentKey, value, results)) {
+      continue;
+    }
+    if (isObject(value)) {
+      performDotNotate(value, didRetain, "".concat(currentKey, "."), results);
+      continue;
+    }
+    results[currentKey] = value;
+  }
+  return results;
+};
+
+/**
+ * Convert an array or object to a single dimensional associative array with dot notation.
+ * Original source concepts from {@link https://github.com/jheagle/si-funciona/blob/main/src/helpers/objects/dotNotate.ts Sí, funciona}
+ * @param {Object} arrayObject - The array or object to dot-notate
+ * @param {Array.<string>} [retainObjects=[]] - An array of keys to retain as objects
+ * @returns {Object<string, *>} The dot-notated object
+ */
+const dotNotate = function (arrayObject) {
+  let retainObjects = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+  return performDotNotate(arrayObject, handleRetainObjects(retainObjects));
+};
+module.exports = dotNotate;

package/dist/utilities/dotSet.js

@@ -0,0 +1,44 @@
+"use strict";
+
+const isObject = require('./isObject');
+const strAfter = require('common-exports/dist/utilities/strAfter').default;
+const strBefore = require('common-exports/dist/utilities/strBefore').default;
+
+/**
+ * Set a nested property value an object.
+ * Original source concepts from {@link https://github.com/jheagle/si-funciona/blob/main/src/helpers/objects/dotSet.ts Sí, funciona}
+ * @param {Object} arrayObject - The array or object to set the property on
+ * @param {string} dotNotation - The path for the property
+ * @param {*} value - The default value to return if the property is not found
+ * @returns {Object} The modified object
+ */
+const dotSet = function (arrayObject, dotNotation) {
+  var _arrayObject$key;
+  let value = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
+  let key = strBefore(dotNotation, '.');
+  const lastKey = !key;
+  if (lastKey) {
+    key = dotNotation;
+  }
+  if (key === '*') {
+    for (let wildKey in arrayObject) {
+      if (lastKey) {
+        arrayObject[wildKey] = value;
+        continue;
+      }
+      if (!isObject(arrayObject[wildKey])) {
+        continue;
+      }
+      dotSet(arrayObject[wildKey], strAfter(dotNotation, '.'), value);
+    }
+    return arrayObject;
+  }
+  if (lastKey) {
+    arrayObject[dotNotation] = value;
+    return arrayObject;
+  }
+  const next = (_arrayObject$key = arrayObject[key]) !== null && _arrayObject$key !== void 0 ? _arrayObject$key : [];
+  arrayObject[key] = dotSet(next, strAfter(dotNotation, '.'), value);
+  return arrayObject;
+};
+module.exports = dotSet;

package/dist/utilities/isObject.js

@@ -0,0 +1,10 @@
+"use strict";
+
+/**
+ * Check if the provided thing is an object / array.
+ * Original source concepts from {@link https://github.com/jheagle/si-funciona/blob/main/src/helpers/objects/isObject.ts Sí, funciona}
+ * @param {*} object
+ * @returns {boolean}
+ */
+const isObject = object => typeof object === 'object' && object !== null;
+module.exports = isObject;