124 lines
2.8 KiB
TypeScript
124 lines
2.8 KiB
TypeScript
import tls from "tls";
|
|
import type { Logger } from "loglevel";
|
|
import type { Ed25519Keypair, Err } from "libskynet";
|
|
import type express from "express";
|
|
|
|
export interface RPCRequest {
|
|
bypassCache?: boolean;
|
|
module: string;
|
|
method: string;
|
|
data: any;
|
|
}
|
|
|
|
export interface RPCResponse {
|
|
updated?: number;
|
|
data?: any;
|
|
error?: string;
|
|
}
|
|
|
|
export interface RPCMethod {
|
|
cacheable: boolean;
|
|
handler: (
|
|
request: RPCRequest,
|
|
sendStream: (stream: AsyncIterable<Uint8Array>) => void
|
|
) => Promise<RPCResponse | null>;
|
|
}
|
|
|
|
export interface StreamFileResponse {
|
|
data?: Uint8Array;
|
|
done: boolean;
|
|
}
|
|
|
|
export type DnsProvider = (ipAddress: string, domain: string) => Promise<void>;
|
|
|
|
export type PluginFunction = (api: PluginAPI) => Promise<void>;
|
|
|
|
export interface Plugin {
|
|
name: string;
|
|
plugin: PluginFunction;
|
|
exports?: any;
|
|
default?: Plugin;
|
|
}
|
|
|
|
export type RPCStreamHandler = (
|
|
stream: AsyncIterable<Uint8Array>
|
|
) => Promise<RPCResponse>;
|
|
|
|
export type OverwriteDataFn = (newData: Uint8Array) => Promise<Err>;
|
|
|
|
export type ReadDataFn = () => Promise<[Uint8Array, Err]>;
|
|
|
|
export interface IndependentFileSmallMetadata {
|
|
largestHistoricSize: bigint;
|
|
}
|
|
|
|
export interface IndependentFileSmall {
|
|
dataKey: Uint8Array;
|
|
fileData: Uint8Array;
|
|
inode: string;
|
|
keypair: Ed25519Keypair;
|
|
metadata: IndependentFileSmallMetadata;
|
|
revision: bigint;
|
|
seed: Uint8Array;
|
|
|
|
skylink: string;
|
|
viewKey: string;
|
|
|
|
overwriteData: OverwriteDataFn;
|
|
|
|
readData: ReadDataFn;
|
|
}
|
|
|
|
export interface SslData {
|
|
cert?: Uint8Array;
|
|
key?: Uint8Array;
|
|
}
|
|
|
|
export interface SavedSslData {
|
|
cert?: IndependentFileSmall;
|
|
key?: IndependentFileSmall;
|
|
}
|
|
|
|
export interface PluginAPI {
|
|
config: any;
|
|
registerMethod: (methodName: string, method: RPCMethod) => void;
|
|
loadPlugin: (moduleName: string) => Promise<Plugin>;
|
|
getMethods: () => string[];
|
|
ssl: {
|
|
setContext: (context: tls.SecureContext) => void;
|
|
getContext: () => tls.SecureContext;
|
|
getSaved: (retry: boolean) => Promise<boolean | SavedSslData>;
|
|
set: (
|
|
cert: IndependentFileSmall | Uint8Array,
|
|
key: IndependentFileSmall | Uint8Array
|
|
) => void;
|
|
get: () => SslData;
|
|
save: () => Promise<void>;
|
|
};
|
|
appRouter: {
|
|
get: () => express.Router;
|
|
set: (newRouter: express.Router) => void;
|
|
reset: () => void;
|
|
};
|
|
files: {
|
|
createIndependentFileSmall(
|
|
seed: Uint8Array,
|
|
userInode: string,
|
|
fileData: Uint8Array
|
|
): Promise<[IndependentFileSmall, Err]>;
|
|
openIndependentFileSmall(
|
|
seed: Uint8Array,
|
|
userInode: string
|
|
): Promise<[IndependentFileSmall, Err]>;
|
|
overwriteIndependentFileSmall(
|
|
file: IndependentFileSmall,
|
|
newData: Uint8Array
|
|
): Promise<Err>;
|
|
};
|
|
dns: {
|
|
setProvider(provider: DnsProvider): void;
|
|
};
|
|
logger: Logger;
|
|
getSeed: () => Uint8Array;
|
|
}
|