spaps-sdk 1.3.0 → 1.4.0

package/dist/index.d.mts

@@ -132,6 +132,46 @@ interface CreateCheckoutSessionPayload {
     require_legal_consent?: boolean;
     legal_consent_text?: string;
 }
+interface EmailSendOptions {
+    templateKey: string;
+    to: string;
+    context: Record<string, string | number | boolean>;
+    userId?: string;
+}
+interface EmailSendResult {
+    success: boolean;
+    messageId?: string;
+    error?: string;
+}
+interface TemplateVariable {
+    name: string;
+    required?: boolean;
+    description?: string;
+}
+interface EmailTemplate {
+    id: string;
+    applicationId?: string;
+    templateKey: string;
+    name: string;
+    description?: string;
+    subject: string;
+    htmlBody?: string;
+    textBody?: string;
+    fromEmail?: string;
+    fromName?: string;
+    replyTo?: string;
+    variables?: TemplateVariable[];
+    sampleContext?: Record<string, unknown>;
+    category?: string;
+    isActive?: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+}
+interface EmailTemplatePreview {
+    subject: string;
+    html: string;
+    text?: string;
+}
 
 declare class SPAPSClient<SecureMessageMetadata extends Record<string, any> = Record<string, any>> {
     private client;
@@ -180,6 +220,12 @@ declare class SPAPSClient<SecureMessageMetadata extends Record<string, any> = Re
         create: (payload: CreateSecureMessageRequest<SecureMessageMetadata>) => Promise<SecureMessage<SecureMessageMetadata>>;
         list: () => Promise<SecureMessage<SecureMessageMetadata>[]>;
     };
+    email: {
+        send: (options: EmailSendOptions) => Promise<EmailSendResult>;
+        listTemplates: () => Promise<EmailTemplate[]>;
+        getTemplate: (templateKey: string) => Promise<EmailTemplate>;
+        previewTemplate: (templateKey: string, context?: Record<string, unknown>) => Promise<EmailTemplatePreview>;
+    };
     constructor(config?: SPAPSConfig);
     /** Raw API request helper that returns an ApiResponse-like shape */
     request<T = any>(method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH', url: string, data?: any, requiresAuth?: boolean): Promise<{
@@ -480,6 +526,22 @@ declare class SPAPSClient<SecureMessageMetadata extends Record<string, any> = Re
     recordUsage(feature: string, amount: number): Promise<void>;
     private createSecureMessage;
     private listSecureMessages;
+    /**
+     * Send an email using a template
+     */
+    private sendEmail;
+    /**
+     * List all email templates for the application
+     */
+    private listEmailTemplates;
+    /**
+     * Get a single email template by key
+     */
+    private getEmailTemplate;
+    /**
+     * Preview a rendered email template
+     */
+    private previewEmailTemplate;
     /**
      * Create a new Stripe product (Admin required)
      */
@@ -619,4 +681,4 @@ declare function createServerClient(secretKey: string, options?: Omit<SPAPSConfi
  */
 declare function detectKeyType(key: string): ApiKeyType | null;
 
-export { type AdminConfig, type ApiKeyType, type CheckoutLineItem, type CheckoutLineItemPriceData, type CreateCheckoutSessionPayload, DEFAULT_ADMIN_ACCOUNTS, type PermissionCheckResult, PermissionChecker, SPAPSClient as SPAPS, SPAPSClient, type SPAPSConfig, TokenManager, WalletUtils, canAccessAdmin, createBrowserClient, createPermissionChecker, createServerClient, SPAPSClient as default, defaultPermissionChecker, detectKeyType, getRoleAwareErrorMessage, getUserDisplay, getUserRole, hasPermission, isAdminAccount, verifyCryptoWebhookSignature };
+export { type AdminConfig, type ApiKeyType, type CheckoutLineItem, type CheckoutLineItemPriceData, type CreateCheckoutSessionPayload, DEFAULT_ADMIN_ACCOUNTS, type EmailSendOptions, type EmailSendResult, type EmailTemplate, type EmailTemplatePreview, type PermissionCheckResult, PermissionChecker, SPAPSClient as SPAPS, SPAPSClient, type SPAPSConfig, type TemplateVariable, TokenManager, WalletUtils, canAccessAdmin, createBrowserClient, createPermissionChecker, createServerClient, SPAPSClient as default, defaultPermissionChecker, detectKeyType, getRoleAwareErrorMessage, getUserDisplay, getUserRole, hasPermission, isAdminAccount, verifyCryptoWebhookSignature };

package/dist/index.d.ts

@@ -132,6 +132,46 @@ interface CreateCheckoutSessionPayload {
     require_legal_consent?: boolean;
     legal_consent_text?: string;
 }
+interface EmailSendOptions {
+    templateKey: string;
+    to: string;
+    context: Record<string, string | number | boolean>;
+    userId?: string;
+}
+interface EmailSendResult {
+    success: boolean;
+    messageId?: string;
+    error?: string;
+}
+interface TemplateVariable {
+    name: string;
+    required?: boolean;
+    description?: string;
+}
+interface EmailTemplate {
+    id: string;
+    applicationId?: string;
+    templateKey: string;
+    name: string;
+    description?: string;
+    subject: string;
+    htmlBody?: string;
+    textBody?: string;
+    fromEmail?: string;
+    fromName?: string;
+    replyTo?: string;
+    variables?: TemplateVariable[];
+    sampleContext?: Record<string, unknown>;
+    category?: string;
+    isActive?: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+}
+interface EmailTemplatePreview {
+    subject: string;
+    html: string;
+    text?: string;
+}
 
 declare class SPAPSClient<SecureMessageMetadata extends Record<string, any> = Record<string, any>> {
     private client;
@@ -180,6 +220,12 @@ declare class SPAPSClient<SecureMessageMetadata extends Record<string, any> = Re
         create: (payload: CreateSecureMessageRequest<SecureMessageMetadata>) => Promise<SecureMessage<SecureMessageMetadata>>;
         list: () => Promise<SecureMessage<SecureMessageMetadata>[]>;
     };
+    email: {
+        send: (options: EmailSendOptions) => Promise<EmailSendResult>;
+        listTemplates: () => Promise<EmailTemplate[]>;
+        getTemplate: (templateKey: string) => Promise<EmailTemplate>;
+        previewTemplate: (templateKey: string, context?: Record<string, unknown>) => Promise<EmailTemplatePreview>;
+    };
     constructor(config?: SPAPSConfig);
     /** Raw API request helper that returns an ApiResponse-like shape */
     request<T = any>(method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH', url: string, data?: any, requiresAuth?: boolean): Promise<{
@@ -480,6 +526,22 @@ declare class SPAPSClient<SecureMessageMetadata extends Record<string, any> = Re
     recordUsage(feature: string, amount: number): Promise<void>;
     private createSecureMessage;
     private listSecureMessages;
+    /**
+     * Send an email using a template
+     */
+    private sendEmail;
+    /**
+     * List all email templates for the application
+     */
+    private listEmailTemplates;
+    /**
+     * Get a single email template by key
+     */
+    private getEmailTemplate;
+    /**
+     * Preview a rendered email template
+     */
+    private previewEmailTemplate;
     /**
      * Create a new Stripe product (Admin required)
      */
@@ -619,4 +681,4 @@ declare function createServerClient(secretKey: string, options?: Omit<SPAPSConfi
  */
 declare function detectKeyType(key: string): ApiKeyType | null;
 
-export { type AdminConfig, type ApiKeyType, type CheckoutLineItem, type CheckoutLineItemPriceData, type CreateCheckoutSessionPayload, DEFAULT_ADMIN_ACCOUNTS, type PermissionCheckResult, PermissionChecker, SPAPSClient as SPAPS, SPAPSClient, type SPAPSConfig, TokenManager, WalletUtils, canAccessAdmin, createBrowserClient, createPermissionChecker, createServerClient, SPAPSClient as default, defaultPermissionChecker, detectKeyType, getRoleAwareErrorMessage, getUserDisplay, getUserRole, hasPermission, isAdminAccount, verifyCryptoWebhookSignature };
+export { type AdminConfig, type ApiKeyType, type CheckoutLineItem, type CheckoutLineItemPriceData, type CreateCheckoutSessionPayload, DEFAULT_ADMIN_ACCOUNTS, type EmailSendOptions, type EmailSendResult, type EmailTemplate, type EmailTemplatePreview, type PermissionCheckResult, PermissionChecker, SPAPSClient as SPAPS, SPAPSClient, type SPAPSConfig, type TemplateVariable, TokenManager, WalletUtils, canAccessAdmin, createBrowserClient, createPermissionChecker, createServerClient, SPAPSClient as default, defaultPermissionChecker, detectKeyType, getRoleAwareErrorMessage, getUserDisplay, getUserRole, hasPermission, isAdminAccount, verifyCryptoWebhookSignature };

package/dist/index.js

@@ -280,6 +280,12 @@ var SPAPSClient = class {
     create: (payload) => this.createSecureMessage(payload),
     list: () => this.listSecureMessages()
   };
+  email = {
+    send: (options) => this.sendEmail(options),
+    listTemplates: () => this.listEmailTemplates(),
+    getTemplate: (templateKey) => this.getEmailTemplate(templateKey),
+    previewTemplate: (templateKey, context) => this.previewEmailTemplate(templateKey, context)
+  };
   constructor(config = {}) {
     const apiUrl = config.apiUrl || process.env.SPAPS_API_URL || process.env.NEXT_PUBLIC_SPAPS_API_URL;
     const isBrowser = typeof window !== "undefined";
@@ -904,6 +910,55 @@ var SPAPSClient = class {
     }
     return payload;
   }
+  // Email Methods
+  /**
+   * Send an email using a template
+   */
+  async sendEmail(options) {
+    const response = await this.client.post("/api/email/send", {
+      template_key: options.templateKey,
+      to: options.to,
+      context: options.context,
+      ...options.userId && { user_id: options.userId }
+    });
+    return this.unwrapApiResponse(response, "Failed to send email");
+  }
+  /**
+   * List all email templates for the application
+   */
+  async listEmailTemplates() {
+    const response = await this.client.get("/api/email/templates");
+    const payload = this.unwrapApiResponse(
+      response,
+      "Failed to list email templates"
+    );
+    if (payload && Array.isArray(payload.templates)) {
+      return payload.templates;
+    }
+    return payload;
+  }
+  /**
+   * Get a single email template by key
+   */
+  async getEmailTemplate(templateKey) {
+    const response = await this.client.get(`/api/email/templates/${templateKey}`);
+    return this.unwrapApiResponse(response, "Failed to get email template");
+  }
+  /**
+   * Preview a rendered email template
+   */
+  async previewEmailTemplate(templateKey, context) {
+    if (context) {
+      const response = await this.client.post(
+        `/api/email/templates/${templateKey}/preview`,
+        { context }
+      );
+      return this.unwrapApiResponse(response, "Failed to preview email template");
+    } else {
+      const response = await this.client.get(`/api/email/templates/${templateKey}/preview`);
+      return this.unwrapApiResponse(response, "Failed to preview email template");
+    }
+  }
   // Admin Methods (Require admin privileges)
   /**
    * Create a new Stripe product (Admin required)

package/dist/index.mjs

@@ -253,6 +253,12 @@ var SPAPSClient = class {
     create: (payload) => this.createSecureMessage(payload),
     list: () => this.listSecureMessages()
   };
+  email = {
+    send: (options) => this.sendEmail(options),
+    listTemplates: () => this.listEmailTemplates(),
+    getTemplate: (templateKey) => this.getEmailTemplate(templateKey),
+    previewTemplate: (templateKey, context) => this.previewEmailTemplate(templateKey, context)
+  };
   constructor(config = {}) {
     const apiUrl = config.apiUrl || process.env.SPAPS_API_URL || process.env.NEXT_PUBLIC_SPAPS_API_URL;
     const isBrowser = typeof window !== "undefined";
@@ -877,6 +883,55 @@ var SPAPSClient = class {
     }
     return payload;
   }
+  // Email Methods
+  /**
+   * Send an email using a template
+   */
+  async sendEmail(options) {
+    const response = await this.client.post("/api/email/send", {
+      template_key: options.templateKey,
+      to: options.to,
+      context: options.context,
+      ...options.userId && { user_id: options.userId }
+    });
+    return this.unwrapApiResponse(response, "Failed to send email");
+  }
+  /**
+   * List all email templates for the application
+   */
+  async listEmailTemplates() {
+    const response = await this.client.get("/api/email/templates");
+    const payload = this.unwrapApiResponse(
+      response,
+      "Failed to list email templates"
+    );
+    if (payload && Array.isArray(payload.templates)) {
+      return payload.templates;
+    }
+    return payload;
+  }
+  /**
+   * Get a single email template by key
+   */
+  async getEmailTemplate(templateKey) {
+    const response = await this.client.get(`/api/email/templates/${templateKey}`);
+    return this.unwrapApiResponse(response, "Failed to get email template");
+  }
+  /**
+   * Preview a rendered email template
+   */
+  async previewEmailTemplate(templateKey, context) {
+    if (context) {
+      const response = await this.client.post(
+        `/api/email/templates/${templateKey}/preview`,
+        { context }
+      );
+      return this.unwrapApiResponse(response, "Failed to preview email template");
+    } else {
+      const response = await this.client.get(`/api/email/templates/${templateKey}/preview`);
+      return this.unwrapApiResponse(response, "Failed to preview email template");
+    }
+  }
   // Admin Methods (Require admin privileges)
   /**
    * Create a new Stripe product (Admin required)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spaps-sdk",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Sweet Potato Authentication & Payment Service SDK - Zero-config client with built-in permission checking, role-based access control, and dayrate scheduling",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -46,7 +46,7 @@
     "email": "buildooor@gmail.com"
   },
   "dependencies": {
-    "spaps-types": "^1.0.59",
+    "spaps-types": "^1.0.60",
     "axios": "^1.6.0",
     "cross-fetch": "^4.0.0"
   },
@@ -74,4 +74,4 @@
   "engines": {
     "node": ">=14.0.0"
   }
-}
+}