@fluxbase/sdk 0.0.1-rc.2 → 0.0.1-rc.6

package/dist/index.cjs

@@ -1213,11 +1213,429 @@ var AppSettingsManager = class {
       security: { enable_global_rate_limit: enabled }
     });
   }
+  /**
+   * Configure SMTP email provider
+   *
+   * Convenience method to set up SMTP email delivery.
+   *
+   * @param config - SMTP configuration
+   * @returns Promise resolving to AppSettings
+   *
+   * @example
+   * ```typescript
+   * await client.admin.settings.app.configureSMTP({
+   *   host: 'smtp.gmail.com',
+   *   port: 587,
+   *   username: 'your-email@gmail.com',
+   *   password: 'your-app-password',
+   *   use_tls: true,
+   *   from_address: 'noreply@yourapp.com',
+   *   from_name: 'Your App'
+   * })
+   * ```
+   */
+  async configureSMTP(config) {
+    return await this.update({
+      email: {
+        enabled: true,
+        provider: "smtp",
+        from_address: config.from_address,
+        from_name: config.from_name,
+        reply_to_address: config.reply_to_address,
+        smtp: {
+          host: config.host,
+          port: config.port,
+          username: config.username,
+          password: config.password,
+          use_tls: config.use_tls
+        }
+      }
+    });
+  }
+  /**
+   * Configure SendGrid email provider
+   *
+   * Convenience method to set up SendGrid email delivery.
+   *
+   * @param apiKey - SendGrid API key
+   * @param options - Optional from address, name, and reply-to
+   * @returns Promise resolving to AppSettings
+   *
+   * @example
+   * ```typescript
+   * await client.admin.settings.app.configureSendGrid('SG.xxx', {
+   *   from_address: 'noreply@yourapp.com',
+   *   from_name: 'Your App'
+   * })
+   * ```
+   */
+  async configureSendGrid(apiKey, options) {
+    return await this.update({
+      email: {
+        enabled: true,
+        provider: "sendgrid",
+        from_address: options?.from_address,
+        from_name: options?.from_name,
+        reply_to_address: options?.reply_to_address,
+        sendgrid: {
+          api_key: apiKey
+        }
+      }
+    });
+  }
+  /**
+   * Configure Mailgun email provider
+   *
+   * Convenience method to set up Mailgun email delivery.
+   *
+   * @param apiKey - Mailgun API key
+   * @param domain - Mailgun domain
+   * @param options - Optional EU region flag and email addresses
+   * @returns Promise resolving to AppSettings
+   *
+   * @example
+   * ```typescript
+   * await client.admin.settings.app.configureMailgun('key-xxx', 'mg.yourapp.com', {
+   *   eu_region: false,
+   *   from_address: 'noreply@yourapp.com',
+   *   from_name: 'Your App'
+   * })
+   * ```
+   */
+  async configureMailgun(apiKey, domain, options) {
+    return await this.update({
+      email: {
+        enabled: true,
+        provider: "mailgun",
+        from_address: options?.from_address,
+        from_name: options?.from_name,
+        reply_to_address: options?.reply_to_address,
+        mailgun: {
+          api_key: apiKey,
+          domain,
+          eu_region: options?.eu_region ?? false
+        }
+      }
+    });
+  }
+  /**
+   * Configure AWS SES email provider
+   *
+   * Convenience method to set up AWS SES email delivery.
+   *
+   * @param accessKeyId - AWS access key ID
+   * @param secretAccessKey - AWS secret access key
+   * @param region - AWS region (e.g., 'us-east-1')
+   * @param options - Optional email addresses
+   * @returns Promise resolving to AppSettings
+   *
+   * @example
+   * ```typescript
+   * await client.admin.settings.app.configureSES(
+   *   'AKIAIOSFODNN7EXAMPLE',
+   *   'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',
+   *   'us-east-1',
+   *   {
+   *     from_address: 'noreply@yourapp.com',
+   *     from_name: 'Your App'
+   *   }
+   * )
+   * ```
+   */
+  async configureSES(accessKeyId, secretAccessKey, region, options) {
+    return await this.update({
+      email: {
+        enabled: true,
+        provider: "ses",
+        from_address: options?.from_address,
+        from_name: options?.from_name,
+        reply_to_address: options?.reply_to_address,
+        ses: {
+          access_key_id: accessKeyId,
+          secret_access_key: secretAccessKey,
+          region
+        }
+      }
+    });
+  }
+  /**
+   * Enable or disable email functionality
+   *
+   * Convenience method to toggle email system on/off.
+   *
+   * @param enabled - Whether to enable email
+   * @returns Promise resolving to AppSettings
+   *
+   * @example
+   * ```typescript
+   * await client.admin.settings.app.setEmailEnabled(true)
+   * ```
+   */
+  async setEmailEnabled(enabled) {
+    return await this.update({
+      email: { enabled }
+    });
+  }
+  /**
+   * Configure password complexity requirements
+   *
+   * Convenience method to set password validation rules.
+   *
+   * @param requirements - Password complexity requirements
+   * @returns Promise resolving to AppSettings
+   *
+   * @example
+   * ```typescript
+   * await client.admin.settings.app.setPasswordComplexity({
+   *   min_length: 12,
+   *   require_uppercase: true,
+   *   require_lowercase: true,
+   *   require_number: true,
+   *   require_special: true
+   * })
+   * ```
+   */
+  async setPasswordComplexity(requirements) {
+    return await this.update({
+      authentication: {
+        password_min_length: requirements.min_length,
+        password_require_uppercase: requirements.require_uppercase,
+        password_require_lowercase: requirements.require_lowercase,
+        password_require_number: requirements.require_number,
+        password_require_special: requirements.require_special
+      }
+    });
+  }
+  /**
+   * Configure session settings
+   *
+   * Convenience method to set session timeout and limits.
+   *
+   * @param timeoutMinutes - Session timeout in minutes (0 for no timeout)
+   * @param maxSessionsPerUser - Maximum concurrent sessions per user (0 for unlimited)
+   * @returns Promise resolving to AppSettings
+   *
+   * @example
+   * ```typescript
+   * // 30 minute sessions, max 3 devices per user
+   * await client.admin.settings.app.setSessionSettings(30, 3)
+   * ```
+   */
+  async setSessionSettings(timeoutMinutes, maxSessionsPerUser) {
+    return await this.update({
+      authentication: {
+        session_timeout_minutes: timeoutMinutes,
+        max_sessions_per_user: maxSessionsPerUser
+      }
+    });
+  }
+  /**
+   * Enable or disable email verification requirement
+   *
+   * Convenience method to require email verification for new signups.
+   *
+   * @param required - Whether to require email verification
+   * @returns Promise resolving to AppSettings
+   *
+   * @example
+   * ```typescript
+   * await client.admin.settings.app.setEmailVerificationRequired(true)
+   * ```
+   */
+  async setEmailVerificationRequired(required) {
+    return await this.update({
+      authentication: { require_email_verification: required }
+    });
+  }
+};
+var CustomSettingsManager = class {
+  constructor(fetch2) {
+    this.fetch = fetch2;
+  }
+  /**
+   * Create a new custom setting
+   *
+   * @param request - Custom setting creation request
+   * @returns Promise resolving to CustomSetting
+   *
+   * @example
+   * ```typescript
+   * const setting = await client.admin.settings.custom.create({
+   *   key: 'api.quotas',
+   *   value: { free: 1000, pro: 10000, enterprise: 100000 },
+   *   value_type: 'json',
+   *   description: 'API request quotas by tier',
+   *   metadata: { category: 'billing' }
+   * })
+   * ```
+   */
+  async create(request) {
+    return await this.fetch.post("/api/v1/admin/settings/custom", request);
+  }
+  /**
+   * List all custom settings
+   *
+   * @returns Promise resolving to ListCustomSettingsResponse
+   *
+   * @example
+   * ```typescript
+   * const response = await client.admin.settings.custom.list()
+   * console.log(response.settings)
+   * ```
+   */
+  async list() {
+    const settings = await this.fetch.get("/api/v1/admin/settings/custom");
+    return { settings: Array.isArray(settings) ? settings : [] };
+  }
+  /**
+   * Get a specific custom setting by key
+   *
+   * @param key - Setting key (e.g., 'feature.dark_mode')
+   * @returns Promise resolving to CustomSetting
+   *
+   * @example
+   * ```typescript
+   * const setting = await client.admin.settings.custom.get('feature.dark_mode')
+   * console.log(setting.value)
+   * ```
+   */
+  async get(key) {
+    return await this.fetch.get(`/api/v1/admin/settings/custom/${key}`);
+  }
+  /**
+   * Update an existing custom setting
+   *
+   * @param key - Setting key
+   * @param request - Update request with new values
+   * @returns Promise resolving to CustomSetting
+   *
+   * @example
+   * ```typescript
+   * const updated = await client.admin.settings.custom.update('feature.dark_mode', {
+   *   value: { enabled: false },
+   *   description: 'Updated description'
+   * })
+   * ```
+   */
+  async update(key, request) {
+    return await this.fetch.put(`/api/v1/admin/settings/custom/${key}`, request);
+  }
+  /**
+   * Delete a custom setting
+   *
+   * @param key - Setting key to delete
+   * @returns Promise<void>
+   *
+   * @example
+   * ```typescript
+   * await client.admin.settings.custom.delete('feature.dark_mode')
+   * ```
+   */
+  async delete(key) {
+    await this.fetch.delete(`/api/v1/admin/settings/custom/${key}`);
+  }
+};
+var EmailTemplateManager = class {
+  constructor(fetch2) {
+    this.fetch = fetch2;
+  }
+  /**
+   * List all email templates
+   *
+   * @returns Promise resolving to ListEmailTemplatesResponse
+   *
+   * @example
+   * ```typescript
+   * const response = await client.admin.emailTemplates.list()
+   * console.log(response.templates)
+   * ```
+   */
+  async list() {
+    const templates = await this.fetch.get("/api/v1/admin/email/templates");
+    return { templates: Array.isArray(templates) ? templates : [] };
+  }
+  /**
+   * Get a specific email template by type
+   *
+   * @param type - Template type (magic_link | verify_email | reset_password | invite_user)
+   * @returns Promise resolving to EmailTemplate
+   *
+   * @example
+   * ```typescript
+   * const template = await client.admin.emailTemplates.get('magic_link')
+   * console.log(template.subject)
+   * console.log(template.html_body)
+   * ```
+   */
+  async get(type) {
+    return await this.fetch.get(`/api/v1/admin/email/templates/${type}`);
+  }
+  /**
+   * Update an email template
+   *
+   * Available template variables:
+   * - magic_link: {{.MagicLink}}, {{.AppName}}, {{.ExpiryMinutes}}
+   * - verify_email: {{.VerificationLink}}, {{.AppName}}
+   * - reset_password: {{.ResetLink}}, {{.AppName}}, {{.ExpiryMinutes}}
+   * - invite_user: {{.InviteLink}}, {{.AppName}}, {{.InviterName}}
+   *
+   * @param type - Template type to update
+   * @param request - Update request with subject, html_body, and optional text_body
+   * @returns Promise resolving to EmailTemplate
+   *
+   * @example
+   * ```typescript
+   * const updated = await client.admin.emailTemplates.update('magic_link', {
+   *   subject: 'Your Magic Link - Sign in to {{.AppName}}',
+   *   html_body: '<html><body><h1>Welcome!</h1><a href="{{.MagicLink}}">Sign In</a></body></html>',
+   *   text_body: 'Click here to sign in: {{.MagicLink}}'
+   * })
+   * ```
+   */
+  async update(type, request) {
+    return await this.fetch.put(`/api/v1/admin/email/templates/${type}`, request);
+  }
+  /**
+   * Reset an email template to default
+   *
+   * Removes any customizations and restores the template to its original state.
+   *
+   * @param type - Template type to reset
+   * @returns Promise resolving to EmailTemplate - The default template
+   *
+   * @example
+   * ```typescript
+   * const defaultTemplate = await client.admin.emailTemplates.reset('magic_link')
+   * ```
+   */
+  async reset(type) {
+    return await this.fetch.post(`/api/v1/admin/email/templates/${type}/reset`, {});
+  }
+  /**
+   * Send a test email using the template
+   *
+   * Useful for previewing template changes before deploying to production.
+   *
+   * @param type - Template type to test
+   * @param recipientEmail - Email address to send test to
+   * @returns Promise<void>
+   *
+   * @example
+   * ```typescript
+   * await client.admin.emailTemplates.test('magic_link', 'test@example.com')
+   * ```
+   */
+  async test(type, recipientEmail) {
+    await this.fetch.post(`/api/v1/admin/email/templates/${type}/test`, {
+      recipient_email: recipientEmail
+    });
+  }
 };
 var FluxbaseSettings = class {
   constructor(fetch2) {
     this.system = new SystemSettingsManager(fetch2);
     this.app = new AppSettingsManager(fetch2);
+    this.custom = new CustomSettingsManager(fetch2);
   }
 };
 
@@ -2240,6 +2658,7 @@ var FluxbaseAdmin = class {
     this.oauth = new FluxbaseOAuth(fetch2);
     this.impersonation = new ImpersonationManager(fetch2);
     this.management = new FluxbaseManagement(fetch2);
+    this.emailTemplates = new EmailTemplateManager(fetch2);
   }
   /**
    * Set admin authentication token
@@ -3238,6 +3657,7 @@ exports.APIKeysManager = APIKeysManager;
 exports.AppSettingsManager = AppSettingsManager;
 exports.AuthSettingsManager = AuthSettingsManager;
 exports.DDLManager = DDLManager;
+exports.EmailTemplateManager = EmailTemplateManager;
 exports.FluxbaseAdmin = FluxbaseAdmin;
 exports.FluxbaseAuth = FluxbaseAuth;
 exports.FluxbaseClient = FluxbaseClient;