krisspy-sdk 1.0.0 → 1.2.0

package/dist/index.d.mts

@@ -87,6 +87,27 @@ interface OAuthProvider {
     provider: 'google' | 'github' | 'microsoft';
     redirectTo?: string;
 }
+interface SignInWithOtpCredentials {
+    email: string;
+    options?: {
+        /** If false, don't create a user when one doesn't exist yet. (Advisory; default true.) */
+        shouldCreateUser?: boolean;
+        /** Where to redirect after the magic link is followed. */
+        emailRedirectTo?: string;
+        /** Delivery channel: 'magiclink' (default) emails a link, 'otp' emails a 6-digit code. */
+        channel?: 'magiclink' | 'otp';
+    };
+}
+interface VerifyOtpParams {
+    email: string;
+    token: string;
+    /** 'magiclink' verifies a magic-link token, 'otp' verifies a 6-digit code, 'email' confirms verification. */
+    type?: 'magiclink' | 'otp' | 'email';
+}
+interface ResendParams {
+    type: 'signup' | 'email_change';
+    email: string;
+}
 interface QueryResponse<T = any> {
     data: T[] | null;
     error: KrisspyError | null;
@@ -339,11 +360,36 @@ declare class KrisspyAuth {
         error: KrisspyError | null;
     }>;
     /**
-     * Request password reset
+     * Request password reset email
      */
     resetPasswordForEmail(email: string): Promise<{
         error: KrisspyError | null;
     }>;
+    /**
+     * Complete a password reset using the token from the reset email.
+     */
+    updatePasswordWithToken(params: {
+        token: string;
+        password: string;
+    }): Promise<{
+        error: KrisspyError | null;
+    }>;
+    /**
+     * Passwordless sign-in: emails a magic link (default) or a one-time code.
+     * No session is returned here — call verifyOtp() with the link token / code.
+     */
+    signInWithOtp(credentials: SignInWithOtpCredentials): Promise<AuthResponse>;
+    /**
+     * Verify a magic-link token or a one-time code and establish a session.
+     */
+    verifyOtp(params: VerifyOtpParams): Promise<AuthResponse>;
+    /**
+     * Resend a verification email.
+     */
+    resend(params: ResendParams): Promise<{
+        data: Record<string, never>;
+        error: KrisspyError | null;
+    }>;
     /**
      * Listen for auth state changes
      */
@@ -1046,6 +1092,47 @@ declare class KrisspyNotifications {
     }>;
 }
 
+/**
+ * Email Module — send custom templated emails to your app's end users.
+ *
+ * Templates are created/managed in the Krisspy dashboard (per backend). From the
+ * SDK you reference a template by slug and pass variables to interpolate.
+ *
+ * @example
+ * await krisspy.email.send({
+ *   template: 'welcome',
+ *   to: 'user@example.com',
+ *   variables: { name: 'Sam', plan: 'Pro' },
+ * })
+ */
+
+interface SendEmailParams {
+    /** Slug of a template configured in the dashboard. */
+    template: string;
+    to: string;
+    variables?: Record<string, any>;
+    /** Optional sender override (honored on BYO providers; the Krisspy default keeps its locked address). */
+    from?: {
+        email: string;
+        name?: string;
+    };
+}
+interface SendEmailResponse {
+    data: {
+        source: string;
+    } | null;
+    error: KrisspyError | null;
+}
+declare class KrisspyEmail {
+    private http;
+    private backendId;
+    constructor(http: HttpClient, backendId: string);
+    /**
+     * Render a dashboard template with the given variables and send it.
+     */
+    send(params: SendEmailParams): Promise<SendEmailResponse>;
+}
+
 /**
  * Query Builder - Supabase-style fluent API for database queries
  */
@@ -1230,6 +1317,7 @@ declare class KrisspyClient {
     private _realtime;
     private _analytics;
     private _notifications;
+    private _email;
     private dataMode;
     private debug;
     constructor(options: KrisspyClientOptions);
@@ -1289,6 +1377,17 @@ declare class KrisspyClient {
      * const { error } = await krisspy.storage.from('uploads').remove(['old.jpg'])
      */
     get storage(): KrisspyStorage;
+    /**
+     * Email module — send custom templated emails to your end users.
+     *
+     * @example
+     * await krisspy.email.send({
+     *   template: 'welcome',
+     *   to: 'user@example.com',
+     *   variables: { name: 'Sam' },
+     * })
+     */
+    get email(): KrisspyEmail;
     /**
      * Analytics module for event tracking
      *
@@ -1519,4 +1618,4 @@ declare class KrisspyClient {
  */
 declare function createClient(options: KrisspyClientOptions): KrisspyClient;
 
-export { type AnalyticsEvent, type AnalyticsInitOptions, type AuthChangeEvent, type AuthResponse, type ChannelState, type FileObject, type FileUploadOptions, type Filter, type FilterOperator, type FunctionInvokeOptions, type FunctionResponse, HttpClient, KrisspyAnalytics, KrisspyAuth, KrisspyClient, type KrisspyClientOptions, type KrisspyError, KrisspyNotifications, KrisspyRealtime, KrisspyStorage, type MutationResponse, type NotificationTicket, type OAuthProvider, type OrderBy, type PostgresChangesConfig, type PushToken, QueryBuilder, type QueryOptions, type QueryResponse, RealtimeChannel, type RealtimeEvent, type RealtimePayload, type SendNotificationParams, type Session, type SignInCredentials, type SignUpCredentials, type SingleResponse, type StorageAdapter, StorageBucket, type UploadAndLinkOptions, type UploadAndLinkResponse, type User, createClient, isBrowser, isReactNative };
+export { type AnalyticsEvent, type AnalyticsInitOptions, type AuthChangeEvent, type AuthResponse, type ChannelState, type FileObject, type FileUploadOptions, type Filter, type FilterOperator, type FunctionInvokeOptions, type FunctionResponse, HttpClient, KrisspyAnalytics, KrisspyAuth, KrisspyClient, type KrisspyClientOptions, KrisspyEmail, type KrisspyError, KrisspyNotifications, KrisspyRealtime, KrisspyStorage, type MutationResponse, type NotificationTicket, type OAuthProvider, type OrderBy, type PostgresChangesConfig, type PushToken, QueryBuilder, type QueryOptions, type QueryResponse, RealtimeChannel, type RealtimeEvent, type RealtimePayload, type ResendParams, type SendEmailParams, type SendEmailResponse, type SendNotificationParams, type Session, type SignInCredentials, type SignInWithOtpCredentials, type SignUpCredentials, type SingleResponse, type StorageAdapter, StorageBucket, type UploadAndLinkOptions, type UploadAndLinkResponse, type User, type VerifyOtpParams, createClient, isBrowser, isReactNative };

package/dist/index.d.ts

@@ -87,6 +87,27 @@ interface OAuthProvider {
     provider: 'google' | 'github' | 'microsoft';
     redirectTo?: string;
 }
+interface SignInWithOtpCredentials {
+    email: string;
+    options?: {
+        /** If false, don't create a user when one doesn't exist yet. (Advisory; default true.) */
+        shouldCreateUser?: boolean;
+        /** Where to redirect after the magic link is followed. */
+        emailRedirectTo?: string;
+        /** Delivery channel: 'magiclink' (default) emails a link, 'otp' emails a 6-digit code. */
+        channel?: 'magiclink' | 'otp';
+    };
+}
+interface VerifyOtpParams {
+    email: string;
+    token: string;
+    /** 'magiclink' verifies a magic-link token, 'otp' verifies a 6-digit code, 'email' confirms verification. */
+    type?: 'magiclink' | 'otp' | 'email';
+}
+interface ResendParams {
+    type: 'signup' | 'email_change';
+    email: string;
+}
 interface QueryResponse<T = any> {
     data: T[] | null;
     error: KrisspyError | null;
@@ -339,11 +360,36 @@ declare class KrisspyAuth {
         error: KrisspyError | null;
     }>;
     /**
-     * Request password reset
+     * Request password reset email
      */
     resetPasswordForEmail(email: string): Promise<{
         error: KrisspyError | null;
     }>;
+    /**
+     * Complete a password reset using the token from the reset email.
+     */
+    updatePasswordWithToken(params: {
+        token: string;
+        password: string;
+    }): Promise<{
+        error: KrisspyError | null;
+    }>;
+    /**
+     * Passwordless sign-in: emails a magic link (default) or a one-time code.
+     * No session is returned here — call verifyOtp() with the link token / code.
+     */
+    signInWithOtp(credentials: SignInWithOtpCredentials): Promise<AuthResponse>;
+    /**
+     * Verify a magic-link token or a one-time code and establish a session.
+     */
+    verifyOtp(params: VerifyOtpParams): Promise<AuthResponse>;
+    /**
+     * Resend a verification email.
+     */
+    resend(params: ResendParams): Promise<{
+        data: Record<string, never>;
+        error: KrisspyError | null;
+    }>;
     /**
      * Listen for auth state changes
      */
@@ -1046,6 +1092,47 @@ declare class KrisspyNotifications {
     }>;
 }
 
+/**
+ * Email Module — send custom templated emails to your app's end users.
+ *
+ * Templates are created/managed in the Krisspy dashboard (per backend). From the
+ * SDK you reference a template by slug and pass variables to interpolate.
+ *
+ * @example
+ * await krisspy.email.send({
+ *   template: 'welcome',
+ *   to: 'user@example.com',
+ *   variables: { name: 'Sam', plan: 'Pro' },
+ * })
+ */
+
+interface SendEmailParams {
+    /** Slug of a template configured in the dashboard. */
+    template: string;
+    to: string;
+    variables?: Record<string, any>;
+    /** Optional sender override (honored on BYO providers; the Krisspy default keeps its locked address). */
+    from?: {
+        email: string;
+        name?: string;
+    };
+}
+interface SendEmailResponse {
+    data: {
+        source: string;
+    } | null;
+    error: KrisspyError | null;
+}
+declare class KrisspyEmail {
+    private http;
+    private backendId;
+    constructor(http: HttpClient, backendId: string);
+    /**
+     * Render a dashboard template with the given variables and send it.
+     */
+    send(params: SendEmailParams): Promise<SendEmailResponse>;
+}
+
 /**
  * Query Builder - Supabase-style fluent API for database queries
  */
@@ -1230,6 +1317,7 @@ declare class KrisspyClient {
     private _realtime;
     private _analytics;
     private _notifications;
+    private _email;
     private dataMode;
     private debug;
     constructor(options: KrisspyClientOptions);
@@ -1289,6 +1377,17 @@ declare class KrisspyClient {
      * const { error } = await krisspy.storage.from('uploads').remove(['old.jpg'])
      */
     get storage(): KrisspyStorage;
+    /**
+     * Email module — send custom templated emails to your end users.
+     *
+     * @example
+     * await krisspy.email.send({
+     *   template: 'welcome',
+     *   to: 'user@example.com',
+     *   variables: { name: 'Sam' },
+     * })
+     */
+    get email(): KrisspyEmail;
     /**
      * Analytics module for event tracking
      *
@@ -1519,4 +1618,4 @@ declare class KrisspyClient {
  */
 declare function createClient(options: KrisspyClientOptions): KrisspyClient;
 
-export { type AnalyticsEvent, type AnalyticsInitOptions, type AuthChangeEvent, type AuthResponse, type ChannelState, type FileObject, type FileUploadOptions, type Filter, type FilterOperator, type FunctionInvokeOptions, type FunctionResponse, HttpClient, KrisspyAnalytics, KrisspyAuth, KrisspyClient, type KrisspyClientOptions, type KrisspyError, KrisspyNotifications, KrisspyRealtime, KrisspyStorage, type MutationResponse, type NotificationTicket, type OAuthProvider, type OrderBy, type PostgresChangesConfig, type PushToken, QueryBuilder, type QueryOptions, type QueryResponse, RealtimeChannel, type RealtimeEvent, type RealtimePayload, type SendNotificationParams, type Session, type SignInCredentials, type SignUpCredentials, type SingleResponse, type StorageAdapter, StorageBucket, type UploadAndLinkOptions, type UploadAndLinkResponse, type User, createClient, isBrowser, isReactNative };
+export { type AnalyticsEvent, type AnalyticsInitOptions, type AuthChangeEvent, type AuthResponse, type ChannelState, type FileObject, type FileUploadOptions, type Filter, type FilterOperator, type FunctionInvokeOptions, type FunctionResponse, HttpClient, KrisspyAnalytics, KrisspyAuth, KrisspyClient, type KrisspyClientOptions, KrisspyEmail, type KrisspyError, KrisspyNotifications, KrisspyRealtime, KrisspyStorage, type MutationResponse, type NotificationTicket, type OAuthProvider, type OrderBy, type PostgresChangesConfig, type PushToken, QueryBuilder, type QueryOptions, type QueryResponse, RealtimeChannel, type RealtimeEvent, type RealtimePayload, type ResendParams, type SendEmailParams, type SendEmailResponse, type SendNotificationParams, type Session, type SignInCredentials, type SignInWithOtpCredentials, type SignUpCredentials, type SingleResponse, type StorageAdapter, StorageBucket, type UploadAndLinkOptions, type UploadAndLinkResponse, type User, type VerifyOtpParams, createClient, isBrowser, isReactNative };

package/dist/index.js

@@ -51,6 +51,7 @@ __export(index_exports, {
   KrisspyAnalytics: () => KrisspyAnalytics,
   KrisspyAuth: () => KrisspyAuth,
   KrisspyClient: () => KrisspyClient,
+  KrisspyEmail: () => KrisspyEmail,
   KrisspyNotifications: () => KrisspyNotifications,
   KrisspyRealtime: () => KrisspyRealtime,
   KrisspyStorage: () => KrisspyStorage,
@@ -562,13 +563,77 @@ var KrisspyAuth = class {
     return { data: { user: (_c = (_b = response.data) == null ? void 0 : _b.user) != null ? _c : null }, error: null };
   }
   /**
-   * Request password reset
+   * Request password reset email
    */
   async resetPasswordForEmail(email) {
     const path = `/api/v1/cloud-backends/${this.backendId}/auth/reset-password`;
     const response = await this.http.post(path, { email });
     return { error: response.error };
   }
+  /**
+   * Complete a password reset using the token from the reset email.
+   */
+  async updatePasswordWithToken(params) {
+    const path = `/api/v1/cloud-backends/${this.backendId}/auth/reset-password/confirm`;
+    const response = await this.http.post(path, {
+      token: params.token,
+      password: params.password
+    });
+    return { error: response.error };
+  }
+  /**
+   * Passwordless sign-in: emails a magic link (default) or a one-time code.
+   * No session is returned here — call verifyOtp() with the link token / code.
+   */
+  async signInWithOtp(credentials) {
+    var _a, _b, _c;
+    const channel = (_b = (_a = credentials.options) == null ? void 0 : _a.channel) != null ? _b : "magiclink";
+    const path = channel === "otp" ? `/api/v1/cloud-backends/${this.backendId}/auth/otp` : `/api/v1/cloud-backends/${this.backendId}/auth/magic-link`;
+    const response = await this.http.post(path, {
+      email: credentials.email,
+      redirectTo: (_c = credentials.options) == null ? void 0 : _c.emailRedirectTo
+    });
+    return {
+      data: { user: null, session: null },
+      error: response.error
+    };
+  }
+  /**
+   * Verify a magic-link token or a one-time code and establish a session.
+   */
+  async verifyOtp(params) {
+    var _a, _b, _c, _d, _e, _f;
+    const type = (_a = params.type) != null ? _a : "otp";
+    if (type === "email") {
+      const path2 = `/api/v1/cloud-backends/${this.backendId}/auth/verify-email`;
+      const response2 = await this.http.post(path2, { token: params.token });
+      return { data: { user: null, session: null }, error: response2.error };
+    }
+    const path = type === "magiclink" ? `/api/v1/cloud-backends/${this.backendId}/auth/magic-link/verify` : `/api/v1/cloud-backends/${this.backendId}/auth/otp/verify`;
+    const body = type === "magiclink" ? { token: params.token } : { email: params.email, token: params.token };
+    const response = await this.http.post(path, body);
+    if (response.error) {
+      return { data: { user: null, session: null }, error: response.error };
+    }
+    if ((_b = response.data) == null ? void 0 : _b.session) {
+      this.setSession(response.data.session);
+    }
+    return {
+      data: {
+        user: (_d = (_c = response.data) == null ? void 0 : _c.user) != null ? _d : null,
+        session: (_f = (_e = response.data) == null ? void 0 : _e.session) != null ? _f : null
+      },
+      error: null
+    };
+  }
+  /**
+   * Resend a verification email.
+   */
+  async resend(params) {
+    const path = `/api/v1/cloud-backends/${this.backendId}/auth/verify-email/resend`;
+    const response = await this.http.post(path, { email: params.email });
+    return { data: {}, error: response.error };
+  }
   /**
    * Listen for auth state changes
    */
@@ -1762,6 +1827,31 @@ var KrisspyNotifications = class {
   }
 };
 
+// src/email.ts
+var KrisspyEmail = class {
+  constructor(http, backendId) {
+    this.http = http;
+    this.backendId = backendId;
+  }
+  /**
+   * Render a dashboard template with the given variables and send it.
+   */
+  async send(params) {
+    var _a, _b;
+    const path = `/api/v1/cloud-backends/${this.backendId}/email/send`;
+    const response = await this.http.post(path, {
+      template: params.template,
+      to: params.to,
+      variables: params.variables,
+      from: params.from
+    });
+    if (response.error) {
+      return { data: null, error: response.error };
+    }
+    return { data: { source: (_b = (_a = response.data) == null ? void 0 : _a.source) != null ? _b : "unknown" }, error: null };
+  }
+};
+
 // src/query-builder.ts
 var MutationFilterBuilder = class {
   constructor(http, path, method, body, initialParams) {
@@ -2133,6 +2223,7 @@ var KrisspyClient = class {
     this._realtime = new KrisspyRealtime(this.baseUrl, this.backendId, this.debug);
     this._analytics = new KrisspyAnalytics(this.http, this.backendId);
     this._notifications = new KrisspyNotifications(this.http, this.backendId);
+    this._email = new KrisspyEmail(this.http, this.backendId);
     this._auth.onAuthStateChange((event) => {
       if (event === "SIGNED_IN") {
         const session = this._auth.session();
@@ -2206,6 +2297,19 @@ var KrisspyClient = class {
   get storage() {
     return this._storage;
   }
+  /**
+   * Email module — send custom templated emails to your end users.
+   *
+   * @example
+   * await krisspy.email.send({
+   *   template: 'welcome',
+   *   to: 'user@example.com',
+   *   variables: { name: 'Sam' },
+   * })
+   */
+  get email() {
+    return this._email;
+  }
   /**
    * Analytics module for event tracking
    *

package/dist/index.mjs

@@ -517,13 +517,77 @@ var KrisspyAuth = class {
     return { data: { user: (_c = (_b = response.data) == null ? void 0 : _b.user) != null ? _c : null }, error: null };
   }
   /**
-   * Request password reset
+   * Request password reset email
    */
   async resetPasswordForEmail(email) {
     const path = `/api/v1/cloud-backends/${this.backendId}/auth/reset-password`;
     const response = await this.http.post(path, { email });
     return { error: response.error };
   }
+  /**
+   * Complete a password reset using the token from the reset email.
+   */
+  async updatePasswordWithToken(params) {
+    const path = `/api/v1/cloud-backends/${this.backendId}/auth/reset-password/confirm`;
+    const response = await this.http.post(path, {
+      token: params.token,
+      password: params.password
+    });
+    return { error: response.error };
+  }
+  /**
+   * Passwordless sign-in: emails a magic link (default) or a one-time code.
+   * No session is returned here — call verifyOtp() with the link token / code.
+   */
+  async signInWithOtp(credentials) {
+    var _a, _b, _c;
+    const channel = (_b = (_a = credentials.options) == null ? void 0 : _a.channel) != null ? _b : "magiclink";
+    const path = channel === "otp" ? `/api/v1/cloud-backends/${this.backendId}/auth/otp` : `/api/v1/cloud-backends/${this.backendId}/auth/magic-link`;
+    const response = await this.http.post(path, {
+      email: credentials.email,
+      redirectTo: (_c = credentials.options) == null ? void 0 : _c.emailRedirectTo
+    });
+    return {
+      data: { user: null, session: null },
+      error: response.error
+    };
+  }
+  /**
+   * Verify a magic-link token or a one-time code and establish a session.
+   */
+  async verifyOtp(params) {
+    var _a, _b, _c, _d, _e, _f;
+    const type = (_a = params.type) != null ? _a : "otp";
+    if (type === "email") {
+      const path2 = `/api/v1/cloud-backends/${this.backendId}/auth/verify-email`;
+      const response2 = await this.http.post(path2, { token: params.token });
+      return { data: { user: null, session: null }, error: response2.error };
+    }
+    const path = type === "magiclink" ? `/api/v1/cloud-backends/${this.backendId}/auth/magic-link/verify` : `/api/v1/cloud-backends/${this.backendId}/auth/otp/verify`;
+    const body = type === "magiclink" ? { token: params.token } : { email: params.email, token: params.token };
+    const response = await this.http.post(path, body);
+    if (response.error) {
+      return { data: { user: null, session: null }, error: response.error };
+    }
+    if ((_b = response.data) == null ? void 0 : _b.session) {
+      this.setSession(response.data.session);
+    }
+    return {
+      data: {
+        user: (_d = (_c = response.data) == null ? void 0 : _c.user) != null ? _d : null,
+        session: (_f = (_e = response.data) == null ? void 0 : _e.session) != null ? _f : null
+      },
+      error: null
+    };
+  }
+  /**
+   * Resend a verification email.
+   */
+  async resend(params) {
+    const path = `/api/v1/cloud-backends/${this.backendId}/auth/verify-email/resend`;
+    const response = await this.http.post(path, { email: params.email });
+    return { data: {}, error: response.error };
+  }
   /**
    * Listen for auth state changes
    */
@@ -1717,6 +1781,31 @@ var KrisspyNotifications = class {
   }
 };
 
+// src/email.ts
+var KrisspyEmail = class {
+  constructor(http, backendId) {
+    this.http = http;
+    this.backendId = backendId;
+  }
+  /**
+   * Render a dashboard template with the given variables and send it.
+   */
+  async send(params) {
+    var _a, _b;
+    const path = `/api/v1/cloud-backends/${this.backendId}/email/send`;
+    const response = await this.http.post(path, {
+      template: params.template,
+      to: params.to,
+      variables: params.variables,
+      from: params.from
+    });
+    if (response.error) {
+      return { data: null, error: response.error };
+    }
+    return { data: { source: (_b = (_a = response.data) == null ? void 0 : _a.source) != null ? _b : "unknown" }, error: null };
+  }
+};
+
 // src/query-builder.ts
 var MutationFilterBuilder = class {
   constructor(http, path, method, body, initialParams) {
@@ -2088,6 +2177,7 @@ var KrisspyClient = class {
     this._realtime = new KrisspyRealtime(this.baseUrl, this.backendId, this.debug);
     this._analytics = new KrisspyAnalytics(this.http, this.backendId);
     this._notifications = new KrisspyNotifications(this.http, this.backendId);
+    this._email = new KrisspyEmail(this.http, this.backendId);
     this._auth.onAuthStateChange((event) => {
       if (event === "SIGNED_IN") {
         const session = this._auth.session();
@@ -2161,6 +2251,19 @@ var KrisspyClient = class {
   get storage() {
     return this._storage;
   }
+  /**
+   * Email module — send custom templated emails to your end users.
+   *
+   * @example
+   * await krisspy.email.send({
+   *   template: 'welcome',
+   *   to: 'user@example.com',
+   *   variables: { name: 'Sam' },
+   * })
+   */
+  get email() {
+    return this._email;
+  }
   /**
    * Analytics module for event tracking
    *
@@ -2398,6 +2501,7 @@ export {
   KrisspyAnalytics,
   KrisspyAuth,
   KrisspyClient,
+  KrisspyEmail,
   KrisspyNotifications,
   KrisspyRealtime,
   KrisspyStorage,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "krisspy-sdk",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "Krisspy Cloud SDK - Database, Auth, Storage, and Functions for your apps",
   "main": "dist/index.js",
   "module": "dist/index.mjs",