@esm-test/guards 1.0.0-beta.3

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 1.0.0-beta.2
+
+- Fixed package repo link
+
+# 1.0.0-beta.1
+
+- init commit extracted from [esm-test-parser](https://gitlab.com/esm-test-group/esm-test-parser)

package/LICENSE

@@ -0,0 +1,15 @@
+The ISC License
+
+Copyright (c) 2017 Peter Flannery and Contributors
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
+IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,8 @@
+# Esm test guards
+
+[![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")
+
+[![BuyMeACoffee](https://www.buymeacoffee.com/assets/img/custom_images/purple_img.png)](https://www.buymeacoffee.com/peterf)

package/index.d.ts

@@ -0,0 +1,23 @@
+declare module 'esm-test-guards' {
+
+  export function notComplexObjectMessage(guardName: string): string;
+  export function throwNotComplexObject(guardName: string, guard: object): void;
+
+  export function notInstanceMessage(guardName: string, guardType: Object): string;
+  export function throwNotInstance(guardName: string, guard: object, guardType: Object): void;
+  export function notAnyInstanceMessage(guardInstance: object, ...guardTypes: Object[]): string;
+  export function throwNotAnyInstance(guardInstance: object, ...guardTypes: Object[]): void;
+
+  export function nullMessage(guardName: string): string;
+  export function throwNull(guardName: string, guard: object): void;
+
+  export function notObjectKeyMessage(guardName: string, guard: object): string;
+  export function throwNotObjectKey(guardName: string, guard: object, guardObjectKey: string): void;
+  
+  export function notTypeMessage(guardName: string, guardType: string): string;
+  export function throwNotType(guardName: string, guard: object, guardType: string): void;
+  
+  export function undefinedMessage(guardName: string): string;
+  export function throwUndefined(guardName: string, guard: object): void;
+
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@esm-test/guards",
+  "version": "1.0.0-beta.3",
+  "description": "A js library for guards objects, instances and types",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./src/index.js",
+  "type": "module",
+  "types": "./index.d.ts",
+  "exports": {
+    "import": "./src/index.js",
+    "types": "./index.d.ts"
+  },
+  "devDependencies": {
+    "@types/mocha": "10.0.1",
+    "@types/node": "18.11.18",
+    "assert": "2.0.0",
+    "c8": "7.12.0",
+    "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",
+    "source-map-support": "0.5.21",
+    "typescript": "4.9.5"
+  },
+  "scripts": {
+    "clean": "rimraf ./out",
+    "coverage": "npm-build-task",
+    "fresh": "npm-build-task",
+    "generate:types": "npm-build-task",
+    "test": "npm-build-task",
+    "prepublishOnly": "npm-build-task"
+  },
+  "author": "pflannery",
+  "license": "ISC",
+  "keywords": [
+    "npm",
+    "node",
+    "test",
+    "guards"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/esm-test-group/esm-test-guards.git"
+  }
+}

package/src/guardComplexObject.js

@@ -0,0 +1,23 @@
+/**
+ * @param {string} guardName
+ */
+export const notComplexObjectMessage = (guardName) => (
+  `'${guardName}' must be a complex object`
+)
+
+/**
+ * @param {string} 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) {
+    throw new Error(notComplexObjectMessage(guardName));
+  }
+}

package/src/guardInstance.js

@@ -0,0 +1,42 @@
+/**
+ * @param {string} guardName
+ * @param {Object} guardType
+ */
+export const notInstanceMessage = (guardName, guardType) => (
+  `'${guardName}' must be an instance of '${guardType.name}'`
+)
+
+/**
+ * @param {string} guardName
+ * @param {object} guard
+ * @param {Object} guardType
+ */
+export const throwNotInstance = (guardName, guard, guardType) => {
+  const isInstance = guard instanceof guardType;
+  if (isInstance === false) {
+    throw new Error(notInstanceMessage(guardName, guardType));
+  }
+}
+
+/**
+ * @param {object} guardInstance
+ * @param {Object[]} guardTypes
+ */
+export const notAnyInstanceMessage = (guardInstance, ...guardTypes) => {
+  const typeNames = guardTypes.map(t => t.name).join('|');
+  return `'${guardInstance.constructor.name}' must be an instance of either '${typeNames}'`
+}
+
+/**
+ * @param {object} guardInstance
+ * @param {Object[]} guardTypes
+ */
+export const throwNotAnyInstance = (guardInstance, ...guardTypes) => {
+  for (let i = 0; i < guardTypes.length; i++) {
+    const isInstance = guardInstance instanceof guardTypes[i];
+    if (isInstance) return;
+  }
+  throw new Error(
+    notAnyInstanceMessage(guardInstance, ...guardTypes)
+  );
+}

package/src/guardNull.js

@@ -0,0 +1,15 @@
+/**
+ * @param {string} guardName
+ */
+export const nullMessage = (guardName) => `${guardName} is null`;
+
+/**
+ * @param {string} guardName
+ * @param {object} guard
+ */
+export const throwNull = (guardName, guard) => {
+  const isNull = guard !== null;
+  if (isNull === false) {
+    throw new Error(nullMessage(guardName));
+  }
+}

package/src/guardObjectKey.js

@@ -0,0 +1,19 @@
+/**
+ * @param {string} guardName
+ * @param {object} guard
+ */
+export const notObjectKeyMessage = (guardName, guard) => (
+  `'${guardName}' must be one of '${Object.keys(guard).join(', ')}'`
+)
+
+/**
+ * @param {string} guardName
+ * @param {object} guard
+ * @param {string} guardObjectKey
+ */
+export const throwNotObjectKey = (guardName, guard, guardObjectKey) => {
+  const hasKey = Object.hasOwn(guard, guardObjectKey);
+  if (hasKey === false) {
+    throw new Error(notObjectKeyMessage(guardName, guard));
+  }
+}

package/src/guardType.js

@@ -0,0 +1,19 @@
+/**
+ * @param {string} guardName
+ * @param {string} guardType
+ */
+export const notTypeMessage = (guardName, guardType) => (
+  `'${guardName}' must be a type of '${guardType}'`
+)
+
+/**
+ * @param {string} guardName
+ * @param {object} guard
+ * @param {string} guardType
+ */
+export const throwNotType = (guardName, guard, guardType) => {
+  const isType = typeof guard === guardType;
+  if (isType === false) {
+    throw new Error(notTypeMessage(guardName, guardType));
+  }
+}

package/src/guardUndefined.js

@@ -0,0 +1,15 @@
+/**
+ * @param {string} guardName
+ */
+export const undefinedMessage = (guardName) => `${guardName} is not defined`;
+
+/**
+ * @param {string} guardName
+ * @param {object} guard
+ */
+export const throwUndefined = (guardName, guard) => {
+  const isDefined = guard !== undefined;
+  if (isDefined === false) {
+    throw new Error(undefinedMessage(guardName));
+  }
+}

package/src/index.js

@@ -0,0 +1,6 @@
+export * from './guardComplexObject.js';
+export * from './guardObjectKey.js';
+export * from './guardInstance.js';
+export * from './guardNull.js';
+export * from './guardType.js';
+export * from './guardUndefined.js';