mirror of
https://github.com/meteor/meteor.git
synced 2026-05-02 03:01:46 -04:00
Add types for accounts-base package
This commit is contained in:
Piotr Pośpiech
326
packages/accounts-base/accounts-base.d.ts
vendored
Normal file
326
packages/accounts-base/accounts-base.d.ts
vendored
Normal file
@@ -0,0 +1,326 @@
|
||||
import { Mongo } from 'meteor/mongo';
|
||||
import { Meteor } from 'meteor/meteor';
|
||||
|
||||
export interface URLS {
|
||||
resetPassword: (token: string) => string;
|
||||
verifyEmail: (token: string) => string;
|
||||
enrollAccount: (token: string) => string;
|
||||
}
|
||||
|
||||
export interface EmailFields {
|
||||
from?: ((user: Meteor.User) => string) | undefined;
|
||||
subject?: ((user: Meteor.User) => string) | undefined;
|
||||
text?: ((user: Meteor.User, url: string) => string) | undefined;
|
||||
html?: ((user: Meteor.User, url: string) => string) | undefined;
|
||||
}
|
||||
|
||||
export namespace Accounts {
|
||||
var urls: URLS;
|
||||
|
||||
function user(options?: {
|
||||
fields?: Mongo.FieldSpecifier | undefined;
|
||||
}): Meteor.User | null;
|
||||
|
||||
function userId(): string | null;
|
||||
|
||||
function createUser(
|
||||
options: {
|
||||
username?: string | undefined;
|
||||
email?: string | undefined;
|
||||
password?: string | undefined;
|
||||
profile?: Object | undefined;
|
||||
},
|
||||
callback?: (error?: Error | Meteor.Error | Meteor.TypedError) => void
|
||||
): string;
|
||||
|
||||
function config(options: {
|
||||
sendVerificationEmail?: boolean | undefined;
|
||||
forbidClientAccountCreation?: boolean | undefined;
|
||||
restrictCreationByEmailDomain?: string | Function | undefined;
|
||||
loginExpirationInDays?: number | undefined;
|
||||
oauthSecretKey?: string | undefined;
|
||||
passwordResetTokenExpirationInDays?: number | undefined;
|
||||
passwordEnrollTokenExpirationInDays?: number | undefined;
|
||||
ambiguousErrorMessages?: boolean | undefined;
|
||||
defaultFieldSelector?: { [key: string]: 0 | 1 } | undefined;
|
||||
}): void;
|
||||
|
||||
function onLogin(
|
||||
func: Function
|
||||
): {
|
||||
stop: () => void;
|
||||
};
|
||||
|
||||
function onLoginFailure(
|
||||
func: Function
|
||||
): {
|
||||
stop: () => void;
|
||||
};
|
||||
|
||||
function loginServicesConfigured(): boolean;
|
||||
|
||||
function onPageLoadLogin(func: Function): void;
|
||||
}
|
||||
|
||||
export namespace Accounts {
|
||||
function changePassword(
|
||||
oldPassword: string,
|
||||
newPassword: string,
|
||||
callback?: (error?: Error | Meteor.Error | Meteor.TypedError) => void
|
||||
): void;
|
||||
|
||||
function forgotPassword(
|
||||
options: { email?: string | undefined },
|
||||
callback?: (error?: Error | Meteor.Error | Meteor.TypedError) => void
|
||||
): void;
|
||||
|
||||
function resetPassword(
|
||||
token: string,
|
||||
newPassword: string,
|
||||
callback?: (error?: Error | Meteor.Error | Meteor.TypedError) => void
|
||||
): void;
|
||||
|
||||
function verifyEmail(
|
||||
token: string,
|
||||
callback?: (error?: Error | Meteor.Error | Meteor.TypedError) => void
|
||||
): void;
|
||||
|
||||
function onEmailVerificationLink(callback: Function): void;
|
||||
|
||||
function onEnrollmentLink(callback: Function): void;
|
||||
|
||||
function onResetPasswordLink(callback: Function): void;
|
||||
|
||||
function loggingIn(): boolean;
|
||||
|
||||
function loggingOut(): boolean;
|
||||
|
||||
function logout(
|
||||
callback?: (error?: Error | Meteor.Error | Meteor.TypedError) => void
|
||||
): void;
|
||||
|
||||
function logoutOtherClients(
|
||||
callback?: (error?: Error | Meteor.Error | Meteor.TypedError) => void
|
||||
): void;
|
||||
|
||||
var ui: {
|
||||
config(options: {
|
||||
requestPermissions?: Object | undefined;
|
||||
requestOfflineToken?: Object | undefined;
|
||||
forceApprovalPrompt?: Object | undefined;
|
||||
passwordSignupFields?: string | undefined;
|
||||
}): void;
|
||||
};
|
||||
}
|
||||
|
||||
export interface Header {
|
||||
[id: string]: string;
|
||||
}
|
||||
|
||||
export interface EmailTemplates {
|
||||
from: string;
|
||||
siteName: string;
|
||||
headers?: Header | undefined;
|
||||
resetPassword: EmailFields;
|
||||
enrollAccount: EmailFields;
|
||||
verifyEmail: EmailFields;
|
||||
}
|
||||
|
||||
export namespace Accounts {
|
||||
var emailTemplates: EmailTemplates;
|
||||
|
||||
function addEmail(userId: string, newEmail: string, verified?: boolean): void;
|
||||
|
||||
function removeEmail(userId: string, email: string): void;
|
||||
|
||||
function onCreateUser(
|
||||
func: (options: { profile?: {} | undefined }, user: Meteor.User) => void
|
||||
): void;
|
||||
|
||||
function findUserByEmail(
|
||||
email: string,
|
||||
options?: { fields?: Mongo.FieldSpecifier | undefined }
|
||||
): Meteor.User | null | undefined;
|
||||
|
||||
function findUserByUsername(
|
||||
username: string,
|
||||
options?: { fields?: Mongo.FieldSpecifier | undefined }
|
||||
): Meteor.User | null | undefined;
|
||||
|
||||
function sendEnrollmentEmail(
|
||||
userId: string,
|
||||
email?: string,
|
||||
extraTokenData?: Record<string, unknown>,
|
||||
extraParams?: Record<string, unknown>
|
||||
): void;
|
||||
|
||||
function sendResetPasswordEmail(
|
||||
userId: string,
|
||||
email?: string,
|
||||
extraTokenData?: Record<string, unknown>,
|
||||
extraParams?: Record<string, unknown>
|
||||
): void;
|
||||
|
||||
function sendVerificationEmail(
|
||||
userId: string,
|
||||
email?: string,
|
||||
extraTokenData?: Record<string, unknown>,
|
||||
extraParams?: Record<string, unknown>
|
||||
): void;
|
||||
|
||||
function setUsername(userId: string, newUsername: string): void;
|
||||
|
||||
function setPassword(
|
||||
userId: string,
|
||||
newPassword: string,
|
||||
options?: { logout?: Object | undefined }
|
||||
): void;
|
||||
|
||||
function validateNewUser(func: Function): boolean;
|
||||
|
||||
function validateLoginAttempt(
|
||||
func: Function
|
||||
): {
|
||||
stop: () => void;
|
||||
};
|
||||
|
||||
function _hashPassword(
|
||||
password: string
|
||||
): { digest: string; algorithm: string };
|
||||
|
||||
interface IValidateLoginAttemptCbOpts {
|
||||
type: string;
|
||||
allowed: boolean;
|
||||
error: Meteor.Error;
|
||||
user: Meteor.User;
|
||||
connection: Meteor.Connection;
|
||||
methodName: string;
|
||||
methodArguments: any[];
|
||||
}
|
||||
}
|
||||
|
||||
export namespace Accounts {
|
||||
function onLogout(func: Function): void;
|
||||
}
|
||||
|
||||
export namespace Accounts {
|
||||
function onLogout(
|
||||
func: (options: {
|
||||
user: Meteor.User;
|
||||
connection: Meteor.Connection;
|
||||
}) => void
|
||||
): void;
|
||||
}
|
||||
|
||||
export namespace Accounts {
|
||||
interface LoginMethodOptions {
|
||||
/**
|
||||
* The method to call (default 'login')
|
||||
*/
|
||||
methodName?: string | undefined;
|
||||
/**
|
||||
* The arguments for the method
|
||||
*/
|
||||
methodArguments?: any[] | undefined;
|
||||
/**
|
||||
* If provided, will be called with the result of the
|
||||
* method. If it throws, the client will not be logged in (and
|
||||
* its error will be passed to the callback).
|
||||
*/
|
||||
validateResult?: Function | undefined;
|
||||
/**
|
||||
* Will be called with no arguments once the user is fully
|
||||
* logged in, or with the error on error.
|
||||
*/
|
||||
userCallback?: ((err?: any) => void) | undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Call a login method on the server.
|
||||
*
|
||||
* A login method is a method which on success calls `this.setUserId(id)` and
|
||||
* `Accounts._setLoginToken` on the server and returns an object with fields
|
||||
* 'id' (containing the user id), 'token' (containing a resume token), and
|
||||
* optionally `tokenExpires`.
|
||||
*
|
||||
* This function takes care of:
|
||||
* - Updating the Meteor.loggingIn() reactive data source
|
||||
* - Calling the method in 'wait' mode
|
||||
* - On success, saving the resume token to localStorage
|
||||
* - On success, calling Accounts.connection.setUserId()
|
||||
* - Setting up an onReconnect handler which logs in with
|
||||
* the resume token
|
||||
*
|
||||
* Options:
|
||||
* - methodName: The method to call (default 'login')
|
||||
* - methodArguments: The arguments for the method
|
||||
* - validateResult: If provided, will be called with the result of the
|
||||
* method. If it throws, the client will not be logged in (and
|
||||
* its error will be passed to the callback).
|
||||
* - userCallback: Will be called with no arguments once the user is fully
|
||||
* logged in, or with the error on error.
|
||||
*
|
||||
* */
|
||||
function callLoginMethod(options: LoginMethodOptions): void;
|
||||
|
||||
/**
|
||||
*
|
||||
* The main entry point for auth packages to hook in to login.
|
||||
*
|
||||
* A login handler is a login method which can return `undefined` to
|
||||
* indicate that the login request is not handled by this handler.
|
||||
*
|
||||
* @param name {String} Optional. The service name, used by default
|
||||
* if a specific service name isn't returned in the result.
|
||||
*
|
||||
* @param handler {Function} A function that receives an options object
|
||||
* (as passed as an argument to the `login` method) and returns one of:
|
||||
* - `undefined`, meaning don't handle;
|
||||
* - a login method result object
|
||||
**/
|
||||
function registerLoginHandler(
|
||||
name: string,
|
||||
handler: (options: any) => undefined | Object
|
||||
): void;
|
||||
|
||||
type Password =
|
||||
| string
|
||||
| {
|
||||
digest: string;
|
||||
algorithm: 'sha-256';
|
||||
};
|
||||
|
||||
/**
|
||||
*
|
||||
* Check whether the provided password matches the bcrypt'ed password in
|
||||
* the database user record. `password` can be a string (in which case
|
||||
* it will be run through SHA256 before bcrypt) or an object with
|
||||
* properties `digest` and `algorithm` (in which case we bcrypt
|
||||
* `password.digest`).
|
||||
*/
|
||||
function _checkPassword(
|
||||
user: Meteor.User,
|
||||
password: Password
|
||||
): { userId: string; error?: any };
|
||||
}
|
||||
|
||||
export namespace Accounts {
|
||||
type StampedLoginToken = {
|
||||
token: string;
|
||||
when: Date;
|
||||
};
|
||||
type HashedStampedLoginToken = {
|
||||
hashedToken: string;
|
||||
when: Date;
|
||||
};
|
||||
|
||||
function _generateStampedLoginToken(): StampedLoginToken;
|
||||
function _hashStampedToken(token: StampedLoginToken): HashedStampedLoginToken;
|
||||
function _insertHashedLoginToken<T>(
|
||||
userId: string,
|
||||
token: HashedStampedLoginToken,
|
||||
query?: Mongo.Selector<T> | Mongo.ObjectID | string
|
||||
): void;
|
||||
function _hashLoginToken(token: string): string;
|
||||
}
|
||||
3
packages/accounts-base/package-types.json
Normal file
3
packages/accounts-base/package-types.json
Normal file
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"typesEntry": "__types/accounts-base.d.ts"
|
||||
}
|
||||
@@ -48,6 +48,8 @@ Package.onUse(api => {
|
||||
// modules that import the accounts-base package.
|
||||
api.mainModule('server_main.js', 'server');
|
||||
api.mainModule('client_main.js', 'client');
|
||||
|
||||
api.addAssets('accounts-base.d.ts', ['client', 'server']);
|
||||
});
|
||||
|
||||
Package.onTest(api => {
|
||||
|
||||
Reference in New Issue
Block a user