feat: introduce jest matchers (#97)

* feat: introduce jest matchers

* fix: use type import for SinonSpyCall

* fix: add @typescript-eslint/no-namespace as eslint rule

replace ignore comment

* fix: rename toHaveReceivedNthCommandWith matcher

* fix: remove notMessage argument from callback

* fix: add missing matcher aliases

* fix: adjust command call format

* fix: test types

Co-authored-by: Maciej Radzikowski <maciej@radzikowski.com.pl>

.eslintrc.json

@@ -31,6 +31,12 @@
     "@typescript-eslint/no-unsafe-member-access": "off",
     "@typescript-eslint/member-delimiter-style": "warn",
     "@typescript-eslint/ban-types": "off",
-    "@typescript-eslint/no-explicit-any": "off"
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/no-namespace": [
+      "error",
+      {
+        "allowDeclarations": true
+      }
+    ]
   }
 }

src/awsClientStub.ts

@@ -160,6 +160,11 @@ export class AwsStub<TInput extends object, TOutput extends MetadataBearer> impl
         this.send = send;
     }
 
+    /** Returns the class name of the underlying mocked client class */
+    clientName(): string {
+        return this.client.constructor.name;
+    }
+
     /**
      * Resets stub. It will replace the stub with a new one, with clean history and behavior.
      */
@@ -333,7 +338,7 @@ export class CommandBehavior<TInput extends object, TOutput extends MetadataBear
     }
 }
 
-type AwsCommand<Input extends ClientInput, Output extends ClientOutput, ClientInput extends object = any, ClientOutput extends MetadataBearer = any> = Command<ClientInput, Input, ClientOutput, Output, any>;
+export type AwsCommand<Input extends ClientInput, Output extends ClientOutput, ClientInput extends object = any, ClientOutput extends MetadataBearer = any> = Command<ClientInput, Input, ClientOutput, Output, any>;
 type CommandResponse<TOutput> = Partial<TOutput> | PromiseLike<Partial<TOutput>>;
 
 export interface AwsError extends Partial<Error>, Partial<MetadataBearer> {

src/index.ts

@@ -1,2 +1,3 @@
 export * from './mockClient';
 export * from './awsClientStub';
+import './jestMatchers';