67 lines
2.1 KiB
TypeScript
67 lines
2.1 KiB
TypeScript
/*
|
|
Copyright 2023 The Matrix.org Foundation C.I.C.
|
|
|
|
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.
|
|
*/
|
|
|
|
export interface HomeserverConfig {
|
|
readonly configDir: string;
|
|
readonly baseUrl: string;
|
|
readonly port: number;
|
|
readonly registrationSecret: string;
|
|
}
|
|
|
|
export interface HomeserverInstance {
|
|
readonly config: HomeserverConfig;
|
|
|
|
/**
|
|
* Register a user on the given Homeserver using the shared registration secret.
|
|
* @param username the username of the user to register
|
|
* @param password the password of the user to register
|
|
* @param displayName optional display name to set on the newly registered user
|
|
*/
|
|
registerUser(username: string, password: string, displayName?: string): Promise<Credentials>;
|
|
|
|
/**
|
|
* Logs into synapse with the given username/password
|
|
* @param userId login username
|
|
* @param password login password
|
|
*/
|
|
loginUser(userId: string, password: string): Promise<Credentials>;
|
|
}
|
|
|
|
export interface StartHomeserverOpts {
|
|
/** path to template within playwright/plugins/{homeserver}docker/template/ directory. */
|
|
template: string;
|
|
|
|
/** Port of an OAuth server to configure the homeserver to use */
|
|
oAuthServerPort?: number;
|
|
|
|
/** Additional variables to inject into the configuration template **/
|
|
variables?: Record<string, string | number>;
|
|
}
|
|
|
|
export interface Homeserver {
|
|
start(opts: StartHomeserverOpts): Promise<HomeserverInstance>;
|
|
stop(): Promise<void>;
|
|
}
|
|
|
|
export interface Credentials {
|
|
accessToken: string;
|
|
userId: string;
|
|
deviceId: string;
|
|
homeServer: string;
|
|
password: string | null; // null for password-less users
|
|
displayName?: string;
|
|
}
|