Improve typing (#364)

* Improve typing

* Make sonar happier

src/@types/keytar.d.ts

@@ -0,0 +1,54 @@
+// Based on https://github.com/atom/node-keytar/blob/master/keytar.d.ts because keytar is a hak-dependency and not a normal one
+// Definitions by: Milan Burda <https://github.com/miniak>, Brendan Forster <https://github.com/shiftkey>, Hari Juturu <https://github.com/juturu>
+// Adapted from DefinitelyTyped: https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/keytar/index.d.ts
+
+declare module "keytar" {
+    /**
+     * Get the stored password for the service and account.
+     *
+     * @param service The string service name.
+     * @param account The string account name.
+     *
+     * @returns A promise for the password string.
+     */
+    export function getPassword(service: string, account: string): Promise<string | null>;
+
+    /**
+     * Add the password for the service and account to the keychain.
+     *
+     * @param service The string service name.
+     * @param account The string account name.
+     * @param password The string password.
+     *
+     * @returns A promise for the set password completion.
+     */
+    export function setPassword(service: string, account: string, password: string): Promise<void>;
+
+    /**
+     * Delete the stored password for the service and account.
+     *
+     * @param service The string service name.
+     * @param account The string account name.
+     *
+     * @returns A promise for the deletion status. True on success.
+     */
+    export function deletePassword(service: string, account: string): Promise<boolean>;
+
+    /**
+     * Find a password for the service in the keychain.
+     *
+     * @param service The string service name.
+     *
+     * @returns A promise for the password string.
+     */
+    export function findPassword(service: string): Promise<string | null>;
+
+    /**
+     * Find all accounts and passwords for `service` in the keychain.
+     *
+     * @param service The string service name.
+     *
+     * @returns A promise for the array of found credentials.
+     */
+    export function findCredentials(service: string): Promise<Array<{ account: string, password: string}>>;
+}

src/@types/matrix-seshat.d.ts

@@ -0,0 +1,145 @@
+/*
+Copyright 2022 New Vector Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+declare module "matrix-seshat" {
+    interface IConfig {
+        language?: string;
+        passphrase?: string;
+    }
+
+    /* eslint-disable camelcase */
+    interface IMatrixEvent {
+        event_id: string;
+        sender: string;
+        room_id: string;
+        origin_server_ts: number;
+        content: Record<string, any>;
+    }
+
+    interface IMatrixProfile {
+        displayname?: string;
+        avatar_url?: string;
+    }
+
+    interface ISearchArgs {
+        searchTerm: number;
+        limit: number;
+        before_limit: number;
+        after_limit: number;
+        order_by_recency: boolean;
+        next_batch?: string;
+    }
+
+    interface ISearchContext {
+        events_before: IMatrixEvent[];
+        events_after: IMatrixEvent[];
+        profile_info: { [userId: string]: IMatrixProfile };
+    }
+
+    interface ISearchResult {
+        next_batch: string;
+        count: number;
+        results: Array<{
+            rank: number;
+            result: IMatrixEvent;
+            context: ISearchContext;
+        }>;
+    }
+    /* eslint-enable camelcase */
+
+    interface ICheckpoint {
+        roomId: string;
+        token: string;
+        fullCrawl: boolean;
+        direction: "b" | "f";
+    }
+
+    interface IDatabaseStats {
+        size: number;
+        eventCount: number;
+        roomCount: number;
+    }
+
+    interface ILoadArgs {
+        roomId: string;
+        limit: number;
+        fromEvent: string;
+        direction: "b" | "f";
+    }
+
+    interface ILoadResult {
+        event: IMatrixEvent;
+        matrixProfile: IMatrixProfile;
+    }
+
+    export class Seshat {
+        constructor(path: string, config?: IConfig);
+        public addEvent(matrixEvent: IMatrixEvent, profile?: IMatrixProfile): void;
+        public deleteEvent(eventId: string): Promise<boolean>;
+        public commit(force?: boolean): Promise<number>;
+        public commitSync(wait?: boolean, force?: boolean): number;
+        public reload(): void;
+        public search(args: ISearchArgs): Promise<ISearchResult>;
+        public searchSync(
+            term: string,
+            limit?: number,
+            beforeLimit?: number,
+            afterLimit?: number,
+            orderByRecency?: boolean,
+        ): ISearchResult;
+        public addHistoricEventsSync(
+            events: IMatrixEvent[],
+            newCheckpoint?: ICheckpoint,
+            oldCheckpoint?: ICheckpoint,
+        ): boolean;
+        public addHistoricEvents(
+            events: IMatrixEvent[],
+            newCheckpoint?: ICheckpoint,
+            oldCheckpoint?: ICheckpoint,
+        ): Promise<boolean>;
+        public addCrawlerCheckpoint(checkpoint: ICheckpoint): Promise<void>;
+        public removeCrawlerCheckpoint(checkpoint: ICheckpoint): Promise<void>;
+        public loadCheckpoints(): Promise<ICheckpoint[]>;
+        public getSize(): Promise<number>;
+        public getStats(): Promise<IDatabaseStats>;
+        public delete(): Promise<void>;
+        public shutdown(): Promise<void>;
+        public changePassphrase(newPassphrase: string): Promise<void>;
+        public isEmpty(): Promise<boolean>;
+        public isRoomIndexed(roomId: string): Promise<boolean>;
+        public getUserVersion(): Promise<number>;
+        public setUserVersion(version: number): Promise<void>;
+        public loadFileEvents(args: ILoadArgs): Promise<ILoadResult[]>;
+    }
+
+    interface IRecoveryInfo {
+        totalEvents: number;
+        reindexedEvents: number;
+        done: number;
+    }
+
+    export class SeshatRecovery {
+        constructor(path: string, config?: IConfig);
+        public info(): IRecoveryInfo;
+        public getUserVersion(): Promise<number>;
+        public shutdown(): Promise<void>;
+        public reindex(): Promise<void>;
+    }
+
+    export class ReindexError extends Error {
+        constructor(message?: string);
+    }
+}