@esm-test/guards 1.0.0-beta.3 → 1.0.0-beta.5

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.0.0-beta.3
+
+- moved package to @esm-test npm org
+
 # 1.0.0-beta.2
 
 - Fixed package repo link

package/README.md

@@ -2,7 +2,13 @@
 
 [![Pipeline status](https://gitlab.com/esm-test-group/esm-test-guards/badges/master/pipeline.svg)](https://gitlab.com/esm-test-group/esm-test-guards/-/pipelines)
 [![The ISC license](https://img.shields.io/badge/license-ISC-orange.png?color=blue&style=flat-square)](http://opensource.org/licenses/ISC)
-[![NPM version](https://img.shields.io/npm/v/esm-test-guards.svg)](https://www.npmjs.org/package/esm-test-guards)
-[![NPM downloads](https://img.shields.io/npm/dm/esm-test-guards.svg)](https://npmjs.org/package/esm-test-guards "View this project on NPM")
+[![NPM version](https://img.shields.io/npm/v/@esm-test/guards.svg)](https://www.npmjs.org/package/@esm-test/guards)
+[![NPM downloads](https://img.shields.io/npm/dm/@esm-test/guards.svg)](https://npmjs.org/package/@esm-test/guards "View this project on NPM")
 
 [![BuyMeACoffee](https://www.buymeacoffee.com/assets/img/custom_images/purple_img.png)](https://www.buymeacoffee.com/peterf)
+
+A js utility library for guarding objects, instances and types
+
+```sh
+npm install @esm-test/guards
+```

package/index.d.ts

@@ -1,4 +1,4 @@
-declare module 'esm-test-guards' {
+declare module '@esm-test/guards' {
 
   export function notComplexObjectMessage(guardName: string): string;
   export function throwNotComplexObject(guardName: string, guard: object): void;

package/legacy/src/guardComplexObject.cjs

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isComplexObject = exports.throwNotComplexObject = exports.notComplexObjectMessage = void 0;
+/**
+ * @param {string} guardName
+ */
+const notComplexObjectMessage = (guardName) => (`'${guardName}' must be a complex object`);
+exports.notComplexObjectMessage = notComplexObjectMessage;
+/**
+ * @param {string} guardName
+ * @param {object} guard
+ */
+const throwNotComplexObject = (guardName, guard) => {
+    if ((0, exports.isComplexObject)(guard) === false) {
+        throw new Error((0, exports.notComplexObjectMessage)(guardName));
+    }
+};
+exports.throwNotComplexObject = throwNotComplexObject;
+/**
+ * @param {object} value
+ * @returns
+ */
+const isComplexObject = (value) => {
+    const isDefined = value !== undefined && value !== null;
+    return isDefined
+        && value.constructor
+        && value.constructor === Object;
+};
+exports.isComplexObject = isComplexObject;
+//# sourceMappingURL=guardComplexObject.cjs.map

package/legacy/src/guardComplexObject.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"guardComplexObject.cjs","sourceRoot":"","sources":["../../src/guardComplexObject.js"],"names":[],"mappings":";;;AAAA;;GAEG;AACI,MAAM,uBAAuB,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,CACpD,IAAI,SAAS,4BAA4B,CAC1C,CAAA;AAFY,QAAA,uBAAuB,2BAEnC;AAED;;;GAGG;AACI,MAAM,qBAAqB,GAAG,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE;IACxD,IAAI,IAAA,uBAAe,EAAC,KAAK,CAAC,KAAK,KAAK,EAAE;QACpC,MAAM,IAAI,KAAK,CAAC,IAAA,+BAAuB,EAAC,SAAS,CAAC,CAAC,CAAC;KACrD;AACH,CAAC,CAAA;AAJY,QAAA,qBAAqB,yBAIjC;AAED;;;GAGG;AACI,MAAM,eAAe,GAAG,CAAC,KAAK,EAAE,EAAE;IACvC,MAAM,SAAS,GAAG,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC;IACxD,OAAO,SAAS;WACX,KAAK,CAAC,WAAW;WACjB,KAAK,CAAC,WAAW,KAAK,MAAM,CAAC;AACpC,CAAC,CAAA;AALY,QAAA,eAAe,mBAK3B"}

package/legacy/src/guardInstance.cjs

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwNotAnyInstance = exports.notAnyInstanceMessage = exports.throwNotInstance = exports.notInstanceMessage = void 0;
+/**
+ * @param {string} guardName
+ * @param {Object} guardType
+ */
+const notInstanceMessage = (guardName, guardType) => (`'${guardName}' must be an instance of '${guardType.name}'`);
+exports.notInstanceMessage = notInstanceMessage;
+/**
+ * @param {string} guardName
+ * @param {object} guard
+ * @param {Object} guardType
+ */
+const throwNotInstance = (guardName, guard, guardType) => {
+    const isInstance = guard instanceof guardType;
+    if (isInstance === false) {
+        throw new Error((0, exports.notInstanceMessage)(guardName, guardType));
+    }
+};
+exports.throwNotInstance = throwNotInstance;
+/**
+ * @param {object} guardInstance
+ * @param {Object[]} guardTypes
+ */
+const notAnyInstanceMessage = (guardInstance, ...guardTypes) => {
+    const typeNames = guardTypes.map(t => t.name).join('|');
+    return `'${guardInstance.constructor.name}' must be an instance of either '${typeNames}'`;
+};
+exports.notAnyInstanceMessage = notAnyInstanceMessage;
+/**
+ * @param {object} guardInstance
+ * @param {Object[]} guardTypes
+ */
+const throwNotAnyInstance = (guardInstance, ...guardTypes) => {
+    for (let i = 0; i < guardTypes.length; i++) {
+        const isInstance = guardInstance instanceof guardTypes[i];
+        if (isInstance)
+            return;
+    }
+    throw new Error((0, exports.notAnyInstanceMessage)(guardInstance, ...guardTypes));
+};
+exports.throwNotAnyInstance = throwNotAnyInstance;
+//# sourceMappingURL=guardInstance.cjs.map

package/legacy/src/guardInstance.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"guardInstance.cjs","sourceRoot":"","sources":["../../src/guardInstance.js"],"names":[],"mappings":";;;AAAA;;;GAGG;AACI,MAAM,kBAAkB,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,EAAE,CAAC,CAC1D,IAAI,SAAS,6BAA6B,SAAS,CAAC,IAAI,GAAG,CAC5D,CAAA;AAFY,QAAA,kBAAkB,sBAE9B;AAED;;;;GAIG;AACI,MAAM,gBAAgB,GAAG,CAAC,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE;IAC9D,MAAM,UAAU,GAAG,KAAK,YAAY,SAAS,CAAC;IAC9C,IAAI,UAAU,KAAK,KAAK,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,IAAA,0BAAkB,EAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;KAC3D;AACH,CAAC,CAAA;AALY,QAAA,gBAAgB,oBAK5B;AAED;;;GAGG;AACI,MAAM,qBAAqB,GAAG,CAAC,aAAa,EAAE,GAAG,UAAU,EAAE,EAAE;IACpE,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxD,OAAO,IAAI,aAAa,CAAC,WAAW,CAAC,IAAI,oCAAoC,SAAS,GAAG,CAAA;AAC3F,CAAC,CAAA;AAHY,QAAA,qBAAqB,yBAGjC;AAED;;;GAGG;AACI,MAAM,mBAAmB,GAAG,CAAC,aAAa,EAAE,GAAG,UAAU,EAAE,EAAE;IAClE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QAC1C,MAAM,UAAU,GAAG,aAAa,YAAY,UAAU,CAAC,CAAC,CAAC,CAAC;QAC1D,IAAI,UAAU;YAAE,OAAO;KACxB;IACD,MAAM,IAAI,KAAK,CACb,IAAA,6BAAqB,EAAC,aAAa,EAAE,GAAG,UAAU,CAAC,CACpD,CAAC;AACJ,CAAC,CAAA;AARY,QAAA,mBAAmB,uBAQ/B"}

package/legacy/src/guardNull.cjs

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwNull = exports.nullMessage = void 0;
+/**
+ * @param {string} guardName
+ */
+const nullMessage = (guardName) => `${guardName} is null`;
+exports.nullMessage = nullMessage;
+/**
+ * @param {string} guardName
+ * @param {object} guard
+ */
+const throwNull = (guardName, guard) => {
+    const isNull = guard !== null;
+    if (isNull === false) {
+        throw new Error((0, exports.nullMessage)(guardName));
+    }
+};
+exports.throwNull = throwNull;
+//# sourceMappingURL=guardNull.cjs.map

package/legacy/src/guardNull.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"guardNull.cjs","sourceRoot":"","sources":["../../src/guardNull.js"],"names":[],"mappings":";;;AAAA;;GAEG;AACI,MAAM,WAAW,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,GAAG,SAAS,UAAU,CAAC;AAApD,QAAA,WAAW,eAAyC;AAEjE;;;GAGG;AACI,MAAM,SAAS,GAAG,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE;IAC5C,MAAM,MAAM,GAAG,KAAK,KAAK,IAAI,CAAC;IAC9B,IAAI,MAAM,KAAK,KAAK,EAAE;QACpB,MAAM,IAAI,KAAK,CAAC,IAAA,mBAAW,EAAC,SAAS,CAAC,CAAC,CAAC;KACzC;AACH,CAAC,CAAA;AALY,QAAA,SAAS,aAKrB"}

package/legacy/src/guardObjectKey.cjs

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwNotObjectKey = exports.notObjectKeyMessage = void 0;
+/**
+ * @param {string} guardName
+ * @param {object} guard
+ */
+const notObjectKeyMessage = (guardName, guard) => (`'${guardName}' must be one of '${Object.keys(guard).join(', ')}'`);
+exports.notObjectKeyMessage = notObjectKeyMessage;
+/**
+ * @param {string} guardName
+ * @param {object} guard
+ * @param {string} guardObjectKey
+ */
+const throwNotObjectKey = (guardName, guard, guardObjectKey) => {
+    const hasKey = Object.hasOwn(guard, guardObjectKey);
+    if (hasKey === false) {
+        throw new Error((0, exports.notObjectKeyMessage)(guardName, guard));
+    }
+};
+exports.throwNotObjectKey = throwNotObjectKey;
+//# sourceMappingURL=guardObjectKey.cjs.map

package/legacy/src/guardObjectKey.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"guardObjectKey.cjs","sourceRoot":"","sources":["../../src/guardObjectKey.js"],"names":[],"mappings":";;;AAAA;;;GAGG;AACI,MAAM,mBAAmB,GAAG,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,CACvD,IAAI,SAAS,qBAAqB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACnE,CAAA;AAFY,QAAA,mBAAmB,uBAE/B;AAED;;;;GAIG;AACI,MAAM,iBAAiB,GAAG,CAAC,SAAS,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE;IACpE,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IACpD,IAAI,MAAM,KAAK,KAAK,EAAE;QACpB,MAAM,IAAI,KAAK,CAAC,IAAA,2BAAmB,EAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;KACxD;AACH,CAAC,CAAA;AALY,QAAA,iBAAiB,qBAK7B"}

package/legacy/src/guardType.cjs

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwNotType = exports.notTypeMessage = void 0;
+/**
+ * @param {string} guardName
+ * @param {string} guardType
+ */
+const notTypeMessage = (guardName, guardType) => (`'${guardName}' must be a type of '${guardType}'`);
+exports.notTypeMessage = notTypeMessage;
+/**
+ * @param {string} guardName
+ * @param {object} guard
+ * @param {string} guardType
+ */
+const throwNotType = (guardName, guard, guardType) => {
+    const isType = typeof guard === guardType;
+    if (isType === false) {
+        throw new Error((0, exports.notTypeMessage)(guardName, guardType));
+    }
+};
+exports.throwNotType = throwNotType;
+//# sourceMappingURL=guardType.cjs.map

package/legacy/src/guardType.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"guardType.cjs","sourceRoot":"","sources":["../../src/guardType.js"],"names":[],"mappings":";;;AAAA;;;GAGG;AACI,MAAM,cAAc,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,EAAE,CAAC,CACtD,IAAI,SAAS,wBAAwB,SAAS,GAAG,CAClD,CAAA;AAFY,QAAA,cAAc,kBAE1B;AAED;;;;GAIG;AACI,MAAM,YAAY,GAAG,CAAC,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE;IAC1D,MAAM,MAAM,GAAG,OAAO,KAAK,KAAK,SAAS,CAAC;IAC1C,IAAI,MAAM,KAAK,KAAK,EAAE;QACpB,MAAM,IAAI,KAAK,CAAC,IAAA,sBAAc,EAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;KACvD;AACH,CAAC,CAAA;AALY,QAAA,YAAY,gBAKxB"}

package/legacy/src/guardUndefined.cjs

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwUndefined = exports.undefinedMessage = void 0;
+/**
+ * @param {string} guardName
+ */
+const undefinedMessage = (guardName) => `${guardName} is not defined`;
+exports.undefinedMessage = undefinedMessage;
+/**
+ * @param {string} guardName
+ * @param {object} guard
+ */
+const throwUndefined = (guardName, guard) => {
+    const isDefined = guard !== undefined;
+    if (isDefined === false) {
+        throw new Error((0, exports.undefinedMessage)(guardName));
+    }
+};
+exports.throwUndefined = throwUndefined;
+//# sourceMappingURL=guardUndefined.cjs.map

package/legacy/src/guardUndefined.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"guardUndefined.cjs","sourceRoot":"","sources":["../../src/guardUndefined.js"],"names":[],"mappings":";;;AAAA;;GAEG;AACI,MAAM,gBAAgB,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,GAAG,SAAS,iBAAiB,CAAC;AAAhE,QAAA,gBAAgB,oBAAgD;AAE7E;;;GAGG;AACI,MAAM,cAAc,GAAG,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE;IACjD,MAAM,SAAS,GAAG,KAAK,KAAK,SAAS,CAAC;IACtC,IAAI,SAAS,KAAK,KAAK,EAAE;QACvB,MAAM,IAAI,KAAK,CAAC,IAAA,wBAAgB,EAAC,SAAS,CAAC,CAAC,CAAC;KAC9C;AACH,CAAC,CAAA;AALY,QAAA,cAAc,kBAK1B"}

package/legacy/src/index.cjs

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./guardComplexObject.cjs"), exports);
+__exportStar(require("./guardObjectKey.cjs"), exports);
+__exportStar(require("./guardInstance.cjs"), exports);
+__exportStar(require("./guardNull.cjs"), exports);
+__exportStar(require("./guardType.cjs"), exports);
+__exportStar(require("./guardUndefined.cjs"), exports);
+//# sourceMappingURL=index.cjs.map

package/legacy/src/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAwC;AACxC,sDAAoC;AACpC,qDAAmC;AACnC,iDAA+B;AAC/B,iDAA+B;AAC/B,sDAAoC"}

package/package.json

@@ -1,30 +1,31 @@
 {
   "name": "@esm-test/guards",
-  "version": "1.0.0-beta.3",
-  "description": "A js library for guards objects, instances and types",
+  "version": "1.0.0-beta.5",
+  "description": "A js utility library for guarding objects, instances and types",
   "publishConfig": {
     "access": "public"
   },
-  "main": "./src/index.js",
+  "main": "./legacy/src/index.cjs",
   "type": "module",
   "types": "./index.d.ts",
   "exports": {
     "import": "./src/index.js",
+    "require": "./legacy/src/index.cjs",
     "types": "./index.d.ts"
   },
   "devDependencies": {
     "@types/mocha": "10.0.1",
-    "@types/node": "18.11.18",
+    "@types/node": "20.5.3",
     "assert": "2.0.0",
-    "c8": "7.12.0",
+    "c8": "8.0.1",
     "js-yaml": "4.1.0",
     "jshint": "2.13.6",
     "mocha": "10.2.0",
     "mocha-ui-esm": "1.0.0-beta.14",
-    "npm-build-tasks": "1.0.0-alpha.5",
-    "rimraf": "4.1.2",
+    "npm-build-tasks": "1.0.0-alpha.10",
+    "rimraf": "5.0.1",
     "source-map-support": "0.5.21",
-    "typescript": "4.9.5"
+    "typescript": "5.1.6"
   },
   "scripts": {
     "clean": "rimraf ./out",
@@ -32,6 +33,7 @@
     "fresh": "npm-build-task",
     "generate:types": "npm-build-task",
     "test": "npm-build-task",
+    "transform:legacy": "npm-build-task",
     "prepublishOnly": "npm-build-task"
   },
   "author": "pflannery",

package/src/guardComplexObject.js

@@ -10,14 +10,18 @@ export const notComplexObjectMessage = (guardName) => (
  * @param {object} guard
  */
 export const throwNotComplexObject = (guardName, guard) => {
-  const isDefined = guard !== undefined && guard !== null;
-  const isType = isDefined && typeof guard === "object";
-  const isComplexObject = isDefined
-    && isType
-    && guard.constructor
-    && guard.constructor === Object;
-
-  if (isComplexObject === false) {
+  if (isComplexObject(guard) === false) {
     throw new Error(notComplexObjectMessage(guardName));
   }
+}
+
+/**
+ * @param {object} value 
+ * @returns 
+ */
+export const isComplexObject = (value) => {
+  const isDefined = value !== undefined && value !== null;
+  return isDefined
+    && value.constructor
+    && value.constructor === Object;
 }