All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Updated and pinned dependencies, including
qs6.15.3, to address security vulnerabilities. - Added a test-specific TypeScript configuration for reliable Jest and
ts-jestcompilation.
- Replaced the test-only
uuiddependency with Node.jscrypto.randomUUID(). - Updated
@types/nodeandts-jestand refreshed transitive dependencies. - Consolidated contributor guidance and added documentation for maintaining alignment with the Mailinator OpenAPI specification.
- Update dev dependencies to address security vulnerabilities and removed
@types/uuidas it is no longer needed with the latestuuidversions which include their own type definitions.
- Implemented
.envloading for Jest to simplify integration test setup. - Implemented
MAILINATOR_TEST_REAL_MESSAGE_IDfor summary endpoint integration testing. - Lots of test updates.
- Implemented
GetMessageSummaryRequestSDK response modeling to align with the{ summary: ... }payload shape, adding a wrapper response type. - Implemented
GetMessageTextRequestplusMessageTextResponseto supportGET /api/v2/domains/{domain}/messages/{messageId}/text. - Implemented
GetMessageTextPlainRequestto supportGET /api/v2/domains/{domain}/messages/{messageId}/textplain. - Implemented
GetMessageTextHtmlRequestto supportGET /api/v2/domains/{domain}/messages/{messageId}/texthtml. - Implemented
GetMessageHeadersRequestto supportGET /api/v2/domains/{domain}/messages/{messageId}/headers. - Implemented
GetStreamDomainMessagesRequestto supportGET /api/v2/domains/{domain}/stream. - Implemented
GetStreamInboxMessagesRequestto supportGET /api/v2/domains/{domain}/stream/{inbox}. - Updated
GetInboxRequestto use*wheninboxis omitted, resolving to/api/v2/domains/{domain}/inboxes/*.
- Fixed package build output synchronization so generated artifacts in
lib/are always refreshed from the latest TypeScript compile output. - Fixed
GetTeamInfoRequestpackage exports so bothlib/stats/index.jsandlib/stats/index.d.tsre-export it, enabling non-deep imports.
- Added missing barrel export for
GetTeamInfoRequestinsrc/stats/index.ts, so it is available from root package imports.
- Standardized barrel/index generation with an in-repo script (
npm run generate:index) and removed reliance on external global tooling. - Updated
buildto run barrel generation before TypeScript compilation. - Updated generated barrel headers to indicate the in-repo generation command.
- Updated README development instructions for index generation.
- Marked
GetAuthenticatorRequest,GetAuthenticatorByIdRequest, andGetAuthenticatorsRequestwith JSDoc@deprecatedtags because they are not in the current OpenAPI specification. - Marked
GetLatestMessagesRequestandGetLatestInboxMessagesRequestwith JSDoc@deprecatedtags because they are not in the current OpenAPI specification and currently return server errors. - Planned npm registry deprecation for
mailinator-client@<=1.0.4with an upgrade warning message; command execution is pending network-approved run. - Added full inbox-list query parameter support to
GetSmsInboxRequest(skip,limit,sort,decode_subject,cursor,full,wait,delete) to align with the OpenAPI contract.
- Added optional
deletequery parameter support toGetInboxMessageRequest, allowing messages to be deleted upon retrieval.
- Fixed URL path inconsistencies between the SDK and the OpenAPI spec across authenticator, domain, message, and stats request classes.
- Marked all Rule request classes (
CreateRuleRequest,DeleteRuleRequest,DisableRuleRequest,EnableRuleRequest,GetRuleRequest,GetRulesRequest) with JSDoc@deprecatedtags to surface warnings in editors and builds. - Marked
DeleteDomainRequestandCreateDomainRequestwith JSDoc@deprecatedtags to surface warnings in editors and builds. - User Agent string is now read directly from
package.jsoninstead of being hardcoded inConstants.ts. - Updated dev dependencies.