initial TypeScript definition file
This commit is contained in:
parent
930c467754
commit
954d6f98eb
2 changed files with 90 additions and 0 deletions
89
javascript/index.d.ts
vendored
Normal file
89
javascript/index.d.ts
vendored
Normal file
|
@ -0,0 +1,89 @@
|
|||
/*
|
||||
Copyright 2020 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 as namespace Olm;
|
||||
|
||||
declare class Account {
|
||||
constructor();
|
||||
free();
|
||||
create();
|
||||
identity_keys(): string;
|
||||
sign(message: string): string;
|
||||
one_time_keys(): string;
|
||||
mark_keys_as_published();
|
||||
max_number_of_one_time_keys(): number;
|
||||
generate_one_time_keys(number_of_keys: number);
|
||||
remove_one_time_keys(session: Session);
|
||||
pickle(key: string): string;
|
||||
unpickle(key: string, pickle: string);
|
||||
}
|
||||
|
||||
declare class Session {
|
||||
constructor();
|
||||
free(): void;
|
||||
pickle(key: string): string;
|
||||
unpickle(key: string, pickle: string);
|
||||
create_outbound(
|
||||
account: Account, their_identity_key: string, their_one_time_key: string,
|
||||
): void;
|
||||
create_inbound(account: Account, one_time_key_message: string): void;
|
||||
create_inbound_from(
|
||||
account: Account, identity_key: string, one_time_key_message: string,
|
||||
): void;
|
||||
session_id(): string;
|
||||
has_received_message(): boolean;
|
||||
matches_inbound(one_time_key_message: string): boolean;
|
||||
matches_inbound_from(identity_key: string, one_time_key_message: string): boolean;
|
||||
encrypt(plaintext: string): object;
|
||||
decrypt(message_type: number, message: string): string;
|
||||
describe(): string;
|
||||
}
|
||||
|
||||
declare class Utility {
|
||||
constructor();
|
||||
free(): void;
|
||||
sha256(input: string): string;
|
||||
ed25519verify(key: string, message: string, signature: string): void;
|
||||
}
|
||||
|
||||
declare class PkEncryption {
|
||||
constructor();
|
||||
free(): void;
|
||||
set_recipient_key(key: string): void;
|
||||
encrypt(plaintext: string): object;
|
||||
}
|
||||
|
||||
declare class PkDecryption {
|
||||
constructor();
|
||||
free(): void;
|
||||
init_with_private_key(key: Uint8Array): string;
|
||||
generate_key(): string;
|
||||
get_private_key(): Uint8Array;
|
||||
pickle(key: string): string;
|
||||
unpickle(key: string, pickle: string): string;
|
||||
}
|
||||
|
||||
declare class PkSigning {
|
||||
constructor();
|
||||
free(): void;
|
||||
init_with_seed(seed: Uint8Array): string;
|
||||
generate_seed(): Uint8Array;
|
||||
sign(message: string): string;
|
||||
}
|
||||
|
||||
export function init(): Promise<void>;
|
||||
|
||||
export function get_library_version(): [number, number, number];
|
|
@ -7,6 +7,7 @@
|
|||
"olm.js",
|
||||
"olm.wasm",
|
||||
"olm_legacy.js",
|
||||
"index.d.ts",
|
||||
"README.md"
|
||||
],
|
||||
"scripts": {
|
||||
|
|
Loading…
Reference in a new issue