contiguity 0.0.1

package/LICENSE.md

@@ -0,0 +1,8 @@
+Copyright 2025 Contiguity LLC
+
+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 @@
+npm i contiguity

package/dist/client/fetch.d.ts

@@ -0,0 +1,30 @@
+import { z } from "zod";
+export interface ContiguityClientOptions {
+    raw?: boolean;
+    debug?: boolean;
+}
+/**
+ * Contiguity API client with request functionality
+ */
+export declare class ContiguityClient {
+    protected readonly token: string;
+    protected readonly raw: boolean;
+    constructor(token: string, options?: ContiguityClientOptions);
+    /**
+     * Make an authenticated request to the Contiguity API
+     */
+    request(endpoint: string, options?: RequestInit): Promise<any>;
+    /**
+     * Parse and normalize API responses to either raw or flattened format
+     * This method handles the complex logic of parsing different response formats
+     * from the Contiguity API and normalizing them consistently.
+     */
+    parse<T extends z.ZodType, R extends z.ZodType>({ response, schemas: { sdk, raw } }: {
+        response: any;
+        schemas: {
+            sdk: T;
+            raw: R;
+        };
+    }): any;
+}
+//# sourceMappingURL=fetch.d.ts.map

package/dist/client/fetch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../src/client/fetch.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAQxB,MAAM,WAAW,uBAAuB;IACpC,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,KAAK,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,qBAAa,gBAAgB;IACzB,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACjC,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;gBAEpB,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,uBAA4B;IAahE;;OAEG;IACG,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,GAAG,CAAC;IA4DxE;;;;OAIG;IACH,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAC5C,QAAQ,EACR,OAAO,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,EACxB,EAAE;QACC,QAAQ,EAAE,GAAG,CAAC;QACd,OAAO,EAAE;YAAE,GAAG,EAAE,CAAC,CAAC;YAAC,GAAG,EAAE,CAAC,CAAC;SAAE,CAAC;KAChC,GAAG,GAAG;CAkCV"}

package/dist/client/fetch.js

@@ -0,0 +1,117 @@
+import { ContiguityRawResponse } from "@/types/response";
+import { ContiguityAPIError, ContiguityError } from "@/types/error";
+// year | month | version (monthly) 
+const LATEST_API_VERSION = "v2025.8.20";
+const BASE_URL = "http://localhost:8080";
+/**
+ * Contiguity API client with request functionality
+ */
+export class ContiguityClient {
+    token;
+    raw;
+    constructor(token, options = {}) {
+        if (!token || typeof token !== 'string') {
+            throw new Error('API token is required and must be a string');
+        }
+        if (token.trim().length === 0) {
+            throw new Error('API token cannot be empty');
+        }
+        this.token = token.trim();
+        this.raw = options.raw || false; // If true, return raw API responses
+    }
+    /**
+     * Make an authenticated request to the Contiguity API
+     */
+    async request(endpoint, options = {}) {
+        const url = `${BASE_URL}${endpoint}`;
+        const defaultHeaders = {
+            "Authorization": `Bearer ${this.token}`,
+            "Content-Type": "application/json",
+            "User-Agent": "@contiguity/javascript",
+            "X-Contiguity-API-Version": LATEST_API_VERSION,
+        };
+        const config = {
+            ...options,
+            headers: {
+                ...defaultHeaders,
+                ...options.headers,
+            },
+        };
+        try {
+            const response = await fetch(url, config);
+            const data = await response.json();
+            if (!response.ok) {
+                // Validate error response with Zod
+                const errorResult = ContiguityAPIError.safeParse(data);
+                if (errorResult.success) {
+                    throw new ContiguityError(errorResult.data);
+                }
+                else {
+                    // Fallback error handling
+                    throw new ContiguityError({
+                        data: {
+                            status: response.status,
+                            error: data?.error || `HTTP ${response.status}: ${response.statusText}`,
+                        }
+                    });
+                }
+            }
+            // Validate successful response with Zod using raw response schema
+            const result = ContiguityRawResponse.safeParse(data);
+            if (result.success) {
+                return result.data;
+            }
+            else {
+                throw new ContiguityError({
+                    data: {
+                        status: 500,
+                        error: "Invalid response format from API",
+                    }
+                });
+            }
+        }
+        catch (error) {
+            if (error instanceof ContiguityError) {
+                throw error;
+            }
+            // Network or other errors
+            throw ContiguityError.fromError(error);
+        }
+    }
+    /**
+     * Parse and normalize API responses to either raw or flattened format
+     * This method handles the complex logic of parsing different response formats
+     * from the Contiguity API and normalizing them consistently.
+     */
+    parse({ response, schemas: { sdk, raw } }) {
+        // Handle different response formats:
+        // 1. Already wrapped in response format (response.object === "response")
+        // 2. Direct data that needs wrapping
+        // 3. Fallback to raw parsing
+        const validatedResponse = response.object === "response"
+            ? raw.parse(response)
+            : sdk.safeParse(response).success
+                ? {
+                    id: response.id || "unknown",
+                    timestamp: response.timestamp || Date.now(),
+                    api_version: response.api_version || "unknown",
+                    object: response.object || "unknown",
+                    data: sdk.parse(response),
+                }
+                : raw.parse(response);
+        if (this.raw) {
+            return validatedResponse;
+        }
+        // For flattened responses, we need to handle both formats
+        const rawData = raw.parse(validatedResponse);
+        return {
+            ...rawData.data,
+            metadata: {
+                id: rawData.id,
+                timestamp: rawData.timestamp,
+                api_version: rawData.api_version,
+                object: rawData.object,
+            },
+        };
+    }
+}

package/dist/contiguity.d.ts

@@ -0,0 +1,81 @@
+import { TextService } from "@/services/text/index";
+import { EmailService } from "@/services/email/index";
+import { iMessageService } from "@/services/imessage/index";
+import { WhatsAppService } from "@/services/whatsapp/index";
+import { LeaseService } from "@/services/lease/index";
+import { OTPService } from "@/services/otp/index";
+import { DomainsService } from "@/services/domains/index";
+/**
+ * Main Contiguity API client class
+ *
+ * @example
+ * ```typescript
+ * import { Contiguity } from '@contiguity/javascript';
+ *
+ * const contiguity = new Contiguity('your-api-token');
+ *
+ * // Send a text message
+ * const response = await contiguity.text.send({
+ *   to: "+1234567890",
+ *   message: "Hello from Contiguity!"
+ * });
+ *
+ * // Send an iMessage
+ * const imessageResponse = await contiguity.imessage.send({
+ *   to: "+1234567890",
+ *   message: "Hello via iMessage!"
+ * });
+ *
+ * // Send a WhatsApp message
+ * const whatsappResponse = await contiguity.whatsapp.send({
+ *   to: "+1234567890",
+ *   message: "Hello via WhatsApp!"
+ * });
+ *
+ * // Lease a phone number
+ * const availableNumbers = await contiguity.lease.available();
+ * const leaseResponse = await contiguity.lease.create({
+ *   number: availableNumbers.numbers[0].id
+ * });
+ *
+ * // Send and verify OTP
+ * const otpResponse = await contiguity.otp.new({
+ *   to: "+1234567890",
+ *   language: "en",
+ *   name: "MyApp"
+ * });
+ * const verification = await contiguity.otp.verify({
+ *   otp_id: otpResponse.otp_id,
+ *   otp: "123456"
+ * });
+ *
+ * // Manage email domains
+ * const domainsList = await contiguity.domains.list();
+ * const registerResponse = await contiguity.domains.register({
+ *   domain: "example.com",
+ *   region: "us-east-1"
+ * });
+ * ```
+ */
+export declare class Contiguity {
+    private readonly token;
+    readonly text: TextService;
+    readonly email: EmailService;
+    readonly imessage: iMessageService;
+    readonly whatsapp: WhatsAppService;
+    readonly lease: LeaseService;
+    readonly otp: OTPService;
+    readonly domains: DomainsService;
+    /**
+     * Create a new Contiguity client instance
+     *
+     * @throws {ContiguitySDKError} When token is not provided or invalid
+     */
+    constructor(token: string);
+    /**
+     * Validate that the client is properly configured
+     * @returns True if the client is ready to use
+     */
+    ready(): boolean;
+}
+//# sourceMappingURL=contiguity.d.ts.map

package/dist/contiguity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contiguity.d.ts","sourceRoot":"","sources":["../src/contiguity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAG1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,qBAAa,UAAU;IACnB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,SAAgB,IAAI,EAAE,WAAW,CAAC;IAClC,SAAgB,KAAK,EAAE,YAAY,CAAC;IACpC,SAAgB,QAAQ,EAAE,eAAe,CAAC;IAC1C,SAAgB,QAAQ,EAAE,eAAe,CAAC;IAC1C,SAAgB,KAAK,EAAE,YAAY,CAAC;IACpC,SAAgB,GAAG,EAAE,UAAU,CAAC;IAChC,SAAgB,OAAO,EAAE,cAAc,CAAC;IAExC;;;;OAIG;gBACS,KAAK,EAAE,MAAM;IAyCzB;;;OAGG;IACH,KAAK,IAAI,OAAO;CAInB"}

package/dist/contiguity.js

@@ -0,0 +1,106 @@
+import { TextService } from "@/services/text/index";
+import { EmailService } from "@/services/email/index";
+import { iMessageService } from "@/services/imessage/index";
+import { WhatsAppService } from "@/services/whatsapp/index";
+import { LeaseService } from "@/services/lease/index";
+import { OTPService } from "@/services/otp/index";
+import { DomainsService } from "@/services/domains/index";
+import { ContiguitySDKError } from "@/types/error";
+/**
+ * Main Contiguity API client class
+ *
+ * @example
+ * ```typescript
+ * import { Contiguity } from '@contiguity/javascript';
+ *
+ * const contiguity = new Contiguity('your-api-token');
+ *
+ * // Send a text message
+ * const response = await contiguity.text.send({
+ *   to: "+1234567890",
+ *   message: "Hello from Contiguity!"
+ * });
+ *
+ * // Send an iMessage
+ * const imessageResponse = await contiguity.imessage.send({
+ *   to: "+1234567890",
+ *   message: "Hello via iMessage!"
+ * });
+ *
+ * // Send a WhatsApp message
+ * const whatsappResponse = await contiguity.whatsapp.send({
+ *   to: "+1234567890",
+ *   message: "Hello via WhatsApp!"
+ * });
+ *
+ * // Lease a phone number
+ * const availableNumbers = await contiguity.lease.available();
+ * const leaseResponse = await contiguity.lease.create({
+ *   number: availableNumbers.numbers[0].id
+ * });
+ *
+ * // Send and verify OTP
+ * const otpResponse = await contiguity.otp.new({
+ *   to: "+1234567890",
+ *   language: "en",
+ *   name: "MyApp"
+ * });
+ * const verification = await contiguity.otp.verify({
+ *   otp_id: otpResponse.otp_id,
+ *   otp: "123456"
+ * });
+ *
+ * // Manage email domains
+ * const domainsList = await contiguity.domains.list();
+ * const registerResponse = await contiguity.domains.register({
+ *   domain: "example.com",
+ *   region: "us-east-1"
+ * });
+ * ```
+ */
+export class Contiguity {
+    token;
+    text;
+    email;
+    imessage;
+    whatsapp;
+    lease;
+    otp;
+    domains;
+    /**
+     * Create a new Contiguity client instance
+     *
+     * @throws {ContiguitySDKError} When token is not provided or invalid
+     */
+    constructor(token) {
+        if (!token || typeof token !== 'string') {
+            throw new ContiguitySDKError('Contiguity API token is required and must be a string', 'invalid_token');
+        }
+        if (token.trim().length === 0) {
+            throw new ContiguitySDKError('Contiguity API token cannot be empty', 'empty_token');
+        }
+        if (!token.startsWith('contiguity_sk_')) {
+            throw new ContiguitySDKError('Contiguity tokens begin with "contiguity_sk_" – are you sure you entered the correct token?', 'invalid_token');
+        }
+        if (token.toUpperCase() === token && !token.startsWith('contiguity_sk_')) {
+            throw new ContiguitySDKError('Unfortunately, you cannot use API v1 keys with API v2. Please generate a new token at https://console.contiguity.com/dashboard/tokens', 'old_token');
+        }
+        this.token = token.trim();
+        // add new services here
+        this.text = new TextService(this.token);
+        this.email = new EmailService(this.token);
+        this.imessage = new iMessageService(this.token);
+        this.whatsapp = new WhatsAppService(this.token);
+        this.lease = new LeaseService(this.token);
+        this.otp = new OTPService(this.token);
+        this.domains = new DomainsService(this.token);
+    }
+    /**
+     * Validate that the client is properly configured
+     * @returns True if the client is ready to use
+     */
+    ready() {
+        const products = [this.text, this.email, this.imessage, this.whatsapp, this.lease, this.otp, this.domains];
+        return products.every(product => product !== undefined);
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,28 @@
+import { Contiguity } from "@/contiguity";
+export { Contiguity };
+export { ContiguityResponse, ContiguityRawResponse } from "@/types/response";
+export { ContiguityAPIError, ContiguityError, ContiguitySDKError } from "@/types/error";
+export type { ContiguityMetadata, WithMetadata } from "@/types/metadata";
+export { createResponse, BaseResponseBuilder, type BaseResponse, type FlattenedResponse, type RawResponse } from "@/types/base";
+export { E164PhoneNumber, MessageContent, OptionalSenderNumber, AttachmentList, SingleOrMultipleEmails, TypingAction, NumberStatus, LeaseStatus, BillingMethod, Currency, Carrier, MessageChannel, createFallbackSchema } from "@/types/common";
+export { TextSendRequest, TextResponse } from "@/services/text/send";
+export { EmailSendRequest, EmailResponse } from "@/services/email/send";
+export { iMessageSendRequest, iMessageResponse } from "@/services/imessage/send";
+export { iMessageTypingRequest, iMessageTypingResponse } from "@/services/imessage/typing";
+export { WhatsAppSendRequest, WhatsAppResponse } from "@/services/whatsapp/send";
+export { WhatsAppTypingRequest, WhatsAppTypingResponse } from "@/services/whatsapp/typing";
+export { LeaseAvailableResponse, AvailableNumber, NumberCapabilities, NumberHealth, NumberLocation, NumberFormat, NumberData, NumberPricing } from "@/services/lease/available";
+export { LeaseGetRequest, LeaseGetResponse } from "@/services/lease/get";
+export { LeaseCreateRequest, LeaseCreateResponse, LeaseBillingPrice, LeaseBillingPeriod, LeaseBilling } from "@/services/lease/create";
+export { LeaseLeasedResponse, LeasedNumber, LeasedBillingPeriod, LeasedBilling } from "@/services/lease/leased";
+export { LeaseDetailsRequest, LeaseDetailsResponse } from "@/services/lease/details";
+export { LeaseTerminateRequest, LeaseTerminateResponse } from "@/services/lease/terminate";
+export { OTPNewRequest, OTPNewResponse } from "@/services/otp/new";
+export { OTPVerifyRequest, OTPVerifyResponse } from "@/services/otp/verify";
+export { OTPResendRequest, OTPResendResponse } from "@/services/otp/resend";
+export { DomainsListResponse, DomainInfo } from "@/services/domains/list";
+export { DomainsGetRequest, DomainsGetResponse, DNSRecord, DomainVerifications } from "@/services/domains/get";
+export { DomainsRegisterRequest, DomainsRegisterResponse } from "@/services/domains/register";
+export { DomainsDeleteRequest, DomainsDeleteResponse } from "@/services/domains/delete";
+export default Contiguity;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAE,UAAU,EAAE,CAAC;AAEtB,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAC7E,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACxF,YAAY,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACzE,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,KAAK,YAAY,EAAE,KAAK,iBAAiB,EAAE,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAChI,OAAO,EACH,eAAe,EACf,cAAc,EACd,oBAAoB,EACpB,cAAc,EACd,sBAAsB,EACtB,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,aAAa,EACb,QAAQ,EACR,OAAO,EACP,cAAc,EACd,oBAAoB,EACvB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACH,eAAe,EACf,YAAY,EACf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACH,gBAAgB,EAChB,aAAa,EAChB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACH,mBAAmB,EACnB,gBAAgB,EACnB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACH,qBAAqB,EACrB,sBAAsB,EACzB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACH,mBAAmB,EACnB,gBAAgB,EACnB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACH,qBAAqB,EACrB,sBAAsB,EACzB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACH,sBAAsB,EACtB,eAAe,EACf,kBAAkB,EAClB,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,UAAU,EACV,aAAa,EAChB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACH,eAAe,EACf,gBAAgB,EACnB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACH,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,EAClB,YAAY,EACf,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACH,mBAAmB,EACnB,YAAY,EACZ,mBAAmB,EACnB,aAAa,EAChB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACH,mBAAmB,EACnB,oBAAoB,EACvB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACH,qBAAqB,EACrB,sBAAsB,EACzB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACH,aAAa,EACb,cAAc,EACjB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACH,gBAAgB,EAChB,iBAAiB,EACpB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACH,gBAAgB,EAChB,iBAAiB,EACpB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACH,mBAAmB,EACnB,UAAU,EACb,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACH,iBAAiB,EACjB,kBAAkB,EAClB,SAAS,EACT,mBAAmB,EACtB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACH,sBAAsB,EACtB,uBAAuB,EAC1B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACH,oBAAoB,EACpB,qBAAqB,EACxB,MAAM,2BAA2B,CAAC;AAEnC,eAAe,UAAU,CAAC"}