contiguity 0.0.6 → 0.0.8

package/README.md

@@ -1,186 +1,78 @@
-# Contiguity JavaScript/TypeScript SDK
+<p align='center'><img src="https://contiguity.co/assets/icon-black.png" height="150px"/></p>
+<h1 align='center'>Contiguity JavaScript SDK</h1>
 
-Official SDK for [Contiguity](https://contiguity.com). Send SMS, email, OTPs, iMessage, WhatsApp, manage domains and number leases, and verify webhooks.
+<p align='center'>
+    <img display="inline-block" src="https://img.shields.io/npm/v/contiguity?style=for-the-badge" />
+    <img display="inline-block" src="https://img.shields.io/badge/Made%20with-TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white" />
+</p>
 
-## Install
+<p align='center'>The official TypeScript/JavaScript SDK for Contiguity's APIs.</p>
 
-Works with Node 18+, Bun, and bundlers. ESM only.
+## Installation
 
 ```bash
-bun add contiguity
-# or
-pnpm add contiguity
-# or
+# Using npm
 npm install contiguity
-# or
-yarn add contiguity
-```
 
-## Init
+# Using pnpm  
+pnpm add contiguity
 
-```ts
-import { Contiguity } from "contiguity";
+# Using bun
+bun add contiguity
+```
 
-const contiguity = new Contiguity("contiguity_sk_...your_token...");
+## Getting Started
 
-// Or omit the token and use env: CONTIGUITY_API_KEY or CONTIGUITY_TOKEN
-const contiguity = new Contiguity();
+```typescript
+import { Contiguity } from 'contiguity';
 
-// With options
-const contiguity = new Contiguity("contiguity_sk_...", {
-  debug: false,  // set true for request logging
-});
+const contiguity = new Contiguity('contiguity_sk_...your_token...');
 ```
 
-## Quick start
+Get your API token from the [Contiguity Console](https://console.contiguity.com/).
 
-### Text (SMS)
+### Send a text message
 
-```ts
-const res = await contiguity.text.send({
-  to: "+1234567890",
-  message: "Hello from Contiguity!",
-  // from: "+15555555555",  // optional, if you lease a number
+```typescript
+const response = await contiguity.text.send({
+    to: "+1234567890",
+    message: "Hello from Contiguity!"
 });
-// res.message_id, res.metadata
-
-await contiguity.text.get("text_abc123");
-await contiguity.text.history({ to: "+1…", from: "+1…", limit: 20 });
-await contiguity.text.react("add", { message_id: "text_abc", reaction: "love" });
 ```
 
-### Email
+### Send an email  
 
-```ts
-const res = await contiguity.email.send({
-  to: "user@example.com",
-  from: "Your App <no-reply@yourapp.com>",
-  subject: "Welcome!",
-  body: { text: "Welcome to our platform!" },
+```typescript
+const response = await contiguity.email.send({
+    to: "user@example.com", 
+    from: "Your App <no-reply@yourapp.com>",
+    subject: "Welcome!",
+    body: { text: "Welcome to our platform!" }
 });
-// res.email_id, res.metadata
 ```
 
-### OTP
+### Send and verify OTP
 
-```ts
-const res = await contiguity.otp.new({
-  to: "+1234567890",
-  language: "en",
-  name: "MyApp",
+```typescript
+const otpResponse = await contiguity.otp.send({
+    to: "+1234567890",
+    language: "en",
+    name: "MyApp"
 });
-// res.otp_id
-
-const verified = await contiguity.otp.verify({ otp_id: res.otp_id, otp: "123456" });
-// verified.verified === true | false
-
-await contiguity.otp.resend({ otp_id: res.otp_id });
-```
-
-### Domains
-
-```ts
-const list = await contiguity.domains.list();
-const one = await contiguity.domains.get("example.com");
-await contiguity.domains.register("example.com", { region: "us-east-1", custom_return_path: "mail" });
-await contiguity.domains.delete("example.com");
-```
-
-### Lease (numbers)
-
-```ts
-const available = await contiguity.lease.available();
-const details = await contiguity.lease.get("+1234567890");
-await contiguity.lease.create("+1234567890", { billing_method: "monthly" });
-const leased = await contiguity.lease.leased();
-const leaseDetails = await contiguity.lease.details("+1234567890");
-await contiguity.lease.terminate("+1234567890");
-```
-
-### iMessage / WhatsApp
-
-```ts
-await contiguity.imessage.send({ to: "+1234567890", message: "Hello via iMessage!" });
-await contiguity.imessage.typing({ to: "+1234567890", action: "start" });
-await contiguity.imessage.get("imessage_abc123");
-await contiguity.imessage.history({ to: "+1…", from: "+1…", limit: 20 });
-await contiguity.imessage.react("add", { to: "+1…", from: "+1…", tapback: "love", message: "Hello!" });
-await contiguity.imessage.read({ to: "+1234567890", from: "+15555555555" });
-
-await contiguity.whatsapp.send({ to: "+1234567890", message: "Hello via WhatsApp!" });
-await contiguity.whatsapp.typing({ to: "+1234567890", action: "stop" });
-await contiguity.whatsapp.react("add", { to: "+1234567890", reaction: "👍", message: "wa_123" });
-```
 
-### Webhooks
-
-Verify signature (use raw body and `Contiguity-Signature` header):
-
-```ts
-// With request-like object (e.g. Express req with raw body)
-const ok = contiguity.webhook.verify(req, process.env.WEBHOOK_SECRET, 300);
-
-// Or with raw values
-const ok = contiguity.webhook.verify(rawBody, signatureHeader, secret, 300);
-```
-
-Parse webhook body (v2 format):
-
-```ts
-const event = contiguity.webhook.parse(rawBody);
-// event.id, event.type, event.timestamp, event.data
-```
-
-### Pass-through options
-
-Request params accept extra JSON; unknown fields are sent to the API as-is. Types are defined for known fields; you can add more for new API options.
-
-## Response format
-
-All responses return a clean shape: method-specific fields at the top level plus `metadata`:
-
-```ts
-{
-  message_id?: string;
-  email_id?: string;
-  otp_id?: string;
-  // ... etc
-  metadata: { id: string; timestamp: string; api_version: string; object: string; }
-}
-```
-
-## Errors
-
-On API errors the SDK throws `ContiguityError` with `message`, `status`, and optional `code`.
-
-```ts
-import { ContiguityError } from "contiguity";
-try {
-  await contiguity.text.send({ ... });
-} catch (e) {
-  if (e instanceof ContiguityError) {
-    console.error(e.status, e.message);
-  }
-}
+const verification = await contiguity.otp.verify({
+    otp_id: otpResponse.otp_id,
+    otp: "123456"
+});
 ```
 
-## Docs
-
-- [SDK overview](https://docs.contiguity.com/sdk/js/overview)
-- [API reference](https://docs.contiguity.com/llms.txt)
-
-## Development
-
-Use Bun for local dev and publishing:
-
-- `bun install` / `bun run build` — install and compile
-- `bun run test` — build and run Vitest (Vitest loads `.env` from project root; unit tests always run; live API tests when `CONTIGUITY_TEST_API_KEY` is set; send tests need `CONTIGUITY_TEST_TO`, optional `CONTIGUITY_TEST_FROM`, `CONTIGUITY_TEST_EMAIL`, optional `CONTIGUITY_TEST_EMAIL_FROM_NAME`)
-- `bun run pack` — create the tarball (e.g. `contiguity-1.0.0.tgz`) without publishing
-- `bun run publish:dry` — build and simulate publish (no upload)
-- `bun publish` — build (via prepublishOnly) and publish to the registry
+## Documentation
 
-The published package is runtime-agnostic ESM and works for everyone.
+For complete documentation, examples, and API reference, visit [docs.contiguity.com](https://docs.contiguity.com/sdk/js/overview).
 
-## License
+## Resources
 
-MIT
+- [API Reference](https://docs.contiguity.com/api-reference/) - Complete API documentation
+- [Console](https://console.contiguity.com/) - Manage your account and API keys  
+- [Discord Community](https://discord.gg/Z9K5XAsS7H) - Get support and connect with other developers
+- [GitHub Repository](https://github.com/contiguity/javascript) - Source code and issue tracking

package/dist/schemas/email.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"email.d.ts","sourceRoot":"","sources":["../../src/schemas/email.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,eAAe;;;;;;;;;;;;iBAWhB,CAAC;AAEb,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC"}
+{"version":3,"file":"email.d.ts","sourceRoot":"","sources":["../../src/schemas/email.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,eAAe;;;;;;;;;;;;iBAoBhB,CAAC;AAEb,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC"}

package/dist/schemas/email.js

@@ -4,7 +4,16 @@ export const emailSendSchema = z
     to: z.union([z.string(), z.array(z.string()).max(10)]),
     from: z.string(),
     subject: z.string(),
-    body: z.object({ text: z.string().nullable().optional(), html: z.string().nullable().optional() }),
+    body: z
+        .object({
+        text: z.string().nullable().optional(),
+        html: z.string().nullable().optional(),
+    })
+        .refine((b) => {
+        const has_text = b.text != null && b.text !== "";
+        const has_html = b.html != null && b.html !== "";
+        return has_text || has_html;
+    }, "Either body.text or body.html must be provided (non-empty)"),
     reply_to: z.string().nullable().optional(),
     cc: z.union([z.string(), z.array(z.string()).max(10)]).nullable().optional(),
     bcc: z.union([z.string(), z.array(z.string()).max(10)]).nullable().optional(),

package/dist/utils/request.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/utils/request.ts"],"names":[],"mappings":"AAGA,QAAA,MAAM,SAAS;;;;;;;CAOL,CAAC;AAEX,MAAM,MAAM,OAAO,GAAG,MAAM,OAAO,SAAS,CAAC;AAE7C,MAAM,WAAW,aAAa;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,wBAAsB,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACrD,MAAM,EAAE,aAAa,EACrB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE;IACL,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAC;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC7B,GACP,OAAO,CAAC,CAAC,GAAG;IAAE,QAAQ,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAAC,CAwBnG"}
+{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/utils/request.ts"],"names":[],"mappings":"AAGA,QAAA,MAAM,SAAS;;;;;;;CAOL,CAAC;AAEX,MAAM,MAAM,OAAO,GAAG,MAAM,OAAO,SAAS,CAAC;AAE7C,MAAM,WAAW,aAAa;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,wBAAsB,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACrD,MAAM,EAAE,aAAa,EACrB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE;IACL,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAC;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC7B,GACP,OAAO,CAAC,CAAC,GAAG;IAAE,QAAQ,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAAC,CAiCnG"}

package/dist/utils/request.js

@@ -25,8 +25,12 @@ export async function request(config, path, options = {}) {
     });
     const json = (await res.json());
     if (!res.ok) {
-        const errMsg = json.data?.error ?? json.object ?? "Unknown error";
-        const status = json.data?.status ?? res.status;
+        // Default API shape: data: { error, status }. Occasional: { message, status } at top level.
+        const errMsg = json.data?.error ??
+            json.message ??
+            json.object ??
+            "Unknown error";
+        const status = json.data?.status ?? json.status ?? res.status;
         throw new ContiguityError(errMsg, status);
     }
     return transformResponse(json);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "contiguity",
-    "version": "0.0.6",
+    "version": "0.0.8",
     "description": "Contiguity JavaScript/TypeScript SDK",
     "type": "module",
     "main": "dist/index.js",