@nymphjs/tilmeld-client 1.0.0-beta.10 → 1.0.0-beta.101

package/dist/User.d.ts

@@ -0,0 +1,257 @@
+import { Nymph, Entity } from '@nymphjs/client';
+import type Group from './Group.js';
+import type { AdminGroupData, CurrentGroupData } from './Group.js';
+export type EventType = 'register' | 'login' | 'logout';
+export type RegisterCallback = (user: User & CurrentUserData) => void;
+export type LoginCallback = (user: User & CurrentUserData) => void;
+export type LogoutCallback = (user: User & UserData) => void;
+export type ClientConfig = {
+    regFields: string[];
+    userFields: string[];
+    emailUsernames: boolean;
+    allowRegistration: boolean;
+    allowUsernameChange: boolean;
+    pwRecovery: boolean;
+    verifyEmail: boolean;
+    unverifiedAccess: boolean;
+};
+export type UserData = {
+    /**
+     * The user's username.
+     */
+    username?: string;
+    /**
+     * The user's first name.
+     */
+    nameFirst?: string;
+    /**
+     * The user's middle name.
+     */
+    nameMiddle?: string;
+    /**
+     * The user's last name.
+     */
+    nameLast?: string;
+    /**
+     * The user's full name.
+     */
+    name?: string;
+    /**
+     * The user's avatar URL. (Use $getAvatar() to support Gravatar.)
+     */
+    avatar?: string;
+    /**
+     * Whether the user can log in.
+     */
+    enabled?: boolean;
+};
+export type CurrentUserData = UserData & {
+    /**
+     * The abilities granted to the user.
+     */
+    abilities?: string[];
+    /**
+     * The user's email address.
+     */
+    email?: string;
+    /**
+     * The user's telephone number.
+     */
+    phone?: string;
+    /**
+     * The user's primary group.
+     */
+    group?: Group & CurrentGroupData;
+    /**
+     * The user's secondary groups.
+     */
+    groups?: (Group & CurrentGroupData)[];
+    /**
+     * Whether the user should inherit the abilities of his groups.
+     */
+    inheritAbilities?: boolean;
+    /**
+     * If the user has changed their email address, this is the new one, awaiting
+     * verification.
+     */
+    newEmailAddress?: string;
+};
+export type AdminUserData = CurrentUserData & {
+    /**
+     * The user's primary group.
+     */
+    group?: Group & AdminGroupData;
+    /**
+     * The user's secondary groups.
+     */
+    groups?: (Group & AdminGroupData)[];
+    /**
+     * A verification secret.
+     */
+    secret?: string;
+    /**
+     * The timestamp of when the email address was last changed.
+     */
+    emailChangeDate?: number;
+    /**
+     * An email change proceed secret.
+     */
+    newEmailSecret?: string;
+    /**
+     * The new email address.
+     */
+    newEmailAddress?: string;
+    /**
+     * An email change cancellation secret.
+     */
+    cancelEmailSecret?: string;
+    /**
+     * The old email address.
+     */
+    cancelEmailAddress?: string;
+    /**
+     * A recovery secret.
+     */
+    recoverSecret?: string;
+    /**
+     * The timestamp of when the recovery secret was issued.
+     */
+    recoverSecretDate?: number;
+    /**
+     * Used by admins to change a user's password. Not saved to the database.
+     */
+    passwordTemp?: string;
+    /**
+     * If set, this timestamp is the cutoff point for JWT issue dates. Any token
+     * issued before this date will not authenticate the user.
+     */
+    revokeTokenDate?: number;
+};
+type InstanceStore = {
+    registerCallbacks: RegisterCallback[];
+    loginCallbacks: LoginCallback[];
+    logoutCallbacks: LogoutCallback[];
+    clientConfig?: ClientConfig;
+    clientConfigPromise?: Promise<ClientConfig>;
+    removeNymphResponseListener?: () => void;
+    currentToken?: string;
+};
+export default class User extends Entity<UserData> {
+    protected static stores: WeakMap<Nymph, InstanceStore>;
+    static class: string;
+    static init(nymph: Nymph): void;
+    static factoryUsername(username?: string): Promise<User & UserData>;
+    static getDomainUsers(domain: string, options?: {
+        limit?: number;
+        offset?: number;
+        sort?: string;
+        reverse?: boolean;
+    }): Promise<(User & UserData)[]>;
+    constructor();
+    $checkUsername(): Promise<{
+        result: boolean;
+        message: string;
+    }>;
+    $checkEmail(): Promise<{
+        result: boolean;
+        message: string;
+    }>;
+    $checkPhone(): Promise<{
+        result: boolean;
+        message: string;
+    }>;
+    $getAvatar(): Promise<string>;
+    $register(data: {
+        password: string;
+        additionalData?: {
+            [k: string]: any;
+        };
+    }): Promise<{
+        result: boolean;
+        loggedin: boolean;
+        message: string;
+    }>;
+    $switchUser(data?: {
+        additionalData?: {
+            [k: string]: any;
+        };
+    }): Promise<{
+        result: boolean;
+        message: string;
+    }>;
+    $logout(): Promise<{
+        result: boolean;
+        message: string;
+    }>;
+    $gatekeeper(ability?: string): Promise<boolean>;
+    $changePassword(data: {
+        newPassword: string;
+        currentPassword: string;
+        revokeCurrentTokens?: boolean;
+    }): Promise<{
+        result: boolean;
+        message: string;
+    }>;
+    $revokeCurrentTokens(data: {
+        password: string;
+    }): Promise<{
+        result: boolean;
+        message: string;
+    }>;
+    $hasTOTPSecret(): Promise<boolean>;
+    $getNewTOTPSecret(): Promise<{
+        uri: string;
+        qrcode: string;
+        secret: string;
+    }>;
+    $saveTOTPSecret(data: {
+        password: string;
+        secret: string;
+        code: string;
+    }): Promise<{
+        result: boolean;
+        message: string;
+    }>;
+    $removeTOTPSecret(data?: {
+        password: string;
+        code: string;
+    }): Promise<{
+        result: boolean;
+        message: string;
+    }>;
+    static current(returnObjectIfNotExist: true): Promise<User & CurrentUserData>;
+    static current(returnObjectIfNotExist?: false): Promise<(User & CurrentUserData) | null>;
+    static loginUser(data: {
+        username: string;
+        password: string;
+        code?: string;
+        additionalData?: {
+            [k: string]: any;
+        };
+    }): Promise<{
+        result: boolean;
+        message: string;
+        needTOTP?: true;
+        user?: User & CurrentUserData;
+    }>;
+    static sendRecovery(data: {
+        recoveryType: 'username' | 'password';
+        account: string;
+    }): Promise<{
+        result: boolean;
+        message: string;
+    }>;
+    static recover(data: {
+        username: string;
+        secret: string;
+        password: string;
+    }): Promise<{
+        result: boolean;
+        message: string;
+    }>;
+    static getClientConfig(): Promise<ClientConfig>;
+    private static handleToken;
+    static on<T extends EventType>(event: T, callback: T extends 'register' ? RegisterCallback : T extends 'login' ? LoginCallback : T extends 'logout' ? LogoutCallback : never): () => boolean;
+    static off<T extends EventType>(event: T, callback: T extends 'register' ? RegisterCallback : T extends 'login' ? LoginCallback : T extends 'logout' ? LogoutCallback : never): boolean;
+}
+export {};

package/dist/User.js

@@ -0,0 +1,263 @@
+import { Entity } from '@nymphjs/client';
+export default class User extends Entity {
+    static stores = new WeakMap();
+    // The name of the server class
+    static class = 'User';
+    static init(nymph) {
+        let store = {
+            registerCallbacks: [],
+            loginCallbacks: [],
+            logoutCallbacks: [],
+        };
+        if (User.stores.has(nymph)) {
+            const storeVal = User.stores.get(nymph);
+            if (storeVal) {
+                store = storeVal;
+            }
+        }
+        User.stores.set(nymph, store);
+        if (store.removeNymphResponseListener) {
+            store.removeNymphResponseListener();
+        }
+        store.removeNymphResponseListener = nymph.on('response', (response) => this.handleToken(response));
+        this.handleToken();
+    }
+    static async factoryUsername(username) {
+        const entity = new this();
+        if (username != null) {
+            const entity = await this.nymph.getEntity({
+                class: this,
+            }, {
+                type: '&',
+                ilike: ['username', username.replace(/([\\%_])/g, (s) => `\\${s}`)],
+            });
+            if (entity != null) {
+                return entity;
+            }
+        }
+        return entity;
+    }
+    static async getDomainUsers(domain, options) {
+        return await this.serverCallStatic('getDomainUsers', [domain, options]);
+    }
+    constructor() {
+        super();
+        this.$data.enabled = true;
+        this.$data.abilities = [];
+        this.$data.groups = [];
+        this.$data.inheritAbilities = true;
+    }
+    async $checkUsername() {
+        return await this.$serverCall('$checkUsername', [], true);
+    }
+    async $checkEmail() {
+        return await this.$serverCall('$checkEmail', [], true);
+    }
+    async $checkPhone() {
+        return await this.$serverCall('$checkPhone', [], true);
+    }
+    async $getAvatar() {
+        return await this.$serverCall('$getAvatar', [], true);
+    }
+    async $register(data) {
+        const store = User.stores.get(this.$nymph);
+        if (store == null) {
+            throw new Error('This user class was never initialized with an instance of Nymph');
+        }
+        const response = await this.$serverCall('$register', [data]);
+        if (response.result) {
+            for (let i = 0; i < store.registerCallbacks.length; i++) {
+                store.registerCallbacks[i] && store.registerCallbacks[i](this);
+            }
+        }
+        if (response.loggedin) {
+            this.constructor.handleToken();
+            for (let i = 0; i < store.loginCallbacks.length; i++) {
+                store.loginCallbacks[i] && store.loginCallbacks[i](this);
+            }
+        }
+        return response;
+    }
+    async $switchUser(data) {
+        const store = User.stores.get(this.$nymph);
+        if (store == null) {
+            throw new Error('This user class was never initialized with an instance of Nymph');
+        }
+        const response = await this.$serverCall('$switchUser', [data]);
+        if (response.result) {
+            this.constructor.handleToken();
+            for (let i = 0; i < store.loginCallbacks.length; i++) {
+                store.loginCallbacks[i] && store.loginCallbacks[i](this);
+            }
+        }
+        return response;
+    }
+    async $logout() {
+        const store = User.stores.get(this.$nymph);
+        if (store == null) {
+            throw new Error('This user class was never initialized with an instance of Nymph');
+        }
+        const response = await this.$serverCall('$logout', []);
+        if (response.result) {
+            this.constructor.handleToken();
+            for (let i = 0; i < store.logoutCallbacks.length; i++) {
+                store.logoutCallbacks[i] && store.logoutCallbacks[i](this);
+            }
+        }
+        return response;
+    }
+    async $gatekeeper(ability) {
+        return await this.$serverCall('$gatekeeper', [ability], true);
+    }
+    async $changePassword(data) {
+        return await this.$serverCall('$changePassword', [data]);
+    }
+    async $revokeCurrentTokens(data) {
+        return await this.$serverCall('$revokeCurrentTokens', [data]);
+    }
+    async $hasTOTPSecret() {
+        return await this.$serverCall('$hasTOTPSecret', [], true);
+    }
+    async $getNewTOTPSecret() {
+        return await this.$serverCall('$getNewTOTPSecret', [], true);
+    }
+    async $saveTOTPSecret(data) {
+        return await this.$serverCall('$saveTOTPSecret', [data]);
+    }
+    async $removeTOTPSecret(data) {
+        return await this.$serverCall('$removeTOTPSecret', [
+            ...(data ? [data] : []),
+        ]);
+    }
+    static async current(returnObjectIfNotExist) {
+        const currentUser = await this.serverCallStatic('current', [false]);
+        if (currentUser == null) {
+            return returnObjectIfNotExist ? this.factorySync() : null;
+        }
+        return currentUser;
+    }
+    static async loginUser(data) {
+        const store = User.stores.get(this.nymph);
+        if (store == null) {
+            throw new Error('This user class was never initialized with an instance of Nymph');
+        }
+        const response = await this.serverCallStatic('loginUser', [data]);
+        if (response.result) {
+            this.handleToken();
+            for (let i = 0; i < store.loginCallbacks.length; i++) {
+                store.loginCallbacks[i] && store.loginCallbacks[i](response.user);
+            }
+        }
+        return response;
+    }
+    static async sendRecovery(data) {
+        return await this.serverCallStatic('sendRecovery', [data]);
+    }
+    static async recover(data) {
+        return await this.serverCallStatic('recover', [data]);
+    }
+    static async getClientConfig() {
+        const store = User.stores.get(this.nymph);
+        if (store == null) {
+            throw new Error('This user class was never initialized with an instance of Nymph');
+        }
+        if (store.clientConfig) {
+            return store.clientConfig;
+        }
+        if (!store.clientConfigPromise) {
+            store.clientConfigPromise = this.serverCallStatic('getClientConfig', []).then((config) => {
+                store.clientConfig = config;
+                store.clientConfigPromise = undefined;
+                return config;
+            });
+        }
+        return await store.clientConfigPromise;
+    }
+    static handleToken(response) {
+        const store = User.stores.get(this.nymph);
+        if (store == null) {
+            throw new Error('This user class was never initialized with an instance of Nymph');
+        }
+        let token = null;
+        let switchToken = null;
+        let hasNoCookie = typeof document === 'undefined' || typeof document.cookie === 'undefined';
+        const authCookiePattern = /(?:(?:^|.*;\s*)TILMELDAUTH\s*=\s*([^;]*).*$)|^.*$/;
+        const switchCookiePattern = /(?:(?:^|.*;\s*)TILMELDSWITCH\s*=\s*([^;]*).*$)|^.*$/;
+        if (response && response.headers.has('X-TILMELDAUTH')) {
+            token = response.headers.get('X-TILMELDAUTH');
+            switchToken = response.headers.get('X-TILMELDSWITCH');
+        }
+        else if (typeof document !== 'undefined' &&
+            document.cookie.match(authCookiePattern)) {
+            token = document.cookie.replace(authCookiePattern, '$1');
+            switchToken = document.cookie.replace(switchCookiePattern, '$1');
+        }
+        else {
+            return;
+        }
+        if (store.currentToken != token) {
+            if (token == null || token === '') {
+                if (store.currentToken != null) {
+                    delete this.nymph.headers['X-Xsrf-Token'];
+                    delete this.nymph.headers['X-TILMELDAUTH'];
+                    delete this.nymph.headers['X-TILMELDSWITCH'];
+                    if (this.nymph.pubsub) {
+                        this.nymph.pubsub.authenticate(null);
+                    }
+                    delete store.currentToken;
+                }
+            }
+            else {
+                const base64Url = token.split('.')[1];
+                const base64 = base64Url.replace(/-/g, '+').replace(/_/g, '/');
+                const json = typeof atob === 'undefined'
+                    ? Buffer.from(base64, 'base64').toString('binary') // node
+                    : atob(base64); // browser
+                const jwt = JSON.parse(json);
+                this.nymph.headers['X-Xsrf-Token'] = jwt.xsrfToken;
+                if (hasNoCookie) {
+                    this.nymph.headers['X-TILMELDAUTH'] = token;
+                    delete this.nymph.headers['X-TILMELDSWITCH'];
+                    if (switchToken != null) {
+                        this.nymph.headers['X-TILMELDSWITCH'] = switchToken;
+                    }
+                }
+                if (this.nymph.pubsub) {
+                    this.nymph.pubsub.authenticate(token, switchToken);
+                }
+                store.currentToken = token;
+            }
+        }
+    }
+    static on(event, callback) {
+        const store = User.stores.get(this.nymph);
+        if (store == null) {
+            throw new Error('This user class was never initialized with an instance of Nymph');
+        }
+        const prop = (event + 'Callbacks');
+        if (!(prop in store)) {
+            throw new Error('Invalid event type.');
+        }
+        // @ts-ignore: The callback should always be the right type here.
+        store[prop].push(callback);
+        return () => this.off(event, callback);
+    }
+    static off(event, callback) {
+        const store = User.stores.get(this.nymph);
+        if (store == null) {
+            throw new Error('This user class was never initialized with an instance of Nymph');
+        }
+        const prop = (event + 'Callbacks');
+        if (!(prop in store)) {
+            return false;
+        }
+        // @ts-ignore: The callback should always be the right type here.
+        const i = store[prop].indexOf(callback);
+        if (i > -1) {
+            // @ts-ignore: The callback should always be the right type here.
+            store[prop].splice(i, 1);
+        }
+        return true;
+    }
+}
+//# sourceMappingURL=User.js.map

package/dist/User.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"User.js","sourceRoot":"","sources":["../src/User.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAmJhD,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,MAAgB;IACtC,MAAM,CAAC,MAAM,GAAG,IAAI,OAAO,EAAwB,CAAC;IAE9D,+BAA+B;IACxB,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC;IAEtB,MAAM,CAAC,IAAI,CAAC,KAAY;QAC7B,IAAI,KAAK,GAAkB;YACzB,iBAAiB,EAAE,EAAE;YACrB,cAAc,EAAE,EAAE;YAClB,eAAe,EAAE,EAAE;SACpB,CAAC;QAEF,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAExC,IAAI,QAAQ,EAAE,CAAC;gBACb,KAAK,GAAG,QAAQ,CAAC;YACnB,CAAC;QACH,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAE9B,IAAI,KAAK,CAAC,2BAA2B,EAAE,CAAC;YACtC,KAAK,CAAC,2BAA2B,EAAE,CAAC;QACtC,CAAC;QACD,KAAK,CAAC,2BAA2B,GAAG,KAAK,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE,CACpE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAC3B,CAAC;QACF,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,QAAiB;QAC5C,MAAM,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QAC1B,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACrB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CACvC;gBACE,KAAK,EAAE,IAAI;aACZ,EACD;gBACE,IAAI,EAAE,GAAG;gBACT,KAAK,EAAE,CAAC,UAAU,EAAE,QAAQ,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;aACpE,CACF,CAAC;YACF,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;gBACnB,OAAO,MAAM,CAAC;YAChB,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,cAAc,CACzB,MAAc,EACd,OAKC;QAED,OAAO,MAAM,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED;QACE,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,KAAyB,CAAC,SAAS,GAAG,EAAE,CAAC;QAC9C,IAAI,CAAC,KAAyB,CAAC,MAAM,GAAG,EAAE,CAAC;QAC3C,IAAI,CAAC,KAAyB,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAC1D,CAAC;IAEM,KAAK,CAAC,cAAc;QAIzB,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;IAC5D,CAAC;IAEM,KAAK,CAAC,WAAW;QAItB,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;IACzD,CAAC;IAEM,KAAK,CAAC,WAAW;QAItB,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;IACzD,CAAC;IAEM,KAAK,CAAC,UAAU;QACrB,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;IACxD,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,IAGtB;QACC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3C,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAC;QACJ,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7D,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;YACpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACxD,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACjE,CAAC;QACH,CAAC;QACD,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;YACrB,IAAI,CAAC,WAA2B,CAAC,WAAW,EAAE,CAAC;YAChD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACrD,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,IAExB;QAIC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3C,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAC;QACJ,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAC/D,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;YACnB,IAAI,CAAC,WAA2B,CAAC,WAAW,EAAE,CAAC;YAChD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACrD,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,OAAO;QAClB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3C,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAC;QACJ,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QACvD,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;YACnB,IAAI,CAAC,WAA2B,CAAC,WAAW,EAAE,CAAC;YAChD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACtD,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAC7D,CAAC;QACH,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,OAAgB;QACvC,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,IAI5B;QACC,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,IAEjC;QACC,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,sBAAsB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,cAAc;QACzB,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;IAC5D,CAAC;IAEM,KAAK,CAAC,iBAAiB;QAK5B,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,mBAAmB,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;IAC/D,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,IAI5B;QACC,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,IAG9B;QACC,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,mBAAmB,EAAE;YACjD,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SACxB,CAAC,CAAC;IACL,CAAC;IAQM,MAAM,CAAC,KAAK,CAAC,OAAO,CACzB,sBAAgC;QAEhC,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QACpE,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;YACxB,OAAO,sBAAsB,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5D,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,IAK7B;QAMC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAC;QACJ,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAClE,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;YACpB,IAAI,CAAC,WAAW,EAAE,CAAC;YACnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACrD,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACpE,CAAC;QACH,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAGhC;QACC,OAAO,MAAM,IAAI,CAAC,gBAAgB,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7D,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAI3B;QACC,OAAO,MAAM,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IACxD,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe;QACjC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAC;QACJ,CAAC;QAED,IAAI,KAAK,CAAC,YAAY,EAAE,CAAC;YACvB,OAAO,KAAK,CAAC,YAAY,CAAC;QAC5B,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,mBAAmB,EAAE,CAAC;YAC/B,KAAK,CAAC,mBAAmB,GAAG,IAAI,CAAC,gBAAgB,CAC/C,iBAAiB,EACjB,EAAE,CACH,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;gBAChB,KAAK,CAAC,YAAY,GAAG,MAAM,CAAC;gBAC5B,KAAK,CAAC,mBAAmB,GAAG,SAAS,CAAC;gBACtC,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC,CAAC;QACL,CAAC;QACD,OAAO,MAAM,KAAK,CAAC,mBAAmB,CAAC;IACzC,CAAC;IAEO,MAAM,CAAC,WAAW,CAAC,QAAmB;QAC5C,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAE1C,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAC;QACJ,CAAC;QAED,IAAI,KAAK,GAAkB,IAAI,CAAC;QAChC,IAAI,WAAW,GAAkB,IAAI,CAAC;QACtC,IAAI,WAAW,GACb,OAAO,QAAQ,KAAK,WAAW,IAAI,OAAO,QAAQ,CAAC,MAAM,KAAK,WAAW,CAAC;QAC5E,MAAM,iBAAiB,GACrB,mDAAmD,CAAC;QACtD,MAAM,mBAAmB,GACvB,qDAAqD,CAAC;QACxD,IAAI,QAAQ,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC;YACtD,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;YAC9C,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QACxD,CAAC;aAAM,IACL,OAAO,QAAQ,KAAK,WAAW;YAC/B,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,EACxC,CAAC;YACD,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;YACzD,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;QACnE,CAAC;aAAM,CAAC;YACN,OAAO;QACT,CAAC;QACD,IAAI,KAAK,CAAC,YAAY,IAAI,KAAK,EAAE,CAAC;YAChC,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;gBAClC,IAAI,KAAK,CAAC,YAAY,IAAI,IAAI,EAAE,CAAC;oBAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;oBAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;oBAC3C,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;oBAC7C,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;wBACtB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;oBACvC,CAAC;oBACD,OAAO,KAAK,CAAC,YAAY,CAAC;gBAC5B,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBACtC,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBAC/D,MAAM,IAAI,GACR,OAAO,IAAI,KAAK,WAAW;oBACzB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,OAAO;oBAC1D,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU;gBAC9B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC7B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,GAAG,CAAC,SAAS,CAAC;gBACnD,IAAI,WAAW,EAAE,CAAC;oBAChB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC;oBAC5C,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;oBAC7C,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;wBACxB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,GAAG,WAAW,CAAC;oBACtD,CAAC;gBACH,CAAC;gBACD,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;oBACtB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;gBACrD,CAAC;gBACD,KAAK,CAAC,YAAY,GAAG,KAAK,CAAC;YAC7B,CAAC;QACH,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,EAAE,CACd,KAAQ,EACR,QAMa;QAEb,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,CAAC,KAAK,GAAG,WAAW,CAMpB,CAAC;QACd,IAAI,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,CAAC;QACD,iEAAiE;QACjE,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3B,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACzC,CAAC;IAEM,MAAM,CAAC,GAAG,CACf,KAAQ,EACR,QAMa;QAEb,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,CAAC,KAAK,GAAG,WAAW,CAMpB,CAAC;QACd,IAAI,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;YACrB,OAAO,KAAK,CAAC;QACf,CAAC;QACD,iEAAiE;QACjE,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACxC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YACX,iEAAiE;YACjE,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC"}

package/dist/helpers.d.ts

@@ -0,0 +1,58 @@
+import type UserClass from './User.js';
+import type { ClientConfig, CurrentUserData } from './User.js';
+export type RegistrationDetails = {
+    /**
+     * New user's username.
+     */
+    username: string;
+    /**
+     * New user's password.
+     */
+    password: string;
+    /**
+     * Repeat the password.
+     */
+    password2: string;
+    /**
+     * Whether the username passed verification.
+     */
+    usernameVerified: boolean;
+    /**
+     * The new user's email address.
+     */
+    email?: string;
+    /**
+     * The new user's given name.
+     */
+    nameFirst?: string;
+    /**
+     * The new user's surname.
+     */
+    nameLast?: string;
+    /**
+     * The new user's phone number.
+     */
+    phone?: string;
+    /**
+     * Additional data to be included in the request.
+     */
+    additionalData?: {
+        [k: string]: any;
+    };
+};
+export declare class NeedTOTPError extends Error {
+}
+export declare function login(User: typeof UserClass, username: string, password: string, code?: string, additionalData?: {
+    [k: string]: any;
+}): Promise<{
+    message: string;
+    user?: UserClass & CurrentUserData;
+}>;
+export declare function register(User: typeof UserClass, userDetails: RegistrationDetails, clientConfig?: ClientConfig): Promise<{
+    loggedin: boolean;
+    message: string;
+    user?: UserClass & CurrentUserData;
+}>;
+export declare function checkUsername(User: typeof UserClass, username: string, clientConfig?: ClientConfig): Promise<{
+    message: string;
+}>;

package/dist/helpers.js

@@ -0,0 +1,98 @@
+export class NeedTOTPError extends Error {
+}
+export async function login(User, username, password, code, additionalData) {
+    if (username === '') {
+        throw new Error('You need to enter a username.');
+    }
+    if (password === '') {
+        throw new Error('You need to enter a password');
+    }
+    try {
+        const { result, needTOTP, ...response } = await User.loginUser({
+            username,
+            password,
+            code,
+            ...(additionalData ? { additionalData } : {}),
+        });
+        if (!result) {
+            if (needTOTP) {
+                throw new NeedTOTPError(response.message);
+            }
+            throw new Error(response.message);
+        }
+        return response;
+    }
+    catch (e) {
+        if (e instanceof NeedTOTPError) {
+            throw e;
+        }
+        throw new Error(e?.message ?? 'An error occurred.');
+    }
+}
+export async function register(User, userDetails, clientConfig) {
+    if (userDetails.username === '') {
+        throw new Error('You need to enter a username.');
+    }
+    if (!userDetails.usernameVerified) {
+        throw new Error('The username you entered is not valid.');
+    }
+    if (userDetails.password !== userDetails.password2) {
+        throw new Error('Your passwords do not match.');
+    }
+    if (userDetails.password === '') {
+        throw new Error('You need to enter a password');
+    }
+    // Create a new user.
+    let user = User.factorySync();
+    user.username = userDetails.username;
+    const config = clientConfig || (await User.getClientConfig());
+    if (config.regFields.includes('email')) {
+        if (config.emailUsernames) {
+            user.email = userDetails.username;
+        }
+        else {
+            user.email = userDetails.email;
+        }
+    }
+    if (config.regFields.includes('name')) {
+        user.nameFirst = userDetails.nameFirst;
+        user.nameLast = userDetails.nameLast;
+    }
+    if (config.regFields.includes('phone')) {
+        user.phone = userDetails.phone;
+    }
+    try {
+        const { result, ...response } = await user.$register({
+            password: userDetails.password,
+            ...(userDetails.additionalData
+                ? { additionalData: userDetails.additionalData }
+                : {}),
+        });
+        if (!result) {
+            throw new Error(response.message);
+        }
+        return { ...response, user };
+    }
+    catch (e) {
+        throw new Error(e?.message ?? 'An error occurred.');
+    }
+}
+export async function checkUsername(User, username, clientConfig) {
+    let user = User.factorySync();
+    user.username = username;
+    const config = clientConfig || (await User.getClientConfig());
+    if (config.emailUsernames) {
+        user.email = username;
+    }
+    try {
+        const { result, ...response } = await user.$checkUsername();
+        if (!result) {
+            throw new Error(response.message);
+        }
+        return response;
+    }
+    catch (e) {
+        throw new Error(e?.message ?? 'An error occurred.');
+    }
+}
+//# sourceMappingURL=helpers.js.map