@redbase/sdk 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,165 @@
+import { SupabaseClient } from '@supabase/supabase-js';
+export { AuthSession, AuthUser, FunctionRegion, FunctionsError, FunctionsFetchError, FunctionsHttpError, FunctionsRelayError, PostgrestError, PostgrestMaybeSingleResponse, PostgrestResponse, PostgrestSingleResponse, QueryData, QueryError, QueryResult, StorageApiError, SupabaseClient, SupabaseClientOptions, createClient as createSupabaseClient } from '@supabase/supabase-js';
+export { AuthApiError, AuthError, AuthResponse, Provider, Session, SignInWithPasswordCredentials, SignUpWithPasswordCredentials, User, UserResponse } from '@supabase/auth-js';
+export { REALTIME_LISTEN_TYPES, REALTIME_POSTGRES_CHANGES_LISTEN_EVENT, REALTIME_PRESENCE_LISTEN_EVENTS, REALTIME_SUBSCRIBE_STATES, RealtimeChannel, RealtimePostgresChangesPayload } from '@supabase/realtime-js';
+
+/**
+ * Options for sending an email via RedBase email worker.
+ */
+interface EmailSendOptions {
+    /** Recipient email address(es). */
+    to: string | string[];
+    /** Email subject line. */
+    subject: string;
+    /** HTML body content. */
+    html: string;
+    /** Plain text body content (optional fallback). */
+    text?: string;
+    /** Reply-to address (optional). */
+    replyTo?: string;
+    /** CC recipients (optional). */
+    cc?: string | string[];
+    /** BCC recipients (optional). */
+    bcc?: string | string[];
+}
+/**
+ * Response from the email send endpoint.
+ */
+interface EmailSendResponse {
+    /** Whether the email was queued successfully. */
+    success: boolean;
+    /** Message ID if successful. */
+    messageId?: string;
+    /** Error message if failed. */
+    error?: string;
+}
+/**
+ * Email client for sending transactional emails via RedBase.
+ *
+ * **Important:** Use with `SERVICE_ROLE_KEY` on the server only.
+ * The email endpoint requires elevated privileges and should never
+ * be called from client-side code with the anon key.
+ */
+interface EmailClient {
+    /**
+     * Send a transactional email.
+     *
+     * @param options - Email options (to, subject, html, text, etc.)
+     * @returns Promise resolving to the send result
+     *
+     * @example
+     * ```ts
+     * const { success, messageId, error } = await rb.email.send({
+     *   to: 'user@example.com',
+     *   subject: 'Welcome!',
+     *   html: '<h1>Hello</h1>',
+     *   text: 'Hello',
+     * })
+     * ```
+     */
+    send(options: EmailSendOptions): Promise<EmailSendResponse>;
+}
+
+/**
+ * RedBase client options.
+ * See @supabase/supabase-js SupabaseClientOptions for full documentation.
+ */
+interface RedbaseClientOptions {
+    auth?: {
+        autoRefreshToken?: boolean;
+        persistSession?: boolean;
+        detectSessionInUrl?: boolean;
+        storage?: unknown;
+        storageKey?: string;
+        flowType?: 'implicit' | 'pkce';
+    };
+    global?: {
+        headers?: Record<string, string>;
+        fetch?: typeof fetch;
+    };
+    db?: {
+        schema?: string;
+    };
+    realtime?: {
+        params?: Record<string, unknown>;
+    };
+}
+/**
+ * RedBase client type - a Supabase client with email capabilities.
+ *
+ * Use with your Database types for full type safety:
+ * ```ts
+ * import type { Database } from './database.types'
+ * const rb = createClient<Database>(url, key)
+ * ```
+ */
+type RedbaseClient<Database = unknown> = SupabaseClient<Database> & {
+    /**
+     * Email client for sending transactional emails.
+     * **Server-side only.** Requires `SERVICE_ROLE_KEY`.
+     */
+    email: EmailClient;
+};
+/**
+ * Creates a RedBase client instance.
+ *
+ * The client is a thin wrapper around `@supabase/supabase-js` that provides:
+ * - Full Supabase client compatibility (`auth`, `from`, `storage`, etc.)
+ * - Additional `email` helper for sending transactional emails
+ *
+ * @param redbaseUrl - The RedBase API URL (e.g., `https://api.payagenda.com` or `http://localhost:8000`)
+ * @param redbaseKey - The API key (anon key for client, service role key for server)
+ * @param options - Optional client configuration
+ * @returns A RedBase client instance
+ *
+ * @example
+ * ```ts
+ * // Client-side usage (anon key)
+ * import { createClient } from '@redbase/sdk'
+ *
+ * const rb = createClient(
+ *   import.meta.env.VITE_REDBASE_URL,
+ *   import.meta.env.VITE_REDBASE_ANON_KEY
+ * )
+ *
+ * // Use like Supabase client
+ * const { data } = await rb.from('users').select('*')
+ * const { data: session } = await rb.auth.getSession()
+ * ```
+ *
+ * @example
+ * ```ts
+ * // With Database types
+ * import { createClient } from '@redbase/sdk'
+ * import type { Database } from './database.types'
+ *
+ * const rb = createClient<Database>(
+ *   import.meta.env.VITE_REDBASE_URL,
+ *   import.meta.env.VITE_REDBASE_ANON_KEY
+ * )
+ *
+ * // Fully typed queries
+ * const { data } = await rb.from('users').select('id, email')
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Server-side usage (service role key for email)
+ * import { createClient } from '@redbase/sdk'
+ *
+ * const rb = createClient(
+ *   process.env.REDBASE_URL!,
+ *   process.env.REDBASE_SERVICE_ROLE_KEY!
+ * )
+ *
+ * // Send transactional email
+ * const { success, error } = await rb.email.send({
+ *   to: 'user@example.com',
+ *   subject: 'Welcome!',
+ *   html: '<h1>Welcome to our app!</h1>',
+ * })
+ * ```
+ */
+declare function createClient<Database = unknown>(redbaseUrl: string, redbaseKey: string, options?: RedbaseClientOptions): RedbaseClient<Database>;
+
+export { type EmailClient, type EmailSendOptions, type EmailSendResponse, type RedbaseClient, type RedbaseClientOptions, createClient };

package/dist/index.d.ts

@@ -0,0 +1,165 @@
+import { SupabaseClient } from '@supabase/supabase-js';
+export { AuthSession, AuthUser, FunctionRegion, FunctionsError, FunctionsFetchError, FunctionsHttpError, FunctionsRelayError, PostgrestError, PostgrestMaybeSingleResponse, PostgrestResponse, PostgrestSingleResponse, QueryData, QueryError, QueryResult, StorageApiError, SupabaseClient, SupabaseClientOptions, createClient as createSupabaseClient } from '@supabase/supabase-js';
+export { AuthApiError, AuthError, AuthResponse, Provider, Session, SignInWithPasswordCredentials, SignUpWithPasswordCredentials, User, UserResponse } from '@supabase/auth-js';
+export { REALTIME_LISTEN_TYPES, REALTIME_POSTGRES_CHANGES_LISTEN_EVENT, REALTIME_PRESENCE_LISTEN_EVENTS, REALTIME_SUBSCRIBE_STATES, RealtimeChannel, RealtimePostgresChangesPayload } from '@supabase/realtime-js';
+
+/**
+ * Options for sending an email via RedBase email worker.
+ */
+interface EmailSendOptions {
+    /** Recipient email address(es). */
+    to: string | string[];
+    /** Email subject line. */
+    subject: string;
+    /** HTML body content. */
+    html: string;
+    /** Plain text body content (optional fallback). */
+    text?: string;
+    /** Reply-to address (optional). */
+    replyTo?: string;
+    /** CC recipients (optional). */
+    cc?: string | string[];
+    /** BCC recipients (optional). */
+    bcc?: string | string[];
+}
+/**
+ * Response from the email send endpoint.
+ */
+interface EmailSendResponse {
+    /** Whether the email was queued successfully. */
+    success: boolean;
+    /** Message ID if successful. */
+    messageId?: string;
+    /** Error message if failed. */
+    error?: string;
+}
+/**
+ * Email client for sending transactional emails via RedBase.
+ *
+ * **Important:** Use with `SERVICE_ROLE_KEY` on the server only.
+ * The email endpoint requires elevated privileges and should never
+ * be called from client-side code with the anon key.
+ */
+interface EmailClient {
+    /**
+     * Send a transactional email.
+     *
+     * @param options - Email options (to, subject, html, text, etc.)
+     * @returns Promise resolving to the send result
+     *
+     * @example
+     * ```ts
+     * const { success, messageId, error } = await rb.email.send({
+     *   to: 'user@example.com',
+     *   subject: 'Welcome!',
+     *   html: '<h1>Hello</h1>',
+     *   text: 'Hello',
+     * })
+     * ```
+     */
+    send(options: EmailSendOptions): Promise<EmailSendResponse>;
+}
+
+/**
+ * RedBase client options.
+ * See @supabase/supabase-js SupabaseClientOptions for full documentation.
+ */
+interface RedbaseClientOptions {
+    auth?: {
+        autoRefreshToken?: boolean;
+        persistSession?: boolean;
+        detectSessionInUrl?: boolean;
+        storage?: unknown;
+        storageKey?: string;
+        flowType?: 'implicit' | 'pkce';
+    };
+    global?: {
+        headers?: Record<string, string>;
+        fetch?: typeof fetch;
+    };
+    db?: {
+        schema?: string;
+    };
+    realtime?: {
+        params?: Record<string, unknown>;
+    };
+}
+/**
+ * RedBase client type - a Supabase client with email capabilities.
+ *
+ * Use with your Database types for full type safety:
+ * ```ts
+ * import type { Database } from './database.types'
+ * const rb = createClient<Database>(url, key)
+ * ```
+ */
+type RedbaseClient<Database = unknown> = SupabaseClient<Database> & {
+    /**
+     * Email client for sending transactional emails.
+     * **Server-side only.** Requires `SERVICE_ROLE_KEY`.
+     */
+    email: EmailClient;
+};
+/**
+ * Creates a RedBase client instance.
+ *
+ * The client is a thin wrapper around `@supabase/supabase-js` that provides:
+ * - Full Supabase client compatibility (`auth`, `from`, `storage`, etc.)
+ * - Additional `email` helper for sending transactional emails
+ *
+ * @param redbaseUrl - The RedBase API URL (e.g., `https://api.payagenda.com` or `http://localhost:8000`)
+ * @param redbaseKey - The API key (anon key for client, service role key for server)
+ * @param options - Optional client configuration
+ * @returns A RedBase client instance
+ *
+ * @example
+ * ```ts
+ * // Client-side usage (anon key)
+ * import { createClient } from '@redbase/sdk'
+ *
+ * const rb = createClient(
+ *   import.meta.env.VITE_REDBASE_URL,
+ *   import.meta.env.VITE_REDBASE_ANON_KEY
+ * )
+ *
+ * // Use like Supabase client
+ * const { data } = await rb.from('users').select('*')
+ * const { data: session } = await rb.auth.getSession()
+ * ```
+ *
+ * @example
+ * ```ts
+ * // With Database types
+ * import { createClient } from '@redbase/sdk'
+ * import type { Database } from './database.types'
+ *
+ * const rb = createClient<Database>(
+ *   import.meta.env.VITE_REDBASE_URL,
+ *   import.meta.env.VITE_REDBASE_ANON_KEY
+ * )
+ *
+ * // Fully typed queries
+ * const { data } = await rb.from('users').select('id, email')
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Server-side usage (service role key for email)
+ * import { createClient } from '@redbase/sdk'
+ *
+ * const rb = createClient(
+ *   process.env.REDBASE_URL!,
+ *   process.env.REDBASE_SERVICE_ROLE_KEY!
+ * )
+ *
+ * // Send transactional email
+ * const { success, error } = await rb.email.send({
+ *   to: 'user@example.com',
+ *   subject: 'Welcome!',
+ *   html: '<h1>Welcome to our app!</h1>',
+ * })
+ * ```
+ */
+declare function createClient<Database = unknown>(redbaseUrl: string, redbaseKey: string, options?: RedbaseClientOptions): RedbaseClient<Database>;
+
+export { type EmailClient, type EmailSendOptions, type EmailSendResponse, type RedbaseClient, type RedbaseClientOptions, createClient };