@wireapp/core 37.5.0 → 38.0.0-beta

package/lib/Account.d.ts

@@ -1,213 +0,0 @@
-/// <reference types="node" />
-import { RegisterData, Context, Cookie, LoginData } from '@wireapp/api-client/lib/auth';
-import { ClientType, RegisteredClient } from '@wireapp/api-client/lib/client/';
-import { EventEmitter } from 'events';
-import { APIClient, BackendFeatures } from '@wireapp/api-client';
-import { CRUDEngine } from '@wireapp/store-engine';
-import { AccountService } from './account/';
-import { BroadcastService } from './broadcast/';
-import { ClientInfo, ClientService } from './client/';
-import { ConnectionService } from './connection/';
-import { AssetService, ConversationService } from './conversation/';
-import { CoreError } from './CoreError';
-import { CryptographyService, SessionId } from './cryptography/';
-import { GiphyService } from './giphy/';
-import { LinkPreviewService } from './linkPreview';
-import { MLSService } from './messagingProtocols/mls';
-import { MLSCallbacks, CryptoProtocolConfig } from './messagingProtocols/mls/types';
-import { HandledEventPayload, NotificationService, NotificationSource } from './notification/';
-import { SelfService } from './self/';
-import { TeamService } from './team/';
-import { UserService } from './user/';
-export type ProcessedEventPayload = HandledEventPayload;
-declare enum TOPIC {
-    ERROR = "Account.TOPIC.ERROR"
-}
-export declare enum ConnectionState {
-    /** The websocket is closed and notifications stream is not being processed */
-    CLOSED = "closed",
-    /** The websocket is being opened */
-    CONNECTING = "connecting",
-    /** The websocket is open but locked and notifications stream is being processed */
-    PROCESSING_NOTIFICATIONS = "processing_notifications",
-    /** The websocket is open and message will go through and notifications stream is fully processed */
-    LIVE = "live"
-}
-export interface Account {
-    on(event: TOPIC.ERROR, listener: (payload: CoreError) => void): this;
-}
-export type CreateStoreFn = (storeName: string, context: Context) => undefined | Promise<CRUDEngine | undefined>;
-interface AccountOptions<T> {
-    /** Used to store info in the database (will create a inMemory engine if returns undefined) */
-    createStore?: CreateStoreFn;
-    /** Number of prekeys to generate when creating a new device (defaults to 2)
-     * Prekeys are Diffie-Hellmann public keys which allow offline initiation of a secure Proteus session between two devices.
-     * Having a high value will:
-     *    - make creating a new device consuming more CPU resources
-     *    - make it less likely that all prekeys get consumed while the device is offline and the last resort prekey will not be used to create new session
-     * Having a low value will:
-     *    - make creating a new device fast
-     *    - make it likely that all prekeys get consumed while the device is offline and the last resort prekey will be used to create new session
-     */
-    nbPrekeys?: number;
-    /**
-     * Config for MLS and proteus devices. Will fallback to the old proteus logic if not provided
-     */
-    cryptoProtocolConfig?: CryptoProtocolConfig<T>;
-}
-type InitOptions = {
-    /** cookie used to identify the current user. Will use the browser cookie if not defined */
-    cookie?: Cookie;
-    /** fully initiate the client and register periodic checks */
-    initClient?: boolean;
-    /**
-     * callback triggered when a message from an unknown client is received.
-     * An unknown client is a client we don't yet have a session with
-     */
-    onNewClient?: (sessionId: SessionId) => void;
-};
-export declare class Account<T = any> extends EventEmitter {
-    private readonly apiClient;
-    private readonly logger;
-    private readonly createStore;
-    private storeEngine?;
-    private readonly nbPrekeys;
-    private readonly cryptoProtocolConfig?;
-    private coreCryptoClient?;
-    static readonly TOPIC: typeof TOPIC;
-    service?: {
-        mls: MLSService;
-        account: AccountService;
-        asset: AssetService;
-        broadcast: BroadcastService;
-        client: ClientService;
-        connection: ConnectionService;
-        conversation: ConversationService;
-        cryptography: CryptographyService;
-        giphy: GiphyService;
-        linkPreview: LinkPreviewService;
-        notification: NotificationService;
-        self: SelfService;
-        team: TeamService;
-        user: UserService;
-    };
-    backendFeatures: BackendFeatures;
-    /**
-     * @param apiClient The apiClient instance to use in the core (will create a new new one if undefined)
-     * @param accountOptions
-     */
-    constructor(apiClient?: APIClient, { createStore, nbPrekeys, cryptoProtocolConfig }?: AccountOptions<T>);
-    /**
-     * Will set the APIClient to use a specific version of the API (by default uses version 0)
-     * It will fetch the API Config and use the highest possible version
-     * @param acceptedVersions Which version the consumer supports
-     * @param useDevVersion allow the api-client to use development version of the api (if present). The dev version also need to be listed on the supportedVersions given as parameters
-     *   If we have version 2 that is a dev version, this is going to be the output of those calls
-     *   - useVersion([0, 1, 2], true) > version 2 is used
-     *   - useVersion([0, 1, 2], false) > version 1 is used
-     *   - useVersion([0, 1], true) > version 1 is used
-     * @return The highest version that is both supported by client and backend
-     */
-    useAPIVersion(supportedVersions: number[], useDevVersion?: boolean): Promise<BackendFeatures>;
-    private persistCookie;
-    get clientId(): string;
-    get userId(): string;
-    /**
-     * Will register a new user to the backend
-     *
-     * @param registration The user's data
-     * @param clientType Type of client to create (temporary or permanent)
-     */
-    register(registration: RegisterData, clientType: ClientType): Promise<Context>;
-    /**
-     * Will init the core with an already existing client (both on backend and local)
-     * Will fail if local client cannot be found
-     *
-     * @param clientType The type of client the user is using (temporary or permanent)
-     */
-    init(clientType: ClientType, { cookie, initClient, onNewClient }?: InitOptions): Promise<Context>;
-    /**
-     * Will log the user in with the given credential.
-     * Will also create the local client and store it in DB
-     *
-     * @param loginData The credentials of the user
-     * @param initClient Should the call also create the local client
-     * @param clientInfo Info about the client to create (name, type...)
-     */
-    login(loginData: LoginData, initClient?: boolean, clientInfo?: ClientInfo): Promise<Context>;
-    /**
-     * Will try to get the load the local client from local DB.
-     * If clientInfo are provided, will also create the client on backend and DB
-     * If clientInfo are not provided, the method will fail if local client cannot be found
-     *
-     * @param loginData User's credentials
-     * @param clientInfo Will allow creating the client if the local client cannot be found (else will fail if local client is not found)
-     * @param entropyData Additional entropy data
-     * @returns The local existing client or newly created client
-     */
-    initClient(loginData: LoginData, clientInfo?: ClientInfo, entropyData?: Uint8Array): Promise<{
-        isNewClient: boolean;
-        localClient: RegisteredClient;
-    }>;
-    /**
-     * In order to be able to send MLS messages, the core needs a few information from the consumer.
-     * Namely:
-     * - is the current user allowed to administrate a specific conversation
-     * - what is the groupId of a conversation
-     * @param mlsCallbacks
-     */
-    configureMLSCallbacks(mlsCallbacks: MLSCallbacks): void;
-    initServices(context: Context): Promise<void>;
-    loadAndValidateLocalClient(entropyData?: Uint8Array): Promise<RegisteredClient>;
-    private createMLSClient;
-    private registerClient;
-    private resetContext;
-    /**
-     * Will logout the current user
-     * @param clearData if set to `true` will completely wipe any database that was created by the Account
-     */
-    logout(clearData?: boolean): Promise<void>;
-    /**
-     * Will download and handle the notification stream since last stored notification id.
-     * Once the notification stream has been handled from backend, will then connect to the websocket and start listening to incoming events
-     *
-     * @param callbacks callbacks that will be called to handle different events
-     * @returns close a function that will disconnect from the websocket
-     */
-    listen({ onEvent, onConnectionStateChanged, onNotificationStreamProgress, onMissedNotifications, dryRun, }?: {
-        /**
-         * Called when a new event arrives from backend
-         * @param payload the payload of the event. Contains the raw event received and the decrypted data (if event was encrypted)
-         * @param source where the message comes from (either websocket or notification stream)
-         */
-        onEvent?: (payload: HandledEventPayload, source: NotificationSource) => void;
-        /**
-         * During the notification stream processing, this function will be called whenever a new notification has been processed
-         */
-        onNotificationStreamProgress?: ({ done, total }: {
-            done: number;
-            total: number;
-        }) => void;
-        /**
-         * called when the connection state with the backend has changed
-         */
-        onConnectionStateChanged?: (state: ConnectionState) => void;
-        /**
-         * called when we detect lost notification from backend.
-         * When a client doesn't log in for a while (28 days, as of now) notifications that are older than 28 days will be deleted from backend.
-         * If the client query the backend for the notifications since a particular notification ID and this ID doesn't exist anymore on the backend, we deduce that some messages were not sync before they were removed from backend.
-         * We can then detect that something was wrong and warn the consumer that there might be some missing old messages
-         * @param  {string} notificationId
-         */
-        onMissedNotifications?: (notificationId: string) => void;
-        /**
-         * When set will not decrypt and not store the last notification ID. This is useful if you only want to subscribe to unencrypted backend events
-         */
-        dryRun?: boolean;
-    }): () => void;
-    private generateDbName;
-    private generateSecretsDbName;
-    private initEngine;
-}
-export {};
-//# sourceMappingURL=Account.d.ts.map

package/lib/Account.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Account.d.ts","sourceRoot":"","sources":["../src/Account.ts"],"names":[],"mappings":";AAmBA,OAAO,EACL,YAAY,EAGZ,OAAO,EACP,MAAM,EAEN,SAAS,EACV,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAuB,UAAU,EAAE,gBAAgB,EAAC,MAAM,iCAAiC,CAAC;AAWnG,OAAO,EAAC,YAAY,EAAC,MAAM,QAAQ,CAAC;AAEpC,OAAO,EAAC,SAAS,EAAE,eAAe,EAAC,MAAM,qBAAqB,CAAC;AAG/D,OAAO,EAAC,UAAU,EAA0C,MAAM,uBAAuB,CAAC;AAE1F,OAAO,EAAC,cAAc,EAAC,MAAM,YAAY,CAAC;AAE1C,OAAO,EAAC,gBAAgB,EAAC,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAC,UAAU,EAAE,aAAa,EAAC,MAAM,WAAW,CAAC;AACpD,OAAO,EAAC,iBAAiB,EAAC,MAAM,eAAe,CAAC;AAChD,OAAO,EAAC,YAAY,EAAE,mBAAmB,EAAC,MAAM,iBAAiB,CAAC;AAElE,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AACtC,OAAO,EAAC,mBAAmB,EAAE,SAAS,EAAC,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAC,YAAY,EAAC,MAAM,UAAU,CAAC;AACtC,OAAO,EAAC,kBAAkB,EAAC,MAAM,eAAe,CAAC;AACjD,OAAO,EAAC,UAAU,EAAC,MAAM,0BAA0B,CAAC;AACpD,OAAO,EAAC,YAAY,EAAE,oBAAoB,EAAC,MAAM,gCAAgC,CAAC;AAElF,OAAO,EAAC,mBAAmB,EAAE,mBAAmB,EAAE,kBAAkB,EAAC,MAAM,iBAAiB,CAAC;AAC7F,OAAO,EAAC,WAAW,EAAC,MAAM,SAAS,CAAC;AACpC,OAAO,EAAC,WAAW,EAAC,MAAM,SAAS,CAAC;AACpC,OAAO,EAAC,WAAW,EAAC,MAAM,SAAS,CAAC;AAGpC,MAAM,MAAM,qBAAqB,GAAG,mBAAmB,CAAC;AAExD,aAAK,KAAK;IACR,KAAK,wBAAwB;CAC9B;AAED,oBAAY,eAAe;IACzB,8EAA8E;IAC9E,MAAM,WAAW;IACjB,oCAAoC;IACpC,UAAU,eAAe;IACzB,mFAAmF;IACnF,wBAAwB,6BAA6B;IACrD,oGAAoG;IACpG,IAAI,SAAS;CACd;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,SAAS,KAAK,IAAI,GAAG,IAAI,CAAC;CACtE;AAED,MAAM,MAAM,aAAa,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,KAAK,SAAS,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;AAEjH,UAAU,cAAc,CAAC,CAAC;IACxB,8FAA8F;IAC9F,WAAW,CAAC,EAAE,aAAa,CAAC;IAE5B;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAC;CAChD;AAED,KAAK,WAAW,GAAG;IACjB,2FAA2F;IAC3F,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,6DAA6D;IAC7D,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,WAAW,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,IAAI,CAAC;CAC9C,CAAC;AAQF,qBAAa,OAAO,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,YAAY;IAChD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;IACtC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;IACxC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAgB;IAC5C,OAAO,CAAC,WAAW,CAAC,CAAa;IACjC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAA0B;IAChE,OAAO,CAAC,gBAAgB,CAAC,CAAa;IAEtC,gBAAuB,KAAK,eAAS;IAC9B,OAAO,CAAC,EAAE;QACf,GAAG,EAAE,UAAU,CAAC;QAChB,OAAO,EAAE,cAAc,CAAC;QACxB,KAAK,EAAE,YAAY,CAAC;QACpB,SAAS,EAAE,gBAAgB,CAAC;QAC5B,MAAM,EAAE,aAAa,CAAC;QACtB,UAAU,EAAE,iBAAiB,CAAC;QAC9B,YAAY,EAAE,mBAAmB,CAAC;QAClC,YAAY,EAAE,mBAAmB,CAAC;QAClC,KAAK,EAAE,YAAY,CAAC;QACpB,WAAW,EAAE,kBAAkB,CAAC;QAChC,YAAY,EAAE,mBAAmB,CAAC;QAClC,IAAI,EAAE,WAAW,CAAC;QAClB,IAAI,EAAE,WAAW,CAAC;QAClB,IAAI,EAAE,WAAW,CAAC;KACnB,CAAC;IACK,eAAe,EAAE,eAAe,CAAC;IAExC;;;OAGG;gBAED,SAAS,GAAE,SAA2B,EACtC,EAAC,WAA6B,EAAE,SAAa,EAAE,oBAAoB,EAAC,GAAE,cAAc,CAAC,CAAC,CAAM;IAyB9F;;;;;;;;;;OAUG;IACU,aAAa,CAAC,iBAAiB,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO;IAM/E,OAAO,CAAC,aAAa;IAKrB,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;;;;OAKG;IACU,QAAQ,CAAC,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC;IAM3F;;;;;OAKG;IACU,IAAI,CACf,UAAU,EAAE,UAAU,EACtB,EAAC,MAAM,EAAE,UAAiB,EAAE,WAAW,EAAC,GAAE,WAAgB,GACzD,OAAO,CAAC,OAAO,CAAC;IA0CnB;;;;;;;OAOG;IACU,KAAK,CAChB,SAAS,EAAE,SAAS,EACpB,UAAU,GAAE,OAAc,EAC1B,UAAU,GAAE,UAA8B,GACzC,OAAO,CAAC,OAAO,CAAC;IAcnB;;;;;;;;;OASG;IACU,UAAU,CACrB,SAAS,EAAE,SAAS,EACpB,UAAU,CAAC,EAAE,UAAU,EACvB,WAAW,CAAC,EAAE,UAAU,GACvB,OAAO,CAAC;QAAC,WAAW,EAAE,OAAO,CAAC;QAAC,WAAW,EAAE,gBAAgB,CAAA;KAAC,CAAC;IAmDjE;;;;;;OAMG;IACH,qBAAqB,CAAC,YAAY,EAAE,YAAY;IAInC,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IA0D7C,0BAA0B,CAAC,WAAW,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,gBAAgB,CAAC;YAiB9E,eAAe;YA2Cf,cAAc;IA4B5B,OAAO,CAAC,YAAY;IAKpB;;;OAGG;IACU,MAAM,CAAC,SAAS,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAS9D;;;;;;OAMG;IACI,MAAM,CAAC,EACZ,OAAkB,EAClB,wBAAmC,EACnC,4BAAuC,EACvC,qBAAgC,EAChC,MAAc,GACf,GAAE;QACD;;;;WAIG;QACH,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,mBAAmB,EAAE,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC;QAE7E;;WAEG;QACH,4BAA4B,CAAC,EAAE,CAAC,EAAC,IAAI,EAAE,KAAK,EAAC,EAAE;YAAC,IAAI,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAA;SAAC,KAAK,IAAI,CAAC;QAEtF;;WAEG;QACH,wBAAwB,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;QAE5D;;;;;;WAMG;QACH,qBAAqB,CAAC,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,IAAI,CAAC;QAEzD;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;KACb,GAAG,MAAM,IAAI;IA2FnB,OAAO,CAAC,cAAc;IAKtB,OAAO,CAAC,qBAAqB;YAIf,UAAU;CAqBzB"}