@esm-test/guards 1.0.0-beta.10

package/CHANGELOG.md

@@ -0,0 +1,39 @@
+# 1.0.0-beta.10
+
+  - updated source to typescript 5.9.3
+
+# 1.0.0-beta.9
+
+  - updated deps
+
+# 1.0.0-beta.8
+
+  - removed undefined and null checks from throwNotStringOrEmpty
+
+# 1.0.0-beta.7
+
+  - fixed index.d.ts fn name for throwNotStringOrEmpty
+
+# 1.0.0-beta.6
+
+- added throwEmpty (for strings)
+
+- added aggregate guards
+  - throwUndefinedOrNull
+  - throwNotSetOrEmpty
+
+# 1.0.0-beta.5
+
+- added cjs dist output
+
+# 1.0.0-beta.3
+
+- moved package to @esm-test npm org
+
+# 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/README.md

@@ -0,0 +1,67 @@
+# 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)
+
+A js utility library for guarding objects, instances and types
+
+```sh
+npm install @esm-test/guards
+```
+
+## Usage
+
+This library provides a set of utility functions to perform runtime checks and throw errors if the conditions are not met.
+
+### Type Guarding
+
+```typescript
+import { throwNotType } from '@esm-test/guards';
+
+const myVar: any = 123;
+throwNotType('myVar', myVar, 'string'); // Throws Error: 'myVar' must be a type of 'string'
+```
+
+### Null and Undefined
+
+```typescript
+import { throwUndefinedOrNull, throwNull, throwUndefined } from '@esm-test/guards';
+
+throwNull('myVar', null); // Throws Error: myVar is null
+throwUndefined('myVar', undefined); // Throws Error: myVar is not defined
+throwUndefinedOrNull('myVar', null); // Throws Error: myVar is null
+```
+
+### Instances
+
+```typescript
+import { throwNotInstance } from '@esm-test/guards';
+
+class MyClass {}
+const instance = new MyClass();
+
+throwNotInstance('instance', {}, MyClass); // Throws Error: 'instance' must be an instance of 'MyClass'
+```
+
+### Complex Objects
+
+Checks if a value is a plain object (not null, and constructor is `Object`).
+
+```typescript
+import { throwNotComplexObject } from '@esm-test/guards';
+
+throwNotComplexObject('config', []); // Throws Error: 'config' must be a complex object
+```
+
+### Strings
+
+```typescript
+import { throwNotStringOrEmpty, throwEmpty } from '@esm-test/guards';
+
+throwEmpty('name', ''); // Throws Error: name is empty
+throwNotStringOrEmpty('name', 123); // Throws Error: 'name' must be a type of 'string'
+```

package/dist/index.min.js

@@ -0,0 +1,2 @@
+var p=t=>`${t} is empty`,s=(t,n)=>{if(n==="")throw new Error(p(t))};var a=t=>`${t} is null`,r=(t,n)=>{if(n!==null===!1)throw new Error(a(t))};var f=(t,n)=>`'${t}' must be a type of '${n}'`,i=(t,n,o)=>{if(typeof n===o===!1)throw new Error(f(t,o))};var y=t=>`${t} is not defined`,c=(t,n)=>{if(n!==void 0===!1)throw new Error(y(t))};var N=(t,n)=>{c(t,n),r(t,n)},O=(t,n)=>{i(t,n,"string"),s(t,n)};var m=t=>`'${t}' must be a complex object`,C=(t,n)=>{if(l(n)===!1)throw new Error(m(t))},l=t=>t!=null&&t.constructor&&t.constructor===Object;var x=(t,n)=>`'${t}' must be an instance of '${n.name}'`,D=(t,n,o)=>{if(n instanceof o===!1)throw new Error(x(t,o))},w=(t,...n)=>{let o=n.map(e=>e.name).join("|");return`'${t.constructor.name}' must be an instance of either '${o}'`},K=(t,...n)=>{for(let o=0;o<n.length;o++)if(t instanceof n[o])return;throw new Error(w(t,...n))};var g=(t,n)=>`'${t}' must be one of '${Object.keys(n).join(", ")}'`,U=(t,n,o)=>{if(Object.hasOwn(n,o)===!1)throw new Error(g(t,n))};export{p as emptyMessage,l as isComplexObject,w as notAnyInstanceMessage,m as notComplexObjectMessage,x as notInstanceMessage,g as notObjectKeyMessage,f as notTypeMessage,a as nullMessage,s as throwEmpty,K as throwNotAnyInstance,C as throwNotComplexObject,D as throwNotInstance,U as throwNotObjectKey,O as throwNotStringOrEmpty,i as throwNotType,r as throwNull,c as throwUndefined,N as throwUndefinedOrNull,y as undefinedMessage};
+//# sourceMappingURL=index.min.js.map

package/dist/index.min.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/guardEmpty.ts", "../src/guardNull.ts", "../src/guardType.ts", "../src/guardUndefined.ts", "../src/guardAggregates.ts", "../src/guardComplexObject.ts", "../src/guardInstance.ts", "../src/guardObjectKey.ts"],
+  "sourcesContent": ["/**\n * Generates an error message when a string is empty.\n * \n * @param guardName - The name of the variable being guarded.\n * @returns A formatted error message.\n */\nexport const emptyMessage = (guardName: string): string => `${guardName} is empty`;\n\n/**\n * Throws an error if the provided string is empty ('').\n * \n * @param guardName - The name of the variable being guarded.\n * @param guard - The string to check for emptiness.\n * @throws {Error} Throws an error if `guard` is an empty string.\n */\nexport const throwEmpty = (guardName: string, guard: string): void => {\n  const isEmpty = guard === '';\n  if (isEmpty) throw new Error(emptyMessage(guardName));\n}", "/**\n * Generates an error message when a value is null.\n * \n * @param guardName - The name of the variable being guarded.\n * @returns A formatted error message.\n */\nexport const nullMessage = (guardName: string): string => `${guardName} is null`;\n\n/**\n * Throws an error if the provided value is null.\n * \n * @param guardName - The name of the variable being guarded.\n * @param guard - The value to check for null.\n * @throws {Error} Throws an error if `guard` is strictly equal to `null`.\n */\nexport const throwNull = (guardName: string, guard: any): void => {\n  const isNull = guard !== null;\n  if (isNull === false) {\n    throw new Error(nullMessage(guardName));\n  }\n}", "/**\n * Supported JavaScript types for type guarding.\n */\nexport type Types = \"number\" | \"string\" | \"boolean\" | \"undefined\" | \"function\" | \"object\" | \"bigint\" | \"symbol\";\n\n\n/**\n * Generates a standard error message when a value is not of the expected type.\n * \n * @param guardName - The name of the variable being guarded.\n * @param guardType - The expected type.\n * @returns A formatted error message.\n */\nexport const notTypeMessage = (guardName: string, guardType: Types): string => (\n  `'${guardName}' must be a type of '${guardType}'`\n)\n\n/**\n * Throws an error if the provided value is not of the specified type.\n * \n * @param guardName - The name of the variable being guarded.\n * @param guard - The value to check.\n * @param guardType - The expected type.\n * @throws {Error} Throws an error if `typeof guard` does not equal `guardType`.\n */\nexport const throwNotType = (guardName: string, guard: any, guardType: Types): void => {\n  const isType = typeof guard === guardType;\n  if (isType === false) {\n    throw new Error(notTypeMessage(guardName, guardType));\n  }\n}", "/**\n * Generates an error message when a value is undefined.\n * \n * @param guardName - The name of the variable being guarded.\n * @returns A formatted error message.\n */\nexport const undefinedMessage = (guardName: string): string => `${guardName} is not defined`;\n\n/**\n * Throws an error if the provided value is undefined.\n * \n * @param guardName - The name of the variable being guarded.\n * @param guard - The value to check for undefined.\n * @throws {Error} Throws an error if `guard` is strictly equal to `undefined`.\n */\nexport const throwUndefined = (guardName: string, guard: any): void => {\n  const isDefined = guard !== undefined;\n  if (isDefined === false) {\n    throw new Error(undefinedMessage(guardName));\n  }\n}", "import { throwEmpty } from \"./guardEmpty.js\";\nimport { throwNull } from \"./guardNull.js\";\nimport { throwNotType } from \"./guardType.js\";\nimport { throwUndefined } from \"./guardUndefined.js\";\n\n/**\n * Throws an error if the provided value is undefined or null.\n * \n * @param guardName - The name of the variable being guarded.\n * @param guard - The value to check.\n * @throws {Error} Throws an error if `guard` is `undefined` or `null`.\n */\nexport const throwUndefinedOrNull = (guardName: string, guard: any): void => {\n  throwUndefined(guardName, guard);\n  throwNull(guardName, guard);\n}\n\n/**\n * Throws an error if the provided value is not a string or is an empty string.\n * \n * @param guardName - The name of the variable being guarded.\n * @param guard - The value to check.\n * @throws {Error} Throws an error if `guard` is not a string or if it's empty ('').\n */\nexport const throwNotStringOrEmpty = (guardName: string, guard: any): void => {\n  throwNotType(guardName, guard, 'string')\n  throwEmpty(guardName, guard);\n}", "/**\n * Generates an error message when a value is not a complex object.\n * \n * @param guardName - The name of the variable being guarded.\n * @returns A formatted error message.\n */\nexport const notComplexObjectMessage = (guardName: string): string => (\n  `'${guardName}' must be a complex object`\n)\n\n/**\n * Throws an error if the provided value is not a complex object.\n * \n * A complex object is defined as a non-null object that is not a primitive and whose constructor is `Object`.\n * \n * @param guardName - The name of the variable being guarded.\n * @param guard - The value to check.\n * @throws {Error} Throws an error if `isComplexObject(guard)` is false.\n */\nexport const throwNotComplexObject = (guardName: string, guard: any): void => {\n  if (isComplexObject(guard) === false) {\n    throw new Error(notComplexObjectMessage(guardName));\n  }\n}\n\n/**\n * Determines if a value is a complex object.\n * \n * @param value - The value to test.\n * @returns `true` if the value is a defined, non-null object with a constructor matching `Object`.\n */\nexport const isComplexObject = (value: any): boolean => {\n  const isDefined = value !== undefined && value !== null;\n  return isDefined\n    && value.constructor\n    && value.constructor === Object;\n}", "/**\n * Represents a class constructor type.\n */\nexport type ClassInstance = new (...args: any[]) => void\n\n/**\n * Generates an error message when a value is not an instance of the specified class.\n * \n * @param guardName - The name of the variable being guarded.\n * @param guardType - The expected class constructor.\n * @returns A formatted error message.\n */\nexport const notInstanceMessage = (guardName: string, guardType: ClassInstance): string => (\n  `'${guardName}' must be an instance of '${guardType.name}'`\n)\n\n/**\n * Throws an error if the provided value is not an instance of the specified class.\n * \n * @param guardName - The name of the variable being guarded.\n * @param guard - The value to check.\n * @param guardType - The expected class constructor.\n * @throws {Error} Throws an error if `guard instanceof guardType` is false.\n */\nexport const throwNotInstance = (guardName: string, guard: any, guardType: ClassInstance): void => {\n  const isInstance = guard instanceof guardType;\n  if (isInstance === false) {\n    throw new Error(notInstanceMessage(guardName, guardType));\n  }\n}\n\n/**\n * Generates an error message when a value is not an instance of any of the specified classes.\n * \n * @param guardInstance - The value that failed the check.\n * @param guardTypes - The expected class constructors.\n * @returns A formatted error message.\n */\nexport const notAnyInstanceMessage = (guardInstance: any, ...guardTypes: ClassInstance[]): string => {\n  const typeNames = guardTypes.map(t => t.name).join('|');\n  return `'${guardInstance.constructor.name}' must be an instance of either '${typeNames}'`\n}\n\n/**\n * Throws an error if the provided value is not an instance of any of the specified classes.\n * \n * @param guardInstance - The value to check.\n * @param guardTypes - One or more expected class constructors.\n * @throws {Error} Throws an error if `guardInstance` is not an instance of any of the `guardTypes`.\n */\nexport const throwNotAnyInstance = (guardInstance: any, ...guardTypes: ClassInstance[]): void => {\n  for (let i = 0; i < guardTypes.length; i++) {\n    const isInstance = guardInstance instanceof guardTypes[i];\n    if (isInstance) return;\n  }\n  throw new Error(notAnyInstanceMessage(guardInstance, ...guardTypes));\n}", "/**\n * Generates an error message when a value is not a key of the provided record.\n * \n * @param guardName - The name of the variable being guarded.\n * @param guard - The record containing valid keys.\n * @returns A formatted error message.\n */\nexport const notObjectKeyMessage = (guardName: string, guard: Record<any, any>): string => (\n  `'${guardName}' must be one of '${Object.keys(guard).join(', ')}'`\n)\n\n/**\n * Throws an error if the provided key is not present in the given record.\n * \n * @param guardName - The name of the variable being guarded.\n * @param guard - The record to check against.\n * @param guardObjectKey - The key to check for existence in the record.\n * @throws {Error} Throws an error if `Object.hasOwn(guard, guardObjectKey)` is false.\n */\nexport const throwNotObjectKey = (guardName: string, guard: Record<any, any>, guardObjectKey: string): void => {\n  const hasKey = Object.hasOwn(guard, guardObjectKey);\n  if (hasKey === false) {\n    throw new Error(notObjectKeyMessage(guardName, guard));\n  }\n}"],
+  "mappings": "AAMO,IAAMA,EAAgBC,GAA8B,GAAGA,CAAS,YAS1DC,EAAa,CAACD,EAAmBE,IAAwB,CAEpE,GADgBA,IAAU,GACb,MAAM,IAAI,MAAMH,EAAaC,CAAS,CAAC,CACtD,ECZO,IAAMG,EAAeC,GAA8B,GAAGA,CAAS,WASzDC,EAAY,CAACD,EAAmBE,IAAqB,CAEhE,GADeA,IAAU,OACV,GACb,MAAM,IAAI,MAAMH,EAAYC,CAAS,CAAC,CAE1C,ECPO,IAAMG,EAAiB,CAACC,EAAmBC,IAChD,IAAID,CAAS,wBAAwBC,CAAS,IAWnCC,EAAe,CAACF,EAAmBG,EAAYF,IAA2B,CAErF,GADe,OAAOE,IAAUF,IACjB,GACb,MAAM,IAAI,MAAMF,EAAeC,EAAWC,CAAS,CAAC,CAExD,ECxBO,IAAMG,EAAoBC,GAA8B,GAAGA,CAAS,kBAS9DC,EAAiB,CAACD,EAAmBE,IAAqB,CAErE,GADkBA,IAAU,SACV,GAChB,MAAM,IAAI,MAAMH,EAAiBC,CAAS,CAAC,CAE/C,ECRO,IAAMG,EAAuB,CAACC,EAAmBC,IAAqB,CAC3EC,EAAeF,EAAWC,CAAK,EAC/BE,EAAUH,EAAWC,CAAK,CAC5B,EASaG,EAAwB,CAACJ,EAAmBC,IAAqB,CAC5EI,EAAaL,EAAWC,EAAO,QAAQ,EACvCK,EAAWN,EAAWC,CAAK,CAC7B,ECrBO,IAAMM,EAA2BC,GACtC,IAAIA,CAAS,6BAYFC,EAAwB,CAACD,EAAmBE,IAAqB,CAC5E,GAAIC,EAAgBD,CAAK,IAAM,GAC7B,MAAM,IAAI,MAAMH,EAAwBC,CAAS,CAAC,CAEtD,EAQaG,EAAmBC,GACWA,GAAU,MAE9CA,EAAM,aACNA,EAAM,cAAgB,OCvBtB,IAAMC,EAAqB,CAACC,EAAmBC,IACpD,IAAID,CAAS,6BAA6BC,EAAU,IAAI,IAW7CC,EAAmB,CAACF,EAAmBG,EAAYF,IAAmC,CAEjG,GADmBE,aAAiBF,IACjB,GACjB,MAAM,IAAI,MAAMF,EAAmBC,EAAWC,CAAS,CAAC,CAE5D,EASaG,EAAwB,CAACC,KAAuBC,IAAwC,CACnG,IAAMC,EAAYD,EAAW,IAAIE,GAAKA,EAAE,IAAI,EAAE,KAAK,GAAG,EACtD,MAAO,IAAIH,EAAc,YAAY,IAAI,oCAAoCE,CAAS,GACxF,EASaE,EAAsB,CAACJ,KAAuBC,IAAsC,CAC/F,QAASI,EAAI,EAAGA,EAAIJ,EAAW,OAAQI,IAErC,GADmBL,aAAyBC,EAAWI,CAAC,EACxC,OAElB,MAAM,IAAI,MAAMN,EAAsBC,EAAe,GAAGC,CAAU,CAAC,CACrE,ECjDO,IAAMK,EAAsB,CAACC,EAAmBC,IACrD,IAAID,CAAS,qBAAqB,OAAO,KAAKC,CAAK,EAAE,KAAK,IAAI,CAAC,IAWpDC,EAAoB,CAACF,EAAmBC,EAAyBE,IAAiC,CAE7G,GADe,OAAO,OAAOF,EAAOE,CAAc,IACnC,GACb,MAAM,IAAI,MAAMJ,EAAoBC,EAAWC,CAAK,CAAC,CAEzD",
+  "names": ["emptyMessage", "guardName", "throwEmpty", "guard", "nullMessage", "guardName", "throwNull", "guard", "notTypeMessage", "guardName", "guardType", "throwNotType", "guard", "undefinedMessage", "guardName", "throwUndefined", "guard", "throwUndefinedOrNull", "guardName", "guard", "throwUndefined", "throwNull", "throwNotStringOrEmpty", "throwNotType", "throwEmpty", "notComplexObjectMessage", "guardName", "throwNotComplexObject", "guard", "isComplexObject", "value", "notInstanceMessage", "guardName", "guardType", "throwNotInstance", "guard", "notAnyInstanceMessage", "guardInstance", "guardTypes", "typeNames", "t", "throwNotAnyInstance", "i", "notObjectKeyMessage", "guardName", "guard", "throwNotObjectKey", "guardObjectKey"]
+}

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

@@ -0,0 +1,17 @@
+/**
+ * Throws an error if the provided value is undefined or null.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guard - The value to check.
+ * @throws {Error} Throws an error if `guard` is `undefined` or `null`.
+ */
+export declare const throwUndefinedOrNull: (guardName: string, guard: any) => void;
+/**
+ * Throws an error if the provided value is not a string or is an empty string.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guard - The value to check.
+ * @throws {Error} Throws an error if `guard` is not a string or if it's empty ('').
+ */
+export declare const throwNotStringOrEmpty: (guardName: string, guard: any) => void;
+//# sourceMappingURL=guardAggregates.d.ts.map

package/dist/types/src/guardAggregates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guardAggregates.d.ts","sourceRoot":"","sources":["../../../src/guardAggregates.ts"],"names":[],"mappings":"AAKA;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,GAAI,WAAW,MAAM,EAAE,OAAO,GAAG,KAAG,IAGpE,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,GAAI,WAAW,MAAM,EAAE,OAAO,GAAG,KAAG,IAGrE,CAAA"}

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

@@ -0,0 +1,25 @@
+/**
+ * Generates an error message when a value is not a complex object.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @returns A formatted error message.
+ */
+export declare const notComplexObjectMessage: (guardName: string) => string;
+/**
+ * Throws an error if the provided value is not a complex object.
+ *
+ * A complex object is defined as a non-null object that is not a primitive and whose constructor is `Object`.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guard - The value to check.
+ * @throws {Error} Throws an error if `isComplexObject(guard)` is false.
+ */
+export declare const throwNotComplexObject: (guardName: string, guard: any) => void;
+/**
+ * Determines if a value is a complex object.
+ *
+ * @param value - The value to test.
+ * @returns `true` if the value is a defined, non-null object with a constructor matching `Object`.
+ */
+export declare const isComplexObject: (value: any) => boolean;
+//# sourceMappingURL=guardComplexObject.d.ts.map

package/dist/types/src/guardComplexObject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guardComplexObject.d.ts","sourceRoot":"","sources":["../../../src/guardComplexObject.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,GAAI,WAAW,MAAM,KAAG,MAE3D,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,GAAI,WAAW,MAAM,EAAE,OAAO,GAAG,KAAG,IAIrE,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAAI,OAAO,GAAG,KAAG,OAK5C,CAAA"}

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

@@ -0,0 +1,16 @@
+/**
+ * Generates an error message when a string is empty.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @returns A formatted error message.
+ */
+export declare const emptyMessage: (guardName: string) => string;
+/**
+ * Throws an error if the provided string is empty ('').
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guard - The string to check for emptiness.
+ * @throws {Error} Throws an error if `guard` is an empty string.
+ */
+export declare const throwEmpty: (guardName: string, guard: string) => void;
+//# sourceMappingURL=guardEmpty.d.ts.map

package/dist/types/src/guardEmpty.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guardEmpty.d.ts","sourceRoot":"","sources":["../../../src/guardEmpty.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,WAAW,MAAM,KAAG,MAAiC,CAAC;AAEnF;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,GAAI,WAAW,MAAM,EAAE,OAAO,MAAM,KAAG,IAG7D,CAAA"}

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

@@ -0,0 +1,38 @@
+/**
+ * Represents a class constructor type.
+ */
+export type ClassInstance = new (...args: any[]) => void;
+/**
+ * Generates an error message when a value is not an instance of the specified class.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guardType - The expected class constructor.
+ * @returns A formatted error message.
+ */
+export declare const notInstanceMessage: (guardName: string, guardType: ClassInstance) => string;
+/**
+ * Throws an error if the provided value is not an instance of the specified class.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guard - The value to check.
+ * @param guardType - The expected class constructor.
+ * @throws {Error} Throws an error if `guard instanceof guardType` is false.
+ */
+export declare const throwNotInstance: (guardName: string, guard: any, guardType: ClassInstance) => void;
+/**
+ * Generates an error message when a value is not an instance of any of the specified classes.
+ *
+ * @param guardInstance - The value that failed the check.
+ * @param guardTypes - The expected class constructors.
+ * @returns A formatted error message.
+ */
+export declare const notAnyInstanceMessage: (guardInstance: any, ...guardTypes: ClassInstance[]) => string;
+/**
+ * Throws an error if the provided value is not an instance of any of the specified classes.
+ *
+ * @param guardInstance - The value to check.
+ * @param guardTypes - One or more expected class constructors.
+ * @throws {Error} Throws an error if `guardInstance` is not an instance of any of the `guardTypes`.
+ */
+export declare const throwNotAnyInstance: (guardInstance: any, ...guardTypes: ClassInstance[]) => void;
+//# sourceMappingURL=guardInstance.d.ts.map

package/dist/types/src/guardInstance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guardInstance.d.ts","sourceRoot":"","sources":["../../../src/guardInstance.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;AAExD;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,GAAI,WAAW,MAAM,EAAE,WAAW,aAAa,KAAG,MAEhF,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,GAAI,WAAW,MAAM,EAAE,OAAO,GAAG,EAAE,WAAW,aAAa,KAAG,IAK1F,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,GAAI,eAAe,GAAG,EAAE,GAAG,YAAY,aAAa,EAAE,KAAG,MAG1F,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,GAAI,eAAe,GAAG,EAAE,GAAG,YAAY,aAAa,EAAE,KAAG,IAMxF,CAAA"}

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

@@ -0,0 +1,16 @@
+/**
+ * Generates an error message when a value is null.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @returns A formatted error message.
+ */
+export declare const nullMessage: (guardName: string) => string;
+/**
+ * Throws an error if the provided value is null.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guard - The value to check for null.
+ * @throws {Error} Throws an error if `guard` is strictly equal to `null`.
+ */
+export declare const throwNull: (guardName: string, guard: any) => void;
+//# sourceMappingURL=guardNull.d.ts.map

package/dist/types/src/guardNull.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guardNull.d.ts","sourceRoot":"","sources":["../../../src/guardNull.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAI,WAAW,MAAM,KAAG,MAAgC,CAAC;AAEjF;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,GAAI,WAAW,MAAM,EAAE,OAAO,GAAG,KAAG,IAKzD,CAAA"}

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

@@ -0,0 +1,18 @@
+/**
+ * Generates an error message when a value is not a key of the provided record.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guard - The record containing valid keys.
+ * @returns A formatted error message.
+ */
+export declare const notObjectKeyMessage: (guardName: string, guard: Record<any, any>) => string;
+/**
+ * Throws an error if the provided key is not present in the given record.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guard - The record to check against.
+ * @param guardObjectKey - The key to check for existence in the record.
+ * @throws {Error} Throws an error if `Object.hasOwn(guard, guardObjectKey)` is false.
+ */
+export declare const throwNotObjectKey: (guardName: string, guard: Record<any, any>, guardObjectKey: string) => void;
+//# sourceMappingURL=guardObjectKey.d.ts.map

package/dist/types/src/guardObjectKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guardObjectKey.d.ts","sourceRoot":"","sources":["../../../src/guardObjectKey.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,GAAI,WAAW,MAAM,EAAE,OAAO,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,KAAG,MAEhF,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,GAAI,WAAW,MAAM,EAAE,OAAO,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,gBAAgB,MAAM,KAAG,IAKtG,CAAA"}

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

@@ -0,0 +1,22 @@
+/**
+ * Supported JavaScript types for type guarding.
+ */
+export type Types = "number" | "string" | "boolean" | "undefined" | "function" | "object" | "bigint" | "symbol";
+/**
+ * Generates a standard error message when a value is not of the expected type.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guardType - The expected type.
+ * @returns A formatted error message.
+ */
+export declare const notTypeMessage: (guardName: string, guardType: Types) => string;
+/**
+ * Throws an error if the provided value is not of the specified type.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guard - The value to check.
+ * @param guardType - The expected type.
+ * @throws {Error} Throws an error if `typeof guard` does not equal `guardType`.
+ */
+export declare const throwNotType: (guardName: string, guard: any, guardType: Types) => void;
+//# sourceMappingURL=guardType.d.ts.map

package/dist/types/src/guardType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guardType.d.ts","sourceRoot":"","sources":["../../../src/guardType.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAGhH;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GAAI,WAAW,MAAM,EAAE,WAAW,KAAK,KAAG,MAEpE,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,GAAI,WAAW,MAAM,EAAE,OAAO,GAAG,EAAE,WAAW,KAAK,KAAG,IAK9E,CAAA"}

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

@@ -0,0 +1,16 @@
+/**
+ * Generates an error message when a value is undefined.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @returns A formatted error message.
+ */
+export declare const undefinedMessage: (guardName: string) => string;
+/**
+ * Throws an error if the provided value is undefined.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guard - The value to check for undefined.
+ * @throws {Error} Throws an error if `guard` is strictly equal to `undefined`.
+ */
+export declare const throwUndefined: (guardName: string, guard: any) => void;
+//# sourceMappingURL=guardUndefined.d.ts.map

package/dist/types/src/guardUndefined.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guardUndefined.d.ts","sourceRoot":"","sources":["../../../src/guardUndefined.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,WAAW,MAAM,KAAG,MAAuC,CAAC;AAE7F;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GAAI,WAAW,MAAM,EAAE,OAAO,GAAG,KAAG,IAK9D,CAAA"}

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

@@ -0,0 +1,9 @@
+export * from './guardAggregates.js';
+export * from './guardComplexObject.js';
+export * from './guardEmpty.js';
+export * from './guardInstance.js';
+export * from './guardNull.js';
+export * from './guardObjectKey.js';
+export * from './guardType.js';
+export * from './guardUndefined.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC"}

package/legacy/src/guardAggregates.cjs

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwNotStringOrEmpty = exports.throwUndefinedOrNull = void 0;
+const guardEmpty_js_1 = require("./guardEmpty.cjs");
+const guardNull_js_1 = require("./guardNull.cjs");
+const guardType_js_1 = require("./guardType.cjs");
+const guardUndefined_js_1 = require("./guardUndefined.cjs");
+/**
+ * Throws an error if the provided value is undefined or null.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guard - The value to check.
+ * @throws {Error} Throws an error if `guard` is `undefined` or `null`.
+ */
+const throwUndefinedOrNull = (guardName, guard) => {
+    (0, guardUndefined_js_1.throwUndefined)(guardName, guard);
+    (0, guardNull_js_1.throwNull)(guardName, guard);
+};
+exports.throwUndefinedOrNull = throwUndefinedOrNull;
+/**
+ * Throws an error if the provided value is not a string or is an empty string.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guard - The value to check.
+ * @throws {Error} Throws an error if `guard` is not a string or if it's empty ('').
+ */
+const throwNotStringOrEmpty = (guardName, guard) => {
+    (0, guardType_js_1.throwNotType)(guardName, guard, 'string');
+    (0, guardEmpty_js_1.throwEmpty)(guardName, guard);
+};
+exports.throwNotStringOrEmpty = throwNotStringOrEmpty;
+//# sourceMappingURL=guardAggregates.cjs.map

package/legacy/src/guardAggregates.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"guardAggregates.cjs","sourceRoot":"","sources":["../../src/guardAggregates.ts"],"names":[],"mappings":";;;AAAA,mDAA6C;AAC7C,iDAA2C;AAC3C,iDAA8C;AAC9C,2DAAqD;AAErD;;;;;;GAMG;AACI,MAAM,oBAAoB,GAAG,CAAC,SAAiB,EAAE,KAAU,EAAQ,EAAE;IAC1E,IAAA,kCAAc,EAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IACjC,IAAA,wBAAS,EAAC,SAAS,EAAE,KAAK,CAAC,CAAC;AAC9B,CAAC,CAAA;AAHY,QAAA,oBAAoB,wBAGhC;AAED;;;;;;GAMG;AACI,MAAM,qBAAqB,GAAG,CAAC,SAAiB,EAAE,KAAU,EAAQ,EAAE;IAC3E,IAAA,2BAAY,EAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAA;IACxC,IAAA,0BAAU,EAAC,SAAS,EAAE,KAAK,CAAC,CAAC;AAC/B,CAAC,CAAA;AAHY,QAAA,qBAAqB,yBAGjC"}

package/legacy/src/guardComplexObject.cjs

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isComplexObject = exports.throwNotComplexObject = exports.notComplexObjectMessage = void 0;
+/**
+ * Generates an error message when a value is not a complex object.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @returns A formatted error message.
+ */
+const notComplexObjectMessage = (guardName) => (`'${guardName}' must be a complex object`);
+exports.notComplexObjectMessage = notComplexObjectMessage;
+/**
+ * Throws an error if the provided value is not a complex object.
+ *
+ * A complex object is defined as a non-null object that is not a primitive and whose constructor is `Object`.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guard - The value to check.
+ * @throws {Error} Throws an error if `isComplexObject(guard)` is false.
+ */
+const throwNotComplexObject = (guardName, guard) => {
+    if ((0, exports.isComplexObject)(guard) === false) {
+        throw new Error((0, exports.notComplexObjectMessage)(guardName));
+    }
+};
+exports.throwNotComplexObject = throwNotComplexObject;
+/**
+ * Determines if a value is a complex object.
+ *
+ * @param value - The value to test.
+ * @returns `true` if the value is a defined, non-null object with a constructor matching `Object`.
+ */
+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.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACI,MAAM,uBAAuB,GAAG,CAAC,SAAiB,EAAU,EAAE,CAAC,CACpE,IAAI,SAAS,4BAA4B,CAC1C,CAAA;AAFY,QAAA,uBAAuB,2BAEnC;AAED;;;;;;;;GAQG;AACI,MAAM,qBAAqB,GAAG,CAAC,SAAiB,EAAE,KAAU,EAAQ,EAAE;IAC3E,IAAI,IAAA,uBAAe,EAAC,KAAK,CAAC,KAAK,KAAK,EAAE,CAAC;QACrC,MAAM,IAAI,KAAK,CAAC,IAAA,+BAAuB,EAAC,SAAS,CAAC,CAAC,CAAC;IACtD,CAAC;AACH,CAAC,CAAA;AAJY,QAAA,qBAAqB,yBAIjC;AAED;;;;;GAKG;AACI,MAAM,eAAe,GAAG,CAAC,KAAU,EAAW,EAAE;IACrD,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/guardEmpty.cjs

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwEmpty = exports.emptyMessage = void 0;
+/**
+ * Generates an error message when a string is empty.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @returns A formatted error message.
+ */
+const emptyMessage = (guardName) => `${guardName} is empty`;
+exports.emptyMessage = emptyMessage;
+/**
+ * Throws an error if the provided string is empty ('').
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guard - The string to check for emptiness.
+ * @throws {Error} Throws an error if `guard` is an empty string.
+ */
+const throwEmpty = (guardName, guard) => {
+    const isEmpty = guard === '';
+    if (isEmpty)
+        throw new Error((0, exports.emptyMessage)(guardName));
+};
+exports.throwEmpty = throwEmpty;
+//# sourceMappingURL=guardEmpty.cjs.map

package/legacy/src/guardEmpty.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"guardEmpty.cjs","sourceRoot":"","sources":["../../src/guardEmpty.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACI,MAAM,YAAY,GAAG,CAAC,SAAiB,EAAU,EAAE,CAAC,GAAG,SAAS,WAAW,CAAC;AAAtE,QAAA,YAAY,gBAA0D;AAEnF;;;;;;GAMG;AACI,MAAM,UAAU,GAAG,CAAC,SAAiB,EAAE,KAAa,EAAQ,EAAE;IACnE,MAAM,OAAO,GAAG,KAAK,KAAK,EAAE,CAAC;IAC7B,IAAI,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,IAAA,oBAAY,EAAC,SAAS,CAAC,CAAC,CAAC;AACxD,CAAC,CAAA;AAHY,QAAA,UAAU,cAGtB"}

package/legacy/src/guardInstance.cjs

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwNotAnyInstance = exports.notAnyInstanceMessage = exports.throwNotInstance = exports.notInstanceMessage = void 0;
+/**
+ * Generates an error message when a value is not an instance of the specified class.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guardType - The expected class constructor.
+ * @returns A formatted error message.
+ */
+const notInstanceMessage = (guardName, guardType) => (`'${guardName}' must be an instance of '${guardType.name}'`);
+exports.notInstanceMessage = notInstanceMessage;
+/**
+ * Throws an error if the provided value is not an instance of the specified class.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guard - The value to check.
+ * @param guardType - The expected class constructor.
+ * @throws {Error} Throws an error if `guard instanceof guardType` is false.
+ */
+const throwNotInstance = (guardName, guard, guardType) => {
+    const isInstance = guard instanceof guardType;
+    if (isInstance === false) {
+        throw new Error((0, exports.notInstanceMessage)(guardName, guardType));
+    }
+};
+exports.throwNotInstance = throwNotInstance;
+/**
+ * Generates an error message when a value is not an instance of any of the specified classes.
+ *
+ * @param guardInstance - The value that failed the check.
+ * @param guardTypes - The expected class constructors.
+ * @returns A formatted error message.
+ */
+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;
+/**
+ * Throws an error if the provided value is not an instance of any of the specified classes.
+ *
+ * @param guardInstance - The value to check.
+ * @param guardTypes - One or more expected class constructors.
+ * @throws {Error} Throws an error if `guardInstance` is not an instance of any of the `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.ts"],"names":[],"mappings":";;;AAKA;;;;;;GAMG;AACI,MAAM,kBAAkB,GAAG,CAAC,SAAiB,EAAE,SAAwB,EAAU,EAAE,CAAC,CACzF,IAAI,SAAS,6BAA6B,SAAS,CAAC,IAAI,GAAG,CAC5D,CAAA;AAFY,QAAA,kBAAkB,sBAE9B;AAED;;;;;;;GAOG;AACI,MAAM,gBAAgB,GAAG,CAAC,SAAiB,EAAE,KAAU,EAAE,SAAwB,EAAQ,EAAE;IAChG,MAAM,UAAU,GAAG,KAAK,YAAY,SAAS,CAAC;IAC9C,IAAI,UAAU,KAAK,KAAK,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,IAAA,0BAAkB,EAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;IAC5D,CAAC;AACH,CAAC,CAAA;AALY,QAAA,gBAAgB,oBAK5B;AAED;;;;;;GAMG;AACI,MAAM,qBAAqB,GAAG,CAAC,aAAkB,EAAE,GAAG,UAA2B,EAAU,EAAE;IAClG,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;;;;;;GAMG;AACI,MAAM,mBAAmB,GAAG,CAAC,aAAkB,EAAE,GAAG,UAA2B,EAAQ,EAAE;IAC9F,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3C,MAAM,UAAU,GAAG,aAAa,YAAY,UAAU,CAAC,CAAC,CAAC,CAAC;QAC1D,IAAI,UAAU;YAAE,OAAO;IACzB,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,IAAA,6BAAqB,EAAC,aAAa,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC;AACvE,CAAC,CAAA;AANY,QAAA,mBAAmB,uBAM/B"}

package/legacy/src/guardNull.cjs

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwNull = exports.nullMessage = void 0;
+/**
+ * Generates an error message when a value is null.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @returns A formatted error message.
+ */
+const nullMessage = (guardName) => `${guardName} is null`;
+exports.nullMessage = nullMessage;
+/**
+ * Throws an error if the provided value is null.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guard - The value to check for null.
+ * @throws {Error} Throws an error if `guard` is strictly equal to `null`.
+ */
+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.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACI,MAAM,WAAW,GAAG,CAAC,SAAiB,EAAU,EAAE,CAAC,GAAG,SAAS,UAAU,CAAC;AAApE,QAAA,WAAW,eAAyD;AAEjF;;;;;;GAMG;AACI,MAAM,SAAS,GAAG,CAAC,SAAiB,EAAE,KAAU,EAAQ,EAAE;IAC/D,MAAM,MAAM,GAAG,KAAK,KAAK,IAAI,CAAC;IAC9B,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,IAAA,mBAAW,EAAC,SAAS,CAAC,CAAC,CAAC;IAC1C,CAAC;AACH,CAAC,CAAA;AALY,QAAA,SAAS,aAKrB"}

package/legacy/src/guardObjectKey.cjs

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwNotObjectKey = exports.notObjectKeyMessage = void 0;
+/**
+ * Generates an error message when a value is not a key of the provided record.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guard - The record containing valid keys.
+ * @returns A formatted error message.
+ */
+const notObjectKeyMessage = (guardName, guard) => (`'${guardName}' must be one of '${Object.keys(guard).join(', ')}'`);
+exports.notObjectKeyMessage = notObjectKeyMessage;
+/**
+ * Throws an error if the provided key is not present in the given record.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guard - The record to check against.
+ * @param guardObjectKey - The key to check for existence in the record.
+ * @throws {Error} Throws an error if `Object.hasOwn(guard, guardObjectKey)` is false.
+ */
+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.ts"],"names":[],"mappings":";;;AAAA;;;;;;GAMG;AACI,MAAM,mBAAmB,GAAG,CAAC,SAAiB,EAAE,KAAuB,EAAU,EAAE,CAAC,CACzF,IAAI,SAAS,qBAAqB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACnE,CAAA;AAFY,QAAA,mBAAmB,uBAE/B;AAED;;;;;;;GAOG;AACI,MAAM,iBAAiB,GAAG,CAAC,SAAiB,EAAE,KAAuB,EAAE,cAAsB,EAAQ,EAAE;IAC5G,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IACpD,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,IAAA,2BAAmB,EAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;IACzD,CAAC;AACH,CAAC,CAAA;AALY,QAAA,iBAAiB,qBAK7B"}

package/legacy/src/guardType.cjs

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwNotType = exports.notTypeMessage = void 0;
+/**
+ * Generates a standard error message when a value is not of the expected type.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guardType - The expected type.
+ * @returns A formatted error message.
+ */
+const notTypeMessage = (guardName, guardType) => (`'${guardName}' must be a type of '${guardType}'`);
+exports.notTypeMessage = notTypeMessage;
+/**
+ * Throws an error if the provided value is not of the specified type.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guard - The value to check.
+ * @param guardType - The expected type.
+ * @throws {Error} Throws an error if `typeof guard` does not equal `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.ts"],"names":[],"mappings":";;;AAMA;;;;;;GAMG;AACI,MAAM,cAAc,GAAG,CAAC,SAAiB,EAAE,SAAgB,EAAU,EAAE,CAAC,CAC7E,IAAI,SAAS,wBAAwB,SAAS,GAAG,CAClD,CAAA;AAFY,QAAA,cAAc,kBAE1B;AAED;;;;;;;GAOG;AACI,MAAM,YAAY,GAAG,CAAC,SAAiB,EAAE,KAAU,EAAE,SAAgB,EAAQ,EAAE;IACpF,MAAM,MAAM,GAAG,OAAO,KAAK,KAAK,SAAS,CAAC;IAC1C,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,IAAA,sBAAc,EAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;IACxD,CAAC;AACH,CAAC,CAAA;AALY,QAAA,YAAY,gBAKxB"}

package/legacy/src/guardUndefined.cjs

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwUndefined = exports.undefinedMessage = void 0;
+/**
+ * Generates an error message when a value is undefined.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @returns A formatted error message.
+ */
+const undefinedMessage = (guardName) => `${guardName} is not defined`;
+exports.undefinedMessage = undefinedMessage;
+/**
+ * Throws an error if the provided value is undefined.
+ *
+ * @param guardName - The name of the variable being guarded.
+ * @param guard - The value to check for undefined.
+ * @throws {Error} Throws an error if `guard` is strictly equal to `undefined`.
+ */
+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.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACI,MAAM,gBAAgB,GAAG,CAAC,SAAiB,EAAU,EAAE,CAAC,GAAG,SAAS,iBAAiB,CAAC;AAAhF,QAAA,gBAAgB,oBAAgE;AAE7F;;;;;;GAMG;AACI,MAAM,cAAc,GAAG,CAAC,SAAiB,EAAE,KAAU,EAAQ,EAAE;IACpE,MAAM,SAAS,GAAG,KAAK,KAAK,SAAS,CAAC;IACtC,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,IAAA,wBAAgB,EAAC,SAAS,CAAC,CAAC,CAAC;IAC/C,CAAC;AACH,CAAC,CAAA;AALY,QAAA,cAAc,kBAK1B"}

package/legacy/src/index.cjs

@@ -0,0 +1,25 @@
+"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("./guardAggregates.cjs"), exports);
+__exportStar(require("./guardComplexObject.cjs"), exports);
+__exportStar(require("./guardEmpty.cjs"), exports);
+__exportStar(require("./guardInstance.cjs"), exports);
+__exportStar(require("./guardNull.cjs"), exports);
+__exportStar(require("./guardObjectKey.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.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,0DAAwC;AACxC,kDAAgC;AAChC,qDAAmC;AACnC,iDAA+B;AAC/B,sDAAoC;AACpC,iDAA+B;AAC/B,sDAAoC"}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@esm-test/guards",
+  "version": "1.0.0-beta.10",
+  "description": "A js utility library for guarding objects, instances and types",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "main": "./dist/index.min.js",
+  "exports": {
+    "types": "./dist/types/src/index.d.ts",
+    "import": "./dist/index.min.js",
+    "require": "./legacy/src/index.cjs"
+  },
+  "imports": {
+    "#src/*": "./out/src/*",
+    "#test/*": "./out/test/*"
+  },
+  "devDependencies": {
+    "@types/mocha": "10.0.10",
+    "@types/node": "22.19.13",
+    "@types/source-map-support": "0.5.10",
+    "assert": "2.1.0",
+    "c8": "11.0.0",
+    "esbuild": "0.27.3",
+    "js-build-tasks": "1.0.0-rc.19",
+    "js-yaml": "4.1.1",
+    "mocha": "11.7.5",
+    "mocha-ui-esm": "1.0.0-beta.14",
+    "rimraf": "6.1.3",
+    "source-map-support": "0.5.21",
+    "typescript": "5.9.3"
+  },
+  "scripts": {
+    "clean": "task",
+    "compile": "task",
+    "coverage": "task",
+    "fresh": "task",
+    "generate:types": "task",
+    "test": "task",
+    "transform:legacy": "task",
+    "prepublishOnly": "task"
+  },
+  "author": "pflannery",
+  "license": "ISC",
+  "keywords": [
+    "npm",
+    "node",
+    "test",
+    "guards"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/esm-test-group/esm-test-guards.git"
+  }
+}