Skip to content

Add missing passwordHashAlgo to types #333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pwespi wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add missing passwordHashAlgo to types #333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions src/userbase-js/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,16 +128,25 @@ export type databaseNameXorIdXorShareToken = (

export type priceIdXorPlanId = ({ priceId?: string, planId?: never } | { planId?: string, priceId?: never });

export type PasswordHashAlgo = (
passwordArrayBuffer: Uint8Array,
salt: Uint8Array,
N: number,
r: number,
p: number,
dkLen: number
) => Promise<Uint8Array>;

export interface Userbase {
init(params: { appId: string, updateUserHandler?: UpdateUserHandler, sessionLength?: number, allowServerSideEncryption?: boolean }): Promise<Session>

signUp(params: { username: string, password: string, email?: string, profile?: UserProfile, rememberMe?: RememberMeOption, sessionLength?: number }): Promise<UserResult>
signUp(params: { username: string, password: string, email?: string, profile?: UserProfile, rememberMe?: RememberMeOption, sessionLength?: number, passwordHashAlgo?: PasswordHashAlgo }): Promise<UserResult>

signIn(params: { username: string, password: string, rememberMe?: RememberMeOption, sessionLength?: number }): Promise<UserResult>
signIn(params: { username: string, password: string, rememberMe?: RememberMeOption, sessionLength?: number, passwordHashAlgo?: PasswordHashAlgo }): Promise<UserResult>

signOut(): Promise<void>

updateUser(params: { username?: string, currentPassword?: string, newPassword?: string, email?: string | null | false | undefined, profile?: UserProfile | null | false | undefined }): Promise<void>
updateUser(params: { username?: string, currentPassword?: string, newPassword?: string, email?: string | null | false | undefined, profile?: UserProfile | null | false | undefined, passwordHashAlgo?: PasswordHashAlgo }): Promise<void>

deleteUser(): Promise<void>

Expand Down
20 changes: 20 additions & 0 deletions src/userbase-js/types/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,17 @@ const {
updatePaymentMethod,
} = userbase

const dummyPasswordHashAlgo = (
passwordArrayBuffer: Uint8Array,
salt: Uint8Array,
N: number,
r: number,
p: number,
dkLen: number
) => {
return Promise.resolve(new Uint8Array(0));
};

// TypeScript Version: 2.1

// $ExpectType Promise<Session>
Expand Down Expand Up @@ -61,6 +72,9 @@ signUp({ username: 'tuser', password: 'tpass', email: 'test@test.com', profile:
// $ExpectType Promise<UserResult>
signUp({ username: 'tuser', password: 'tpass', email: 'test@test.com', profile: { tkey: 'tval' }, rememberMe: 'none' })

// $ExpectType Promise<UserResult>
signUp({ username: 'tuser', password: 'tpass', email: 'test@test.com', profile: { tkey: 'tval' }, rememberMe: 'none', passwordHashAlgo: dummyPasswordHashAlgo })

// $ExpectError
signUp({ username: 'tuser', password: 'tpass', email: 'test@test.com', profile: { tkey: {} } })

Expand All @@ -82,6 +96,9 @@ signIn({ username: 'tuser', password: 'tpass' })
// $ExpectType Promise<UserResult>
signIn({ username: 'tuser', password: 'tpass', rememberMe: 'session' })

// $ExpectType Promise<UserResult>
signIn({ username: 'tuser', password: 'tpass', rememberMe: 'session', passwordHashAlgo: dummyPasswordHashAlgo })

// $ExpectError
signIn({ username: 'tuser' })

Expand All @@ -103,6 +120,9 @@ updateUser({ username: 'tusernew' })
// $ExpectType Promise<void>
updateUser({ currentPassword: 'tpasscurrent', newPassword: 'tpassnew' })

// $ExpectType Promise<void>
updateUser({ currentPassword: 'tpasscurrent', newPassword: 'tpassnew', passwordHashAlgo: dummyPasswordHashAlgo })

// $ExpectType Promise<void>
updateUser({ email: 'testnew@test.com' })

Expand Down