type-enforcer-test-helper 1.3.10 → 2.0.0-alpha.0

package/dist/types/src/testMethod.d.ts

@@ -0,0 +1,20 @@
+interface ITestMethodCoerce {
+    value: unknown;
+    coerced: unknown;
+}
+interface ExtraProps {
+    [key: string]: unknown;
+}
+interface ITestMethodSettings {
+    name: string;
+    init: unknown;
+    extraProps?: ExtraProps;
+    true: Array<unknown>;
+    false: Array<unknown>;
+    coerce?: Array<ITestMethodCoerce> | false;
+    coerceTrue?: Array<unknown>;
+}
+export default function (this: object, settings: ITestMethodSettings, thisMethod: Function, method: {
+    [key: string]: unknown;
+}): void;
+export {};

package/dist/types/src/testMethod.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/utility/difference.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (array1: Array<unknown>, ...args: Array<Array<unknown>>) => Array<unknown>;
+export default _default;

package/dist/types/src/utility/difference.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "type-enforcer-test-helper",
-	"version": "1.3.10",
+	"version": "2.0.0-alpha.0",
 	"description": "Test data and helper functions for type-enforcer and addons",
 	"keywords": [],
 	"license": "MIT",
@@ -17,65 +17,47 @@
 	"bugs": {
 		"url": "https://github.com/DarrenPaulWright/type-enforcer-test-helper/issues"
 	},
-	"main": "index.js",
 	"type": "module",
-	"types": "types/index.d.ts",
+	"main": "dist/js/index.ts",
+	"module": "dist/js/index.ts",
+	"types": "dist/types/index.d.ts",
 	"files": [
-		"/types",
-		"/src"
+		"/dist",
+		"!/dist/**/*.test.js",
+		"!/dist/**/*.test.d.js"
 	],
-	"badges": {
-		"npm": {
-			"image": "https://img.shields.io/npm/v/type-enforcer-test-helper.svg",
-			"url": "https://npmjs.com/package/type-enforcer-test-helper"
-		},
-		"deps": {
-			"image": "https://david-dm.org/DarrenPaulWright/type-enforcer-test-helper.svg",
-			"url": "https://david-dm.org/DarrenPaulWright/type-enforcer-test-helper"
-		},
-		"size": {
-			"base": "https://packagephobia.now.sh/",
-			"image": "badge?p=type-enforcer-test-helper",
-			"url": "result?p=type-enforcer-test-helper"
-		},
-		"vulnerabilities": {
-			"base": "https://snyk.io/test/github/DarrenPaulWright/type-enforcer-test-helper",
-			"image": "/badge.svg?targetFile=package.json",
-			"url": "?targetFile=package.json"
-		},
-		"license": {
-			"image": "https://img.shields.io/github/license/DarrenPaulWright/type-enforcer-test-helper.svg",
-			"url": "https://npmjs.com/package/type-enforcer-test-helper/LICENSE.md"
-		}
-	},
 	"scripts": {
-		"test": "",
+		"test": "tsc && hippogriff",
 		"test-watch": "",
 		"preversion": "npm test && npm run docs && git add --all && git diff HEAD --quiet || git commit -m \"Updating docs\"",
 		"postversion": "npm publish",
 		"postpublish": "git push --follow-tags",
 		"pre-clean": "rm -rf node_modules && del /f package-lock.json",
-		"clean": "npm run pre-clean && npm install && npm audit fix",
-		"update": "ncu -u && git diff --quiet || npm install && npm audit fix",
+		"clean": "npm run pre-clean && npm install",
+		"update": "ncu -u && git diff --quiet || npm install",
 		"update-clean": "npm run pre-clean && npm run update",
 		"update-commit": "npm run update && npm test && git add --all && git diff HEAD --quiet || git commit -m \"Updating dependencies\"",
 		"update-patch": "npm run update && npm test && git add --all && git diff HEAD --quiet || git commit -m \"Updating dependencies\" && npm version patch",
-		"docs:readme": "jsdoc2md ./index.js src/**/*.js > README.md -t node_modules/dmd-readable/overview.hbs --plugin dmd-readable/overview-plugin.js",
-		"docs:main": "exec-each --out docs/{basefile}.md src/*.js jsdoc2md -- {path} -t node_modules/dmd-readable/docs.hbs --plugin dmd-readable",
-		"docs:data": "exec-each --out docs/{basefile}.md src/data/*.js jsdoc2md -- {path} -t node_modules/dmd-readable/docs.hbs --plugin dmd-readable",
-		"docs:types": "rm -rf types && tsc",
-		"docs": "run-p docs:*"
+		"docs": "typedoc"
 	},
 	"dependencies": {
-		"display-value": "^2.2.0",
-		"object-agent": "^1.6.0",
-		"type-enforcer": "^1.2.4"
+		"display-value": "^3.1.0",
+		"object-agent": "^1.6.1",
+		"type-enforcer": "^1.2.7"
+	},
+	"peerDependencies": {
+		"hippogriff": "^0.1.2"
 	},
 	"devDependencies": {
+		"@types/node": "^25.0.3",
 		"dmd-readable": "^1.2.4",
 		"exec-each": "0.0.3",
-		"jsdoc-to-markdown": "^8.0.0",
+		"hippogriff": "0.1.2",
+		"jsdoc-to-markdown": "^9.1.3",
 		"npm-run-all": "^4.1.5",
-		"typescript": "^5.2.2"
+		"typedoc": "^0.28.15",
+		"typedoc-plugin-markdown": "^4.9.0",
+		"typedoc-plugin-missing-exports": "^4.1.2",
+		"typescript": "^5.9.3"
 	}
 }

package/index.js

@@ -1,17 +0,0 @@
-/**
- * @name About
- * @private
- * @summary
- *
- * This library consists of two things. First is a data set of variations of different data type instances and values, along with coercible values, many of which were hand picked from the [big-list-of-naughty-strings](https://github.com/minimaxir/big-list-of-naughty-strings). Second is a handful of functions to help in testing type-enforcer and type-enforcer addons.
- */
-
-export * from './src/data/testValues.js';
-export { default as TestClass } from './src/data/TestClass.js';
-export * from './src/data/testData.js';
-
-export { default as multiTest } from './src/multiTest.js';
-
-export { default as testCheck } from './src/testCheck.js';
-export { default as testEnforce } from './src/testEnforce.js';
-export { default as testMethod } from './src/testMethod.js';

package/src/data/TestClass.js

@@ -1,11 +0,0 @@
-/**
- * @class TestClass
- * @classdesc A simple class for testing things like instanceof
- *
- * @param {unknown} value - Adds a property "value" to an instance of TestClass, set to the value provided.
- */
-export default class TestClass {
-	constructor(value) {
-		this.value = value;
-	}
-}

package/src/data/coercible.js

@@ -1,85 +0,0 @@
-export const coerceArrayTrue = ['["test"]', '[]'];
-
-export const coerceInfinity = [
-	'Infinity',
-	'-Infinity'
-];
-
-export const coerceIntegerTrue = [
-	'0',
-	'1',
-	'1.00',
-	'1E2',
-	'1E02',
-	'1E+02',
-	'-1',
-	'-1.00',
-	'-1E2',
-	'-1E02',
-	'-1E+02',
-	'-0',
-	'-0.0',
-	'+0',
-	'+0.0',
-	'0.00',
-	'0x0',
-	'0xffffffff',
-	'0xffffffffffffffff',
-	'0xabad1dea',
-	'01000',
-	'08',
-	'09'];
-
-export const coerceFloatTrue = [
-	'3.2',
-	'10.5'
-];
-
-export const coerceNumberFalse = [
-	'$1.00',
-	'1/2',
-	'-$1.00',
-	'-1/2',
-	'1/0',
-	'0/0',
-	'-2147483648/-1',
-	'-9223372036854775808/-1',
-	'0..0',
-	'.',
-	'0.0.0',
-	'0,00',
-	'0,,0',
-	',',
-	'0,0,0',
-	'0.0/0',
-	'1.0/0.0',
-	'0.0/0.0',
-	'1,0/0,0',
-	'0,0/0,0',
-	'--1',
-	'-',
-	'-.',
-	'-,',
-	'NaN',
-	'INF',
-	'1#INF',
-	'-1#IND',
-	'1#QNAN',
-	'1#SNAN',
-	'1#IND',
-	'1,000.00',
-	'1 000.00',
-	'1\'000.00',
-	'1,000,000.00',
-	'1 000 000.00',
-	'1\'000\'000.00',
-	'1.000,00',
-	'1 000,00',
-	'1\'000,00',
-	'1.000.000,00',
-	'1 000 000,00',
-	'1\'000\'000,00',
-	NaN
-];
-
-export const coerceObjectTrue = ['{}', '{"test":"test"}'];

package/src/data/testData.js

@@ -1,417 +0,0 @@
-import difference from '../utility/difference.js';
-import {
-	coerceArrayTrue,
-	coerceFloatTrue,
-	coerceInfinity,
-	coerceIntegerTrue,
-	coerceNumberFalse,
-	coerceObjectTrue
-} from './coercible.js';
-import TestClass from './TestClass.js';
-import {
-	testValues,
-	validArrays,
-	validBooleans,
-	validDates,
-	validFloats,
-	validFunctions,
-	validInfinities,
-	validInstances,
-	validIntegers,
-	validMaps,
-	validObjects,
-	validPromises,
-	validRegExps,
-	validSets,
-	validStrings,
-	validSymbols,
-	validWeakMaps,
-	validWeakSets
-} from './testValues.js';
-
-/**
- * An array of all the test type objects (arrayData, booleanData, etc.)
- *
- * @constant {Array} testTypes
- */
-
-/**
- * A data set for testing Arrays
- *
- * @constant {object} arrayData
- * @property {Function} value - Array constructor
- * @property {string} name - The name used in type-enforcer namespaces for this type
- * @property {Array} true - [validArrays](testValues.md#validArrays)
- * @property {Array} false - [testValues](testValues.md#testValues) minus validArrays
- * @property {Array} coerceTrue - Values that can be coerced to this type
- * @property {Array} coerceFalse - Values that cannot be coerced to this type
- */
-export const arrayData = {
-	value: Array,
-	name: 'array',
-	true: validArrays,
-	false: difference(testValues, validArrays),
-	coerceTrue: coerceArrayTrue,
-	coerceFalse: difference(testValues, validArrays)
-};
-
-/**
- * A data set for testing Booleans
- *
- * @constant {object} booleanData
- * @property {Function} value - Boolean constructor
- * @property {string} name - The name used in type-enforcer namespaces for this type
- * @property {Array} true - [validBooleans](testValues.md#validBooleans)
- * @property {Array} false - [testValues](testValues.md#testValues) minus validBooleans
- * @property {Array} coerceTrue - Values that can be coerced to this type
- * @property {Array} coerceFalse - Values that cannot be coerced to this type
- */
-export const booleanData = {
-	value: Boolean,
-	name: 'boolean',
-	true: validBooleans,
-	false: difference(testValues, validBooleans),
-	coerceTrue: difference(testValues, validBooleans),
-	coerceFalse: []
-};
-
-/**
- * A data set for testing Dates
- *
- * @constant {object} dateData
- * @property {Function} value - Date constructor
- * @property {string} name - The name used in type-enforcer namespaces for this type
- * @property {Array} true - [validDates](testValues.md#validDates)
- * @property {Array} false - [testValues](testValues.md#testValues) minus validDates
- * @property {Array} coerceTrue - Values that can be coerced to this type
- * @property {Array} coerceFalse - Values that cannot be coerced to this type
- */
-export const dateData = {
-	value: Date,
-	name: 'date',
-	true: validDates,
-	false: difference(testValues, validDates),
-	coerceTrue: ['10/12/1980', 'January 8, 2014'],
-	coerceFalse: difference(testValues, validDates, validArrays, validFloats, validIntegers, validRegExps)
-};
-
-/**
- * A data set for testing Functions
- *
- * @constant {object} functionData
- * @property {Function} value - Function constructor
- * @property {string} name - The name used in type-enforcer namespaces for this type
- * @property {Array} true - [validFunctions](testValues.md#validFunctions)
- * @property {Array} false - [testValues](testValues.md#testValues) minus validFunctions
- * @property {Array} coerceTrue - Values that can be coerced to this type
- * @property {Array} coerceFalse - Values that cannot be coerced to this type
- */
-export const functionData = {
-	value: Function,
-	name: 'function',
-	true: validFunctions,
-	false: difference(testValues, validFunctions),
-	coerceTrue: [],
-	coerceFalse: difference(testValues, validFunctions)
-};
-
-/**
- * A data set for testing instanceOf
- *
- * @constant {object} instanceData
- * @property {Function} value - [TestClass](TestClass.md)
- * @property {string} name - The name used in type-enforcer namespaces for this type
- * @property {Array} true - [validInstances](testValues.md#validInstances)
- * @property {Array} false - [testValues](testValues.md#testValues) minus validInstances
- * @property {Array} coerceTrue - Included for consistency
- * @property {Array} coerceFalse - Included for consistency
- */
-export const instanceData = {
-	value: TestClass,
-	name: 'instanceOf',
-	true: validInstances,
-	false: difference(testValues, validInstances),
-	coerceTrue: [],
-	coerceFalse: []
-};
-
-/**
- * A data set for testing integers
- *
- * @constant {object} integerData
- * @property {string} name - The name used in type-enforcer namespaces for this type
- * @property {Array} skip - The "name" property of other test objects that will produce false negatives if tested against this objects data
- * @property {Array} true - [validIntegers](testValues.md#validIntegers)
- * @property {Array} false - [testValues](testValues.md#testValues) minus validIntegers and validInfinities
- * @property {Array} coerceTrue - Values that can be coerced to this type.
- * @property {Array} coerceFalse - Values that cannot be coerced to this type
- */
-export const integerData = {
-	name: 'integer',
-	skip: ['number', 'float'],
-	true: validIntegers,
-	false: difference(testValues, validIntegers, validInfinities),
-	coerceTrue: coerceIntegerTrue,
-	coerceFalse: coerceNumberFalse.concat(coerceFloatTrue, coerceInfinity)
-};
-
-/**
- * A data set for testing JSON
- *
- * @constant {object} jsonData
- * @property {string} name - The name used in type-enforcer namespaces for this type
- * @property {Array} true - Values that don't throw when passed through JSON.parse()
- * @property {Array} false - Values that DO throw when passed through JSON.parse()
- * @property {Array} coerceTrue - Included for consistency
- * @property {Array} coerceFalse - Included for consistency
- */
-export const jsonData = {
-	name: 'json',
-	true: coerceObjectTrue.concat(coerceArrayTrue, JSON.stringify(testValues)),
-	false: ['json'].concat(validDates, validFunctions, validObjects, validRegExps),
-	coerceTrue: [],
-	coerceFalse: []
-};
-
-/**
- * A data set for testing integers
- *
- * @constant {object} floatData
- * @property {string} name - The name used in type-enforcer namespaces for this type
- * @property {Array} skip - The "name" property of other test objects that will produce false negatives if tested against this objects data
- * @property {Array} true - [validFloats](testValues.md#validFloats)
- * @property {Array} false - [testValues](testValues.md#testValues) minus validFloats
- * @property {Array} coerceTrue - Values that can be coerced to this type
- * @property {Array} coerceFalse - Values that cannot be coerced to this type
- */
-export const floatData = {
-	name: 'float',
-	skip: ['number', 'integer'],
-	true: validFloats,
-	false: difference(testValues, validFloats, validIntegers, validInfinities),
-	coerceTrue: coerceIntegerTrue.concat(coerceFloatTrue),
-	coerceFalse: coerceNumberFalse.concat(coerceInfinity)
-};
-
-/**
- * A data set for testing numbers
- *
- * @constant {object} numberData
- * @property {Function} value - Number constructor
- * @property {string} name - The name used in type-enforcer namespaces for this type
- * @property {Array} skip - The "name" property of other test objects that will produce false negatives if tested against this objects data
- * @property {Array} true - [validFloats](testValues.md#validFloats)
- * @property {Array} false - [testValues](testValues.md#testValues) minus validFloats
- * @property {Array} coerceTrue - Values that can be coerced to this type
- * @property {Array} coerceFalse - Values that cannot be coerced to this type
- */
-export const numberData = {
-	value: Number,
-	name: 'number',
-	skip: ['integer', 'float'],
-	true: validFloats.concat(validIntegers, validInfinities),
-	false: difference(testValues, validFloats, validIntegers, validInfinities, [NaN]),
-	coerceTrue: coerceIntegerTrue.concat(coerceInfinity),
-	coerceFalse: coerceNumberFalse
-};
-
-/**
- * A data set for testing Maps
- *
- * @constant {object} mapData
- * @property {Function} value - Map constructor
- * @property {string} name - The name used in type-enforcer namespaces for this type
- * @property {Array} true - [validMaps](testValues.md#validMaps)
- * @property {Array} false - [testValues](testValues.md#testValues) minus validMaps
- * @property {Array} coerceTrue - Values that can be coerced to this type
- * @property {Array} coerceFalse - Values that cannot be coerced to this type
- */
-export const mapData = {
-	value: Map,
-	name: 'map',
-	true: validMaps,
-	false: difference(testValues, validMaps),
-	coerceTrue: coerceObjectTrue.concat(validObjects, [[[TestClass, 2],
-		[TestClass, 'test']], '[["test 1", 2], ["test 2", "test"]]']),
-	coerceFalse: difference(testValues, validMaps, validObjects, validArrays).concat(['test'])
-};
-
-/**
- * A data set for testing plain Objects
- *
- * @constant {object} objectData
- * @property {Function} value - Object constructor
- * @property {string} name - The name used in type-enforcer namespaces for this type
- * @property {Array} true - [validObjects](testValues.md#validObjects)
- * @property {Array} false - [testValues](testValues.md#testValues) minus validObjects
- * @property {Array} coerceTrue - Values that can be coerced to this type
- * @property {Array} coerceFalse - Values that cannot be coerced to this type
- */
-export const objectData = {
-	value: Object,
-	name: 'object',
-	true: validObjects,
-	false: [null, undefined, true, false],
-	coerceTrue: coerceObjectTrue,
-	coerceFalse: validStrings
-};
-
-/**
- * A data set for testing Promises
- *
- * @constant {object} promiseData
- * @property {Function} value - Promise constructor
- * @property {string} name - The name used in type-enforcer namespaces for this type
- * @property {Array} true - [validPromises](testValues.md#validPromises)
- * @property {Array} false - [testValues](testValues.md#testValues) minus validPromises
- * @property {Array} coerceTrue - [validFunctions](testValues.md#validFunctions)
- * @property {Array} coerceFalse - [testValues](testValues.md#testValues) minus validPromises and validFunctions
- */
-export const promiseData = {
-	value: Promise,
-	name: 'promise',
-	true: validPromises,
-	false: difference(testValues, validPromises),
-	coerceTrue: validFunctions,
-	coerceFalse: difference(testValues, validFunctions, validPromises)
-};
-
-/**
- * A data set for testing RegExps
- *
- * @constant {object} regExpData
- * @property {Function} value - RegExp constructor
- * @property {string} name - The name used in type-enforcer namespaces for this type
- * @property {Array} true - [validRegExps](testValues.md#validRegExps)
- * @property {Array} false - [testValues](testValues.md#testValues) minus validRegExps
- * @property {Array} coerceTrue - Values that can be coerced to this type
- * @property {Array} coerceFalse - Values that cannot be coerced to this type
- */
-export const regExpData = {
-	value: RegExp,
-	name: 'regExp',
-	true: validRegExps,
-	false: difference(testValues, validRegExps),
-	coerceTrue: ['test', '/[a-z]+/', '/[a-z]+/gi'],
-	coerceFalse: difference(testValues, validStrings, validRegExps)
-};
-
-/**
- * A data set for testing Sets
- *
- * @constant {object} setData
- * @property {Function} value - Set constructor
- * @property {string} name - The name used in type-enforcer namespaces for this type
- * @property {Array} true - [validSets](testValues.md#validSets)
- * @property {Array} false - [testValues](testValues.md#testValues) minus validSets
- * @property {Array} coerceTrue - Values that can be coerced to this type
- * @property {Array} coerceFalse - Values that cannot be coerced to this type
- */
-export const setData = {
-	value: Set,
-	name: 'set',
-	true: validSets,
-	false: difference(testValues, validSets),
-	coerceTrue: validArrays.concat(['[]', '[1, 2]']),
-	coerceFalse: difference(testValues, validSets, validArrays)
-};
-
-/**
- * A data set for testing Strings
- *
- * @constant {object} stringData
- * @property {Function} value - String constructor
- * @property {string} name - The name used in type-enforcer namespaces for this type
- * @property {Array} true - [validStrings](testValues.md#validStrings)
- * @property {Array} false - [testValues](testValues.md#testValues) minus validStrings
- * @property {Array} coerceTrue - Values that can be coerced to this type
- * @property {Array} coerceFalse - Values that cannot be coerced to this type
- */
-export const stringData = {
-	value: String,
-	name: 'string',
-	true: validStrings,
-	false: difference(testValues, validStrings),
-	coerceTrue: difference(testValues, validStrings, [null, undefined]),
-	coerceFalse: [null, undefined]
-};
-
-/**
- * A data set for testing Symbols
- *
- * @constant {object} symbolData
- * @property {Function} value - Symbol constructor
- * @property {string} name - The name used in type-enforcer namespaces for this type
- * @property {Array} true - [validSymbols](testValues.md#validSymbols)
- * @property {Array} false - [testValues](testValues.md#testValues) minus validSymbols
- * @property {Array} coerceTrue - Values that can be coerced to this type
- * @property {Array} coerceFalse - Values that cannot be coerced to this type
- */
-export const symbolData = {
-	value: Symbol,
-	name: 'symbol',
-	true: validSymbols,
-	false: difference(testValues, validSymbols),
-	coerceTrue: stringData.coerceTrue,
-	coerceFalse: stringData.coerceFalse
-};
-
-/**
- * A data set for testing WeakMaps
- *
- * @constant {object} weakMapData
- * @property {Function} value - WeakMap constructor
- * @property {string} name - The name used in type-enforcer namespaces for this type
- * @property {Array} true - [validWeakMaps](testValues.md#validWeakMaps)
- * @property {Array} false - [testValues](testValues.md#testValues) minus validWeakMaps
- * @property {Array} coerceTrue - Values that can be coerced to this type
- * @property {Array} coerceFalse - Values that cannot be coerced to this type
- */
-export const weakMapData = {
-	value: WeakMap,
-	name: 'weakMap',
-	true: validWeakMaps,
-	false: difference(testValues, validWeakMaps),
-	coerceTrue: [[[TestClass, 2], [TestClass, 'test']]],
-	coerceFalse: difference(testValues, validWeakMaps, validArrays).concat(['test'])
-};
-
-/**
- * A data set for testing WeakSets
- *
- * @constant {object} weakSetData
- * @property {Function} value - WeakSet constructor
- * @property {string} name - The name used in type-enforcer namespaces for this type
- * @property {Array} true - [validWeakSets](testValues.md#validWeakSets)
- * @property {Array} false - [testValues](testValues.md#testValues) minus validWeakSets
- * @property {Array} coerceTrue - Values that can be coerced to this type
- * @property {Array} coerceFalse - Values that cannot be coerced to this type
- */
-export const weakSetData = {
-	value: WeakSet,
-	name: 'weakSet',
-	true: validWeakSets,
-	false: difference(testValues, validWeakSets),
-	coerceTrue: [validInstances],
-	coerceFalse: difference(testValues, validWeakSets, validArrays)
-};
-
-export const testTypes = [
-	arrayData,
-	booleanData,
-	dateData,
-	functionData,
-	instanceData,
-	integerData,
-	floatData,
-	numberData,
-	mapData,
-	objectData,
-	promiseData,
-	regExpData,
-	setData,
-	stringData,
-	symbolData,
-	weakMapData,
-	weakSetData
-];