1.4.0

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm and npmci
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+
+      - name: Run npm prepare
+        run: npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Release
+        run: |
+          npmci node install stable
+          npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Code quality
+        run: |
+          npmci command npm install -g typescript
+          npmci npm install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @gitzone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

.gitea/workflows/gitzone_ci_default.yaml

@@ -1,104 +0,0 @@
-name: CI Pipeline
-
-on: push
-
-env:
-  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-
-jobs:
-
-  security:
-    runs-on: ubuntu-latest
-    continue-on-error: true
-    container:
-      image: $
-
-    steps:
-    - uses: actions/checkout@v3
-
-    - name: Install pnpm and npmci
-      run: |
-        pnpm install -g pnpm
-        pnpm install -g @shipzone/npmci
-
-    - name: Run npm prepare
-      run: npmci npm prepare
-
-    - name: Audit production dependencies
-      run: |
-        npmci command npm config set registry https://registry.npmjs.org
-        npmci command pnpm audit --audit-level=high --prod
-
-    - name: Audit development dependencies
-      run: |
-        npmci command npm config set registry https://registry.npmjs.org
-        npmci command pnpm audit --audit-level=high --dev
-
-  test:
-    needs: security
-    runs-on: ubuntu-latest
-    container:
-      image: $
-
-    steps:
-    - uses: actions/checkout@v3
-
-    - name: Test stable
-      run: |
-        npmci node install stable
-        npmci npm install
-        npmci npm test
-
-    - name: Test build
-      run: |
-        npmci node install stable
-        npmci npm install
-        npmci npm build
-
-  release:
-    needs: test
-    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
-    runs-on: ubuntu-latest
-    container:
-      image: $
-
-    steps:
-    - uses: actions/checkout@v3
-
-    - name: Release
-      run: |
-        npmci node install stable
-        npmci npm publish
-
-  metadata:
-    needs: test
-    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
-    runs-on: ubuntu-latest
-    container:
-      image: $
-    continue-on-error: true
-
-    steps:
-    - uses: actions/checkout@v3
-
-    - name: Code quality
-      run: |
-        npmci command npm install -g typescript
-        npmci npm prepare
-        npmci npm install
-
-    - name: Trigger
-      run: npmci trigger
-
-    - name: Build docs and upload artifacts
-      run: |
-        npmci node install stable
-        npmci npm install
-        npmci command npm run buildDocs
-
-    - name: Upload artifacts
-      uses: actions/upload-artifact@v2
-      with:
-        name: public
-        path: public
-        retention-days: 7

changelog.md

@@ -0,0 +1,67 @@
+# Changelog
+
+## 2024-12-30 - 1.4.0 - feat(Assertion)
+Add log method to Assertion class
+
+- Introduced a log method in the Assertion class to output assertion context.
+
+## 2024-12-30 - 1.3.0 - feat(Assertion)
+Refactor Assertion class for better error handling and code clarity
+
+- Improved method runCheck to better handle async and sync execution
+- Enhanced getObjectToTestReference to handle undefined or null values gracefully
+- Refactored error message logic for clarity and added more descriptive fail messages
+- Added arrayItem method for better handling of array index access
+- Improved structure by integrating consistent error handling in assertion methods
+
+## 2024-08-24 - 1.2.1 - fix(Assertion)
+Refactor methods for setting failure and success messages
+
+- Renamed 'withFailMessage' to 'setFailMessage' for better readability and consistency.
+- Renamed 'withSuccessMessage' to 'setSuccessMessage' to align with the naming convention.
+
+## 2024-08-24 - 1.2.0 - feat(assertions)
+Add custom fail and success messages for assertions
+
+- Implemented withFailMessage method in Assertion class to customize fail messages
+- Implemented withSuccessMessage method in Assertion class to customize success messages
+- Enhanced error messages to use custom fail messages when provided
+
+## 2024-08-17 - 1.1.0 - feat(assertion)
+Add toBeDefined assertion method
+
+- Added the toBeDefined method to the Assertion class for checking if an object is defined
+
+## 2024-05-29 - 1.0.21 - General Updates
+General updates and maintenance.
+
+- Updated description
+- Updated tsconfig
+- Updated npmextra.json: githost
+
+## 2023-08-12 - 1.0.20 to 1.0.21 - General Fixes
+General fixes and update.
+
+- Fixed core updates (multiple instances)
+- 1.0.21 release
+
+## 2023-07-10 - 1.0.15 - Organization Update
+- Switched to new org scheme
+
+## 2023-06-22 - 1.0.14 to 1.0.19 - General Updates
+General fixes and updates.
+
+- Fixed core updates (multiple instances)
+- 1.0.18 to 1.0.16 releases
+
+## 2022-02-02 - 1.0.8 to 1.0.13 - General Fixes
+General fixes and update.
+
+- Fixed core updates (multiple instances)
+- 1.0.14 release
+
+## 2022-01-20 - 1.0.1 to 1.0.7 - Initial Releases
+Initial core updates and fixes.
+
+- Fixed core updates (multiple instances)
+- 1.0.7 release

npmextra.json

@@ -2,17 +2,32 @@
   "gitzone": {
     "projectType": "npm",
     "module": {
-      "githost": "gitlab.com",
+      "githost": "code.foss.global",
       "gitscope": "push.rocks",
       "gitrepo": "smartexpect",
-      "description": "manage expectations in code",
+      "description": "A testing library to manage expectations in code, offering both synchronous and asynchronous assertion methods.",
       "npmPackagename": "@push.rocks/smartexpect",
       "license": "MIT",
-      "projectDomain": "push.rocks"
+      "projectDomain": "push.rocks",
+      "keywords": [
+        "testing",
+        "assertions",
+        "code quality",
+        "unit testing",
+        "test driven development",
+        "synchronous testing",
+        "asynchronous testing",
+        "expectations",
+        "validation",
+        "development tools"
+      ]
     }
   },
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "tsdoc": {
+    "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
   }
 }

package.json

@@ -1,8 +1,8 @@
 {
   "name": "@push.rocks/smartexpect",
-  "version": "1.0.19",
+  "version": "1.4.0",
   "private": false,
-  "description": "manage expectations in code",
+  "description": "A testing library to manage expectations in code, offering both synchronous and asynchronous assertion methods.",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
   "type": "module",
@@ -18,12 +18,12 @@
     "@gitzone/tsbundle": "^2.0.8",
     "@gitzone/tsrun": "^1.2.44",
     "@gitzone/tstest": "^1.0.77",
-    "@push.rocks/tapbundle": "^5.0.12",
+    "@push.rocks/tapbundle": "^5.5.0",
-    "@types/node": "^20.4.10"
+    "@types/node": "^22.9.0"
   },
   "dependencies": {
     "@push.rocks/smartdelay": "^3.0.5",
-    "@push.rocks/smartpromise": "^4.0.2",
+    "@push.rocks/smartpromise": "^4.0.4",
     "fast-deep-equal": "^3.1.3"
   },
   "browserslist": [
@@ -40,5 +40,22 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
-  ]
+  ],
+  "keywords": [
+    "testing",
+    "assertions",
+    "code quality",
+    "unit testing",
+    "test driven development",
+    "synchronous testing",
+    "asynchronous testing",
+    "expectations",
+    "validation",
+    "development tools"
+  ],
+  "homepage": "https://code.foss.global/push.rocks/smartexpect",
+  "repository": {
+    "type": "git",
+    "url": "https://code.foss.global/push.rocks/smartexpect.git"
+  }
 }

readme.hints.md

@@ -0,0 +1 @@
+ 

readme.md

@@ -1,37 +1,144 @@
-# @pushrocks/smartexpect
+# @push.rocks/smartexpect
 manage expectations in code
 
-## Availabililty and Links
+## Install
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartexpect)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/smartexpect)
-* [github.com (source mirror)](https://github.com/pushrocks/smartexpect)
-* [docs (typedoc)](https://pushrocks.gitlab.io/smartexpect/)
 
-## Status for master
+To install `@push.rocks/smartexpect`, use the following command in your terminal:
 
-Status Category | Status Badge
+```bash
--- | --
+npm install @push.rocks/smartexpect --save
-GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartexpect/badges/master/pipeline.svg)](https://lossless.cloud)
+```
-GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartexpect/badges/master/coverage.svg)](https://lossless.cloud)
+
-npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartexpect)](https://lossless.cloud)
+This will add `@push.rocks/smartexpect` to your project's dependencies. Make sure you're inside your project directory before running this command.
-Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartexpect)](https://lossless.cloud)
-TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
-node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
-PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartexpect)](https://lossless.cloud)
-PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartexpect)](https://lossless.cloud)
-BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartexpect)](https://lossless.cloud)
 
 ## Usage
 
-Use TypeScript for best in class intellisense
+`@push.rocks/smartexpect` is a TypeScript library designed to manage expectations in your code effectively, improving testing readability and maintainability. Below are various scenarios showcasing how to use this library effectively across both synchronous and asynchronous code paths.
 
-## Contribution
+### Getting Started
 
-We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+First, import `@push.rocks/smartexpect` into your TypeScript file:
 
-For further information read the linked docs at the top of this readme.
+```typescript
+import { expect, expectAsync } from '@push.rocks/smartexpect';
+```
 
-## Legal
+### Synchronous Expectations
-> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
+
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+You can employ `expect` to create synchronous assertions:
+
+```typescript
+import { expect } from '@push.rocks/smartexpect';
+
+// String type assertion
+expect('hello').toBeTypeofString();
+
+// Negated String type assertion
+expect(1).not.toBeTypeofString();
+
+// Boolean type assertion
+expect(true).toBeTypeofBoolean();
+
+// Equality assertion
+expect('hithere').toEqual('hithere');
+
+// Deep equality assertion
+expect({ key: 'value' }).toEqual({ key: 'value' });
+
+// Regular expression matching
+expect('hithere').toMatch(/hi/);
+```
+
+### Asynchronous Expectations
+
+For asynchronous operations, use `expectAsync` to return a promise:
+
+```typescript
+import { expectAsync } from '@push.rocks/smartexpect';
+
+const asyncStringFetcher = async (): Promise<string> => {
+  return 'async string';
+};
+
+const asyncTest = async () => {
+  await expectAsync(asyncStringFetcher()).toBeTypeofString();
+  await expectAsync(asyncStringFetcher()).toEqual('async string');
+};
+
+asyncTest();
+```
+
+### Advanced Usage
+
+- **Properties and Deep Properties:** Assert the existence of properties and their values.
+  
+  ```typescript
+  const testObject = { level1: { level2: 'value' } };
+
+  // Property existence
+  expect(testObject).toHaveProperty('level1');
+  
+  // Deep Property existence
+  expect(testObject).toHaveDeepProperty(['level1', 'level2']);
+  ```
+
+- **Conditions and Comparisons:** Allow more intricate assertions like greater than, less than, or matching specific conditions.
+
+  ```typescript
+  // Greater Than
+  expect(5).toBeGreaterThan(3);
+
+  // Less Than
+  expect(3).toBeLessThan(5);
+
+  // Custom conditions
+  expect(7).customAssertion(value => value > 5, 'Value is not greater than 5');
+  ```
+
+- **Arrays and Objects:** Work seamlessly with arrays and objects, checking for containment, length, or specific values.
+
+  ```typescript
+  const testArray = [1, 2, 3];
+
+  // Containment
+  expect(testArray).toContain(2);
+
+  // Array length
+  expect(testArray).toHaveLength(3);
+
+  // Object matching
+  expect({ name: 'Test', value: 123 }).toMatchObject({ name: 'Test' });
+  ```
+
+### Handling Promises and Async Operations
+
+`@push.rocks/smartexpect` gracefully integrates with asynchronous operations, providing a `expectAsync` function that handles promise-based assertions. This keeps your tests clean and readable, irrespective of the nature of the code being tested.
+
+### Best Practices
+
+- **Readability:** Favor clarity and readability by explicitly stating your expectations. `@push.rocks/smartexpect`'s API is designed to be fluent and expressive, making your tests easy to write and, more importantly, easy to read.
+
+- **Comprehensive Coverage:** Utilize the full spectrum of assertions provided to cover a broad set of use cases, ensuring your code behaves as expected not just in ideal conditions but across various edge cases.
+
+- **Maintainability:** Group related assertions together to improve test maintainability. This makes it easier to update tests as your codebase evolves.
+
+Through judicious use of `@push.rocks/smartexpect`, you can enhance the reliability and maintainability of your test suite, making your codebase more robust and your development workflow more efficient.
+
+## License and Legal Information
+
+This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
+
+**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
+
+### Trademarks
+
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
+
+### Company Information
+
+Task Venture Capital GmbH  
+Registered at District court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

ts/00_commitinfo_data.ts

@@ -1,8 +1,8 @@
 /**
- * autocreated commitinfo by @pushrocks/commitinfo
+ * autocreated commitinfo by @push.rocks/commitinfo
  */
 export const commitinfo = {
   name: '@push.rocks/smartexpect',
-  version: '1.0.19',
+  version: '1.4.0',
-  description: 'manage expectations in code'
+  description: 'A testing library to manage expectations in code, offering both synchronous and asynchronous assertion methods.'
 }

ts/index.ts

@@ -1,5 +1,3 @@
-import * as plugins from './smartexpect.plugins.js';
-
 import { Assertion } from './smartexpect.classes.assertion.js';
 
 export const expect = (baseArg: any) => {
@@ -11,3 +9,4 @@ export const expectAsync = (baseArg: any) => {
   const assertion = new Assertion(baseArg, 'async');
   return assertion;
 };
+

ts/smartexpect.classes.assertion.ts

@@ -5,9 +5,13 @@ export type TExecutionType = 'sync' | 'async';
 export class Assertion {
   executionMode: TExecutionType;
   baseReference: any;
-  propertyDrillDown: string[] = [];
+  propertyDrillDown: Array<string | number> = [];
+
   private notSetting = false;
   private timeoutSetting = 0;
+  private failMessage: string;
+  private successMessage: string;
+
   constructor(baseReferenceArg: any, executionModeArg: TExecutionType) {
     this.baseReference = baseReferenceArg;
     this.executionMode = executionModeArg;
@@ -16,6 +20,14 @@ export class Assertion {
   private getObjectToTestReference() {
     let returnObjectToTestReference = this.baseReference;
     for (const property of this.propertyDrillDown) {
+      if (returnObjectToTestReference == null) {
+        // if it's null or undefined, stop
+        break;
+      }
+
+      // We just directly access with bracket notation.
+      // If property is a string, it's like obj["someProp"];
+      // If property is a number, it's like obj[0].
       returnObjectToTestReference = returnObjectToTestReference[property];
     }
     return returnObjectToTestReference;
@@ -31,6 +43,16 @@ export class Assertion {
     return this;
   }
 
+  public setFailMessage(failMessageArg: string) {
+    this.failMessage = failMessageArg;
+    return this;
+  }
+
+  public setSuccessMessage(successMessageArg: string) {
+    this.successMessage = successMessageArg;
+    return this;
+  }
+
   private runCheck(checkFunction: () => any) {
     const runDirectOrNegated = (checkFunction: () => any) => {
       if (!this.notSetting) {
@@ -43,7 +65,7 @@ export class Assertion {
           isOk = true;
         }
         if (!isOk) {
-          throw new Error('Negated assertion is not ok!');
+          throw new Error(this.failMessage || 'Negated assertion is not ok!');
         }
       }
     };
@@ -60,7 +82,7 @@ export class Assertion {
             }
           });
         }
-        this.baseReference.then((promiseResultArg) => {
+        this.baseReference.then((promiseResultArg: any) => {
           this.baseReference = promiseResultArg;
           done.resolve(runDirectOrNegated(checkFunction));
         });
@@ -71,10 +93,22 @@ export class Assertion {
     }
   }
 
+  public toBeDefined() {
+    return this.runCheck(() => {
+      if (this.getObjectToTestReference() === undefined) {
+        throw new Error(
+          this.failMessage ||
+            `${this.baseReference} with drill down ${this.propertyDrillDown} is not defined`
+        );
+      }
+    });
+  }
+
   public toBeTypeofString() {
     return this.runCheck(() => {
       if (typeof this.getObjectToTestReference() !== 'string') {
         throw new Error(
+          this.failMessage ||
             `Assertion failed: ${this.baseReference} with drill down ${
               this.propertyDrillDown
             } is not of type string, but typeof ${typeof this.baseReference}`
@@ -87,6 +121,7 @@ export class Assertion {
     return this.runCheck(() => {
       if (typeof this.getObjectToTestReference() !== 'number') {
         throw new Error(
+          this.failMessage ||
             `Assertion failed: ${this.baseReference} with drill down ${
               this.propertyDrillDown
             } is not of type string, but typeof ${typeof this.baseReference}`
@@ -99,6 +134,7 @@ export class Assertion {
     return this.runCheck(() => {
       if (typeof this.getObjectToTestReference() !== 'boolean') {
         throw new Error(
+          this.failMessage ||
             `Assertion failed: ${this.baseReference} with drill down ${
               this.propertyDrillDown
             } is not of type string, but typeof ${typeof this.baseReference}`
@@ -112,6 +148,7 @@ export class Assertion {
       const result = plugins.fastDeepEqual(this.getObjectToTestReference(), comparisonObject);
       if (!result) {
         throw new Error(
+          this.failMessage ||
             `${this.baseReference} with drill down ${this.propertyDrillDown} does not equal ${comparisonObject}`
         );
       }
@@ -123,7 +160,10 @@ export class Assertion {
       const result = comparisonObject.test(this.getObjectToTestReference());
       if (!result) {
         throw new Error(
-          `${this.baseReference} with drill down ${this.propertyDrillDown} does not equal ${comparisonObject}`
+          this.failMessage ||
+            `${this.baseReference} with drill down ${
+              this.propertyDrillDown
+            } does not match regex ${comparisonObject}`
         );
       }
     });
@@ -136,6 +176,7 @@ export class Assertion {
         this.getObjectToTestReference() === true;
       if (!result) {
         throw new Error(
+          this.failMessage ||
             `${this.baseReference} with drill down ${this.propertyDrillDown} is not true or not of type boolean`
         );
       }
@@ -149,6 +190,7 @@ export class Assertion {
         this.getObjectToTestReference() === false;
       if (!result) {
         throw new Error(
+          this.failMessage ||
             `${this.baseReference} with drill down ${this.propertyDrillDown} is not false or not of type boolean`
         );
       }
@@ -160,6 +202,7 @@ export class Assertion {
       const result = this.getObjectToTestReference() instanceof classArg;
       if (!result) {
         throw new Error(
+          this.failMessage ||
             `${this.baseReference} with drill down ${this.propertyDrillDown} is not an instance of ${classArg}`
         );
       }
@@ -168,16 +211,22 @@ export class Assertion {
 
   public toHaveProperty(propertyArg: string, equalsArg?: any) {
     return this.runCheck(() => {
-      const result = !!this.getObjectToTestReference()[propertyArg];
+      const obj = this.getObjectToTestReference();
-      if (!result) {
+      if (!obj || !(propertyArg in obj)) {
         throw new Error(
-          `${this.baseReference} with drill down ${this.propertyDrillDown} does not have property ${propertyArg}`
+          this.failMessage ||
+            `${this.baseReference} with drill down ${
+              this.propertyDrillDown
+            } does not have property ${propertyArg}`
         );
       }
-      if (equalsArg) {
+      if (equalsArg !== undefined) {
-        if (result !== equalsArg) {
+        if (obj[propertyArg] !== equalsArg) {
           throw new Error(
-            `${this.baseReference} with drill down ${this.propertyDrillDown} does have property ${propertyArg}, but it does not equal ${equalsArg}`
+            this.failMessage ||
+              `${this.baseReference} with drill down ${
+                this.propertyDrillDown
+              } does have property ${propertyArg}, but it does not equal ${equalsArg}`
           );
         }
       }
@@ -197,7 +246,10 @@ export class Assertion {
         }
 
         if (!obj || !(property in obj)) {
-          throw new Error(`Missing property at path "${currentPath}" in ${this.baseReference}`);
+          throw new Error(
+            this.failMessage ||
+              `Missing property at path "${currentPath}" in ${this.baseReference}`
+          );
         }
         obj = obj[property];
       }
@@ -209,6 +261,7 @@ export class Assertion {
       const result = this.getObjectToTestReference() > numberArg;
       if (!result) {
         throw new Error(
+          this.failMessage ||
             `${this.baseReference} with drill down ${this.propertyDrillDown} is not greater than ${numberArg}`
         );
       }
@@ -220,6 +273,7 @@ export class Assertion {
       const result = this.getObjectToTestReference() < numberArg;
       if (!result) {
         throw new Error(
+          this.failMessage ||
             `${this.baseReference} with drill down ${this.propertyDrillDown} is not less than ${numberArg}`
         );
       }
@@ -231,6 +285,7 @@ export class Assertion {
       const result = this.getObjectToTestReference() === null;
       if (!result) {
         throw new Error(
+          this.failMessage ||
             `${this.baseReference} with drill down ${this.propertyDrillDown} is not null`
         );
       }
@@ -242,6 +297,7 @@ export class Assertion {
       const result = this.getObjectToTestReference() === undefined;
       if (!result) {
         throw new Error(
+          this.failMessage ||
             `${this.baseReference} with drill down ${this.propertyDrillDown} is not undefined`
         );
       }
@@ -250,26 +306,27 @@ export class Assertion {
 
   public toBeNullOrUndefined() {
     return this.runCheck(() => {
-      const result =
+      const testRef = this.getObjectToTestReference();
-        this.getObjectToTestReference() === null || this.getObjectToTestReference() === undefined;
+      const result = testRef === null || testRef === undefined;
       if (!result) {
         throw new Error(
+          this.failMessage ||
             `${this.baseReference} with drill down ${this.propertyDrillDown} is not null or undefined`
         );
       }
     });
   }
 
-  // Array
+  // Array checks
 
   public toContain(itemArg: any) {
     return this.runCheck(() => {
-      const result =
+      const testRef = this.getObjectToTestReference();
-        this.getObjectToTestReference() instanceof Array &&
+      const result = Array.isArray(testRef) && testRef.includes(itemArg);
-        this.getObjectToTestReference().includes(itemArg);
       if (!result) {
         throw new Error(
-          `${this.baseReference} with drill down ${this.propertyDrillDown} is not contain ${itemArg}`
+          this.failMessage ||
+            `${this.baseReference} with drill down ${this.propertyDrillDown} does not contain ${itemArg}`
         );
       }
     });
@@ -279,7 +336,10 @@ export class Assertion {
     return this.runCheck(() => {
       const arrayRef = this.getObjectToTestReference();
       if (!Array.isArray(arrayRef) || arrayRef.length !== 0) {
-        throw new Error(`Expected ${this.baseReference} to be an empty array, but it was not.`);
+        throw new Error(
+          this.failMessage ||
+            `Expected ${this.baseReference} to be an empty array, but it was not.`
+        );
       }
     });
   }
@@ -288,12 +348,17 @@ export class Assertion {
     return this.runCheck(() => {
       const arrayRef = this.getObjectToTestReference();
       if (!Array.isArray(arrayRef)) {
-        throw new Error(`Expected ${this.baseReference} to be an array.`);
+        throw new Error(
+          this.failMessage ||
+            `Expected ${this.baseReference} with drill down ${
+              this.propertyDrillDown
+            } to be an array.`
+        );
       }
-
       for (const value of values) {
         if (!arrayRef.includes(value)) {
           throw new Error(
+            this.failMessage ||
               `Expected ${this.baseReference} to include value "${value}", but it did not.`
           );
         }
@@ -305,11 +370,16 @@ export class Assertion {
     return this.runCheck(() => {
       const arrayRef = this.getObjectToTestReference();
       if (!Array.isArray(arrayRef)) {
-        throw new Error(`Expected ${this.baseReference} to be an array.`);
+        throw new Error(
+          this.failMessage ||
+            `Expected ${this.baseReference} with drill down ${
+              this.propertyDrillDown
+            } to be an array.`
+        );
       }
-
       if (arrayRef.includes(value)) {
         throw new Error(
+          this.failMessage ||
             `Expected ${this.baseReference} to exclude value "${value}", but it included it.`
         );
       }
@@ -322,7 +392,10 @@ export class Assertion {
       const result = typeof testObject === 'string' && testObject.startsWith(itemArg);
       if (!result) {
         throw new Error(
-          `${this.baseReference} with drill down ${this.propertyDrillDown} is not contain ${itemArg}`
+          this.failMessage ||
+            `${this.baseReference} with drill down ${
+              this.propertyDrillDown
+            } does not start with ${itemArg}`
         );
       }
     });
@@ -334,19 +407,21 @@ export class Assertion {
       const result = typeof testObject === 'string' && testObject.endsWith(itemArg);
       if (!result) {
         throw new Error(
-          `${this.baseReference} with drill down ${this.propertyDrillDown} is not contain ${itemArg}`
+          this.failMessage ||
+            `${this.baseReference} with drill down ${
+              this.propertyDrillDown
+            } does not end with ${itemArg}`
         );
       }
     });
   }
 
-  // ... previous code ...
-
   public toBeOneOf(values: any[]) {
     return this.runCheck(() => {
       const result = values.includes(this.getObjectToTestReference());
       if (!result) {
         throw new Error(
+          this.failMessage ||
             `${this.baseReference} with drill down ${this.propertyDrillDown} is not one of ${values}`
         );
       }
@@ -358,7 +433,10 @@ export class Assertion {
       const obj = this.getObjectToTestReference();
       if (typeof obj.length !== 'number' || obj.length !== length) {
         throw new Error(
-          `${this.baseReference} with drill down ${this.propertyDrillDown} does not have a length of ${length}`
+          this.failMessage ||
+            `${this.baseReference} with drill down ${
+              this.propertyDrillDown
+            } does not have a length of ${length}`
         );
       }
     });
@@ -369,7 +447,10 @@ export class Assertion {
       const difference = Math.abs(this.getObjectToTestReference() - value);
       if (difference > Math.pow(10, -precision) / 2) {
         throw new Error(
-          `${this.baseReference} with drill down ${this.propertyDrillDown} is not close to ${value} up to ${precision} decimal places`
+          this.failMessage ||
+            `${this.baseReference} with drill down ${
+              this.propertyDrillDown
+            } is not close to ${value} up to ${precision} decimal places`
         );
       }
     });
@@ -384,6 +465,7 @@ export class Assertion {
         thrown = true;
         if (expectedError && !(e instanceof expectedError)) {
           throw new Error(
+            this.failMessage ||
               `Expected function to throw ${expectedError.name}, but it threw ${e.name}`
           );
         }
@@ -398,6 +480,7 @@ export class Assertion {
     return this.runCheck(() => {
       if (!this.getObjectToTestReference()) {
         throw new Error(
+          this.failMessage ||
             `${this.baseReference} with drill down ${this.propertyDrillDown} is not truthy`
         );
       }
@@ -408,6 +491,7 @@ export class Assertion {
     return this.runCheck(() => {
       if (this.getObjectToTestReference()) {
         throw new Error(
+          this.failMessage ||
             `${this.baseReference} with drill down ${this.propertyDrillDown} is not falsy`
         );
       }
@@ -416,9 +500,12 @@ export class Assertion {
 
   public toBeGreaterThanOrEqual(numberArg: number) {
     return this.runCheck(() => {
-      if (this.getObjectToTestReference() <= numberArg) {
+      if (this.getObjectToTestReference() < numberArg) {
         throw new Error(
-          `${this.baseReference} with drill down ${this.propertyDrillDown} is not greater than or equal to ${numberArg}`
+          this.failMessage ||
+            `${this.baseReference} with drill down ${
+              this.propertyDrillDown
+            } is not greater than or equal to ${numberArg}`
         );
       }
     });
@@ -426,9 +513,12 @@ export class Assertion {
 
   public toBeLessThanOrEqual(numberArg: number) {
     return this.runCheck(() => {
-      if (this.getObjectToTestReference() >= numberArg) {
+      if (this.getObjectToTestReference() > numberArg) {
         throw new Error(
-          `${this.baseReference} with drill down ${this.propertyDrillDown} is not less than or equal to ${numberArg}`
+          this.failMessage ||
+            `${this.baseReference} with drill down ${
+              this.propertyDrillDown
+            } is not less than or equal to ${numberArg}`
         );
       }
     });
@@ -436,10 +526,14 @@ export class Assertion {
 
   public toMatchObject(objectArg: object) {
     return this.runCheck(() => {
-      const partialMatch = plugins.fastDeepEqual(this.getObjectToTestReference(), objectArg); // Note: Implement a deep comparison function or use one from a library
+      // Implement a partial object match if needed.
-      if (!partialMatch) {
+      const matchResult = plugins.fastDeepEqual(this.getObjectToTestReference(), objectArg);
+      if (!matchResult) {
         throw new Error(
-          `${this.baseReference} with drill down ${this.propertyDrillDown} does not match the object ${objectArg}`
+          this.failMessage ||
+            `${this.baseReference} with drill down ${
+              this.propertyDrillDown
+            } does not match the object ${JSON.stringify(objectArg)}`
         );
       }
     });
@@ -448,10 +542,18 @@ export class Assertion {
   public toContainEqual(value: any) {
     return this.runCheck(() => {
       const arr = this.getObjectToTestReference();
-      const found = arr.some((item: any) => plugins.fastDeepEqual(item, value)); // Assuming fastDeepEqual checks deep equality
+      if (!Array.isArray(arr)) {
+        throw new Error(
+          this.failMessage || `Expected ${this.baseReference} to be an array but it is not.`
+        );
+      }
+      const found = arr.some((item: any) => plugins.fastDeepEqual(item, value));
       if (!found) {
         throw new Error(
-          `${this.baseReference} with drill down ${this.propertyDrillDown} does not contain the value ${value}`
+          this.failMessage ||
+            `${this.baseReference} with drill down ${
+              this.propertyDrillDown
+            } does not contain the value ${JSON.stringify(value)}`
         );
       }
     });
@@ -461,6 +563,7 @@ export class Assertion {
     return this.runCheck(() => {
       if (!Array.isArray(this.getObjectToTestReference())) {
         throw new Error(
+          this.failMessage ||
             `${this.baseReference} with drill down ${this.propertyDrillDown} is not an array`
         );
       }
@@ -469,9 +572,13 @@ export class Assertion {
 
   public toInclude(substring: string) {
     return this.runCheck(() => {
-      if (!this.getObjectToTestReference().includes(substring)) {
+      const testRef = this.getObjectToTestReference();
+      if (typeof testRef !== 'string' || !testRef.includes(substring)) {
         throw new Error(
-          `${this.baseReference} with drill down ${this.propertyDrillDown} does not include the substring ${substring}`
+          this.failMessage ||
+            `${this.baseReference} with drill down ${
+              this.propertyDrillDown
+            } does not include the substring ${substring}`
         );
       }
     });
@@ -482,7 +589,10 @@ export class Assertion {
       const obj = this.getObjectToTestReference();
       if (typeof obj.length !== 'number' || obj.length <= length) {
         throw new Error(
-          `${this.baseReference} with drill down ${this.propertyDrillDown} does not have a length greater than ${length}`
+          this.failMessage ||
+            `${this.baseReference} with drill down ${
+              this.propertyDrillDown
+            } does not have a length greater than ${length}`
         );
       }
     });
@@ -493,7 +603,10 @@ export class Assertion {
       const obj = this.getObjectToTestReference();
       if (typeof obj.length !== 'number' || obj.length >= length) {
         throw new Error(
-          `${this.baseReference} with drill down ${this.propertyDrillDown} does not have a length less than ${length}`
+          this.failMessage ||
+            `${this.baseReference} with drill down ${
+              this.propertyDrillDown
+            } does not have a length less than ${length}`
         );
       }
     });
@@ -501,8 +614,10 @@ export class Assertion {
 
   public toBeDate() {
     return this.runCheck(() => {
-      if (!(this.getObjectToTestReference() instanceof Date)) {
+      const testRef = this.getObjectToTestReference();
+      if (!(testRef instanceof Date)) {
         throw new Error(
+          this.failMessage ||
             `${this.baseReference} with drill down ${this.propertyDrillDown} is not a date`
         );
       }
@@ -511,8 +626,10 @@ export class Assertion {
 
   public toBeBeforeDate(date: Date) {
     return this.runCheck(() => {
-      if (!(this.getObjectToTestReference() < date)) {
+      const testRef = this.getObjectToTestReference();
+      if (!(testRef instanceof Date) || testRef >= date) {
         throw new Error(
+          this.failMessage ||
             `${this.baseReference} with drill down ${this.propertyDrillDown} is not before ${date}`
         );
       }
@@ -521,24 +638,47 @@ export class Assertion {
 
   public toBeAfterDate(date: Date) {
     return this.runCheck(() => {
-      if (!(this.getObjectToTestReference() > date)) {
+      const testRef = this.getObjectToTestReference();
+      if (!(testRef instanceof Date) || testRef <= date) {
         throw new Error(
+          this.failMessage ||
             `${this.baseReference} with drill down ${this.propertyDrillDown} is not after ${date}`
         );
       }
     });
   }
 
-  public customAssertion(assertionFunction: (value: any) => boolean, errorMessage: string) {
+  public customAssertion(
+    assertionFunction: (value: any) => boolean,
+    errorMessage: string
+  ) {
     return this.runCheck(() => {
       if (!assertionFunction(this.getObjectToTestReference())) {
-        throw new Error(errorMessage);
+        throw new Error(this.failMessage || errorMessage);
       }
     });
   }
 
+  /**
+   * Drill into a property
+   */
   public property(propertyNameArg: string) {
     this.propertyDrillDown.push(propertyNameArg);
     return this;
   }
+
+  /**
+   * Drill into an array index
+   */
+  public arrayItem(indexArg: number) {
+    // Save the number (instead of "[index]")
+    this.propertyDrillDown.push(indexArg);
+    return this;
+  }
+
+  public log() {
+    console.log(`this is the object to test:`);
+    console.log(JSON.stringify(this.getObjectToTestReference(), null, 2));
+    return this;
+  }
 }

tsconfig.json

@@ -3,9 +3,12 @@
     "experimentalDecorators": true,
     "useDefineForClassFields": false,
     "target": "ES2022",
-    "module": "ES2022",
+    "module": "NodeNext",
-    "moduleResolution": "nodenext",
+    "moduleResolution": "NodeNext",
     "esModuleInterop": true,
-    "verbatimModuleSyntax": true,
+    "verbatimModuleSyntax": true
-  }
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
 }