aws-sdk-vitest-mock 0.3.0 → 0.4.0

package/README.md

@@ -43,6 +43,8 @@ pnpm add -D aws-sdk-vitest-mock
 
 ### Basic Usage
 
+> **Note:** `mockClient()` mocks **all instances** of a client class. Use `mockClientInstance()` when you need to mock a specific instance.
+
 ```typescript
 import { describe, test, expect, beforeEach, afterEach } from "vitest";
 import { mockClient } from "aws-sdk-vitest-mock";
@@ -65,10 +67,10 @@ describe("DocumentService", () => {
   let documentService: DocumentService;
 
   beforeEach(() => {
-    // Mock the S3 client
+    // Mock all instances of S3Client
     s3Mock = mockClient(S3Client);
 
-    // Create service with real S3Client (which is now mocked)
+    // Any S3Client instance created after this will be mocked
     const s3Client = new S3Client({ region: "us-east-1" });
     documentService = new DocumentService(s3Client);
   });
@@ -93,6 +95,18 @@ describe("DocumentService", () => {
 });
 ```
 
+## 🎯 Key Concepts
+
+Understanding these concepts will help you use the library effectively:
+
+- **`mockClient(ClientClass)`** - Mocks **all instances** of a client class. Use this in most test scenarios where you control client creation.
+- **`mockClientInstance(instance)`** - Mocks a **specific client instance**. Use when the client is created outside your test (e.g., in application bootstrap).
+- **Command Matching** - Commands are matched by constructor. Optionally match by input properties (partial matching by default, strict matching available).
+- **Sequential Responses** - Use `resolvesOnce()` / `rejectsOnce()` for one-time behaviors that fall back to permanent handlers set with `resolves()` / `rejects()`.
+- **Chainable API** - All mock configuration methods return the stub, allowing method chaining for cleaner test setup.
+
+## 📖 Usage Guide
+
 ### Request Matching
 
 ```typescript
@@ -121,56 +135,66 @@ s3Mock
 // All other calls return 'subsequent calls'
 ```
 
-### Fixture Loading
-
-Load mock responses from files for easier test data management:
+### Error Handling
 
 ```typescript
-// Load JSON response from file
-s3Mock.on(GetObjectCommand).resolvesFromFile("./fixtures/s3-response.json");
+s3Mock.on(GetObjectCommand).rejects(new Error("Not found"));
 
-// Load text response from file
-s3Mock.on(GetObjectCommand).resolvesFromFile("./fixtures/response.txt");
+// Or with rejectsOnce
+s3Mock
+  .on(GetObjectCommand)
+  .rejectsOnce(new Error("Temporary failure"))
+  .resolves({ Body: "success" });
+```
+
+### Custom Handlers
 
-// JSON files are automatically parsed, text files returned as strings
-// File paths are resolved relative to current working directory
+```typescript
+s3Mock.on(GetObjectCommand).callsFake(async (input, getClient) => {
+  const client = getClient();
+  console.log("Bucket:", input.Bucket);
+  return { Body: `Dynamic response for ${input.Key}` };
+});
 ```
 
-### Paginator Support
+### Mocking Existing Instances
 
-Mock AWS SDK v3 pagination with automatic token handling:
+Use `mockClientInstance()` when you need to mock a client that's already been created:
 
 ```typescript
-// Mock DynamoDB scan with pagination
-const items = Array.from({ length: 25 }, (_, i) => ({
-  id: { S: `item-${i + 1}` },
-}));
+// Your application service that uses an injected S3 client
+class FileUploadService {
+  constructor(private s3Client: S3Client) {}
 
-dynamoMock.on(ScanCommand).resolvesPaginated(items, {
-  pageSize: 10,
-  itemsKey: "Items",
-  tokenKey: "NextToken",
-});
+  async uploadFile(bucket: string, key: string, data: string) {
+    return await this.s3Client.send(
+      new PutObjectCommand({ Bucket: bucket, Key: key, Body: data }),
+    );
+  }
+}
 
-// First call returns items 1-10 with NextToken
-// Second call with NextToken returns items 11-20
-// Third call returns items 21-25 without NextToken
+test("should mock existing S3 client instance", async () => {
+  // Client is already created (e.g., in application bootstrap)
+  const s3Client = new S3Client({ region: "us-east-1" });
+  const service = new FileUploadService(s3Client);
 
-// Mock S3 list objects with pagination
-const objects = Array.from({ length: 15 }, (_, i) => ({
-  Key: `file-${i + 1}.txt`,
-}));
+  // Mock the specific client instance
+  const mock = mockClientInstance(s3Client);
+  mock.on(PutObjectCommand).resolves({ ETag: "mock-etag" });
 
-s3Mock.on(ListObjectsV2Command).resolvesPaginated(objects, {
-  pageSize: 10,
-  itemsKey: "Contents",
-  tokenKey: "ContinuationToken",
+  // Test your service
+  const result = await service.uploadFile("bucket", "key", "data");
+
+  expect(result.ETag).toBe("mock-etag");
+  expect(mock).toHaveReceivedCommand(PutObjectCommand);
 });
 ```
 
+## 🔧 AWS Service Examples
+
 ### DynamoDB with Marshal/Unmarshal
 
-Mock DynamoDB operations using AWS SDK's marshal/unmarshal utilities for type-safe data handling:
+Mock DynamoDB operations using marshal/unmarshal utilities for type-safe data handling:
 
 ```typescript
 import { describe, test, expect, beforeEach, afterEach } from "vitest";
@@ -265,7 +289,9 @@ describe("UserService with DynamoDB", () => {
 });
 ```
 
-### Stream Mocking (S3 Helper)
+## 🚀 Advanced Features
+
+### Stream Mocking (S3)
 
 Mock S3 operations that return streams with automatic environment detection:
 
@@ -283,21 +309,70 @@ s3Mock
   .resolvesStream("Subsequent calls");
 ```
 
-### Delay/Latency Simulation
+### Paginator Support
 
-Simulate network delays for testing timeouts and race conditions:
+Mock AWS SDK v3 pagination with automatic token handling:
 
 ```typescript
-// Resolve with delay
-s3Mock.on(GetObjectCommand).resolvesWithDelay({ Body: "data" }, 1000);
+// Mock DynamoDB scan with pagination
+// DynamoDB uses different keys for input (ExclusiveStartKey) and output (LastEvaluatedKey)
+const items = Array.from({ length: 25 }, (_, i) => ({
+  id: { S: `item-${i + 1}` },
+}));
 
-// Reject with delay
-s3Mock.on(GetObjectCommand).rejectsWithDelay("Network timeout", 500);
+dynamoMock.on(ScanCommand).resolvesPaginated(items, {
+  pageSize: 10,
+  itemsKey: "Items",
+  tokenKey: "LastEvaluatedKey", // Token key in response
+  inputTokenKey: "ExclusiveStartKey", // Token key in request (when different from response)
+});
+
+// First call returns items 1-10 with LastEvaluatedKey
+const result1 = await client.send(new ScanCommand({ TableName: "test" }));
+// result1.LastEvaluatedKey = "token-10"
+
+// Second call with ExclusiveStartKey returns items 11-20
+const result2 = await client.send(
+  new ScanCommand({
+    TableName: "test",
+    ExclusiveStartKey: result1.LastEvaluatedKey,
+  }),
+);
+// result2.LastEvaluatedKey = "token-20"
+
+// Third call returns items 21-25 without LastEvaluatedKey
+const result3 = await client.send(
+  new ScanCommand({
+    TableName: "test",
+    ExclusiveStartKey: result2.LastEvaluatedKey,
+  }),
+);
+// result3.LastEvaluatedKey = undefined (no more pages)
+
+// Mock S3 list objects with pagination
+// S3 uses the same key for input and output, so inputTokenKey is optional
+const objects = Array.from({ length: 15 }, (_, i) => ({
+  Key: `file-${i + 1}.txt`,
+}));
+
+s3Mock.on(ListObjectsV2Command).resolvesPaginated(objects, {
+  pageSize: 10,
+  itemsKey: "Contents",
+  tokenKey: "NextContinuationToken", // Used for both input and output
+});
 ```
 
+**Pagination Options:**
+
+- `pageSize` - Number of items per page (default: 10)
+- `itemsKey` - Property name for items array in response (default: "Items")
+- `tokenKey` - Property name for pagination token in response (default: "NextToken")
+- `inputTokenKey` - Property name for pagination token in request (default: same as `tokenKey`)
+  - Use this when AWS service uses different names for input/output tokens (e.g., DynamoDB's `ExclusiveStartKey` vs `LastEvaluatedKey`)
+
 ### AWS Error Simulation
 
-Convenient methods for common AWS errors:
+Convenient helper methods for common AWS errors:
 
 ```typescript
 // S3 Errors
@@ -314,61 +389,34 @@ s3Mock.on(GetObjectCommand).rejectsWithThrottling();
 s3Mock.on(GetObjectCommand).rejectsWithInternalServerError();
 ```
 
-### Error Handling
+### Delay/Latency Simulation
+
+Simulate network delays for testing timeouts and race conditions:
 
 ```typescript
-s3Mock.on(GetObjectCommand).rejects(new Error("Not found"));
+// Resolve with delay
+s3Mock.on(GetObjectCommand).resolvesWithDelay({ Body: "data" }, 1000);
 
-// Or with rejectsOnce
-s3Mock
-  .on(GetObjectCommand)
-  .rejectsOnce(new Error("Temporary failure"))
-  .resolves({ Body: "success" });
+// Reject with delay
+s3Mock.on(GetObjectCommand).rejectsWithDelay("Network timeout", 500);
 ```
 
-### Custom Handlers
-
-```typescript
-s3Mock.on(GetObjectCommand).callsFake(async (input, getClient) => {
-  const client = getClient();
-  console.log("Bucket:", input.Bucket);
-  return { Body: `Dynamic response for ${input.Key}` };
-});
-```
+### Fixture Loading
 
-### Mocking Existing Instances
+Load mock responses from files for easier test data management:
 
 ```typescript
-// Your application service that uses an injected S3 client
-class FileUploadService {
-  constructor(private s3Client: S3Client) {}
-
-  async uploadFile(bucket: string, key: string, data: string) {
-    return await this.s3Client.send(
-      new PutObjectCommand({ Bucket: bucket, Key: key, Body: data }),
-    );
-  }
-}
-
-test("should mock existing S3 client instance", async () => {
-  // Create the client your application will use
-  const s3Client = new S3Client({ region: "us-east-1" });
-  const service = new FileUploadService(s3Client);
-
-  // Mock the existing client instance
-  const mock = mockClientInstance(s3Client);
-  mock.on(PutObjectCommand).resolves({ ETag: "mock-etag" });
-
-  // Test your service
-  const result = await service.uploadFile("bucket", "key", "data");
+// Load JSON response from file (automatically parsed)
+s3Mock.on(GetObjectCommand).resolvesFromFile("./fixtures/s3-response.json");
 
-  expect(result.ETag).toBe("mock-etag");
-  expect(mock).toHaveReceivedCommand(PutObjectCommand);
-});
+// Load text response from file (returned as string)
+s3Mock.on(GetObjectCommand).resolvesFromFile("./fixtures/response.txt");
 ```
 
 ### Debug Mode
 
+Enable debug logging to troubleshoot mock configurations when they're not matching as expected:
+
 Enable debug logging to troubleshoot mock configurations and see detailed information about command matching:
 
 ```typescript
@@ -543,9 +591,11 @@ bun nx build
 
 See [CONTRIBUTING.md](./CONTRIBUTING.md) for the complete guide.
 
-## 🙏 Acknowledgements
+## Acknowledgements
+
+This library is based on the core ideas and API patterns introduced by [aws-sdk-client-mock](https://github.com/m-radzikowski/aws-sdk-client-mock), which is no longer actively maintained.
 
-This library was inspired by [aws-sdk-client-mock](https://github.com/m-radzikowski/aws-sdk-client-mock). Adapted the core concepts and API design for Vitest while adding additional features and capabilities.
+It reimagines those concepts for Vitest, while extending them with additional features, improved ergonomics, and ongoing maintenance.
 
 ## 📝 License
 

package/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const b=require("vitest"),P=require("node:fs"),R=require("node:path"),N=require("node:stream"),C=require("./matchers-Rq18z2C7.cjs");class d extends Error{constructor(e,s,c,n){super(e),this.name="AwsError",this.code=s,this.statusCode=c,this.retryable=n}}const W=t=>{const e=t?`The specified key does not exist. Key: ${t}`:"The specified key does not exist.";return new d(e,"NoSuchKey",404,!1)},M=t=>{const e=t?`The specified bucket does not exist. Bucket: ${t}`:"The specified bucket does not exist.";return new d(e,"NoSuchBucket",404,!1)},$=t=>{const e=t?`Access Denied for resource: ${t}`:"Access Denied";return new d(e,"AccessDenied",403,!1)},D=t=>{const e=t?`Requested resource not found: ${t}`:"Requested resource not found";return new d(e,"ResourceNotFoundException",400,!1)},I=()=>new d("The conditional request failed","ConditionalCheckFailedException",400,!1),O=()=>new d("Rate exceeded","Throttling",400,!0),T=()=>new d("We encountered an internal error. Please try again.","InternalServerError",500,!0);function k(){return{enabled:!1,log(t,e){this.enabled&&(e===void 0?console.log(`[aws-sdk-vitest-mock](Debug) ${t}`):console.log(`[aws-sdk-vitest-mock](Debug) ${t}`,e))}}}function y(t){t.enabled=!0}function v(t){t.enabled=!1}function F(t){const e=R.resolve(t),s=P.readFileSync(e,"utf8");return t.endsWith(".json")?JSON.parse(s):s}function L(t,e={}){const{pageSize:s=10,tokenKey:c="NextToken",itemsKey:n="Items"}=e;if(t.length===0)return[{[n]:[]}];const o=[];for(let r=0;r<t.length;r+=s){const u=t.slice(r,r+s),i=r+s<t.length,l={[n]:u};if(i){const a=l;a[c]=`token-${r+s}`}o.push(l)}return o}function A(){return typeof process<"u"&&process.versions?.node?"node":typeof process<"u"&&process.versions?.bun?"bun":"browser"}function K(t){const e=typeof t=="string"?Buffer.from(t,"utf8"):Buffer.from(t);return new N.Readable({read(){this.push(e),this.push(void 0)}})}function q(t){let e;return typeof t=="string"?e=new TextEncoder().encode(t):t instanceof Buffer?e=new Uint8Array(t):e=t,new ReadableStream({start(s){s.enqueue(e),s.close()}})}function h(t){const e=A();return e==="node"||e==="bun"?K(t):q(t)}function w(t,e){return Object.keys(e).every(s=>{const c=e[s],n=t[s];return c&&typeof c=="object"&&!Array.isArray(c)?typeof n!="object"||n===null?!1:w(n,c):n===c})}function j(t,e){if(t===e)return!0;if(typeof t!="object"||t===null||typeof e!="object"||e===null)return t===e;const s=Object.keys(t),c=Object.keys(e);return s.length!==c.length?!1:c.every(n=>{if(!Object.prototype.hasOwnProperty.call(t,n))return!1;const o=t,r=e,u=o[n],i=r[n];return typeof u=="object"&&u!==null&&typeof i=="object"&&i!==null?j(u,i):u===i})}function S(t){return async function(e){const s=()=>this;t.debugLogger.log(`Received command: ${e.constructor.name}`,e.input);const c=t.map.get(e.constructor);if(c){t.debugLogger.log(`Found ${c.length} mock(s) for ${e.constructor.name}`);const n=c.findIndex(o=>o.strict?o.matcher&&j(e.input,o.matcher):!o.matcher||w(e.input,o.matcher));if(n===-1)t.debugLogger.log(`No matching mock found for ${e.constructor.name}`,e.input);else{const o=c[n];if(!o)throw new Error(`Mock at index ${n} not found`);return t.debugLogger.log(`Using mock at index ${n} for ${e.constructor.name}`),o.once&&(c.splice(n,1),t.debugLogger.log(`Removed one-time mock for ${e.constructor.name}`)),o.handler(e.input,s())}}else t.debugLogger.log(`No mocks configured for ${e.constructor.name}`);throw new Error(`No mock configured for command: ${e.constructor.name}`)}}function x(t,e,s,c={}){const n=(r,u)=>{const i={matcher:s,handler:r,once:u,strict:!!c.strict},l=t.map.get(e)??[];if(u){const a=l.findIndex(f=>!f.once);a===-1?l.push(i):l.splice(a,0,i),t.map.set(e,l)}else{const a=l.filter(f=>f.once||JSON.stringify(f.matcher)!==JSON.stringify(s));a.push(i),t.map.set(e,a)}},o={resolves(r){return n(()=>Promise.resolve(r),!1),o},rejects(r){return n(()=>{const u=typeof r=="string"?new Error(r):r;return Promise.reject(u)},!1),o},callsFake(r){return n(r,!1),o},resolvesOnce(r){return n(()=>Promise.resolve(r),!0),o},rejectsOnce(r){return n(()=>{const u=typeof r=="string"?new Error(r):r;return Promise.reject(u)},!0),o},callsFakeOnce(r){return n(r,!0),o},resolvesStream(r){return n(()=>Promise.resolve({Body:h(r)}),!1),o},resolvesStreamOnce(r){return n(()=>Promise.resolve({Body:h(r)}),!0),o},resolvesWithDelay(r,u){const i=l=>{setTimeout(()=>l(r),u)};return n(()=>new Promise(i),!1),o},rejectsWithDelay(r,u){const i=typeof r=="string"?new Error(r):r,l=(a,f)=>{setTimeout(()=>f(i),u)};return n(()=>new Promise(l),!1),o},rejectsWithNoSuchKey(r){return n(()=>Promise.reject(W(r)),!1),o},rejectsWithNoSuchBucket(r){return n(()=>Promise.reject(M(r)),!1),o},rejectsWithAccessDenied(r){return n(()=>Promise.reject($(r)),!1),o},rejectsWithResourceNotFound(r){return n(()=>Promise.reject(D(r)),!1),o},rejectsWithConditionalCheckFailed(){return n(()=>Promise.reject(I()),!1),o},rejectsWithThrottling(){return n(()=>Promise.reject(O()),!1),o},rejectsWithInternalServerError(){return n(()=>Promise.reject(T()),!1),o},resolvesPaginated(r,u={}){const i=L(r,u);let l=0;return n(a=>{const f=u.tokenKey||"NextToken",p=a[f];if(p){const g=/token-(\d+)/.exec(p);if(g&&g[1]){const E=g[1];l=Math.floor(Number.parseInt(E,10)/(u.pageSize||10))}}else l=0;const m=i[l]||i[i.length-1]||i[0];if(!m)throw new Error("No paginated responses available");return l=Math.min(l+1,i.length-1),Promise.resolve(m)},!1),o},resolvesFromFile(r){return n(()=>{const u=F(r);return Promise.resolve(u)},!1),o}};return o}const B=t=>{const e={map:new WeakMap,debugLogger:k()},s=t.prototype,c=b.vi.spyOn(s,"send").mockImplementation(S(e));return{client:void 0,on:(o,r,u)=>x(e,o,r,u),reset:()=>{c.mockClear(),e.map=new WeakMap},restore:()=>{c.mockRestore(),e.map=new WeakMap},calls:()=>c.mock.calls.map(o=>o[0]),__rawCalls:()=>c.mock.calls,enableDebug:()=>{y(e.debugLogger)},disableDebug:()=>{v(e.debugLogger)}}},_=t=>{const e={map:new WeakMap,debugLogger:k()},s=b.vi.spyOn(t,"send").mockImplementation(S(e));return{client:t,on:(n,o,r)=>x(e,n,o,r),reset:()=>{s.mockClear(),e.map=new WeakMap},restore:()=>{s.mockRestore(),e.map=new WeakMap},calls:()=>s.mock.calls.map(n=>n[0]),__rawCalls:()=>s.mock.calls,enableDebug:()=>{y(e.debugLogger)},disableDebug:()=>{v(e.debugLogger)}}};exports.matchers=C.matchers;exports.mockClient=B;exports.mockClientInstance=_;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const b=require("vitest"),R=require("node:fs"),N=require("node:path"),C=require("node:stream"),W=require("./matchers-Rq18z2C7.cjs");class d extends Error{constructor(e,s,c,n){super(e),this.name="AwsError",this.code=s,this.statusCode=c,this.retryable=n}}const M=t=>{const e=t?`The specified key does not exist. Key: ${t}`:"The specified key does not exist.";return new d(e,"NoSuchKey",404,!1)},T=t=>{const e=t?`The specified bucket does not exist. Bucket: ${t}`:"The specified bucket does not exist.";return new d(e,"NoSuchBucket",404,!1)},$=t=>{const e=t?`Access Denied for resource: ${t}`:"Access Denied";return new d(e,"AccessDenied",403,!1)},D=t=>{const e=t?`Requested resource not found: ${t}`:"Requested resource not found";return new d(e,"ResourceNotFoundException",400,!1)},I=()=>new d("The conditional request failed","ConditionalCheckFailedException",400,!1),O=()=>new d("Rate exceeded","Throttling",400,!0),F=()=>new d("We encountered an internal error. Please try again.","InternalServerError",500,!0);function k(){return{enabled:!1,log(t,e){this.enabled&&(e===void 0?console.log(`[aws-sdk-vitest-mock](Debug) ${t}`):console.log(`[aws-sdk-vitest-mock](Debug) ${t}`,e))}}}function y(t){t.enabled=!0}function v(t){t.enabled=!1}function L(t){const e=N.resolve(t),s=R.readFileSync(e,"utf8");return t.endsWith(".json")?JSON.parse(s):s}function K(t,e={}){const{pageSize:s=10,tokenKey:c="NextToken",itemsKey:n="Items"}=e;if(t.length===0)return[{[n]:[]}];const o=[];for(let r=0;r<t.length;r+=s){const u=t.slice(r,r+s),i=r+s<t.length,l={[n]:u};if(i){const a=l;a[c]=`token-${r+s}`}o.push(l)}return o}function A(){return typeof process<"u"&&process.versions?.node?"node":typeof process<"u"&&process.versions?.bun?"bun":"browser"}function q(t){const e=typeof t=="string"?Buffer.from(t,"utf8"):Buffer.from(t);let s=!1;return new C.Readable({read(){s||(this.push(e),this.push(null),s=!0)}})}function B(t){let e;return typeof t=="string"?e=new TextEncoder().encode(t):t instanceof Buffer?e=new Uint8Array(t):e=t,new ReadableStream({start(s){s.enqueue(e),s.close()}})}function h(t){const e=A();return e==="node"||e==="bun"?q(t):B(t)}function w(t,e){return Object.keys(e).every(s=>{const c=e[s],n=t[s];return c&&typeof c=="object"&&!Array.isArray(c)?typeof n!="object"||n===null?!1:w(n,c):n===c})}function j(t,e){if(t===e)return!0;if(typeof t!="object"||t===null||typeof e!="object"||e===null)return t===e;const s=Object.keys(t),c=Object.keys(e);return s.length!==c.length?!1:c.every(n=>{if(!Object.prototype.hasOwnProperty.call(t,n))return!1;const o=t,r=e,u=o[n],i=r[n];return typeof u=="object"&&u!==null&&typeof i=="object"&&i!==null?j(u,i):u===i})}function S(t){return async function(e){const s=()=>this;t.debugLogger.log(`Received command: ${e.constructor.name}`,e.input);const c=t.map.get(e.constructor);if(c){t.debugLogger.log(`Found ${c.length} mock(s) for ${e.constructor.name}`);const n=c.findIndex(o=>o.strict?o.matcher&&j(e.input,o.matcher):!o.matcher||w(e.input,o.matcher));if(n===-1)t.debugLogger.log(`No matching mock found for ${e.constructor.name}`,e.input);else{const o=c[n];if(!o)throw new Error(`Mock at index ${n} not found`);return t.debugLogger.log(`Using mock at index ${n} for ${e.constructor.name}`),o.once&&(c.splice(n,1),t.debugLogger.log(`Removed one-time mock for ${e.constructor.name}`)),o.handler(e.input,s())}}else t.debugLogger.log(`No mocks configured for ${e.constructor.name}`);throw new Error(`No mock configured for command: ${e.constructor.name}`)}}function x(t,e,s,c={}){const n=(r,u)=>{const i={matcher:s,handler:r,once:u,strict:!!c.strict},l=t.map.get(e)??[];if(u){const a=l.findIndex(f=>!f.once);a===-1?l.push(i):l.splice(a,0,i),t.map.set(e,l)}else{const a=l.filter(f=>f.once||JSON.stringify(f.matcher)!==JSON.stringify(s));a.push(i),t.map.set(e,a)}},o={resolves(r){return n(()=>Promise.resolve(r),!1),o},rejects(r){return n(()=>{const u=typeof r=="string"?new Error(r):r;return Promise.reject(u)},!1),o},callsFake(r){return n(r,!1),o},resolvesOnce(r){return n(()=>Promise.resolve(r),!0),o},rejectsOnce(r){return n(()=>{const u=typeof r=="string"?new Error(r):r;return Promise.reject(u)},!0),o},callsFakeOnce(r){return n(r,!0),o},resolvesStream(r){return n(()=>Promise.resolve({Body:h(r)}),!1),o},resolvesStreamOnce(r){return n(()=>Promise.resolve({Body:h(r)}),!0),o},resolvesWithDelay(r,u){const i=l=>{setTimeout(()=>l(r),u)};return n(()=>new Promise(i),!1),o},rejectsWithDelay(r,u){const i=typeof r=="string"?new Error(r):r,l=(a,f)=>{setTimeout(()=>f(i),u)};return n(()=>new Promise(l),!1),o},rejectsWithNoSuchKey(r){return n(()=>Promise.reject(M(r)),!1),o},rejectsWithNoSuchBucket(r){return n(()=>Promise.reject(T(r)),!1),o},rejectsWithAccessDenied(r){return n(()=>Promise.reject($(r)),!1),o},rejectsWithResourceNotFound(r){return n(()=>Promise.reject(D(r)),!1),o},rejectsWithConditionalCheckFailed(){return n(()=>Promise.reject(I()),!1),o},rejectsWithThrottling(){return n(()=>Promise.reject(O()),!1),o},rejectsWithInternalServerError(){return n(()=>Promise.reject(F()),!1),o},resolvesPaginated(r,u={}){const i=K(r,u);let l=0;return n(a=>{const f=u.tokenKey||"NextToken",E=u.inputTokenKey||f,p=a[E];if(p){const g=/token-(\d+)/.exec(p);if(g&&g[1]){const P=g[1];l=Math.floor(Number.parseInt(P,10)/(u.pageSize||10))}}else l=0;const m=i[l]||i[i.length-1]||i[0];if(!m)throw new Error("No paginated responses available");return l=Math.min(l+1,i.length-1),Promise.resolve(m)},!1),o},resolvesFromFile(r){return n(()=>{const u=L(r);return Promise.resolve(u)},!1),o}};return o}const _=t=>{const e={map:new WeakMap,debugLogger:k()},s=t.prototype,c=b.vi.spyOn(s,"send").mockImplementation(S(e));return{client:void 0,on:(o,r,u)=>x(e,o,r,u),reset:()=>{c.mockClear(),e.map=new WeakMap},restore:()=>{c.mockRestore(),e.map=new WeakMap},calls:()=>c.mock.calls.map(o=>o[0]),__rawCalls:()=>c.mock.calls,enableDebug:()=>{y(e.debugLogger)},disableDebug:()=>{v(e.debugLogger)}}},V=t=>{const e={map:new WeakMap,debugLogger:k()},s=b.vi.spyOn(t,"send").mockImplementation(S(e));return{client:t,on:(n,o,r)=>x(e,n,o,r),reset:()=>{s.mockClear(),e.map=new WeakMap},restore:()=>{s.mockRestore(),e.map=new WeakMap},calls:()=>s.mock.calls.map(n=>n[0]),__rawCalls:()=>s.mock.calls,enableDebug:()=>{y(e.debugLogger)},disableDebug:()=>{v(e.debugLogger)}}};exports.matchers=W.matchers;exports.mockClient=_;exports.mockClientInstance=V;

package/index.js

@@ -1,26 +1,26 @@
 import { vi as b } from "vitest";
-import { readFileSync as P } from "node:fs";
-import R from "node:path";
-import { Readable as N } from "node:stream";
-import { m as X } from "./matchers-C6AtmwWz.js";
+import { readFileSync as R } from "node:fs";
+import N from "node:path";
+import { Readable as W } from "node:stream";
+import { m as Y } from "./matchers-C6AtmwWz.js";
 class d extends Error {
   constructor(e, s, c, n) {
     super(e), this.name = "AwsError", this.code = s, this.statusCode = c, this.retryable = n;
   }
 }
-const W = (t) => {
+const C = (t) => {
   const e = t ? `The specified key does not exist. Key: ${t}` : "The specified key does not exist.";
   return new d(e, "NoSuchKey", 404, !1);
-}, C = (t) => {
+}, $ = (t) => {
   const e = t ? `The specified bucket does not exist. Bucket: ${t}` : "The specified bucket does not exist.";
   return new d(e, "NoSuchBucket", 404, !1);
-}, $ = (t) => {
+}, D = (t) => {
   const e = t ? `Access Denied for resource: ${t}` : "Access Denied";
   return new d(e, "AccessDenied", 403, !1);
-}, D = (t) => {
+}, M = (t) => {
   const e = t ? `Requested resource not found: ${t}` : "Requested resource not found";
   return new d(e, "ResourceNotFoundException", 400, !1);
-}, M = () => new d(
+}, T = () => new d(
   "The conditional request failed",
   "ConditionalCheckFailedException",
   400,
@@ -45,11 +45,11 @@ function y(t) {
 function w(t) {
   t.enabled = !1;
 }
-function T(t) {
-  const e = R.resolve(t), s = P(e, "utf8");
+function F(t) {
+  const e = N.resolve(t), s = R(e, "utf8");
   return t.endsWith(".json") ? JSON.parse(s) : s;
 }
-function F(t, e = {}) {
+function L(t, e = {}) {
   const { pageSize: s = 10, tokenKey: c = "NextToken", itemsKey: n = "Items" } = e;
   if (t.length === 0)
     return [{ [n]: [] }];
@@ -64,18 +64,19 @@ function F(t, e = {}) {
   }
   return o;
 }
-function L() {
+function K() {
   return typeof process < "u" && process.versions?.node ? "node" : typeof process < "u" && process.versions?.bun ? "bun" : "browser";
 }
 function A(t) {
   const e = typeof t == "string" ? Buffer.from(t, "utf8") : Buffer.from(t);
-  return new N({
+  let s = !1;
+  return new W({
     read() {
-      this.push(e), this.push(void 0);
+      s || (this.push(e), this.push(null), s = !0);
     }
   });
 }
-function K(t) {
+function B(t) {
   let e;
   return typeof t == "string" ? e = new TextEncoder().encode(t) : t instanceof Buffer ? e = new Uint8Array(t) : e = t, new ReadableStream({
     start(s) {
@@ -84,8 +85,8 @@ function K(t) {
   });
 }
 function h(t) {
-  const e = L();
-  return e === "node" || e === "bun" ? A(t) : K(t);
+  const e = K();
+  return e === "node" || e === "bun" ? A(t) : B(t);
 }
 function v(t, e) {
   return Object.keys(e).every((s) => {
@@ -222,23 +223,23 @@ function S(t, e, s, c = {}) {
       return n(() => new Promise(l), !1), o;
     },
     rejectsWithNoSuchKey(r) {
-      return n(() => Promise.reject(W(r)), !1), o;
+      return n(() => Promise.reject(C(r)), !1), o;
     },
     rejectsWithNoSuchBucket(r) {
-      return n(() => Promise.reject(C(r)), !1), o;
+      return n(() => Promise.reject($(r)), !1), o;
     },
     rejectsWithAccessDenied(r) {
-      return n(() => Promise.reject($(r)), !1), o;
+      return n(() => Promise.reject(D(r)), !1), o;
     },
     rejectsWithResourceNotFound(r) {
       return n(
-        () => Promise.reject(D(r)),
+        () => Promise.reject(M(r)),
         !1
       ), o;
     },
     rejectsWithConditionalCheckFailed() {
       return n(
-        () => Promise.reject(M()),
+        () => Promise.reject(T()),
         !1
       ), o;
     },
@@ -249,16 +250,16 @@ function S(t, e, s, c = {}) {
       return n(() => Promise.reject(O()), !1), o;
     },
     resolvesPaginated(r, u = {}) {
-      const i = F(r, u);
+      const i = L(r, u);
       let l = 0;
       return n((a) => {
-        const f = u.tokenKey || "NextToken", p = a[f];
+        const f = u.tokenKey || "NextToken", E = u.inputTokenKey || f, p = a[E];
         if (p) {
           const g = /token-(\d+)/.exec(p);
           if (g && g[1]) {
-            const E = g[1];
+            const P = g[1];
             l = Math.floor(
-              Number.parseInt(E, 10) / (u.pageSize || 10)
+              Number.parseInt(P, 10) / (u.pageSize || 10)
             );
           }
         } else
@@ -275,14 +276,14 @@ function S(t, e, s, c = {}) {
     },
     resolvesFromFile(r) {
       return n(() => {
-        const u = T(r);
+        const u = F(r);
         return Promise.resolve(u);
       }, !1), o;
     }
   };
   return o;
 }
-const U = (t) => {
+const G = (t) => {
   const e = {
     map: /* @__PURE__ */ new WeakMap(),
     debugLogger: k()
@@ -310,7 +311,7 @@ const U = (t) => {
       w(e.debugLogger);
     }
   };
-}, G = (t) => {
+}, H = (t) => {
   const e = {
     map: /* @__PURE__ */ new WeakMap(),
     debugLogger: k()
@@ -340,7 +341,7 @@ const U = (t) => {
   };
 };
 export {
-  X as matchers,
-  U as mockClient,
-  G as mockClientInstance
+  Y as matchers,
+  G as mockClient,
+  H as mockClientInstance
 };

package/lib/utils/paginator-helpers.d.ts

@@ -1,6 +1,7 @@
 export interface PaginatorOptions {
     pageSize?: number;
     tokenKey?: string;
+    inputTokenKey?: string;
     itemsKey?: string;
 }
 export interface PaginatedResponse<T = unknown> {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aws-sdk-vitest-mock",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "type": "module",
   "main": "./index.cjs",
   "module": "./index.js",