Arsharth/hydrogen-web
1
0
Fork 0
forked from mystiq/hydrogen-web
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix incorrect types

Browse source
This commit is contained in:
RMidhunSuresh 2022-02-03 18:42:02 +05:30
parent 0ad0ecfcc2
commit 8a3c0afba6
3 changed files with 51 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

82
src/matrix/net/HomeServerApi.ts
View file

@ -20,7 +20,7 @@ import {HomeServerRequest} from "./HomeServerRequest";
import type {IHomeServerRequest} from "./HomeServerRequest"; import type {IHomeServerRequest} from "./HomeServerRequest";
import type {Reconnector} from "./Reconnector"; import type {Reconnector} from "./Reconnector";
import type {EncodedBody} from "./common"; import type {EncodedBody} from "./common";
import type {IRequestOptions, RequestFunction} from "../../platform/types/types"; import type {RequestFunction} from "../../platform/types/types";
import type {ILogItem} from "../../logging/types"; import type {ILogItem} from "../../logging/types";
type RequestMethod = "POST" | "GET" | "PUT"; type RequestMethod = "POST" | "GET" | "PUT";
@ -36,6 +36,14 @@ type Options = {
reconnector: Reconnector; reconnector: Reconnector;
}; };
type BaseRequestOptions = {
log?: ILogItem;
allowedErrors?: number[];
uploadProgress?: (loadedBytes: number) => void;
timeout?: number;
prefix?: string;
};
export class HomeServerApi { export class HomeServerApi {
private readonly _homeserver: string; private readonly _homeserver: string;
private readonly _accessToken: string; private readonly _accessToken: string;
@ -55,7 +63,7 @@ export class HomeServerApi {
return this._homeserver + prefix + csPath; return this._homeserver + prefix + csPath;
} }
private _baseRequest(method: RequestMethod, url: string, queryParams?: Record<string, any>, body?: Record<string, any>, options?: IRequestOptions, accessToken?: string): IHomeServerRequest { private _baseRequest(method: RequestMethod, url: string, queryParams?: Record<string, any>, body?: Record<string, any>, options?: BaseRequestOptions, accessToken?: string): IHomeServerRequest {
const queryString = encodeQueryParams(queryParams); const queryString = encodeQueryParams(queryParams);
url = `${url}?${queryString}`; url = `${url}?${queryString}`;
let encodedBody: EncodedBody["body"]; let encodedBody: EncodedBody["body"];
@ -97,27 +105,27 @@ export class HomeServerApi {
return hsRequest; return hsRequest;
} }
private _unauthedRequest(method: RequestMethod, url: string, queryParams?: Record<string, any>, body?: Record<string, any>, options?: IRequestOptions): IHomeServerRequest { private _unauthedRequest(method: RequestMethod, url: string, queryParams?: Record<string, any>, body?: Record<string, any>, options?: BaseRequestOptions): IHomeServerRequest {
return this._baseRequest(method, url, queryParams, body, options); return this._baseRequest(method, url, queryParams, body, options);
} }
private _authedRequest(method: RequestMethod, url: string, queryParams?: Record<string, any>, body?: Record<string, any>, options?: IRequestOptions): IHomeServerRequest { private _authedRequest(method: RequestMethod, url: string, queryParams?: Record<string, any>, body?: Record<string, any>, options?: BaseRequestOptions): IHomeServerRequest {
return this._baseRequest(method, url, queryParams, body, options, this._accessToken); return this._baseRequest(method, url, queryParams, body, options, this._accessToken);
} }
private _post(csPath: string, queryParams: Record<string, any>, body: Record<string, any>, options?: IRequestOptions): IHomeServerRequest { private _post(csPath: string, queryParams: Record<string, any>, body: Record<string, any>, options?: BaseRequestOptions): IHomeServerRequest {
return this._authedRequest("POST", this._url(csPath, options?.prefix || CS_R0_PREFIX), queryParams, body, options); return this._authedRequest("POST", this._url(csPath, options?.prefix || CS_R0_PREFIX), queryParams, body, options);
} }
private _put(csPath: string, queryParams: Record<string, any>, body?: Record<string, any>, options?: IRequestOptions): IHomeServerRequest { private _put(csPath: string, queryParams: Record<string, any>, body?: Record<string, any>, options?: BaseRequestOptions): IHomeServerRequest {
return this._authedRequest("PUT", this._url(csPath, options?.prefix || CS_R0_PREFIX), queryParams, body, options); return this._authedRequest("PUT", this._url(csPath, options?.prefix || CS_R0_PREFIX), queryParams, body, options);
} }
private _get(csPath: string, queryParams?: Record<string, any>, body?: Record<string, any>, options?: IRequestOptions): IHomeServerRequest { private _get(csPath: string, queryParams?: Record<string, any>, body?: Record<string, any>, options?: BaseRequestOptions): IHomeServerRequest {
return this._authedRequest("GET", this._url(csPath, options?.prefix || CS_R0_PREFIX), queryParams, body, options); return this._authedRequest("GET", this._url(csPath, options?.prefix || CS_R0_PREFIX), queryParams, body, options);
} }
sync(since: string, filter: string, timeout: number, options?: IRequestOptions): IHomeServerRequest { sync(since: string, filter: string, timeout: number, options?: BaseRequestOptions): IHomeServerRequest {
return this._get("/sync", {since, timeout, filter}, undefined, options); return this._get("/sync", {since, timeout, filter}, undefined, options);
} }
@ -126,29 +134,29 @@ export class HomeServerApi {
} }
// params is from, dir and optionally to, limit, filter. // params is from, dir and optionally to, limit, filter.
messages(roomId: string, params: Record<string, any>, options?: IRequestOptions): IHomeServerRequest { messages(roomId: string, params: Record<string, any>, options?: BaseRequestOptions): IHomeServerRequest {
return this._get(`/rooms/${encodeURIComponent(roomId)}/messages`, params, undefined, options); return this._get(`/rooms/${encodeURIComponent(roomId)}/messages`, params, undefined, options);
} }
// params is at, membership and not_membership // params is at, membership and not_membership
members(roomId: string, params: Record<string, any>, options?: IRequestOptions): IHomeServerRequest { members(roomId: string, params: Record<string, any>, options?: BaseRequestOptions): IHomeServerRequest {
return this._get(`/rooms/${encodeURIComponent(roomId)}/members`, params, undefined, options); return this._get(`/rooms/${encodeURIComponent(roomId)}/members`, params, undefined, options);
} }
send(roomId: string, eventType: string, txnId: string, content: Record<string, any>, options?: IRequestOptions): IHomeServerRequest { send(roomId: string, eventType: string, txnId: string, content: Record<string, any>, options?: BaseRequestOptions): IHomeServerRequest {
return this._put(`/rooms/${encodeURIComponent(roomId)}/send/${encodeURIComponent(eventType)}/${encodeURIComponent(txnId)}`, {}, content, options); return this._put(`/rooms/${encodeURIComponent(roomId)}/send/${encodeURIComponent(eventType)}/${encodeURIComponent(txnId)}`, {}, content, options);
} }
redact(roomId: string, eventId: string, txnId: string, content: Record<string, any>, options?: IRequestOptions): IHomeServerRequest { redact(roomId: string, eventId: string, txnId: string, content: Record<string, any>, options?: BaseRequestOptions): IHomeServerRequest {
return this._put(`/rooms/${encodeURIComponent(roomId)}/redact/${encodeURIComponent(eventId)}/${encodeURIComponent(txnId)}`, {}, content, options); return this._put(`/rooms/${encodeURIComponent(roomId)}/redact/${encodeURIComponent(eventId)}/${encodeURIComponent(txnId)}`, {}, content, options);
} }
receipt(roomId: string, receiptType: string, eventId: string, options?: IRequestOptions): IHomeServerRequest { receipt(roomId: string, receiptType: string, eventId: string, options?: BaseRequestOptions): IHomeServerRequest {
return this._post(`/rooms/${encodeURIComponent(roomId)}/receipt/${encodeURIComponent(receiptType)}/${encodeURIComponent(eventId)}`, return this._post(`/rooms/${encodeURIComponent(roomId)}/receipt/${encodeURIComponent(receiptType)}/${encodeURIComponent(eventId)}`,
{}, {}, options); {}, {}, options);
} }
state(roomId: string, eventType: string, stateKey: string, options?: IRequestOptions): IHomeServerRequest { state(roomId: string, eventType: string, stateKey: string, options?: BaseRequestOptions): IHomeServerRequest {
return this._get(`/rooms/${encodeURIComponent(roomId)}/state/${encodeURIComponent(eventType)}/${encodeURIComponent(stateKey)}`, {}, undefined, options); return this._get(`/rooms/${encodeURIComponent(roomId)}/state/${encodeURIComponent(eventType)}/${encodeURIComponent(stateKey)}`, {}, undefined, options);
} }
@ -156,7 +164,7 @@ export class HomeServerApi {
return this._unauthedRequest("GET", this._url("/login")); return this._unauthedRequest("GET", this._url("/login"));
} }
register(username: string | null, password: string, initialDeviceDisplayName: string, auth?: Record<string, any>, inhibitLogin: boolean = true , options: IRequestOptions = {}): IHomeServerRequest { register(username: string | null, password: string, initialDeviceDisplayName: string, auth?: Record<string, any>, inhibitLogin: boolean = true , options: BaseRequestOptions = {}): IHomeServerRequest {
options.allowedErrors = [401]; options.allowedErrors = [401];
const body: any = { const body: any = {
auth, auth,
@ -171,7 +179,7 @@ export class HomeServerApi {
return this._unauthedRequest( "POST", this._url("/register", CS_V3_PREFIX), undefined, body, options); return this._unauthedRequest( "POST", this._url("/register", CS_V3_PREFIX), undefined, body, options);
} }
passwordLogin(username: string, password: string, initialDeviceDisplayName: string, options?: IRequestOptions): IHomeServerRequest { passwordLogin(username: string, password: string, initialDeviceDisplayName: string, options?: BaseRequestOptions): IHomeServerRequest {
return this._unauthedRequest("POST", this._url("/login"), undefined, { return this._unauthedRequest("POST", this._url("/login"), undefined, {
"type": "m.login.password", "type": "m.login.password",
"identifier": { "identifier": {
@ -183,7 +191,7 @@ export class HomeServerApi {
}, options); }, options);
} }
tokenLogin(loginToken: string, txnId: string, initialDeviceDisplayName: string, options?: IRequestOptions): IHomeServerRequest { tokenLogin(loginToken: string, txnId: string, initialDeviceDisplayName: string, options?: BaseRequestOptions): IHomeServerRequest {
return this._unauthedRequest("POST", this._url("/login"), undefined, { return this._unauthedRequest("POST", this._url("/login"), undefined, {
"type": "m.login.token", "type": "m.login.token",
"identifier": { "identifier": {
@ -195,15 +203,15 @@ export class HomeServerApi {
}, options); }, options);
} }
createFilter(userId: string, filter: Record<string, any>, options?: IRequestOptions): IHomeServerRequest { createFilter(userId: string, filter: Record<string, any>, options?: BaseRequestOptions): IHomeServerRequest {
return this._post(`/user/${encodeURIComponent(userId)}/filter`, {}, filter, options); return this._post(`/user/${encodeURIComponent(userId)}/filter`, {}, filter, options);
} }
versions(options?: IRequestOptions): IHomeServerRequest { versions(options?: BaseRequestOptions): IHomeServerRequest {
return this._unauthedRequest("GET", `${this._homeserver}/_matrix/client/versions`, undefined, undefined, options); return this._unauthedRequest("GET", `${this._homeserver}/_matrix/client/versions`, undefined, undefined, options);
} }
uploadKeys(dehydratedDeviceId: string, payload: Record<string, any>, options?: IRequestOptions): IHomeServerRequest { uploadKeys(dehydratedDeviceId: string, payload: Record<string, any>, options?: BaseRequestOptions): IHomeServerRequest {
let path = "/keys/upload"; let path = "/keys/upload";
if (dehydratedDeviceId) { if (dehydratedDeviceId) {
path = path + `/${encodeURIComponent(dehydratedDeviceId)}`; path = path + `/${encodeURIComponent(dehydratedDeviceId)}`;
@ -211,19 +219,19 @@ export class HomeServerApi {
return this._post(path, {}, payload, options); return this._post(path, {}, payload, options);
} }
queryKeys(queryRequest: Record<string, any>, options?: IRequestOptions): IHomeServerRequest { queryKeys(queryRequest: Record<string, any>, options?: BaseRequestOptions): IHomeServerRequest {
return this._post("/keys/query", {}, queryRequest, options); return this._post("/keys/query", {}, queryRequest, options);
} }
claimKeys(payload: Record<string, any>, options?: IRequestOptions): IHomeServerRequest { claimKeys(payload: Record<string, any>, options?: BaseRequestOptions): IHomeServerRequest {
return this._post("/keys/claim", {}, payload, options); return this._post("/keys/claim", {}, payload, options);
} }
sendToDevice(type: string, payload: Record<string, any>, txnId: string, options?: IRequestOptions): IHomeServerRequest { sendToDevice(type: string, payload: Record<string, any>, txnId: string, options?: BaseRequestOptions): IHomeServerRequest {
return this._put(`/sendToDevice/${encodeURIComponent(type)}/${encodeURIComponent(txnId)}`, {}, payload, options); return this._put(`/sendToDevice/${encodeURIComponent(type)}/${encodeURIComponent(txnId)}`, {}, payload, options);
} }
roomKeysVersion(version?: string, options?: IRequestOptions): IHomeServerRequest { roomKeysVersion(version?: string, options?: BaseRequestOptions): IHomeServerRequest {
let versionPart = ""; let versionPart = "";
if (version) { if (version) {
versionPart = `/${encodeURIComponent(version)}`; versionPart = `/${encodeURIComponent(version)}`;
@ -231,57 +239,57 @@ export class HomeServerApi {
return this._get(`/room_keys/version${versionPart}`, undefined, undefined, options); return this._get(`/room_keys/version${versionPart}`, undefined, undefined, options);
} }
roomKeyForRoomAndSession(version: string, roomId: string, sessionId: string, options?: IRequestOptions): IHomeServerRequest { roomKeyForRoomAndSession(version: string, roomId: string, sessionId: string, options?: BaseRequestOptions): IHomeServerRequest {
return this._get(`/room_keys/keys/${encodeURIComponent(roomId)}/${encodeURIComponent(sessionId)}`, {version}, undefined, options); return this._get(`/room_keys/keys/${encodeURIComponent(roomId)}/${encodeURIComponent(sessionId)}`, {version}, undefined, options);
} }
uploadRoomKeysToBackup(version: string, payload: Record<string, any>, options?: IRequestOptions): IHomeServerRequest { uploadRoomKeysToBackup(version: string, payload: Record<string, any>, options?: BaseRequestOptions): IHomeServerRequest {
return this._put(`/room_keys/keys`, {version}, payload, options); return this._put(`/room_keys/keys`, {version}, payload, options);
} }
uploadAttachment(blob: Blob, filename: string, options?: IRequestOptions): IHomeServerRequest { uploadAttachment(blob: Blob, filename: string, options?: BaseRequestOptions): IHomeServerRequest {
return this._authedRequest("POST", `${this._homeserver}/_matrix/media/r0/upload`, {filename}, blob, options); return this._authedRequest("POST", `${this._homeserver}/_matrix/media/r0/upload`, {filename}, blob, options);
} }
setPusher(pusher: Record<string, any>, options?: IRequestOptions): IHomeServerRequest { setPusher(pusher: Record<string, any>, options?: BaseRequestOptions): IHomeServerRequest {
return this._post("/pushers/set", {}, pusher, options); return this._post("/pushers/set", {}, pusher, options);
} }
getPushers(options?: IRequestOptions): IHomeServerRequest { getPushers(options?: BaseRequestOptions): IHomeServerRequest {
return this._get("/pushers", undefined, undefined, options); return this._get("/pushers", undefined, undefined, options);
} }
join(roomId: string, options?: IRequestOptions): IHomeServerRequest { join(roomId: string, options?: BaseRequestOptions): IHomeServerRequest {
return this._post(`/rooms/${encodeURIComponent(roomId)}/join`, {}, {}, options); return this._post(`/rooms/${encodeURIComponent(roomId)}/join`, {}, {}, options);
} }
joinIdOrAlias(roomIdOrAlias: string, options?: IRequestOptions): IHomeServerRequest { joinIdOrAlias(roomIdOrAlias: string, options?: BaseRequestOptions): IHomeServerRequest {
return this._post(`/join/${encodeURIComponent(roomIdOrAlias)}`, {}, {}, options); return this._post(`/join/${encodeURIComponent(roomIdOrAlias)}`, {}, {}, options);
} }
leave(roomId: string, options?: IRequestOptions): IHomeServerRequest { leave(roomId: string, options?: BaseRequestOptions): IHomeServerRequest {
return this._post(`/rooms/${encodeURIComponent(roomId)}/leave`, {}, {}, options); return this._post(`/rooms/${encodeURIComponent(roomId)}/leave`, {}, {}, options);
} }
forget(roomId: string, options?: IRequestOptions): IHomeServerRequest { forget(roomId: string, options?: BaseRequestOptions): IHomeServerRequest {
return this._post(`/rooms/${encodeURIComponent(roomId)}/forget`, {}, {}, options); return this._post(`/rooms/${encodeURIComponent(roomId)}/forget`, {}, {}, options);
} }
logout(options?: IRequestOptions): IHomeServerRequest { logout(options?: BaseRequestOptions): IHomeServerRequest {
return this._post(`/logout`, {}, {}, options); return this._post(`/logout`, {}, {}, options);
} }
getDehydratedDevice(options: IRequestOptions): IHomeServerRequest { getDehydratedDevice(options: BaseRequestOptions): IHomeServerRequest {
options.prefix = DEHYDRATION_PREFIX; options.prefix = DEHYDRATION_PREFIX;
return this._get(`/dehydrated_device`, undefined, undefined, options); return this._get(`/dehydrated_device`, undefined, undefined, options);
} }
createDehydratedDevice(payload: Record<string, any>, options: IRequestOptions): IHomeServerRequest { createDehydratedDevice(payload: Record<string, any>, options: BaseRequestOptions): IHomeServerRequest {
options.prefix = DEHYDRATION_PREFIX; options.prefix = DEHYDRATION_PREFIX;
return this._put(`/dehydrated_device`, {}, payload, options); return this._put(`/dehydrated_device`, {}, payload, options);
} }
claimDehydratedDevice(deviceId: string, options: IRequestOptions): IHomeServerRequest { claimDehydratedDevice(deviceId: string, options: BaseRequestOptions): IHomeServerRequest {
options.prefix = DEHYDRATION_PREFIX; options.prefix = DEHYDRATION_PREFIX;
return this._post(`/dehydrated_device/claim`, {}, {device_id: deviceId}, options); return this._post(`/dehydrated_device/claim`, {}, {device_id: deviceId}, options);
} }

8
src/matrix/net/HomeServerRequest.ts
View file

@ -18,7 +18,6 @@ limitations under the License.
import {HomeServerError, ConnectionError} from "../error.js"; import {HomeServerError, ConnectionError} from "../error.js";
import type {RequestResult} from "../../platform/web/dom/request/fetch.js"; import type {RequestResult} from "../../platform/web/dom/request/fetch.js";
import type {ILogItem} from "../../logging/types"; import type {ILogItem} from "../../logging/types";
import type {IRequestOptions} from "../../platform/types/types.js";
export interface IHomeServerRequest { export interface IHomeServerRequest {
abort(): void; abort(): void;
@ -26,13 +25,18 @@ export interface IHomeServerRequest {
responseCode(): Promise<number>; responseCode(): Promise<number>;
} }
type HomeServerRequestOptions = {
log?: ILogItem;
allowedErrors?: number[];
};
export class HomeServerRequest implements IHomeServerRequest { export class HomeServerRequest implements IHomeServerRequest {
private readonly _log?: ILogItem; private readonly _log?: ILogItem;
private _sourceRequest?: RequestResult; private _sourceRequest?: RequestResult;
// as we add types for expected responses from hs, this could be a generic class instead // as we add types for expected responses from hs, this could be a generic class instead
private readonly _promise: Promise<any>; private readonly _promise: Promise<any>;
constructor(method: string, url: string, sourceRequest: RequestResult, options?: IRequestOptions) { constructor(method: string, url: string, sourceRequest: RequestResult, options?: HomeServerRequestOptions) {
let log: ILogItem | undefined; let log: ILogItem | undefined;
if (options?.log) { if (options?.log) {
const parent = options?.log; const parent = options?.log;

3
src/platform/types/types.ts
View file

@ -24,11 +24,8 @@ export interface IRequestOptions {
body?: EncodedBody; body?: EncodedBody;
headers?: Map<string, string|number>; headers?: Map<string, string|number>;
cache?: boolean; cache?: boolean;
log?: ILogItem;
prefix?: string;
method?: string; method?: string;
format?: string; format?: string;
allowedErrors?: number[];
} }
export type RequestFunction = (url: string, options: IRequestOptions) => RequestResult; export type RequestFunction = (url: string, options: IRequestOptions) => RequestResult;