fix(jest): allow "toHaveReceivedCommandWith" partial match without re…

…quired Command fields
m-radzikowski · Jun 20, 2024 · 79929ae · 79929ae
1 parent 97ae3cd
commit 79929ae
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 12 deletions.
diff --git a/packages/aws-sdk-client-mock-jest/src/jestMatchers.ts b/packages/aws-sdk-client-mock-jest/src/jestMatchers.ts
@@ -69,9 +69,9 @@ interface AwsSdkJestMockBaseMatchers<R> extends Record<string, Function> {
     toHaveReceivedCommandWith<TCmdInput extends object,
         TCmdOutput extends MetadataBearer>(
         command: new (input: TCmdInput) => AwsCommand<TCmdInput, TCmdOutput>,
-        input: {
+        input: Partial<{
             [Property in keyof TCmdInput]: unknown;
-        },
+        }>,
     ): R;
 
     /**
@@ -97,9 +97,9 @@ interface AwsSdkJestMockBaseMatchers<R> extends Record<string, Function> {
         TCmdOutput extends MetadataBearer>(
         call: number,
         command: new (input: TCmdInput) => AwsCommand<TCmdInput, TCmdOutput>,
-        input: {
+        input: Partial<{
             [Property in keyof TCmdInput]: unknown;
-        },
+        }>,
     ): R;
 
     /**
@@ -124,9 +124,9 @@ interface AwsSdkJestMockBaseMatchers<R> extends Record<string, Function> {
     toHaveReceivedNthSpecificCommandWith<TCmdInput extends object, TCmdOutput extends MetadataBearer>(
         call: number,
         command: new (input: TCmdInput) => AwsCommand<TCmdInput, TCmdOutput>,
-        input: {
+        input: Partial<{
             [Property in keyof TCmdInput]: unknown;
-        },
+        }>,
     ): R;
 
     /**
@@ -159,9 +159,9 @@ interface AwsSdkJestMockAliasMatchers<R> extends Record<string, Function> {
     toReceiveCommandWith<TCmdInput extends object,
         TCmdOutput extends MetadataBearer>(
         command: new (input: TCmdInput) => AwsCommand<TCmdInput, TCmdOutput>,
-        input: {
+        input: Partial<{
             [Property in keyof TCmdInput]: unknown;
-        },
+        }>,
     ): R;
 
     /**
@@ -171,9 +171,9 @@ interface AwsSdkJestMockAliasMatchers<R> extends Record<string, Function> {
         TCmdOutput extends MetadataBearer>(
         call: number,
         command: new (input: TCmdInput) => AwsCommand<TCmdInput, TCmdOutput>,
-        input: {
+        input: Partial<{
             [Property in keyof TCmdInput]: unknown;
-        },
+        }>,
     ): R;
 
     /**
@@ -182,9 +182,9 @@ interface AwsSdkJestMockAliasMatchers<R> extends Record<string, Function> {
     toReceiveNthSpecificCommandWith<TCmdInput extends object, TCmdOutput extends MetadataBearer>(
         call: number,
         command: new (input: TCmdInput) => AwsCommand<TCmdInput, TCmdOutput>,
-        input: {
+        input: Partial<{
             [Property in keyof TCmdInput]: unknown;
-        },
+        }>,
     ): R;
 
     /**

diff --git a/packages/aws-sdk-client-mock-jest/test-d/types.ts b/packages/aws-sdk-client-mock-jest/test-d/types.ts
@@ -15,9 +15,15 @@ expect(mockClient(SNSClient)).toHaveReceivedCommandTimes(PublishCommand, 1);
 expectError(expect(mockClient(SNSClient)).toHaveReceivedCommandTimes(PublishCommand));
 
 expect(mockClient(SNSClient)).toHaveReceivedCommandWith(PublishCommand, {Message: ''});
+expect(mockClient(SNSClient)).toHaveReceivedCommandWith(PublishCommand, {TopicArn: ''}); // partial match withouth required fields
 expectError(expect(mockClient(SNSClient)).toHaveReceivedCommandWith(PublishCommand, {Foo: ''}));
 
 expect(mockClient(SNSClient)).toHaveReceivedNthCommandWith(1, PublishCommand, {Message: ''});
+expect(mockClient(SNSClient)).toHaveReceivedNthCommandWith(1, PublishCommand, {TopicArn: ''});
 expectError(expect(mockClient(SNSClient)).toHaveReceivedNthCommandWith(1, PublishCommand, {Foo: ''}));
 
+expect(mockClient(SNSClient)).toHaveReceivedNthSpecificCommandWith(1, PublishCommand, {Message: ''});
+expect(mockClient(SNSClient)).toHaveReceivedNthSpecificCommandWith(1, PublishCommand, {TopicArn: ''});
+expectError(expect(mockClient(SNSClient)).toHaveReceivedNthSpecificCommandWith(1, PublishCommand, {Foo: ''}));
+
 globalsExpect(mockClient(SNSClient)).toHaveReceivedCommand(PublishCommand);