@marlinjai/mail-contract 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 marlinjai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,20 @@
+# @marlinjai/mail-contract
+
+The version 1 Application Programming Interface (API) contract of the Lumitra Mail service: [zod](https://zod.dev) schemas and TypeScript types for every request, response, error and webhook, the route table, and the webhook signing helpers.
+
+The service, [`@marlinjai/mail-sdk`](https://www.npmjs.com/package/@marlinjai/mail-sdk) and the dashboard all import these definitions instead of keeping their own copies, so a shape is defined exactly once. Its only runtime dependency is zod, and it uses no Node.js built-ins, so it runs in Node.js, browsers and edge runtimes.
+
+```bash
+pnpm add @marlinjai/mail-contract zod
+```
+
+Most applications use `@marlinjai/mail-sdk`, which builds on this package. Import the contract directly to validate data at your own boundary, or to verify webhooks without the SDK:
+
+- request and response schemas and their types, per resource (workspaces, templates, providers, contacts, mailings, webhooks, unsubscribe)
+- the error codes and error body (`ErrorCodeSchema`, `errorBody`, `statusForError`)
+- the route table (`matchRoute`, `buildPath`, `acceptsIdempotencyKey`)
+- webhook signing and verification (`signWebhook`, `verifyWebhook`): the signature is `v1=<hex>` over `${timestamp}.${rawBody}`, checked in constant time, with a 300 second tolerance
+
+## License
+
+MIT