@niledatabase/client 5.0.0-alpha.2

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 The Nile Platform
+
+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,38 @@
+<p align="center">
+  <img width="1434" alt="Screen Shot 2024-09-18 at 9 20 04 AM" src="https://github.com/user-attachments/assets/20585883-5cdc-4f15-93d3-dc150e87bc11">
+</p>
+
+---
+
+# Nile's Client SDK
+
+This package (`@niledatabase/client`) is part of [Nile's Javascript SDK](https://github.com/niledatabase/nile-js/tree/main).
+
+Nile's React package provides:
+
+- 🎨 UI components for authentication, user management, and tenant management (customizable with Tailwind CSS)
+- 🪝 React hooks for authentication, user management, and tenant management functionality
+
+You can browse all the components and explore their properties in [Nile's documentation](https://www.thenile.dev/docs/auth/components/signin) or in [Storybook](https://storybook.thenile.dev).
+
+The components and hooks are designed to work best and provide a secure user experience when used with the generated routes provided by [Nile's Server-Side SDK](https://www.npmjs.com/package/@niledatabase/server).
+
+**Nile is a Postgres platform that decouples storage from compute, virtualizes tenants, and supports vertical and horizontal scaling globally to ship B2B applications fast while being safe with limitless scale.** All B2B applications are multi-tenant. A tenant/customer is primarily a company, an organization, or a workspace in your product that contains a group of users. A B2B application provides services to multiple tenants. Tenant is the basic building block of all B2B applications.
+
+## Usage
+
+### Installation
+
+```bash
+npm install @niledatabase/client
+```
+
+### Social Login (SSO)
+
+Nile-Auth supports multiple social providers. You configure and enable them in [Nile console](https://console.thenile.dev), and then simply drop-in the components. For example, for Discord authentication:
+
+## Learn more
+
+- You can learn more about Nile and the SDK in [https://thenile.dev/docs]
+- You can find detailed code examples in [our main repo](https://github.com/niledatabase/niledatabase)
+- Nile SDK interacts with APIs in Nile Auth service. You can learn more about it in the [repository](https://github.com/niledatabase/nile-auth) and the [docs](https://thenile.dev/docs/auth)

package/dist/index.d.mts

@@ -0,0 +1,244 @@
+import { IncomingMessage } from 'http';
+
+interface SignInResponse {
+    error: string | null;
+    status: number;
+    ok: boolean;
+    url: string | null;
+}
+type LiteralUnion<T extends U, U = string> = T | (U & Record<never, never>);
+interface SignInOptions extends Record<string, unknown> {
+    /**
+     * Specify to which URL the user will be redirected after signing in. Defaults to the page URL the sign-in is initiated from.
+     *
+     * [Documentation](https://next-auth.js.org/getting-started/client#specifying-a-callbackurl)
+     */
+    callbackUrl?: string;
+    /** [Documentation](https://next-auth.js.org/getting-started/client#using-the-redirect-false-option) */
+    redirect?: boolean;
+}
+type SignInAuthorizationParams = string | string[][] | Record<string, string> | URLSearchParams;
+type ProviderType = 'oauth' | 'email' | 'credentials';
+interface ClientSafeProvider {
+    id: LiteralUnion<BuiltInProviderType>;
+    name: string;
+    type: ProviderType;
+    signinUrl: string;
+    callbackUrl: string;
+}
+type RedirectableProviderType = 'email' | 'credentials';
+type OAuthProviderType = 'linkedin' | 'hubspot' | 'google' | 'azure-ad' | 'slack' | 'github' | 'twitter' | 'discord';
+type BuiltInProviderType = RedirectableProviderType | OAuthProviderType;
+type JWT = {
+    email: string;
+    sub: string;
+    id: string;
+    iat: number;
+    exp: number;
+    jti: string;
+    loading: boolean;
+};
+type ActiveSession = {
+    loading: boolean;
+    id: string;
+    email: string;
+    expires: string;
+    user?: {
+        id: string;
+        name: string;
+        image: string;
+        email: string;
+        emailVerified: void | Date;
+    };
+};
+type NonErrorSession = JWT | ActiveSession | null | undefined;
+type NileSession = Response | NonErrorSession;
+type AuthState = {
+    basePath: string;
+    baseUrl: string;
+    lastSync: number;
+    getSession: (...args: any[]) => void;
+    session: NonErrorSession | undefined | null;
+    loading: boolean;
+};
+type ListenerParams = {
+    key: ListenerKeys;
+    next: any;
+    prev: any;
+};
+type Listener = (callback: ListenerParams) => void;
+type ListenerKeys = 'basePath' | 'baseUrl' | 'lastSync' | 'getSession' | 'session' | 'loading';
+type AuthConfig = Config & {
+    listenerKeys?: Array<ListenerKeys>;
+};
+type Config = {
+    basePath?: string;
+    baseUrl?: string;
+    init?: RequestInit;
+};
+type PartialAuthorizer = null | {
+    state?: {
+        baseUrl?: string;
+        basePath?: string;
+        session?: {
+            user?: {
+                email?: string | undefined;
+            };
+        };
+    };
+    requestInit?: RequestInit | undefined;
+};
+interface CtxOrReq {
+    req?: Partial<IncomingMessage> & {
+        body?: any;
+    };
+    ctx?: {
+        req: Partial<IncomingMessage> & {
+            body?: any;
+        };
+    };
+}
+interface SignOutParams<R extends boolean = true> {
+    callbackUrl?: string;
+    redirect?: R;
+}
+interface SignOutResponse {
+    url: string;
+}
+
+type WarningCode = 'NEXTAUTH_URL' | 'NO_SECRET' | 'TWITTER_OAUTH_2_BETA' | 'DEBUG_ENABLED';
+/**
+ * Override any of the methods, and the rest will use the default logger.
+ *
+ * [Documentation](https://next-auth.js.org/configuration/options#logger)
+ */
+interface LoggerInstance extends Record<string, (...args: any) => any> {
+    warn: (code: WarningCode) => void;
+    error: (code: string, 
+    /**
+     * Either an instance of (JSON serializable) Error
+     * or an object that contains some debug information.
+     * (Error is still available through `metadata.error`)
+     */
+    metadata: Error | {
+        error: Error;
+        [key: string]: unknown;
+    }) => void;
+    debug: (code: string, metadata: unknown) => void;
+}
+
+type GetSessionParams = CtxOrReq & {
+    event?: 'storage' | 'timer' | 'hidden' | string;
+    triggerEvent?: boolean;
+    broadcast?: boolean;
+    baseUrl?: string;
+    init?: RequestInit;
+};
+declare enum State {
+    SESSION = "getSession"
+}
+declare class Authorizer {
+    state: AuthState;
+    logger: LoggerInstance;
+    requestInit?: RequestInit;
+    addListener: (cb: Listener) => void;
+    removeListener: (cb: Listener) => void;
+    status: null | State;
+    constructor(config?: AuthConfig);
+    sync(event?: 'storage' | 'timer' | 'hidden' | 'poll' | 'visibilitychange'): Promise<void>;
+    set baseUrl(val: string);
+    get baseUrl(): string;
+    configure(config?: Config): this;
+    sanitize(): PartialAuthorizer;
+    initialize(params?: {
+        baseUrl?: string;
+        session?: NonErrorSession | null | undefined;
+        event?: 'storage' | 'timer' | 'hidden' | 'poll' | 'visibilitychange';
+    }): Promise<void>;
+    get apiBaseUrl(): string;
+    sendData(url: string, init?: RequestInit): Promise<Response | undefined>;
+    fetchData<T = any>(url: string, init?: RequestInit): Promise<T | undefined>;
+    fetchFormData<T = {
+        url: string;
+    }>(url: string, init: RequestInit): Promise<{
+        data: T;
+        status: number;
+        ok: boolean;
+        url: string;
+    } | undefined>;
+    getProviders(url?: string): Promise<Record<LiteralUnion<BuiltInProviderType>, ClientSafeProvider> | undefined>;
+    getCsrfToken(url?: string): Promise<string | undefined>;
+    getSession(params?: GetSessionParams): Promise<NonErrorSession>;
+    refreshSession(): Promise<NonErrorSession>;
+    signOut<R extends boolean = true>(options?: SignOutParams<R> & {
+        baseUrl?: string;
+        auth?: Authorizer | PartialAuthorizer;
+        fetchUrl?: string;
+        basePath?: string;
+    }): Promise<R extends true ? undefined : SignOutResponse>;
+    signIn<P extends RedirectableProviderType | undefined = undefined>(provider?: LiteralUnion<P extends RedirectableProviderType ? P | BuiltInProviderType : BuiltInProviderType>, options?: SignInOptions & {
+        baseUrl?: string;
+        providersUrl?: string;
+        csrfUrl?: string;
+        init?: ResponseInit;
+        fetchUrl?: string;
+        resetUrl?: string;
+        auth?: Authorizer | PartialAuthorizer;
+    }, authorizationParams?: SignInAuthorizationParams): Promise<P extends RedirectableProviderType ? SignInResponse | undefined : undefined>;
+    signUp(options: {
+        baseUrl?: string;
+        init?: ResponseInit;
+        fetchUrl?: string;
+        newTenantName?: string;
+        createTenant?: string | boolean;
+        email: string;
+        password: string;
+        auth?: Authorizer | PartialAuthorizer;
+        tenantId?: string;
+        callbackUrl?: string;
+        redirect?: boolean;
+    }): Promise<any>;
+    resetPassword(options: {
+        baseUrl?: string;
+        init?: ResponseInit;
+        fetchUrl?: string;
+        email: string;
+        password: string;
+        auth?: Authorizer | PartialAuthorizer;
+        callbackUrl?: string;
+        redirect?: boolean;
+    }): Promise<Response | undefined>;
+    _configureFetch(params: {
+        baseUrl?: string;
+        auth?: Authorizer | PartialAuthorizer;
+        init?: RequestInit;
+    }): void;
+}
+declare const authorizer: Authorizer;
+declare const auth: Authorizer;
+declare const getSession: (params?: GetSessionParams) => Promise<NonErrorSession>;
+declare const getCsrfToken: (url?: string) => Promise<string | undefined>;
+declare const getProviders: () => Promise<Record<LiteralUnion<BuiltInProviderType>, ClientSafeProvider> | undefined>;
+declare const signOut: typeof authorizer.signOut;
+declare const signIn: typeof authorizer.signIn;
+declare const signUp: typeof authorizer.signUp;
+declare const resetPassword: typeof authorizer.resetPassword;
+
+declare function getStatus(load: boolean, sess: NonErrorSession | null | undefined): "loading" | "authenticated" | "unauthenticated";
+
+interface BroadcastMessage {
+    event?: 'session';
+    data?: {
+        trigger?: 'signout' | 'getSession';
+    };
+    clientId: string;
+    timestamp: number;
+}
+declare const broadcast: {
+    /** Get notified by other tabs/windows. */
+    receive(onReceive: (message: BroadcastMessage) => void): () => void;
+    /** Notify other tabs/windows. */
+    post(message: Record<string, unknown>): void;
+};
+
+export { type ActiveSession, type AuthConfig, type AuthState, Authorizer, type BuiltInProviderType, type ClientSafeProvider, type Config, type CtxOrReq, type JWT, type Listener, type ListenerKeys, type ListenerParams, type LiteralUnion, type NileSession, type NonErrorSession, type PartialAuthorizer, type ProviderType, type RedirectableProviderType, type SignInAuthorizationParams, type SignInOptions, type SignInResponse, type SignOutParams, type SignOutResponse, auth, broadcast, getCsrfToken, getProviders, getSession, getStatus, resetPassword, signIn, signOut, signUp };

package/dist/index.d.ts

@@ -0,0 +1,244 @@
+import { IncomingMessage } from 'http';
+
+interface SignInResponse {
+    error: string | null;
+    status: number;
+    ok: boolean;
+    url: string | null;
+}
+type LiteralUnion<T extends U, U = string> = T | (U & Record<never, never>);
+interface SignInOptions extends Record<string, unknown> {
+    /**
+     * Specify to which URL the user will be redirected after signing in. Defaults to the page URL the sign-in is initiated from.
+     *
+     * [Documentation](https://next-auth.js.org/getting-started/client#specifying-a-callbackurl)
+     */
+    callbackUrl?: string;
+    /** [Documentation](https://next-auth.js.org/getting-started/client#using-the-redirect-false-option) */
+    redirect?: boolean;
+}
+type SignInAuthorizationParams = string | string[][] | Record<string, string> | URLSearchParams;
+type ProviderType = 'oauth' | 'email' | 'credentials';
+interface ClientSafeProvider {
+    id: LiteralUnion<BuiltInProviderType>;
+    name: string;
+    type: ProviderType;
+    signinUrl: string;
+    callbackUrl: string;
+}
+type RedirectableProviderType = 'email' | 'credentials';
+type OAuthProviderType = 'linkedin' | 'hubspot' | 'google' | 'azure-ad' | 'slack' | 'github' | 'twitter' | 'discord';
+type BuiltInProviderType = RedirectableProviderType | OAuthProviderType;
+type JWT = {
+    email: string;
+    sub: string;
+    id: string;
+    iat: number;
+    exp: number;
+    jti: string;
+    loading: boolean;
+};
+type ActiveSession = {
+    loading: boolean;
+    id: string;
+    email: string;
+    expires: string;
+    user?: {
+        id: string;
+        name: string;
+        image: string;
+        email: string;
+        emailVerified: void | Date;
+    };
+};
+type NonErrorSession = JWT | ActiveSession | null | undefined;
+type NileSession = Response | NonErrorSession;
+type AuthState = {
+    basePath: string;
+    baseUrl: string;
+    lastSync: number;
+    getSession: (...args: any[]) => void;
+    session: NonErrorSession | undefined | null;
+    loading: boolean;
+};
+type ListenerParams = {
+    key: ListenerKeys;
+    next: any;
+    prev: any;
+};
+type Listener = (callback: ListenerParams) => void;
+type ListenerKeys = 'basePath' | 'baseUrl' | 'lastSync' | 'getSession' | 'session' | 'loading';
+type AuthConfig = Config & {
+    listenerKeys?: Array<ListenerKeys>;
+};
+type Config = {
+    basePath?: string;
+    baseUrl?: string;
+    init?: RequestInit;
+};
+type PartialAuthorizer = null | {
+    state?: {
+        baseUrl?: string;
+        basePath?: string;
+        session?: {
+            user?: {
+                email?: string | undefined;
+            };
+        };
+    };
+    requestInit?: RequestInit | undefined;
+};
+interface CtxOrReq {
+    req?: Partial<IncomingMessage> & {
+        body?: any;
+    };
+    ctx?: {
+        req: Partial<IncomingMessage> & {
+            body?: any;
+        };
+    };
+}
+interface SignOutParams<R extends boolean = true> {
+    callbackUrl?: string;
+    redirect?: R;
+}
+interface SignOutResponse {
+    url: string;
+}
+
+type WarningCode = 'NEXTAUTH_URL' | 'NO_SECRET' | 'TWITTER_OAUTH_2_BETA' | 'DEBUG_ENABLED';
+/**
+ * Override any of the methods, and the rest will use the default logger.
+ *
+ * [Documentation](https://next-auth.js.org/configuration/options#logger)
+ */
+interface LoggerInstance extends Record<string, (...args: any) => any> {
+    warn: (code: WarningCode) => void;
+    error: (code: string, 
+    /**
+     * Either an instance of (JSON serializable) Error
+     * or an object that contains some debug information.
+     * (Error is still available through `metadata.error`)
+     */
+    metadata: Error | {
+        error: Error;
+        [key: string]: unknown;
+    }) => void;
+    debug: (code: string, metadata: unknown) => void;
+}
+
+type GetSessionParams = CtxOrReq & {
+    event?: 'storage' | 'timer' | 'hidden' | string;
+    triggerEvent?: boolean;
+    broadcast?: boolean;
+    baseUrl?: string;
+    init?: RequestInit;
+};
+declare enum State {
+    SESSION = "getSession"
+}
+declare class Authorizer {
+    state: AuthState;
+    logger: LoggerInstance;
+    requestInit?: RequestInit;
+    addListener: (cb: Listener) => void;
+    removeListener: (cb: Listener) => void;
+    status: null | State;
+    constructor(config?: AuthConfig);
+    sync(event?: 'storage' | 'timer' | 'hidden' | 'poll' | 'visibilitychange'): Promise<void>;
+    set baseUrl(val: string);
+    get baseUrl(): string;
+    configure(config?: Config): this;
+    sanitize(): PartialAuthorizer;
+    initialize(params?: {
+        baseUrl?: string;
+        session?: NonErrorSession | null | undefined;
+        event?: 'storage' | 'timer' | 'hidden' | 'poll' | 'visibilitychange';
+    }): Promise<void>;
+    get apiBaseUrl(): string;
+    sendData(url: string, init?: RequestInit): Promise<Response | undefined>;
+    fetchData<T = any>(url: string, init?: RequestInit): Promise<T | undefined>;
+    fetchFormData<T = {
+        url: string;
+    }>(url: string, init: RequestInit): Promise<{
+        data: T;
+        status: number;
+        ok: boolean;
+        url: string;
+    } | undefined>;
+    getProviders(url?: string): Promise<Record<LiteralUnion<BuiltInProviderType>, ClientSafeProvider> | undefined>;
+    getCsrfToken(url?: string): Promise<string | undefined>;
+    getSession(params?: GetSessionParams): Promise<NonErrorSession>;
+    refreshSession(): Promise<NonErrorSession>;
+    signOut<R extends boolean = true>(options?: SignOutParams<R> & {
+        baseUrl?: string;
+        auth?: Authorizer | PartialAuthorizer;
+        fetchUrl?: string;
+        basePath?: string;
+    }): Promise<R extends true ? undefined : SignOutResponse>;
+    signIn<P extends RedirectableProviderType | undefined = undefined>(provider?: LiteralUnion<P extends RedirectableProviderType ? P | BuiltInProviderType : BuiltInProviderType>, options?: SignInOptions & {
+        baseUrl?: string;
+        providersUrl?: string;
+        csrfUrl?: string;
+        init?: ResponseInit;
+        fetchUrl?: string;
+        resetUrl?: string;
+        auth?: Authorizer | PartialAuthorizer;
+    }, authorizationParams?: SignInAuthorizationParams): Promise<P extends RedirectableProviderType ? SignInResponse | undefined : undefined>;
+    signUp(options: {
+        baseUrl?: string;
+        init?: ResponseInit;
+        fetchUrl?: string;
+        newTenantName?: string;
+        createTenant?: string | boolean;
+        email: string;
+        password: string;
+        auth?: Authorizer | PartialAuthorizer;
+        tenantId?: string;
+        callbackUrl?: string;
+        redirect?: boolean;
+    }): Promise<any>;
+    resetPassword(options: {
+        baseUrl?: string;
+        init?: ResponseInit;
+        fetchUrl?: string;
+        email: string;
+        password: string;
+        auth?: Authorizer | PartialAuthorizer;
+        callbackUrl?: string;
+        redirect?: boolean;
+    }): Promise<Response | undefined>;
+    _configureFetch(params: {
+        baseUrl?: string;
+        auth?: Authorizer | PartialAuthorizer;
+        init?: RequestInit;
+    }): void;
+}
+declare const authorizer: Authorizer;
+declare const auth: Authorizer;
+declare const getSession: (params?: GetSessionParams) => Promise<NonErrorSession>;
+declare const getCsrfToken: (url?: string) => Promise<string | undefined>;
+declare const getProviders: () => Promise<Record<LiteralUnion<BuiltInProviderType>, ClientSafeProvider> | undefined>;
+declare const signOut: typeof authorizer.signOut;
+declare const signIn: typeof authorizer.signIn;
+declare const signUp: typeof authorizer.signUp;
+declare const resetPassword: typeof authorizer.resetPassword;
+
+declare function getStatus(load: boolean, sess: NonErrorSession | null | undefined): "loading" | "authenticated" | "unauthenticated";
+
+interface BroadcastMessage {
+    event?: 'session';
+    data?: {
+        trigger?: 'signout' | 'getSession';
+    };
+    clientId: string;
+    timestamp: number;
+}
+declare const broadcast: {
+    /** Get notified by other tabs/windows. */
+    receive(onReceive: (message: BroadcastMessage) => void): () => void;
+    /** Notify other tabs/windows. */
+    post(message: Record<string, unknown>): void;
+};
+
+export { type ActiveSession, type AuthConfig, type AuthState, Authorizer, type BuiltInProviderType, type ClientSafeProvider, type Config, type CtxOrReq, type JWT, type Listener, type ListenerKeys, type ListenerParams, type LiteralUnion, type NileSession, type NonErrorSession, type PartialAuthorizer, type ProviderType, type RedirectableProviderType, type SignInAuthorizationParams, type SignInOptions, type SignInResponse, type SignOutParams, type SignOutResponse, auth, broadcast, getCsrfToken, getProviders, getSession, getStatus, resetPassword, signIn, signOut, signUp };