@peassoft/mnr-web-topline 3.0.0 → 4.0.0

package/README.md

@@ -1,31 +1,35 @@
 # @peassoft/mnr-web-topline
 
-Topline widget for mem'n'rev web applications.
+Topline widget for Memorize'n'Revise web applications.
+
+## Installation
+
+```shell
+npm i @peassoft/mnr-web-topline
+```
 
 ## Usage Example
 
 ```jsx
-import { useCallback } from 'react';
+import { useCallback, type JSX } from 'react';
 import WebTopline, {
-  ToplineService,
-  ToplineUser,
+  type ToplineService,
+  type ToplineUser,
+  ToplineEventName,
 } from '@peassoft/mnr-web-topline';
 
 export default function Topline(): JSX.Element {
   const handleReady = useCallback(
-    async(toplineService: ToplineService, toplineUser: ToplineUser | null) => {
-      toplineService
-        .on('userChange', user => {
-          //
-        })
-        .on('logout', () => {
-          //
-        })
-        .on('syncNotification', syncId => {
-          //
-        });
-
-      // Use toplineService and toplineUser somehow else
+    (toplineService: ToplineService, toplineUser: ToplineUser | null, isUserKnown: boolean) => {
+      toplineService.on(ToplineEventName.Login, user => {/*...*/});
+      toplineService.on(ToplineEventName.Signup, user => {/*...*/});
+      toplineService.on(ToplineEventName.Logout, () => {/*...*/});
+      toplineService.on(ToplineEventName.UserChange, user => {/*...*/});
+      toplineService.on(ToplineEventName.SyncNotification, syncId => {/*...*/});
+
+      // Use `toplineUser`...
+
+      // Use `isUserKnown` e.g. to determine whether to fetch the default set of data.
     },
     [],
   );
@@ -41,4 +45,87 @@ export default function Topline(): JSX.Element {
 
 ## API Reference
 
-Refer to the file `index.d.ts`.
+### Props
+
+```ts
+type ToplineProps = {
+  /** User to use in SSR */
+  ssrUser?: ToplineUser | null;
+
+  /**
+   * If set to `true`, the link to the home page opens the home page in a separate window.
+   *
+   * For use in PWA.
+   */
+  forceBlankHomeLink?: boolean;
+
+  /** Callback that is invoked after user is restored from a local DB */
+  onReady?: (
+    toplineService: ToplineService,
+    user: ToplineUser | null,
+    isUserKnown: boolean,
+  ) => unknown;
+
+  /**
+   * Callback that is invoked if an unexpected error is caught by React's error boundary
+   * component
+   *
+   * This callback invokation will almost always indicate that the user management system
+   * is broken or in an undefined state. Thus, the hosting app should not try to recover
+   * from this error, but take reasonable measures depending on the situation.
+   */
+  onError?: (err: Error) => unknown;
+};
+```
+
+### `onReady` Callback Function Parameters
+
+* `toplineService: ToplineService` - An object containing functionality of the topline (see below).
+
+* `user: ToplineUser | null` - User data as it's restored from the local DB. Later, topline will make an attempt to fetch fresh user data from the server which may result in the following scenarios:
+
+  * User data fetched is identical to the local data: Nothing will happen.
+
+  * User data fetched defers from the local data: `ToplineEventName.UserChange` event will be emitted on the `toplineService`.
+
+  * Request is not authenticated: `ToplineEventName.Logout` event will be emitted on the `toplineService`.
+
+  * Request fails (e.g. no Internet connection): Nothing will happen.
+
+* `isUserKnown: boolean` - Flag that if set to `true` indicates that the current browser once been used for logging in Memorize'n'Revise. The `false` value is possible when `user` value is `null`.
+
+
+
+### `ToplineService`
+
+#### Events
+
+* `ToplineService.on(ToplineEventName.Login, (user: ToplineUser) => unknown)` - Emitted after user has successfully logged in (possibly, after password restoration procedure).
+
+* `ToplineService.on(ToplineEventName.Signup, (user: ToplineUser) => unknown)` - Emitted after user has successfully created a new account and is now logged-in.
+
+* `ToplineService.on(ToplineEventName.Logout, () => unknown)` - Emitted when:
+
+  * user has explicitely logged out;
+
+  * a sync notification is received about user's log-out in another application instance;
+
+  * initialization sync request resulted in status code 401.
+
+* `ToplineService.on(ToplineEventName.UserChange, (user: ToplineUser) => unknown)` - Emitted when:
+
+  * a sync notification is received about user's data having been changed in another application instance;
+
+  * initialization sync returns different user data as of stored in the local DB.
+
+* `ToplineService.on(ToplineEventName.SyncNotification, (syncId: string) => unknown)` - Emitted when a notification about sync is received. `syncId` is supposed to be used by applications to filter out syncs which are initiated by the application itself.
+
+#### Methods
+
+* `ToplineService.grantToken(): string | null` - Get current `grantToken` to use in a request which requires authorization.
+
+* `ToplineService.upgradeGrantToken(): Promise<string | null>` - Upgrade `grantToken` with `refreshToken`. Supposed to be used after a request that used an expired `grantToken` resulted in status code `401`.
+
+* `ToplineService.logIn(): void` - Command to open logging-in form.
+
+* `ToplineService.createAccount(): void` - Command to open creating account form.

package/dist/css/index.css

@@ -102,7 +102,7 @@
 
 .topline_shell_userMenu {
   position: absolute;
-  z-index: 1;
+  z-index: 2;
   bottom: 0;
   right: 0;
   width: 300px;
@@ -203,7 +203,7 @@
 
 .topline_c_modal_overlay {
   position: fixed;
-  z-index: 1;
+  z-index: 2;
   top: 0;
   bottom: 0;
   left: 0;

package/dist/en/modules/keyboard-navigation/key-codes.d.ts

@@ -1,18 +1,16 @@
-/**
- * Keyboard key codes
- */
-declare const keyCodes: Readonly<{
-    TAB: 9;
-    RETURN: 13;
-    ESC: 27;
-    SPACE: 32;
-    PAGEUP: 33;
-    PAGEDOWN: 34;
-    END: 35;
-    HOME: 36;
-    LEFT: 37;
-    UP: 38;
-    RIGHT: 39;
-    DOWN: 40;
-}>;
-export default keyCodes;
+export declare enum Key {
+    Tab = "Tab",
+    Enter = "Enter",
+    Escape = "Escape",
+    Space = " ",
+    PageUp = "PageUp",
+    PageDown = "PageDown",
+    End = "End",
+    Home = "Home",
+    Left = "ArrowLeft",
+    Up = "ArrowUp",
+    Right = "ArrowRight",
+    Down = "ArrowDown",
+    F2 = "F2",
+    F10 = "F10"
+}

package/dist/en/modules/keyboard-navigation/key-codes.js

@@ -1,18 +1,17 @@
-/**
- * Keyboard key codes
- */
-const keyCodes = Object.freeze({
-  TAB: 9,
-  RETURN: 13,
-  ESC: 27,
-  SPACE: 32,
-  PAGEUP: 33,
-  PAGEDOWN: 34,
-  END: 35,
-  HOME: 36,
-  LEFT: 37,
-  UP: 38,
-  RIGHT: 39,
-  DOWN: 40
-});
-export default keyCodes;
+export var Key;
+(function (Key) {
+  Key["Tab"] = "Tab";
+  Key["Enter"] = "Enter";
+  Key["Escape"] = "Escape";
+  Key["Space"] = " ";
+  Key["PageUp"] = "PageUp";
+  Key["PageDown"] = "PageDown";
+  Key["End"] = "End";
+  Key["Home"] = "Home";
+  Key["Left"] = "ArrowLeft";
+  Key["Up"] = "ArrowUp";
+  Key["Right"] = "ArrowRight";
+  Key["Down"] = "ArrowDown";
+  Key["F2"] = "F2";
+  Key["F10"] = "F10";
+})(Key || (Key = {}));

package/dist/en/modules/keyboard-navigation/vertical-menu.d.ts

@@ -1,7 +1,7 @@
 import type { ToplineAction } from '../../types/app.js';
 export type ProcessKeyDownParams = {
     currIndex: number;
-    e: Pick<React.KeyboardEvent, 'which' | 'preventDefault' | 'stopPropagation'>;
+    e: Pick<React.KeyboardEvent, 'key' | 'preventDefault' | 'stopPropagation'>;
     setCurrItemIdx: (idx: number) => unknown;
     menuItemRefs: React.RefObject<HTMLDivElement | null>[];
     actionName: ToplineAction;

package/dist/en/modules/keyboard-navigation/vertical-menu.js

@@ -1,4 +1,4 @@
-import keyCodes from './key-codes.js';
+import { Key } from './key-codes.js';
 /**
  * Process pressed key for vertical menu
  */
@@ -14,17 +14,17 @@ export function processKeyDown(params) {
   } = params;
   const itemsNum = menuItemRefs.length;
   let nextIndex = -Infinity;
-  switch (e.which) {
-    case keyCodes.DOWN:
+  switch (e.key) {
+    case Key.Down:
       nextIndex = currIndex === itemsNum - 1 ? 0 : currIndex + 1;
       break;
-    case keyCodes.UP:
+    case Key.Up:
       nextIndex = currIndex === 0 ? itemsNum - 1 : currIndex - 1;
       break;
-    case keyCodes.HOME:
+    case Key.Home:
       nextIndex = 0;
       break;
-    case keyCodes.END:
+    case Key.End:
       nextIndex = itemsNum - 1;
   }
   if (nextIndex > -Infinity) {
@@ -34,11 +34,11 @@ export function processKeyDown(params) {
     menuItemRefs[nextIndex]?.current?.focus();
     return;
   }
-  if (e.which === keyCodes.RETURN) {
+  if (e.key === Key.Enter) {
     onSelect(actionName);
     return;
   }
-  if (e.which === keyCodes.ESC) {
+  if (e.key === Key.Escape) {
     onClose();
     return;
   }

package/dist/en/modules/local-db/actions/delete-all-data/index.js

@@ -1,4 +1,4 @@
-import { getDb, STORE_NAME } from '../../init-db.js';
+import { getDb, MAIN_STORE_NAME } from '../../init-db.js';
 import createRequestError from '../../create-request-error.js';
 import { logError } from '../../../logger/index.js';
 /**
@@ -11,7 +11,7 @@ export default function deleteAllData() {
       resolve();
       return;
     }
-    const req = db.transaction(STORE_NAME, 'readwrite').objectStore(STORE_NAME).clear();
+    const req = db.transaction(MAIN_STORE_NAME, 'readwrite').objectStore(MAIN_STORE_NAME).clear();
     req.onsuccess = () => resolve();
     req.onerror = () => {
       logError(createRequestError('deleteAllData'));

package/dist/en/modules/local-db/actions/get-all-data/index.js

@@ -1,4 +1,4 @@
-import { getDb, STORE_NAME } from '../../init-db.js';
+import { getDb, MAIN_STORE_NAME } from '../../init-db.js';
 import createRequestError from '../../create-request-error.js';
 import { logError } from '../../../logger/index.js';
 /**
@@ -15,7 +15,7 @@ export default function getAllData() {
       });
       return;
     }
-    const req = db.transaction(STORE_NAME).objectStore(STORE_NAME).getAll();
+    const req = db.transaction(MAIN_STORE_NAME).objectStore(MAIN_STORE_NAME).getAll();
     req.onsuccess = function () {
       const recordset = this.result;
       let user = null;

package/dist/en/modules/local-db/actions/get-is-user-known/index.d.ts

@@ -0,0 +1,5 @@
+import { type Result } from '../../../../types/result.js';
+/**
+ * Retrieve the value of flag `isUserKnown`.
+ */
+export default function getIsUserKnown(): Promise<Result<boolean, never>>;

package/dist/en/modules/local-db/actions/get-is-user-known/index.js

@@ -0,0 +1,33 @@
+import { getDb, PERSISTENT_STORE_NAME } from '../../init-db.js';
+import createRequestError from '../../create-request-error.js';
+import { logError } from '../../../logger/index.js';
+import { Ok } from '../../../../types/result.js';
+/**
+ * Retrieve the value of flag `isUserKnown`.
+ */
+export default function getIsUserKnown() {
+  return new Promise(resolve => {
+    const db = getDb();
+    if (!db) {
+      // If something is wrong with the DB, we would be better off returning "true"
+      // to prevent presenting the user the default set of content when it might
+      // be unreasonable.
+      resolve(Ok(true));
+      return;
+    }
+    const req = db.transaction(PERSISTENT_STORE_NAME).objectStore(PERSISTENT_STORE_NAME).get('isUserKnown');
+    req.onsuccess = function () {
+      const record = this.result;
+      if (record) {
+        resolve(Ok(record.isUserKnown));
+      } else {
+        resolve(Ok(false));
+      }
+    };
+    req.onerror = () => {
+      logError(createRequestError('getIsUserKnown'));
+      // For reasoning for returning "true" see comment on the "db" instance absence above.
+      resolve(Ok(true));
+    };
+  });
+}

package/dist/en/modules/local-db/actions/update-grant-token/index.js

@@ -1,4 +1,4 @@
-import { getDb, STORE_NAME } from '../../init-db.js';
+import { getDb, MAIN_STORE_NAME } from '../../init-db.js';
 import createRequestError from '../../create-request-error.js';
 import { logError } from '../../../logger/index.js';
 /**
@@ -11,13 +11,13 @@ export default function updateGrantToken(grantToken) {
       resolve();
       return;
     }
-    const transaction = db.transaction(STORE_NAME, 'readwrite');
+    const transaction = db.transaction(MAIN_STORE_NAME, 'readwrite');
     transaction.oncomplete = () => resolve();
     transaction.onerror = () => {
       logError(createRequestError('updateGrantToken'));
       resolve();
     };
-    const objectStore = transaction.objectStore(STORE_NAME);
+    const objectStore = transaction.objectStore(MAIN_STORE_NAME);
     objectStore.put({
       entityType: 'grantToken',
       grantToken

package/dist/en/modules/local-db/actions/update-is-user-known/index.d.ts

@@ -0,0 +1,5 @@
+import { type Result } from '../../../../types/result.js';
+/**
+ * Update the value of flag `isUserKnown`.
+ */
+export default function updateIsUserKnown(value: boolean): Promise<Result<void, never>>;

package/dist/en/modules/local-db/actions/update-is-user-known/index.js

@@ -0,0 +1,27 @@
+import { getDb, PERSISTENT_STORE_NAME } from '../../init-db.js';
+import createRequestError from '../../create-request-error.js';
+import { logError } from '../../../logger/index.js';
+import { Ok } from '../../../../types/result.js';
+/**
+ * Update the value of flag `isUserKnown`.
+ */
+export default function updateIsUserKnown(value) {
+  return new Promise(resolve => {
+    const db = getDb();
+    if (!db) {
+      resolve(Ok(undefined));
+      return;
+    }
+    const transaction = db.transaction(PERSISTENT_STORE_NAME, 'readwrite');
+    transaction.oncomplete = () => resolve(Ok(undefined));
+    transaction.onerror = () => {
+      logError(createRequestError('updateRefreshToken'));
+      resolve(Ok(undefined));
+    };
+    const objectStore = transaction.objectStore(PERSISTENT_STORE_NAME);
+    objectStore.put({
+      entityType: 'isUserKnown',
+      isUserKnown: value
+    });
+  });
+}

package/dist/en/modules/local-db/actions/update-refresh-token/index.js

@@ -1,4 +1,4 @@
-import { getDb, STORE_NAME } from '../../init-db.js';
+import { getDb, MAIN_STORE_NAME } from '../../init-db.js';
 import createRequestError from '../../create-request-error.js';
 import { logError } from '../../../logger/index.js';
 /**
@@ -11,13 +11,13 @@ export default function updateRefreshToken(refreshToken) {
       resolve();
       return;
     }
-    const transaction = db.transaction(STORE_NAME, 'readwrite');
+    const transaction = db.transaction(MAIN_STORE_NAME, 'readwrite');
     transaction.oncomplete = () => resolve();
     transaction.onerror = () => {
       logError(createRequestError('updateRefreshToken'));
       resolve();
     };
-    const objectStore = transaction.objectStore(STORE_NAME);
+    const objectStore = transaction.objectStore(MAIN_STORE_NAME);
     objectStore.put({
       entityType: 'refreshToken',
       refreshToken

package/dist/en/modules/local-db/actions/update-user/index.js

@@ -1,4 +1,4 @@
-import { getDb, STORE_NAME } from '../../init-db.js';
+import { getDb, MAIN_STORE_NAME } from '../../init-db.js';
 import createRequestError from '../../create-request-error.js';
 import { logError } from '../../../logger/index.js';
 /**
@@ -11,13 +11,13 @@ export default function updateUser(user) {
       resolve();
       return;
     }
-    const transaction = db.transaction(STORE_NAME, 'readwrite');
+    const transaction = db.transaction(MAIN_STORE_NAME, 'readwrite');
     transaction.oncomplete = () => resolve();
     transaction.onerror = () => {
       logError(createRequestError('updateUser'));
       resolve();
     };
-    const objectStore = transaction.objectStore(STORE_NAME);
+    const objectStore = transaction.objectStore(MAIN_STORE_NAME);
     objectStore.put({
       entityType: 'user',
       user

package/dist/en/modules/local-db/index.d.ts

@@ -4,3 +4,5 @@ export { default as deleteAllData } from './actions/delete-all-data/index.js';
 export { default as updateUser } from './actions/update-user/index.js';
 export { default as updateGrantToken } from './actions/update-grant-token/index.js';
 export { default as updateRefreshToken } from './actions/update-refresh-token/index.js';
+export { default as getIsUserKnown } from './actions/get-is-user-known/index.js';
+export { default as updateIsUserKnown } from './actions/update-is-user-known/index.js';

package/dist/en/modules/local-db/index.js

@@ -3,4 +3,6 @@ export { default as getAllData } from './actions/get-all-data/index.js';
 export { default as deleteAllData } from './actions/delete-all-data/index.js';
 export { default as updateUser } from './actions/update-user/index.js';
 export { default as updateGrantToken } from './actions/update-grant-token/index.js';
-export { default as updateRefreshToken } from './actions/update-refresh-token/index.js';
+export { default as updateRefreshToken } from './actions/update-refresh-token/index.js';
+export { default as getIsUserKnown } from './actions/get-is-user-known/index.js';
+export { default as updateIsUserKnown } from './actions/update-is-user-known/index.js';

package/dist/en/modules/local-db/init-db.d.ts

@@ -1,4 +1,5 @@
-export declare const STORE_NAME = "main";
+export declare const MAIN_STORE_NAME = "main";
+export declare const PERSISTENT_STORE_NAME = "persistent";
 /**
  * Get IndexedDb database object
  *

package/dist/en/modules/local-db/init-db.js

@@ -1,7 +1,10 @@
 import WebError from '@memnrev/web-error';
 const DB_NAME = 'mnr_topline';
-const DB_VERSION = 1;
-export const STORE_NAME = 'main';
+const DB_VERSION = 2;
+// Main store data is deleted when a user logs out.
+export const MAIN_STORE_NAME = 'main';
+// Persistent store is not cleaned up when a user logs out.
+export const PERSISTENT_STORE_NAME = 'persistent';
 let _db = null;
 /**
  * Get IndexedDb database object
@@ -33,14 +36,20 @@ export function initDb() {
       resolve();
     };
     openDbReq.onupgradeneeded = function (e) {
-      if (e.oldVersion < DB_VERSION) {
-        const db = this.result;
-        for (const objectStoreName of db.objectStoreNames) {
-          db.deleteObjectStore(objectStoreName);
-        }
-        db.createObjectStore(STORE_NAME, {
-          keyPath: 'entityType'
-        });
+      const db = this.result;
+      switch (e.oldVersion) {
+        case 0:
+          db.createObjectStore(MAIN_STORE_NAME, {
+            keyPath: 'entityType'
+          });
+          db.createObjectStore(PERSISTENT_STORE_NAME, {
+            keyPath: 'entityType'
+          });
+          break;
+        case 1:
+          db.createObjectStore(PERSISTENT_STORE_NAME, {
+            keyPath: 'entityType'
+          });
       }
     };
     openDbReq.onblocked = function () {

package/dist/en/modules/topline-service/index.d.ts

@@ -1,4 +1,4 @@
-import { type LogoutListener, type UserChangeListener, type SyncNotificationListener, ToplineEventName } from './types.js';
+import { type LoginListener, type SignupListener, type LogoutListener, type UserChangeListener, type SyncNotificationListener, ToplineEventName } from './types.js';
 export { ToplineEventName, InnerToplineEventName } from './types.js';
 export { default as innerToplineService, type InnerService } from './inner-service.js';
 /**
@@ -13,6 +13,8 @@ declare class _ToplineService {
     /** Upgrade grant token with refresh token */
     upgradeGrantToken(): Promise<string | null>;
     /** Register an event listener */
+    on(eventName: ToplineEventName.Login, cb: LoginListener): this;
+    on(eventName: ToplineEventName.Signup, cb: SignupListener): this;
     on(eventName: ToplineEventName.Logout, cb: LogoutListener): this;
     on(eventName: ToplineEventName.UserChange, cb: UserChangeListener): this;
     on(eventName: ToplineEventName.SyncNotification, cb: SyncNotificationListener): this;

package/dist/en/modules/topline-service/index.js

@@ -17,6 +17,12 @@ class _ToplineService {
   }
   on(eventName, cb) {
     switch (eventName) {
+      case ToplineEventName.Login:
+        this.#innerSrvs.on(eventName, cb);
+        break;
+      case ToplineEventName.Signup:
+        this.#innerSrvs.on(eventName, cb);
+        break;
       case ToplineEventName.Logout:
         this.#innerSrvs.on(eventName, cb);
         break;

package/dist/en/modules/topline-service/inner-service.d.ts

@@ -4,7 +4,7 @@ import { getApiBaseUrl } from '../env/index.js';
 import request from '../request/index.js';
 import { logError } from '../logger/index.js';
 import type { ToplineUser } from '../../types/data.js';
-import { type LogoutListener, type UserChangeListener, type SyncNotificationListener, type InnerListenerCallback, ToplineEventName, InnerToplineEventName } from './types.js';
+import { type LoginListener, type SignupListener, type LogoutListener, type UserChangeListener, type SyncNotificationListener, type InnerListenerCallback, ToplineEventName, InnerToplineEventName } from './types.js';
 export type Deps = {
     getRefreshToken: typeof getRefreshToken;
     setGrantToken: typeof setGrantToken;
@@ -21,13 +21,18 @@ export declare class InnerService {
     /** Get grant token */
     grantToken(): string | null;
     /** Register an event listener */
+    on(eventName: ToplineEventName.Login, cb: LoginListener): void;
+    on(eventName: ToplineEventName.Signup, cb: SignupListener): void;
     on(eventName: ToplineEventName.Logout, cb: LogoutListener): void;
     on(eventName: ToplineEventName.UserChange, cb: UserChangeListener): void;
     on(eventName: ToplineEventName.SyncNotification, cb: SyncNotificationListener): void;
     /** Emit an outer event */
+    emit(eventName: ToplineEventName.Login, payload: ToplineUser): void;
+    emit(eventName: ToplineEventName.Signup, payload: ToplineUser): void;
     emit(eventName: ToplineEventName.Logout): void;
     emit(eventName: ToplineEventName.UserChange, payload: ToplineUser): void;
     emit(eventName: ToplineEventName.SyncNotification, payload: string): void;
+    emit(eventName: ToplineEventName, payload?: ToplineUser | string): void;
     /** Upgrade grant token with refresh token */
     upgradeGrantToken(): Promise<string | null>;
     /**

package/dist/en/modules/topline-service/inner-service.js

@@ -38,6 +38,18 @@ export class InnerService {
   }
   on(eventName, cb) {
     switch (eventName) {
+      case ToplineEventName.Login:
+        this.#listeners.add({
+          eventName,
+          cb: cb
+        });
+        break;
+      case ToplineEventName.Signup:
+        this.#listeners.add({
+          eventName,
+          cb: cb
+        });
+        break;
       case ToplineEventName.Logout:
         this.#listeners.add({
           eventName,
@@ -67,6 +79,12 @@ export class InnerService {
     this.#listeners.forEach(listener => {
       if (eventName === listener.eventName) {
         switch (listener.eventName) {
+          case ToplineEventName.Login:
+            listener.cb.call(this, payload);
+            break;
+          case ToplineEventName.Signup:
+            listener.cb.call(this, payload);
+            break;
           case ToplineEventName.Logout:
             listener.cb.call(this);
             break;

package/dist/en/modules/topline-service/types.d.ts

@@ -5,6 +5,10 @@ import type { ToplineUser } from '../../types/data.js';
  * @public
  */
 export declare enum ToplineEventName {
+    /** User has been logged in */
+    Login = "login",
+    /** User has been signed up */
+    Signup = "signup",
     /** User has been logged out */
     Logout = "logout",
     /** User data changed */
@@ -12,10 +16,18 @@ export declare enum ToplineEventName {
     /** A sync notification has been received */
     SyncNotification = "syncNotification"
 }
+export type LoginListener = (user: ToplineUser) => unknown;
+export type SignupListener = (user: ToplineUser) => unknown;
 export type LogoutListener = () => unknown;
 export type UserChangeListener = (user: ToplineUser) => unknown;
 export type SyncNotificationListener = (syncId: string) => unknown;
 export type ToplineEventListener = {
+    eventName: ToplineEventName.Login;
+    cb: LoginListener;
+} | {
+    eventName: ToplineEventName.Signup;
+    cb: SignupListener;
+} | {
     eventName: ToplineEventName.Logout;
     cb: LogoutListener;
 } | {