You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Types.ts 3.7KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. import * as I from "./Interfaces";
  2. import { RPCSocket } from "./Frontend";
  3. import { PromiseIO } from "./PromiseIO/Server";
  4. export type PioBindListener = (...args: any) => void
  5. export type PioHookListener = AnyFunction
  6. export type AnyFunction = (...args:any) => any
  7. export type HookFunction = AnyFunction
  8. export type AccessFilter<InterfaceT extends RPCInterface = RPCInterface> = (sesame:string|undefined, exporter: I.RPCExporter<InterfaceT, keyof InterfaceT>) => Promise<boolean> | boolean
  9. export type Visibility = "127.0.0.1" | "0.0.0.0"
  10. export type ConnectionHandler = (socket:I.Socket) => void
  11. export type ErrorHandler = (socket:I.Socket, error:any, rpcName: string, args: any[]) => void
  12. export type CloseHandler = (socket:I.Socket) => void
  13. export type SesameFunction = (sesame : string) => boolean
  14. export type SesameConf = {
  15. sesame?: string | SesameFunction
  16. }
  17. export type FrontEndHandlerType = {
  18. 'error' : (e: any) => void
  19. 'close' : () => void
  20. }
  21. export type ClientConfig = SocketIOClient.ConnectOpts & {
  22. protocol?: 'http' | 'https'
  23. }
  24. export type ExporterArray<InterfaceT extends RPCInterface = RPCInterface> = I.RPCExporter<RPCInterface<InterfaceT>, keyof InterfaceT>[]
  25. export type ConnectedSocket<T extends RPCInterface = RPCInterface> = RPCSocket & AsyncIfc<T>
  26. export type ServerConf<InterfaceT extends RPCInterface> = {
  27. accessFilter?: AccessFilter<InterfaceT>
  28. connectionHandler?: ConnectionHandler
  29. errorHandler?: ErrorHandler
  30. closeHandler?: CloseHandler
  31. throwOnUnknownRPC?: boolean
  32. } & SesameConf
  33. export type ResponseType = "Subscribe" | "Success" | "Error"
  34. export type Outcome = "Success" | "Error"
  35. export type Respose<T> = T & { result: Outcome }
  36. export type SuccessResponse<T = {}> = Respose<T> & { result: "Success" }
  37. export type ErrorResponse<T = {}> = Respose<T> & { result: "Error", message?:string }
  38. export type RPCType = 'Hook' | 'Unhook' | 'Call'
  39. export type CallRPC<Name, Func extends AnyFunction> = {
  40. name: Name
  41. call: Func
  42. }
  43. export type HookRPC<Name, Func extends AnyFunction> = {
  44. name: Name
  45. hook: Func
  46. onCallback?: AnyFunction
  47. onDestroy?: HookCloseFunction<ReturnType<Func> extends Promise<infer T> ? T : ReturnType<Func>>
  48. }
  49. export type RPC<Name, Func extends AnyFunction> = HookRPC<Name, Func> | CallRPC<Name,Func> | Func
  50. export type RPCInterface<Impl extends RPCInterface = {}> = {
  51. [grp in string] : {
  52. [rpc in string] : AnyFunction
  53. }
  54. } & Impl
  55. export type exportT = {
  56. [group in string]: {}
  57. }
  58. export type RPCDefinitions<Ifc extends RPCInterface> = {
  59. [grp in keyof Ifc]:( { [rpc in keyof Ifc[grp]]: RPC<rpc, Ifc[grp][rpc]> }[keyof Ifc[grp]] )[]
  60. }
  61. export type BaseInfo = {
  62. name: string,
  63. owner: string,
  64. argNames: string[],
  65. }
  66. export type HookInfo<SubresT = {}> = BaseInfo & {
  67. type: 'Hook',
  68. generator: (socket?:I.Socket) => (...args:any[]) => SubresT
  69. }
  70. export type CallInfo = BaseInfo & {
  71. type: 'Call',
  72. call: AnyFunction
  73. }
  74. export type RpcInfo = HookInfo | CallInfo
  75. export type ExtendedRpcInfo = RpcInfo & { uniqueName: string }
  76. export type OnFunction = <T extends "error" | "close">(type: T, f: FrontEndHandlerType[T]) => void
  77. export type HookCloseFunction<T> = (res: T, rpc:HookRPC<any, any>) => any
  78. export type AsyncIfc<Ifc extends RPCInterface> = { [grp in keyof Ifc]: {[rpcname in keyof Ifc[grp]] : AsyncAnyFunction<Ifc[grp][rpcname]> } }
  79. export type AsyncAnyFunction<F extends AnyFunction = AnyFunction> = F extends (...args: Parameters<F>) => infer R
  80. ? ((...args: Parameters<F>) => R extends Promise<any> ? R : Promise<R> )
  81. : Promise<any>