@niledatabase/server 5.0.0-alpha.1 → 5.0.0-alpha.3

package/dist/index.d.mts

@@ -32,6 +32,10 @@ declare class Config {
      */
     apiUrl: string;
     origin?: string | undefined | null;
+    /**
+     * important for separating the `origin` config value from a default in order to make requests
+     */
+    serverOrigin: string;
     debug?: boolean;
     /**
      * To use secure cookies or not in the fetch
@@ -65,6 +69,7 @@ type Routes = {
     VERIFY_REQUEST: string;
     PASSWORD_RESET: string;
     LOG: string;
+    VERIFY_EMAIL: string;
 };
 
 type Opts = {
@@ -143,6 +148,7 @@ type NileConfig = {
     /**
      * In some cases, you may want to force secure cookies.
      * The SDK handles this for you, but might be necessary in some firewall / internal cases
+     * Defaults to true if you're in production
      */
     secureCookies?: boolean;
     /**
@@ -150,6 +156,7 @@ type NileConfig = {
      * Allows the setting of the callback origin to a random FE
      * eg FE localhost:3001 -> BE: localhost:5432 would set to localhost:3001 to be sure nile-auth uses that.
      * In full stack cases, will just be the `host` header of the incoming request, which is used by default
+     * It is also important to set this when dealing with secure cookies. Calling via server side needs to know if TLS is being used so that nile-auth knows which cookies to be sent.
      */
     origin?: null | undefined | string;
     /**
@@ -303,6 +310,9 @@ type Tenant = {
 };
 
 type ProviderName = 'discord' | 'github' | 'google' | 'hubspot' | 'linkedin' | 'slack' | 'twitter' | 'email' | 'credentials' | 'azure';
+type Providers = {
+    [providerName in ProviderName]: Provider;
+};
 type Provider = {
     id: string;
     name: string;
@@ -334,10 +344,14 @@ type ActiveSession = {
 declare class Users {
     #private;
     constructor(config: Config);
-    updateSelf<T = User[] | Response>(req: Partial<Omit<User, 'email' | 'tenants' | 'created' | 'updated'>>, rawResponse?: boolean): Promise<T>;
+    updateSelf<T = User[] | Response>(req: Partial<Omit<User, 'email' | 'tenants' | 'created' | 'updated' | 'emailVerified'> & {
+        emailVerified: boolean;
+    }>, rawResponse?: boolean): Promise<T>;
     removeSelf(): Promise<Response>;
-    getSelf(rawResponse?: true): Promise<Response>;
     getSelf<T = User | Response>(): Promise<T>;
+    getSelf(rawResponse?: true): Promise<Response>;
+    verifySelf<T = Response | void>(): Promise<T>;
+    verifySelf(rawResponse?: true): Promise<Response>;
 }
 
 type ReqContext = {
@@ -359,25 +373,25 @@ declare class Tenants {
     delete<T = Response>(payload: {
         id: string;
     }): Promise<T>;
-    get(rawResponse: true): Promise<Response>;
     get<T = Tenant | Response>(id: string, rawResponse?: boolean): Promise<T>;
+    get(rawResponse: true): Promise<Response>;
     get<T = Tenant | Response>(payload: {
         id: string;
     }, rawResponse?: boolean): Promise<T>;
     update(req: Partial<Tenant>, rawResponse: true): Promise<Response>;
     update<T = Tenant | Response | undefined>(req: Partial<Tenant>, rawResponse?: boolean): Promise<T>;
-    list(rawResponse: true): Promise<Response>;
     list<T = Tenant[] | Response>(): Promise<T>;
+    list(rawResponse: true): Promise<Response>;
     leaveTenant<T = Response>(req?: string | {
         tenantId: string;
     }): Promise<T>;
     addMember(req: JoinTenantRequest, rawResponse: true): Promise<Response>;
     addMember<T = User | Response>(req: JoinTenantRequest, rawResponse?: boolean): Promise<T>;
     removeMember(req: JoinTenantRequest, rawResponse?: boolean): Promise<Response>;
-    users(req: boolean): Promise<Response>;
     users<T = User[] | Response>(req?: boolean | {
         tenantId?: string;
     }, rawResponse?: boolean): Promise<T>;
+    users(req: true): Promise<Response>;
 }
 
 type SignUpPayload = {
@@ -389,10 +403,10 @@ type SignUpPayload = {
 declare class Auth {
     #private;
     constructor(config: Config);
-    getSession(rawResponse: true): Promise<Response>;
     getSession<T = JWT | ActiveSession | undefined>(rawResponse?: false): Promise<T>;
-    getCsrf(rawResponse: true): Promise<Response>;
+    getSession(rawResponse: true): Promise<Response>;
     getCsrf<T = Response | JSON>(rawResponse?: false): Promise<T>;
+    getCsrf(rawResponse: true): Promise<Response>;
     listProviders(rawResponse: true): Promise<Response>;
     listProviders<T = {
         [key: string]: Provider;
@@ -405,13 +419,25 @@ declare class Auth {
      */
     signUp(payload: SignUpPayload, rawResponse: true): Promise<Response>;
     signUp<T = User | Response>(payload: SignUpPayload): Promise<T>;
+    forgotPassword(req: {
+        email: string;
+        callbackUrl?: string;
+        redirectUrl?: string;
+    }): Promise<Response>;
+    resetPassword(req: Request | {
+        email: string;
+        password: string;
+        callbackUrl?: string;
+        redirectUrl?: string;
+    }): Promise<Response>;
+    callback(provider: ProviderName, body?: string | Request): Promise<Response>;
     /**
      * The return value from this will be a redirect for the client
      * In most cases, you should forward the response directly to the client
      * @param payload
      * @param rawResponse
      */
-    signIn<T = Response>(provider: ProviderName, payload?: {
+    signIn<T = Response>(provider: ProviderName, payload?: Request | {
         email: string;
         password: string;
     }, rawResponse?: true): Promise<T>;
@@ -484,4 +510,4 @@ declare class Server {
 }
 declare function create(config?: NileConfig): Server;
 
-export { type APIError, APIErrorErrorCodeEnum, type ActiveSession, type AfterCreate, type CreateBasicUserRequest, type CreateTenantUserRequest, type JWT, type LoggerType, type LoginUserResponse, type LoginUserResponseToken, LoginUserResponseTokenTypeEnum, create as Nile, type NileConfig, type NileDb, type NilePoolConfig, type NileRequest, type NileResponse, type Opts, Server, type Tenant, type User, parseCSRF, parseCallback, parseToken };
+export { type APIError, APIErrorErrorCodeEnum, type ActiveSession, type AfterCreate, type CreateBasicUserRequest, type CreateTenantUserRequest, type JWT, type LoggerType, type LoginUserResponse, type LoginUserResponseToken, LoginUserResponseTokenTypeEnum, create as Nile, type NileConfig, type NileDb, type NilePoolConfig, type NileRequest, type NileResponse, type Opts, type Providers, Server, type Tenant, type User, parseCSRF, parseCallback, parseToken };

package/dist/index.d.ts

@@ -32,6 +32,10 @@ declare class Config {
      */
     apiUrl: string;
     origin?: string | undefined | null;
+    /**
+     * important for separating the `origin` config value from a default in order to make requests
+     */
+    serverOrigin: string;
     debug?: boolean;
     /**
      * To use secure cookies or not in the fetch
@@ -65,6 +69,7 @@ type Routes = {
     VERIFY_REQUEST: string;
     PASSWORD_RESET: string;
     LOG: string;
+    VERIFY_EMAIL: string;
 };
 
 type Opts = {
@@ -143,6 +148,7 @@ type NileConfig = {
     /**
      * In some cases, you may want to force secure cookies.
      * The SDK handles this for you, but might be necessary in some firewall / internal cases
+     * Defaults to true if you're in production
      */
     secureCookies?: boolean;
     /**
@@ -150,6 +156,7 @@ type NileConfig = {
      * Allows the setting of the callback origin to a random FE
      * eg FE localhost:3001 -> BE: localhost:5432 would set to localhost:3001 to be sure nile-auth uses that.
      * In full stack cases, will just be the `host` header of the incoming request, which is used by default
+     * It is also important to set this when dealing with secure cookies. Calling via server side needs to know if TLS is being used so that nile-auth knows which cookies to be sent.
      */
     origin?: null | undefined | string;
     /**
@@ -303,6 +310,9 @@ type Tenant = {
 };
 
 type ProviderName = 'discord' | 'github' | 'google' | 'hubspot' | 'linkedin' | 'slack' | 'twitter' | 'email' | 'credentials' | 'azure';
+type Providers = {
+    [providerName in ProviderName]: Provider;
+};
 type Provider = {
     id: string;
     name: string;
@@ -334,10 +344,14 @@ type ActiveSession = {
 declare class Users {
     #private;
     constructor(config: Config);
-    updateSelf<T = User[] | Response>(req: Partial<Omit<User, 'email' | 'tenants' | 'created' | 'updated'>>, rawResponse?: boolean): Promise<T>;
+    updateSelf<T = User[] | Response>(req: Partial<Omit<User, 'email' | 'tenants' | 'created' | 'updated' | 'emailVerified'> & {
+        emailVerified: boolean;
+    }>, rawResponse?: boolean): Promise<T>;
     removeSelf(): Promise<Response>;
-    getSelf(rawResponse?: true): Promise<Response>;
     getSelf<T = User | Response>(): Promise<T>;
+    getSelf(rawResponse?: true): Promise<Response>;
+    verifySelf<T = Response | void>(): Promise<T>;
+    verifySelf(rawResponse?: true): Promise<Response>;
 }
 
 type ReqContext = {
@@ -359,25 +373,25 @@ declare class Tenants {
     delete<T = Response>(payload: {
         id: string;
     }): Promise<T>;
-    get(rawResponse: true): Promise<Response>;
     get<T = Tenant | Response>(id: string, rawResponse?: boolean): Promise<T>;
+    get(rawResponse: true): Promise<Response>;
     get<T = Tenant | Response>(payload: {
         id: string;
     }, rawResponse?: boolean): Promise<T>;
     update(req: Partial<Tenant>, rawResponse: true): Promise<Response>;
     update<T = Tenant | Response | undefined>(req: Partial<Tenant>, rawResponse?: boolean): Promise<T>;
-    list(rawResponse: true): Promise<Response>;
     list<T = Tenant[] | Response>(): Promise<T>;
+    list(rawResponse: true): Promise<Response>;
     leaveTenant<T = Response>(req?: string | {
         tenantId: string;
     }): Promise<T>;
     addMember(req: JoinTenantRequest, rawResponse: true): Promise<Response>;
     addMember<T = User | Response>(req: JoinTenantRequest, rawResponse?: boolean): Promise<T>;
     removeMember(req: JoinTenantRequest, rawResponse?: boolean): Promise<Response>;
-    users(req: boolean): Promise<Response>;
     users<T = User[] | Response>(req?: boolean | {
         tenantId?: string;
     }, rawResponse?: boolean): Promise<T>;
+    users(req: true): Promise<Response>;
 }
 
 type SignUpPayload = {
@@ -389,10 +403,10 @@ type SignUpPayload = {
 declare class Auth {
     #private;
     constructor(config: Config);
-    getSession(rawResponse: true): Promise<Response>;
     getSession<T = JWT | ActiveSession | undefined>(rawResponse?: false): Promise<T>;
-    getCsrf(rawResponse: true): Promise<Response>;
+    getSession(rawResponse: true): Promise<Response>;
     getCsrf<T = Response | JSON>(rawResponse?: false): Promise<T>;
+    getCsrf(rawResponse: true): Promise<Response>;
     listProviders(rawResponse: true): Promise<Response>;
     listProviders<T = {
         [key: string]: Provider;
@@ -405,13 +419,25 @@ declare class Auth {
      */
     signUp(payload: SignUpPayload, rawResponse: true): Promise<Response>;
     signUp<T = User | Response>(payload: SignUpPayload): Promise<T>;
+    forgotPassword(req: {
+        email: string;
+        callbackUrl?: string;
+        redirectUrl?: string;
+    }): Promise<Response>;
+    resetPassword(req: Request | {
+        email: string;
+        password: string;
+        callbackUrl?: string;
+        redirectUrl?: string;
+    }): Promise<Response>;
+    callback(provider: ProviderName, body?: string | Request): Promise<Response>;
     /**
      * The return value from this will be a redirect for the client
      * In most cases, you should forward the response directly to the client
      * @param payload
      * @param rawResponse
      */
-    signIn<T = Response>(provider: ProviderName, payload?: {
+    signIn<T = Response>(provider: ProviderName, payload?: Request | {
         email: string;
         password: string;
     }, rawResponse?: true): Promise<T>;
@@ -484,4 +510,4 @@ declare class Server {
 }
 declare function create(config?: NileConfig): Server;
 
-export { type APIError, APIErrorErrorCodeEnum, type ActiveSession, type AfterCreate, type CreateBasicUserRequest, type CreateTenantUserRequest, type JWT, type LoggerType, type LoginUserResponse, type LoginUserResponseToken, LoginUserResponseTokenTypeEnum, create as Nile, type NileConfig, type NileDb, type NilePoolConfig, type NileRequest, type NileResponse, type Opts, Server, type Tenant, type User, parseCSRF, parseCallback, parseToken };
+export { type APIError, APIErrorErrorCodeEnum, type ActiveSession, type AfterCreate, type CreateBasicUserRequest, type CreateTenantUserRequest, type JWT, type LoggerType, type LoginUserResponse, type LoginUserResponseToken, LoginUserResponseTokenTypeEnum, create as Nile, type NileConfig, type NileDb, type NilePoolConfig, type NileRequest, type NileResponse, type Opts, type Providers, Server, type Tenant, type User, parseCSRF, parseCallback, parseToken };