manyfest 1.0.16 → 1.0.18

package/.browserslistrc

@@ -0,0 +1 @@
+> 0.01%

package/.browserslistrc_compatible

@@ -0,0 +1 @@
+> 0.01%

package/.browserslistrc_default

@@ -0,0 +1 @@
+since 2018

package/gulpfile-config.json

@@ -0,0 +1,11 @@
+{
+	"EntrypointInputSourceFile": "./source/Manyfest-Browser-Shim.js",
+
+	"LibraryObjectName": "Manyfest",
+
+	"LibraryOutputFolder": "./dist/",
+
+	"LibraryUniminifiedFileName": "manyfest.compatible.js",
+
+	"LibraryMinifiedFileName": "manyfest.compatible.min.js"
+}

package/gulpfile-config_compatible.json

@@ -0,0 +1,11 @@
+{
+	"EntrypointInputSourceFile": "./source/Manyfest-Browser-Shim.js",
+
+	"LibraryObjectName": "Manyfest",
+
+	"LibraryOutputFolder": "./dist/",
+
+	"LibraryUniminifiedFileName": "manyfest.compatible.js",
+
+	"LibraryMinifiedFileName": "manyfest.compatible.min.js"
+}

package/gulpfile-config_default.json

@@ -0,0 +1,11 @@
+{
+	"EntrypointInputSourceFile": "./source/Manyfest-Browser-Shim.js",
+
+	"LibraryObjectName": "Manyfest",
+
+	"LibraryOutputFolder": "./dist/",
+
+	"LibraryUniminifiedFileName": "manyfest.js",
+
+	"LibraryMinifiedFileName": "manyfest.min.js"
+}

package/gulpfile.js

@@ -1,62 +1,164 @@
 'use strict';
 
+/*
+  After hours of reading and trying various ways of using gulp-env, environment variables
+  and babel browesrslistrc / package.json environments it is clear that the state of using
+  these tools is a mess.  There are ways of getting it to work but none of them feel like
+  they will work well in the long term (all of the examples seem to be in bands of about
+  a year or two of working before the pattern changes entirely).
+
+  WHY did we need such a crazy compatible version?  wkhtmltopdf is why.  It uses a very
+  old incompatible version of the QT browser.
+
+  Therefore, we will use a very old and simple method.
+
+	1) There is a config file (gulpfile-config.json), documented here, describing the inputs and outputs for the build operation.
+
+		const _CONFIG = (
+			{
+				// The input source file that should be passed to browserify:
+				// (if you need to auto-instantiate an object, for instance)
+				EntrypointInputSourceFile: `${__dirname}/source/Fable-Browser-Shim.js`,
+
+				// The name of the packaged object to be passed to browserify:
+				// (browserify sets this to global scope and window.SOMEOBJECTNAMEHERE where SOMEOBJECTNAMEHERE is the string below)
+				LibraryObjectName: `Fable`,
+
+				// The folder to write the library files and maps out to:
+				LibraryOutputFolder: `${__dirname}/dist/`,
+
+				// The name of the unminified version of the packaged library, for easy debugging:
+				LibraryUniminifiedFileName: `fable.js`,
+
+				// The name of the minified version of the packaged library, for production release:
+				LibraryMinifiedFileName: `fable.min.js`
+			});
+
+	2) We are using a .browserslistrc file... this is what tells gulp-babel, through the
+	   magic of the @babel/preset-env library, how to transpile the library into a compatible
+	   enough format for our targets.
+
+	   For example as of writing this, there are two targets we want:
+
+			*	Modern browsers in the last five years, expressed as a .browserslistrc with the string "since 2018"
+			*	Very old janky browsers expressed as a .browserslistrc with the string "> 0.01%"
+				... which is interpreted as anything more than 0.01% of browsers in existence or something like that
+
+	3) Because we want multiple outputs, and, the tools do fine if we want one output but some of
+	   the toolchain doesn't like making different targets well, we're just going to have multiple
+	   configurations and .browserslistrc files.  So if our spec above says we need a ".browserslistrc"
+	   file and a "gulpfile-config.json", we're going to make the following two sets of configuration:
+
+			*	.browserslistrc_default, .gulpfile-config_default.json
+			*	.browserslistrc_compatible, .gulpfile-config_compatible.json
+
+	4) We will copy, synchronously, these files to where the rest of our toolchain expects
+	   them, before we begin the build.  This will be done by looking at the GULP_CUSTOM_BUILD_TARGET
+	   environment variable.  This allows us to create new targets to experiment by copying a couple files,
+	   jimmying the settings and setting an environment variable before running the pipeline.
+
+	5) We will run the toolchain and it will happily think it's just doing a single build and kinda work.
+
+ */
+// BEGINNING OF STEP 3 and STEP 4 ABOVE
+const libFS = require('fs');
+const _GULP_CUSTOM_BUILD_TARGET = (typeof(process.env.GULP_CUSTOM_BUILD_TARGET) == 'undefined') ? 'default' : process.env.GULP_CUSTOM_BUILD_TARGET;
+console.log(`--> Gulp custom build target set to: [${_GULP_CUSTOM_BUILD_TARGET}]`);
+const _GULP_CONFIG = `./gulpfile-config_${_GULP_CUSTOM_BUILD_TARGET}.json`;
+const _GULP_CONFIG_TARGET = `./gulpfile-config.json`;
+console.log(`   : Environment set gulp config [${_GULP_CONFIG}] will be copied to [${_GULP_CONFIG_TARGET}]`);
+if (!libFS.existsSync(`./${_GULP_CONFIG}`))
+{
+	console.log(`!!!> Enviromnent set gulp config doesn't exist!`);
+	process.exit(1);
+}
+else
+{
+	libFS.copyFileSync(_GULP_CONFIG, _GULP_CONFIG_TARGET);
+	console.log(`   > Environment Gulp Config copied`);
+}
+const _BROWSERSLISTRC = `./.browserslistrc_${_GULP_CUSTOM_BUILD_TARGET}`;
+const _BROWSERSLISTRC_TARGET = `./.browserslistrc`;
+console.log(`   : Environment set browserslistrc [${_BROWSERSLISTRC}] will be copied to [${_BROWSERSLISTRC_TARGET}]`);
+if (!libFS.existsSync(`./${_GULP_CONFIG}`))
+{
+	console.log(`!!!> Enviromnent set browserslistrc doesn't exist!`);
+	process.exit(1);
+}
+else
+{
+	libFS.copyFileSync(_BROWSERSLISTRC, _BROWSERSLISTRC_TARGET);
+	console.log(`   > Environment Gulp Config copied`);
+}
+console.log(`---> The browserslistrc compatibility set is: ${libFS.readFileSync(_BROWSERSLISTRC_TARGET, 'utf8')}`);
+// END OF STEP 3 and STEP 4 ABOVE
+
+
+// ---> Now load the config and get on with building <--- \\
+console.log(``);
+console.log(`---> Loading the gulp config...`);
+const _CONFIG = require('./gulpfile-config.json');
+console.log(`   > Building to [${_CONFIG.LibraryUniminifiedFileName}] and [${_CONFIG.LibraryMinifiedFileName}]`)
+
+// --->  Boilerplate Browser Uglification and Packaging  <--- \\
+console.log(``);
+console.log(`--> Gulp is taking over!`);
+
 const libBrowserify = require('browserify');
 const libGulp = require('gulp');
 
 const libVinylSourceStream = require('vinyl-source-stream');
 const libVinylBuffer = require('vinyl-buffer');
 
-const libTerser = require('gulp-terser');
-const libBuble = require('gulp-buble');
 const libSourcemaps = require('gulp-sourcemaps');
 const libGulpUtil = require('gulp-util');
+const libBabel = require('gulp-babel');
+const libTerser = require('gulp-terser');
 
 // Build the module for the browser
-//   This gulp task is taken from the gulp recipe repository:
-//   https://github.com/gulpjs/gulp/blob/master/docs/recipes/browserify-uglify-sourcemap.md
 libGulp.task('minified',
 () => {
 	// set up the custom browserify instance for this task
 	var tmpBrowserify = libBrowserify(
 	{
-		entries: './source/Manyfest-Browser-Shim.js',
-		standalone: 'Fable',
+		entries: _CONFIG.EntrypointInputSourceFile,
+		standalone: _CONFIG.LibraryObjectName,
 		debug: true
 	});
 
 	return tmpBrowserify.bundle()
-		.pipe(libVinylSourceStream('manyfest.min.js'))
+		.pipe(libVinylSourceStream(_CONFIG.LibraryMinifiedFileName))
 		.pipe(libVinylBuffer())
 		.pipe(libSourcemaps.init({loadMaps: true}))
 				// Add transformation tasks to the pipeline here.
+				.pipe(libBabel())
 				.pipe(libTerser())
 				.on('error', libGulpUtil.log)
 		.pipe(libSourcemaps.write('./'))
-		.pipe(libGulp.dest('./dist/'));
+		.pipe(libGulp.dest(_CONFIG.LibraryOutputFolder));
 });
 
 // Build the module for the browser
-//   This gulp task is taken from the gulp recipe repository:
-//   https://github.com/gulpjs/gulp/blob/master/docs/recipes/browserify-uglify-sourcemap.md
 libGulp.task('debug',
 	() => {
 		// set up the custom browserify instance for this task
 		var tmpBrowserify = libBrowserify(
 		{
-			entries: './source/Manyfest-Browser-Shim.js',
-			standalone: 'Manyfest',
+			entries: _CONFIG.EntrypointInputSourceFile,
+			standalone: _CONFIG.LibraryObjectName,
 			debug: true
 		});
 
 		return tmpBrowserify.bundle()
-			.pipe(libVinylSourceStream('manyfest.js'))
+			.pipe(libVinylSourceStream(_CONFIG.LibraryUniminifiedFileName))
 			.pipe(libVinylBuffer())
+					.pipe(libBabel())
 					.on('error', libGulpUtil.log)
-			.pipe(libGulp.dest('./dist/'));
+			.pipe(libGulp.dest(_CONFIG.LibraryOutputFolder));
 	});
 
 libGulp.task
 (
 	'build',
 	libGulp.series('debug', 'minified')
-);
+);

package/package.json

@@ -1,14 +1,17 @@
 {
   "name": "manyfest",
-  "version": "1.0.16",
+  "version": "1.0.18",
   "description": "JSON Object Manifest for Data Description and Parsing",
   "main": "source/Manyfest.js",
   "scripts": {
+    "start": "node source/Manyfest.js",
     "docker-dev-build-image": "docker build ./ -f Dockerfile_LUXURYCode -t retold/manyfest:local",
     "docker-dev-run": "docker run -it -d --name manyfest -p 12340:8080 -v \"$PWD/.config:/home/coder/.config\"  -v \"$PWD:/home/coder/manyfest\" -u \"$(id -u):$(id -g)\" -e \"DOCKER_USER=$USER\" retold/manyfest:local",
     "test": "./node_modules/mocha/bin/_mocha -u tdd -R spec",
     "tests": "./node_modules/mocha/bin/_mocha -u tdd -R spec --grep",
-    "coverage": "nyc npm run test && nyc report --reporter=lcov"
+    "coverage": "nyc npm run test && nyc report --reporter=lcov",
+    "build": "./node_modules/.bin/gulp build",
+    "build-compatible": "GULP_CUSTOM_BUILD_TARGET=compatible ./node_modules/.bin/gulp build"
   },
   "repository": {
     "type": "git",
@@ -39,28 +42,29 @@
     ]
   },
   "devDependencies": {
-    "@babel/core": "^7.17.9",
-    "@babel/preset-env": "^7.16.11",
-    "@testing-library/dom": "^8.13.0",
-    "async": "^3.2.3",
+    "@babel/core": "^7.21.5",
+    "@babel/preset-env": "^7.21.5",
+    "@testing-library/dom": "^9.2.0",
+    "async": "^3.2.4",
     "browserify": "^17.0.0",
-    "chai": "4.3.6",
+    "chai": "4.3.7",
     "gulp": "^4.0.2",
     "gulp-babel": "^8.0.0",
     "gulp-buble": "^0.9.0",
+    "gulp-env": "^0.4.0",
     "gulp-sourcemaps": "^3.0.0",
     "gulp-terser": "^2.1.0",
     "gulp-util": "^3.0.8",
-    "jsdom": "^19.0.0",
-    "mocha": "9.2.2",
-    "npm-check-updates": "^12.5.9",
+    "jsdom": "^21.1.1",
+    "mocha": "10.2.0",
+    "npm-check-updates": "^16.10.9",
     "nyc": "^15.1.0",
     "vinyl-buffer": "^1.0.1",
     "vinyl-source-stream": "^2.0.0"
   },
   "dependencies": {
-    "elucidator": "^1.0.2",
-    "precedent": "^1.0.6"
+    "elucidator": "^1.0.7",
+    "precedent": "^1.0.9"
   },
   "author": "steven velozo <steven@velozo.com>",
   "license": "MIT",

package/source/Manyfest-HashTranslation.js

@@ -7,7 +7,7 @@ let libSimpleLog = require('./Manyfest-LogToConsole.js');
 /**
 * Hash Translation
 *
-* This is a very simple translation table for hashes, which allows the same schema to resolve 
+* This is a very simple translation table for hashes, which allows the same schema to resolve
 * differently based on a loaded translation table.
 *
 * This is to prevent the requirement for mutating schemas over and over again when we want to

package/test/Manyfest_Embedded_Solvers_tests.js

@@ -80,7 +80,7 @@ suite
 									},
                                 Solvers:
                                     {
-                                        'ThumbnailFilesOnly': 
+                                        'ThumbnailFilesOnly':
                                             {
                                                 "Description":
                                                 {
@@ -94,7 +94,7 @@ suite
                                                         "Namespace": "Logic",
                                                         "Instruction": "if",
 
-														"InputHashAddressMap": 
+														"InputHashAddressMap":
                                                             {
                                                                 "leftValue": "Record.format",
                                                                 "rightValue": "SolutionState.Config.SearchTerm",

package/test/Manyfest_Object_Delete_tests.js

@@ -67,7 +67,7 @@ suite
 										"IDAnimal": { "Name":"Database ID", "Description":"The unique integer-based database identifier for an Animal record.", "DataType":"Integer" },
 										"Name": { "Description":"The animal's colloquial species name (e.g. Rabbit, Dog, Bear, Mongoose)." },
 										"Type": { "Description":"Whether or not the animal is wild, domesticated, agricultural, in a research lab or a part of a zoo.." },
-										"MedicalStats": 
+										"MedicalStats":
 											{
 												"Name":"Medical Statistics", "Description":"Basic medical statistics for this animal"
 											},
@@ -89,7 +89,7 @@ suite
 
 						fTestComplete();
 					}
-				);			
+				);
 			}
 		);
 	}

package/test/Manyfest_Object_HashTranslation_tests.js

@@ -45,7 +45,7 @@ suite
 						tmpCreator = _Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Director');
 						Expect(tmpCreator)
 							.to.equal('General Mills');
-							
+
 						fTestComplete();
 					}
 				);
@@ -67,7 +67,7 @@ suite
 						Expect(_Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Director')).to.equal('General Mills');
 						// And Author!
 						Expect(_Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Author')).to.equal('General Mills');
-							
+
 						fTestComplete();
 					}
 				);
@@ -91,7 +91,7 @@ suite
 						_Manyfest.hashTranslations.removeTranslation('Director');
 						Expect(_Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Author')).to.equal('General Mills');
 						Expect(_Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Director')).to.equal(undefined);
-							
+
 						fTestComplete();
 					}
 				);
@@ -116,7 +116,7 @@ suite
 						Expect(_Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Author')).to.equal(undefined);
 						Expect(_Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Director')).to.equal(undefined);
 						Expect(_Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Songwriter')).to.equal('General Mills');
-							
+
 						fTestComplete();
 					}
 				);
@@ -142,7 +142,7 @@ suite
 						Expect(_Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Director')).to.equal(undefined);
 						Expect(_Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Songwriter')).to.equal(undefined);
 						Expect(_Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Creator')).to.equal('General Mills');
-							
+
 						fTestComplete();
 					}
 				);
@@ -152,13 +152,13 @@ suite
 					(fTestComplete)=>
 					{
 						let _Manyfest = new libManyfest({ Scope:'Archive.org', Descriptors: {'metadata.creator': {Name:'Creator', Hash:'Creator'}}});
-						// Create a translation between "Creator" and "metadata.identifier", which isn't in the manifest in any way 
+						// Create a translation between "Creator" and "metadata.identifier", which isn't in the manifest in any way
 						_Manyfest.hashTranslations.addTranslation({"Creator":"metadata.identifier"});
 						// This address is not in the descriptor address list or the hash list
 						Expect(_Manyfest.getValueAtAddress(_SampleDataArchiveOrgFrankenberry, 'metadata.identifier')).to.equal('FrankenberryCountChoculaTevevisionCommercial1971');
 						// But now we've pointed the Creator hash to it!
 						Expect(_Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Creator')).to.equal('FrankenberryCountChoculaTevevisionCommercial1971');
-							
+
 						fTestComplete();
 					}
 				);
@@ -172,7 +172,7 @@ suite
 						Expect(_Manyfest.hashTranslations.addTranslation('THIS SHOULD BE AN OBJECT')).to.equal(false);
 
 						Expect(_Manyfest.hashTranslations.translationCount()).to.equal(0);
-							
+
 						fTestComplete();
 					}
 				);

package/test/Manyfest_Object_Populate_tests.js

@@ -47,7 +47,7 @@ suite
 
 						fTestComplete();
 					}
-				);				
+				);
 				test
 				(
 					'All properties should be auto created on Populate.',
@@ -133,7 +133,7 @@ suite
 
 						fTestComplete();
 					}
-				);	
+				);
 			}
 		);
 	}

package/test/Manyfest_Object_ReadSets_tests.js

@@ -42,6 +42,7 @@ suite
 							});
 						let tmpFileSet = _Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'FileSet');
 						Expect(Array.isArray(tmpFileSet)).to.equal(true);
+						let tmpFileSizes = _Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'FileSizes');
 						fTestComplete();
 					}
 				);

package/test/Manyfest_Object_Read_tests.js

@@ -68,7 +68,7 @@ suite
 										"IDAnimal": { "Name":"Database ID", "Description":"The unique integer-based database identifier for an Animal record.", "DataType":"Integer" },
 										"Name": { "Description":"The animal's colloquial species name (e.g. Rabbit, Dog, Bear, Mongoose)." },
 										"Type": { "Description":"Whether or not the animal is wild, domesticated, agricultural, in a research lab or a part of a zoo.." },
-										"MedicalStats": 
+										"MedicalStats":
 											{
 												"Name":"Medical Statistics", "Description":"Basic medical statistics for this animal"
 											},
@@ -95,7 +95,7 @@ suite
 
 						fTestComplete();
 					}
-				);			
+				);
 			}
 		);
 		suite

package/test/Manyfest_Object_SchemaManipulation_tests.js

@@ -41,7 +41,7 @@ suite
 								"a": "CarrotCost",
 								"b": "AppleCost"
 							});
-						
+
 						Expect(tmpSchemaDescriptors.a.Hash).to.equal('a');
 
 						let _Manyfest = new libManyfest();
@@ -71,7 +71,7 @@ suite
 								"a": "CarrotCost",
 								"b": "AppleCost"
 							});
-						
+
 						Expect(tmpSchemaDescriptors.a.Hash).to.equal('a');
 
 						let _Manyfest = new libManyfest();
@@ -97,7 +97,7 @@ suite
 								"a": { "Hash": "a", "Type": "Number" },
 								"b": { "Hash": "b", "Type": "Number" }
 							});
-						
+
 						let tmpSchemaDescriptorsToMerge = (
 							{
 								"c": { "Hash": "c" },
@@ -105,7 +105,7 @@ suite
 								"e": { "Hash": "e" },
 								"a": { "Hash": "ARBUCKLE", "Type": "Number" }
 							});
-						
+
 						Expect(tmpSchemaDescriptors.a.Hash).to.equal('a');
 
 						let _Manyfest = new libManyfest();
@@ -137,14 +137,14 @@ suite
 								"a": "CarrotCost",
 								"b": "AppleCost"
 							});
-						
+
 						let _Manyfest = new libManyfest({ Scope:'Archive.org', Descriptors: {'metadata.creator': {Name:'Creator', Hash:'Creator'}}});
 						// Property not schema, accessed by hash:
 						let tmpCreator = _Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Creator');
 						Expect(tmpCreator).to.equal('General Mills');
 						let _ClonedManyfest = _Manyfest.clone();
 						Expect(_ClonedManyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Creator')).to.equal('General Mills');
-	
+
 						fTestComplete();
 					}
 				);
@@ -164,7 +164,7 @@ suite
 								"a": "CarrotCost",
 								"b": "AppleCost"
 							});
-						
+
 						let _Manyfest = new libManyfest({ Scope:'Archive.org', Descriptors: {'metadata.creator': {Name:'Creator', Hash:'Creator'}}});
 						// Property not schema, accessed by hash:
 						let tmpCreator = _Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Creator');
@@ -193,7 +193,7 @@ suite
 						_ClonedManyfest.hashTranslations.addTranslation({"Director":"Creator", "Author":"Creator", "Songwriter":"Creator"});
 						Expect(_ClonedManyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Director')).to.equal('General Mills');
 						Expect(_Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Director')).to.equal(undefined);
-	
+
 						fTestComplete();
 					}
 				);
@@ -213,7 +213,7 @@ suite
 									"c": null
 								}
 							});
-						
+
 						let _Manyfest = new libManyfest();
 						// Now remap the schema (in-place)
 						let tmpSchemaPrototype = _Manyfest.objectAddressGeneration.generateAddressses(tmpSchemaDescriptors);
@@ -230,7 +230,7 @@ suite
 				(
 					'Make a much bigger schema prototype.',
 					(fTestComplete)=>
-					{						
+					{
 						let _Manyfest = new libManyfest();
 						// Now remap the schema (in-place)
 						let tmpSchemaPrototype = _Manyfest.objectAddressGeneration.generateAddressses(_SampleDataArchiveOrgFrankenberry);
@@ -257,7 +257,7 @@ suite
 										"IDAnimal": { "Name":"Database ID", "Description":"The unique integer-based database identifier for an Animal record.", "DataType":"Integer" },
 										"Name": { "Description":"The animal's colloquial species name (e.g. Rabbit, Dog, Bear, Mongoose)." },
 										"Type": { "Description":"Whether or not the animal is wild, domesticated, agricultural, in a research lab or a part of a zoo.." },
-										"MedicalStats": 
+										"MedicalStats":
 											{
 												"Name":"Medical Statistics", "Description":"Basic medical statistics for this animal"
 											},

package/test/Manyfest_Object_Validate_tests.js

@@ -60,7 +60,7 @@ suite
 
 						fTestComplete();
 					}
-				);				
+				);
 				test
 				(
 					'Validate should be able to test for dates.',