objectmodel 4.4.4 → 4.4.6

package/.eslintignore

@@ -1,9 +1,9 @@
-docs/examples/common.js
-dist
-test/lib
-docs/**/lib
-docs/v1
-docs/v2
-docs/node_modules
-*.compiled.js
+docs/examples/common.js
+dist
+test/lib
+docs/**/lib
+docs/v1
+docs/v2
+docs/node_modules
+*.compiled.js
 *.html

package/.eslintrc.json

@@ -1,26 +1,26 @@
-{
-	"extends": "eslint:recommended",
-	"env": {
-		"browser": true,
-		"node": true,
-		"es6": true
-	},
-	"parserOptions": {
-		"ecmaVersion": 2018,
-		"sourceType": "module"
-	},
-	"rules": {
-		"indent": [
-			"error",
-			"tab",
-			{
-				"SwitchCase": 1
-			}
-		],
-		"no-mixed-spaces-and-tabs": [
-			"error",
-			"smart-tabs"
-		],
-		"no-console": "off"
-	}
+{
+	"extends": "eslint:recommended",
+	"env": {
+		"browser": true,
+		"node": true,
+		"es6": true
+	},
+	"parserOptions": {
+		"ecmaVersion": 2018,
+		"sourceType": "module"
+	},
+	"rules": {
+		"indent": [
+			"error",
+			"tab",
+			{
+				"SwitchCase": 1
+			}
+		],
+		"no-mixed-spaces-and-tabs": [
+			"error",
+			"smart-tabs"
+		],
+		"no-console": "off"
+	}
 }

package/LICENSE

@@ -1,22 +1,22 @@
-Copyright (c) 2015 Sylvain Pollet-Villard
-
-Permission is hereby granted, free of charge, to any person
-obtaining a copy of this software and associated documentation
-files (the "Software"), to deal in the Software without
-restriction, including without limitation the rights to use,
-copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the
-Software is furnished to do so, subject to the following
-conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2015 Sylvain Pollet-Villard
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,68 +1,68 @@
-<p align="center"><a href="http://objectmodel.js.org" target="_blank"><img width="400" src="http://objectmodel.js.org/docs/res/logo.png"></a></p>
-
-<p align="center">Strong Dynamically Typed Object Modeling for JavaScript</p>
-<p align="center">
-  <a href="https://www.npmjs.com/package/objectmodel"><img src="https://img.shields.io/npm/dt/objectmodel.svg" alt="Downloads"></a>
-  <a href="https://www.npmjs.com/package/objectmodel"><img src="https://img.shields.io/npm/v/objectmodel.svg" alt="Version"></a>
-  <a href="https://travis-ci.org/sylvainpolletvillard/ObjectModel"><img src="https://travis-ci.org/sylvainpolletvillard/ObjectModel.svg?branch=master" alt="Status"></a>
-  <a href="https://www.npmjs.com/package/objectmodel"><img src="https://img.shields.io/npm/l/objectmodel.svg" alt="License"></a>
-</p>
-
----
-
-## What is this library ?
-   
-  ObjectModel intends to bring **strong dynamic type checking** to your web applications. Contrary to static type-checking solutions like [TypeScript] or [Flow], ObjectModel can also validate data at runtime: JSON from the server, form inputs, content from localStorage, external libraries...
-  
-  By leveraging **ES6 Proxies**, this library ensures that your variables always match the model definition and validation constraints you added to them. Thanks to the generated exceptions, it will help you spot potential bugs and save you time spent on debugging. ObjectModel is also very easy to master: *no new language to learn, no new tools, no compilation step, just a minimalist and intuitive API in a plain old JS micro-library*.
-  
-  Validating at runtime also brings many other benefits: you can define your own types, use them in complex model definitions with custom assertions that can even change depending on your application state. Actually it goes much further than just type safety. Go on and see for yourself.
-
-## Installation
-Add the library to your project dependencies with NPM:
-```bash
-$ npm install objectmodel
-```
-
-or just [download the library from Github][github-releases]
-
-## Basic usage example
-
-```javascript
-import { ObjectModel } from "objectmodel"
-
-const Order = new ObjectModel({
-	product: { name: String, quantity: Number },
-	orderDate: Date
-});
-
-const myOrder = new Order({
-	product: { name: "Apple Pie", quantity: 1 },
-	orderDate: new Date()
-});
-
-myOrder.product.quantity = 2; // no exceptions thrown
-myOrder.product.quantity = false; //try to assign a Boolean
-// ❌ TypeError: expecting product.quantity to be Number, got Boolean false
-```
-
-## Documentation
-
-For more examples, documentation and questions, please refer to the project website: [objectmodel.js.org][website]
-
-## Changelog and Release History
-
-Please refer to [Github Releases][github-releases]
-
-*Bug reports and pull requests are welcome.*
-
-Distributed under the MIT license. See ``LICENSE`` for more information.
-
-[website]:http://objectmodel.js.org
-[TypeScript]:https://www.typescriptlang.org/
-[Flow]:https://flowtype.org/
-[github-releases]:https://github.com/sylvainpolletvillard/ObjectModel/releases
-[npm-url]: https://npmjs.org/package/objectmodel
-[npm-image]: https://img.shields.io/npm/v/objectmodel.svg
-[npm-downloads]: https://img.shields.io/npm/dm/objectmodel.svg
+<p align="center"><a href="http://objectmodel.js.org" target="_blank"><img width="400" src="http://objectmodel.js.org/docs/res/logo.png"></a></p>
+
+<p align="center">Strong Dynamically Typed Object Modeling for JavaScript</p>
+<p align="center">
+  <a href="https://www.npmjs.com/package/objectmodel"><img src="https://img.shields.io/npm/dt/objectmodel.svg" alt="Downloads"></a>
+  <a href="https://www.npmjs.com/package/objectmodel"><img src="https://img.shields.io/npm/v/objectmodel.svg" alt="Version"></a>
+  <a href="https://travis-ci.org/sylvainpolletvillard/ObjectModel"><img src="https://travis-ci.org/sylvainpolletvillard/ObjectModel.svg?branch=master" alt="Status"></a>
+  <a href="https://www.npmjs.com/package/objectmodel"><img src="https://img.shields.io/npm/l/objectmodel.svg" alt="License"></a>
+</p>
+
+---
+
+## What is this library ?
+   
+  ObjectModel intends to bring **strong dynamic type checking** to your web applications. Contrary to static type-checking solutions like [TypeScript] or [Flow], ObjectModel can also validate data at runtime: JSON from the server, form inputs, content from localStorage, external libraries...
+  
+  By leveraging **ES6 Proxies**, this library ensures that your variables always match the model definition and validation constraints you added to them. Thanks to the generated exceptions, it will help you spot potential bugs and save you time spent on debugging. ObjectModel is also very easy to master: *no new language to learn, no new tools, no compilation step, just a minimalist and intuitive API in a plain old JS micro-library*.
+  
+  Validating at runtime also brings many other benefits: you can define your own types, use them in complex model definitions with custom assertions that can even change depending on your application state. Actually it goes much further than just type safety. Go on and see for yourself.
+
+## Installation
+Add the library to your project dependencies with NPM:
+```bash
+$ npm install objectmodel
+```
+
+or just [download the library from Github][github-releases]
+
+## Basic usage example
+
+```javascript
+import { ObjectModel } from "objectmodel"
+
+const Order = new ObjectModel({
+	product: { name: String, quantity: Number },
+	orderDate: Date
+});
+
+const myOrder = new Order({
+	product: { name: "Apple Pie", quantity: 1 },
+	orderDate: new Date()
+});
+
+myOrder.product.quantity = 2; // no exceptions thrown
+myOrder.product.quantity = false; //try to assign a Boolean
+// ❌ TypeError: expecting product.quantity to be Number, got Boolean false
+```
+
+## Documentation
+
+For more examples, documentation and questions, please refer to the project website: [objectmodel.js.org][website]
+
+## Changelog and Release History
+
+Please refer to [Github Releases][github-releases]
+
+*Bug reports and pull requests are welcome.*
+
+Distributed under the MIT license. See ``LICENSE`` for more information.
+
+[website]:http://objectmodel.js.org
+[TypeScript]:https://www.typescriptlang.org/
+[Flow]:https://flowtype.org/
+[github-releases]:https://github.com/sylvainpolletvillard/ObjectModel/releases
+[npm-url]: https://npmjs.org/package/objectmodel
+[npm-image]: https://img.shields.io/npm/v/objectmodel.svg
+[npm-downloads]: https://img.shields.io/npm/dm/objectmodel.svg
 [license-badge]:https://img.shields.io/badge/license-MIT-blue.svg

package/build/add-banner.js

@@ -1,14 +1,14 @@
-import fs from 'fs';
-import pkg from '../package.json' assert { type: 'json' };
-
-const banner = `// ObjectModel v${pkg.version} - ${pkg.homepage}
-// ${pkg.license} License - ${pkg.author}`;
-
-const paths = [
-	"./dist/object-model.js",
-	"./dist/object-model.min.js"
-]
-
-paths.forEach(path => {
-	fs.writeFileSync(path, banner + '\n' + fs.readFileSync(path, 'utf8'))
+import fs from 'fs';
+import pkg from '../package.json' with { type: 'json' };
+
+const banner = `// ObjectModel v${pkg.version} - ${pkg.homepage}
+// ${pkg.license} License - ${pkg.author}`;
+
+const paths = [
+	"./dist/object-model.js",
+	"./dist/object-model.min.js"
+]
+
+paths.forEach(path => {
+	fs.writeFileSync(path, banner + '\n' + fs.readFileSync(path, 'utf8'))
 })

package/build/bundle-entry.dev.js

@@ -1,3 +1,3 @@
-import "../src/devtool-formatter"
-
+import "../src/devtool-formatter"
+
 export * from "./bundle-entry"

package/build/bundle-entry.js

@@ -1,12 +1,12 @@
-import { Model, BasicModel, ObjectModel, ArrayModel, FunctionModel, MapModel, SetModel, Any } from "../src/index"
-
-export {
-	Model,
-	BasicModel,
-	ObjectModel,
-	ArrayModel,
-	FunctionModel,
-	MapModel,
-	SetModel,
-	Any
+import { Model, BasicModel, ObjectModel, ArrayModel, FunctionModel, MapModel, SetModel, Any } from "../src/index"
+
+export {
+	Model,
+	BasicModel,
+	ObjectModel,
+	ArrayModel,
+	FunctionModel,
+	MapModel,
+	SetModel,
+	Any
 }

package/build/update-docs.js

@@ -2,7 +2,7 @@ import fs from 'fs';
 import filesize from 'pretty-bytes';
 import { gzipSizeSync } from 'gzip-size';
 
-import pkg from '../package.json' assert { type: 'json' };
+import pkg from '../package.json' with { type: 'json' };
 
 function updateIndex(html){
 	const libPath = "./dist/object-model.min.js"

package/dist/object-model.cjs

@@ -1,50 +1,50 @@
-// ObjectModel v4.4.4 - http://objectmodel.js.org
-// MIT License - Sylvain Pollet-Villard
-const
-	ObjectProto = Object.prototype,
-	bettertypeof = x => ObjectProto.toString.call(x).match(/\s([a-zA-Z]+)/)[1],
-	getProto = Object.getPrototypeOf,
-	setProto = Object.setPrototypeOf,
-
-	has = (o, prop) => ObjectProto.hasOwnProperty.call(o, prop),
-	is = (Constructor, obj) => obj instanceof Constructor,
-	isFunction = f => typeof f === "function",
-	isObject = o => o && typeof o === "object",
-	isString = s => typeof s === "string",
-	isPlainObject = o => isObject(o) && getProto(o) === ObjectProto,
-	isIterable = x => x && isFunction(x[Symbol.iterator]),
-
-	proxify = (val, traps) => new Proxy(val, traps),
-
-	merge = (target, src = {}) => {
-		for (let key in src) {
-			if (isPlainObject(src[key])) {
-				const o = {};
-				merge(o, target[key]);
-				merge(o, src[key]);
-				target[key] = o;
-			} else {
-				target[key] = src[key];
-			}
-		}
-		return target
-	},
-
-	define = (obj, key, value, enumerable = false) => {
-		Object.defineProperty(obj, key, { value, enumerable, writable: true, configurable: true });
-	},
-
-	extend = (child, parent, props) => {
-		child.prototype = Object.assign(Object.create(parent.prototype, {
-			constructor: {
-				value: child,
-				writable: true,
-				configurable: true
-			}
-		}), props);
-		setProto(child, parent);
-	};
-
+// ObjectModel v4.4.5 - http://objectmodel.js.org
+// MIT License - Sylvain Pollet-Villard
+const
+	ObjectProto = Object.prototype,
+	bettertypeof = x => ObjectProto.toString.call(x).match(/\s([a-zA-Z]+)/)[1],
+	getProto = Object.getPrototypeOf,
+	setProto = Object.setPrototypeOf,
+
+	has = (o, prop) => ObjectProto.hasOwnProperty.call(o, prop),
+	is = (Constructor, obj) => obj instanceof Constructor,
+	isFunction = f => typeof f === "function",
+	isObject = o => o && typeof o === "object",
+	isString = s => typeof s === "string",
+	isPlainObject = o => isObject(o) && getProto(o) === ObjectProto,
+	isIterable = x => x && isFunction(x[Symbol.iterator]),
+
+	proxify = (val, traps) => new Proxy(val, traps),
+
+	merge = (target, src = {}) => {
+		for (let key in src) {
+			if (isPlainObject(src[key])) {
+				const o = {};
+				merge(o, target[key]);
+				merge(o, src[key]);
+				target[key] = o;
+			} else {
+				target[key] = src[key];
+			}
+		}
+		return target
+	},
+
+	define = (obj, key, value, enumerable = false) => {
+		Object.defineProperty(obj, key, { value, enumerable, writable: true, configurable: true });
+	},
+
+	extend = (child, parent, props) => {
+		child.prototype = Object.assign(Object.create(parent.prototype, {
+			constructor: {
+				value: child,
+				writable: true,
+				configurable: true
+			}
+		}), props);
+		setProto(child, parent);
+	};
+
 const
 	_check = Symbol(),
 	_checked = Symbol(), // used to skip validation at instanciation for perf
@@ -102,6 +102,7 @@ const
 					err.message = "expecting " + (err.path ? err.path + " to be " : "") + formatDefinition(err.expected)
 						+ ", got " + (err.received != null ? bettertypeof(err.received) + " " : "") + format$1(err.received);
 				}
+				err.model = model;
 				return err
 			});
 
@@ -518,49 +519,49 @@ Any.remaining = function (def) { this.definition = def; };
 extend(Any.remaining, Any, {
 	toString() { return "..." + formatDefinition(this.definition) }
 });
-Any[Symbol.iterator] = function* () { yield new Any.remaining(this.definition); };
-
-const initListModel = (base, constructor, def, init, clone, mutators, otherTraps) => {
-
-	return initModel(def, constructor, base, init, model => Object.assign({
-		getPrototypeOf: () => model.prototype,
-		get(l, key) {
-			if (key === _original) return l
-
-			const val = l[key];
-			return isFunction(val) ? proxify(val, {
-				apply(fn, ctx, args) {
-					if (has(mutators, key)) {
-						// indexes of arguments to check def + cast
-						const [begin, end = args.length - 1, getArgDef] = mutators[key];
-						for (let i = begin; i <= end; i++) {
-							const argDef = getArgDef ? getArgDef(i) : model.definition;
-							args[i] = checkDefinition(
-								args[i],
-								argDef,
-								`${base.name}.${key} arguments[${i}]`,
-								model.errors,
-								[],
-								true
-							);
-						}
-
-						if (model.assertions.length > 0) {
-							const testingClone = clone(l);
-							fn.apply(testingClone, args);
-							checkAssertions(testingClone, model, `after ${key} mutation`);
-						}
-
-						unstackErrors(model);
-					}
-
-					return fn.apply(l, args)
-				}
-			}) : val
-		}
-	}, otherTraps))
-};
-
+Any[Symbol.iterator] = function* () { yield new Any.remaining(this.definition); };
+
+const initListModel = (base, constructor, def, init, clone, mutators, otherTraps) => {
+
+	return initModel(def, constructor, base, init, model => Object.assign({
+		getPrototypeOf: () => model.prototype,
+		get(l, key) {
+			if (key === _original) return l
+
+			const val = l[key];
+			return isFunction(val) ? proxify(val, {
+				apply(fn, ctx, args) {
+					if (has(mutators, key)) {
+						// indexes of arguments to check def + cast
+						const [begin, end = args.length - 1, getArgDef] = mutators[key];
+						for (let i = begin; i <= end; i++) {
+							const argDef = getArgDef ? getArgDef(i) : model.definition;
+							args[i] = checkDefinition(
+								args[i],
+								argDef,
+								`${base.name}.${key} arguments[${i}]`,
+								model.errors,
+								[],
+								true
+							);
+						}
+
+						if (model.assertions.length > 0) {
+							const testingClone = clone(l);
+							fn.apply(testingClone, args);
+							checkAssertions(testingClone, model, `after ${key} mutation`);
+						}
+
+						unstackErrors(model);
+					}
+
+					return fn.apply(l, args)
+				}
+			}) : val
+		}
+	}, otherTraps))
+};
+
 function ArrayModel(initialDefinition) {
 	const model = initListModel(
 		Array,
@@ -622,8 +623,8 @@ const controlMutation = (model, array, key, value, applyMutation, canBeExtended)
 	const isSuccess = !unstackErrors(model);
 	if (isSuccess) applyMutation(array, value);
 	return isSuccess
-};
-
+};
+
 function SetModel(initialDefinition) {
 	const model = initListModel(
 		Set,
@@ -658,8 +659,8 @@ extend(SetModel, Model, {
 	extend(...newParts) {
 		return extendModel(new SetModel(extendDefinition(this.definition, newParts)), this)
 	}
-});
-
+});
+
 function MapModel(initialKeyDefinition, initialValueDefinition) {
 	const getDef = i => i === 0 ? model.definition.key : model.definition.value;
 	const model = initListModel(
@@ -701,8 +702,8 @@ extend(MapModel, Model, {
 			extendDefinition(this.definition.value, valueParts)
 		), this)
 	}
-});
-
+});
+
 function FunctionModel(...argsDef) {
 	return initModel({ arguments: argsDef }, FunctionModel, Function, null, model => ({
 		getPrototypeOf: () => model.prototype,
@@ -755,8 +756,8 @@ extend(FunctionModel, Model, {
 	[_check](f, path, errors) {
 		if (!isFunction(f)) stackError(errors, "Function", f, path);
 	}
-});
-
+});
+
 const styles = {
 	list: "list-style-type: none; padding: 0; margin: 0;",
 	listItem: "padding: 0 0 0 1em;",
@@ -948,16 +949,16 @@ const ModelInstanceFormatter = {
 if (typeof window !== "undefined") {
 	window.devtoolsFormatters = (window.devtoolsFormatters || [])
 		.concat(ModelFormatter, ModelInstanceFormatter);
-}
-
-;
-//# sourceMappingURL=object-model.js.map
-
-exports.Any=Any;
-exports.ArrayModel=ArrayModel;
-exports.BasicModel=BasicModel;
-exports.FunctionModel=FunctionModel;
-exports.MapModel=MapModel;
-exports.Model=Model;
-exports.ObjectModel=ObjectModel;
+}
+
+;
+//# sourceMappingURL=object-model.js.map
+
+exports.Any=Any;
+exports.ArrayModel=ArrayModel;
+exports.BasicModel=BasicModel;
+exports.FunctionModel=FunctionModel;
+exports.MapModel=MapModel;
+exports.Model=Model;
+exports.ObjectModel=ObjectModel;
 exports.SetModel=SetModel;