Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Typings: lots of type definition fixes #695

Merged
merged 4 commits into from
Nov 3, 2020
Merged

Typings: lots of type definition fixes #695

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
47d1f9e
Typings: fix type def of ChannelOptions (everything is optional)
SimonWoolf Nov 3, 2020
e3e952d
Typings: fix typings of Crypto interface
SimonWoolf Nov 3, 2020
90b58ca
Typings: fix defn of recover clientoption
SimonWoolf Nov 3, 2020
e07e9d1
Typings: rewrite callback typings
SimonWoolf Nov 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 40 additions & 23 deletions ably.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,12 @@ declare namespace Types {
* Can be used to explicitly recover a connection.
* See https://www.ably.io/documentation/realtime/connection#connection-state-recovery
*/
recover?: standardCallback | string;
recover?: string | ((lastConnectionDetails: {
recoveryKey: string;
disconnectedAt: number;
location: string;
clientId: string | null;
}, callback: (shouldRecover: boolean) => void) => void);

/**
* Use a non-secure connection connection. By default, a TLS connection is used to connect to Ably
Expand Down Expand Up @@ -180,7 +185,7 @@ declare namespace Types {

interface CipherParams {
algorithm: string;
key: any;
key: CipherKey;
keyLength: number;
mode: string;
}
Expand Down Expand Up @@ -253,9 +258,9 @@ declare namespace Types {
type ChannelModes = Array<ChannelMode>;

interface ChannelOptions {
cipher: any;
params: ChannelParams;
modes: ChannelModes;
cipher?: CipherParamOptions | CipherParams;
params?: ChannelParams;
modes?: ChannelModes;
}

interface RestHistoryParams {
Expand Down Expand Up @@ -355,16 +360,16 @@ declare namespace Types {
}

// Common Listeners
type paginatedResultCallback<T> = (error: ErrorInfo, results: PaginatedResult<T>) => void;
type standardCallback = (error: ErrorInfo, results: any) => void;
type StandardCallback<T> = (err: ErrorInfo | null, result?: T) => void;
type paginatedResultCallback<T> = StandardCallback<PaginatedResult<T>>;
type messageCallback<T> = (message: T) => void;
type errorCallback = (error: ErrorInfo) => void;
type errorCallback = (error?: ErrorInfo) => void;
type channelEventCallback = (changeStateChange: ChannelStateChange) => void;
type connectionEventCallback = (connectionStateChange: ConnectionStateChange) => void;
type timeCallback = (error: ErrorInfo, time: number) => void;
type realtimePresenceGetCallback = (error: ErrorInfo, messages: PresenceMessage[]) => void;
type tokenDetailsCallback = (error: ErrorInfo, Results: TokenDetails) => void;
type tokenRequestCallback = (error: ErrorInfo, Results: TokenRequest) => void;
type timeCallback = StandardCallback<number>;
type realtimePresenceGetCallback = StandardCallback<PresenceMessage[]>;
type tokenDetailsCallback = StandardCallback<TokenDetails>;
type tokenRequestCallback = StandardCallback<TokenRequest>;
type fromEncoded<T> = (JsonObject: any, channelOptions?: ChannelOptions) => T;
type fromEncodedArray<T> = (JsonArray: any[], channelOptions?: ChannelOptions) => T[];

Expand Down Expand Up @@ -396,7 +401,7 @@ declare namespace Types {
static Callbacks: typeof Types.RestCallbacks;
auth: Types.AuthCallbacks;
channels: Types.Channels<Types.ChannelCallbacks>;
request: (method: string, path: string, params?: any, body?: any[] | any, headers?: any, callback?: (error: Types.ErrorInfo, response: Types.HttpPaginatedResponse) => void) => void;
request: (method: string, path: string, params?: any, body?: any[] | any, headers?: any, callback?: Types.StandardCallback<Types.HttpPaginatedResponse>) => void;
stats: (paramsOrCallback?: Types.paginatedResultCallback<Types.Stats> | any, callback?: Types.paginatedResultCallback<Types.Stats>) => void;
time: (callback?: Types.timeCallback) => void;
push: Types.PushCallbacks;
Expand Down Expand Up @@ -425,7 +430,7 @@ declare namespace Types {
auth: Types.AuthCallbacks;
channels: Types.Channels<Types.RealtimeChannelCallbacks>;
connection: Types.ConnectionCallbacks;
request: (method: string, path: string, params?: any, body?: any[] | any, headers?: any, callback?: (error: Types.ErrorInfo, response: Types.HttpPaginatedResponse) => void) => void;
request: (method: string, path: string, params?: any, body?: any[] | any, headers?: any, callback?: Types.StandardCallback<Types.HttpPaginatedResponse>) => void;
stats: (paramsOrCallback?: Types.paginatedResultCallback<Types.Stats> | any, callback?: Types.paginatedResultCallback<Types.Stats>) => void;
time: (callback?: Types.timeCallback) => void;
push: Types.PushCallbacks;
Expand Down Expand Up @@ -475,7 +480,7 @@ declare namespace Types {
class RealtimePresenceCallbacks extends RealtimePresenceBase {
get: (paramsOrCallback?: realtimePresenceGetCallback | RealtimePresenceParams, callback?: realtimePresenceGetCallback) => void;
history: (paramsOrCallback?: RealtimeHistoryParams | paginatedResultCallback<PresenceMessage>, callback?: paginatedResultCallback<PresenceMessage>) => void;
subscribe: (presenceOrListener: PresenceAction | messageCallback<PresenceMessage> | Array<PresenceAction>, listener?: messageCallback<PresenceMessage>, callbackWhenAttached?: standardCallback) => void;
subscribe: (presenceOrListener: PresenceAction | messageCallback<PresenceMessage> | Array<PresenceAction>, listener?: messageCallback<PresenceMessage>, callbackWhenAttached?: errorCallback) => void;
enter: (data?: errorCallback | any, callback?: errorCallback) => void;
update: (data?: errorCallback | any, callback?: errorCallback) => void;
leave: (data?: errorCallback | any, callback?: errorCallback) => void;
Expand Down Expand Up @@ -523,11 +528,11 @@ declare namespace Types {

class RealtimeChannelCallbacks extends RealtimeChannelBase {
presence: RealtimePresenceCallbacks;
attach: (callback?: standardCallback) => void;
detach: (callback?: standardCallback) => void;
attach: (callback?: errorCallback) => void;
detach: (callback?: errorCallback) => void;
history: (paramsOrCallback?: RealtimeHistoryParams | paginatedResultCallback<Message>, callback?: paginatedResultCallback<Message>) => void;
setOptions: (options: ChannelOptions, callback?: errorCallback) => void;
subscribe: (eventOrCallback: messageCallback<Message> | string | Array<string>, listener?: messageCallback<Message>, callbackWhenAttached?: standardCallback) => void;
subscribe: (eventOrCallback: messageCallback<Message> | string | Array<string>, listener?: messageCallback<Message>, callbackWhenAttached?: errorCallback) => void;
publish: (messagesOrName: any, messageDataOrCallback?: errorCallback | any, callback?: errorCallback) => void;
whenState: (targetState: ChannelState, callback: channelEventCallback) => void;
}
Expand Down Expand Up @@ -585,8 +590,20 @@ declare namespace Types {
fromEncodedArray: fromEncodedArray<PresenceMessage>;
}

type CipherKeyParam = ArrayBuffer | Uint8Array | string; // if string must be base64-encoded
type CipherKey = unknown; // WordArray on browsers, Buffer on node, using unknown as
// user should not be interacting with it - output of getDefaultParams should be used opaquely

type CipherParamOptions = {
key: CipherKeyParam;
algorithm?: 'aes';
keyLength?: number;
mode?: 'cbc';
}

interface Crypto {
generateRandomKey: (callback: (error: ErrorInfo, key: string) => void) => void;
generateRandomKey: (callback: Types.StandardCallback<CipherKey>) => void;
getDefaultParams: (params: CipherParamOptions, callback: Types.StandardCallback<CipherParams>) => void;
}

class ConnectionBase extends EventEmitter<connectionEventCallback, ConnectionStateChange, ConnectionEvent, ConnectionState> {
Expand All @@ -601,7 +618,7 @@ declare namespace Types {
}

class ConnectionCallbacks extends ConnectionBase {
ping: (callback?: (error: ErrorInfo, responseTime: number) => void) => void;
ping: (callback?: Types.StandardCallback<number>) => void;
whenState: (targetState: ConnectionState, callback: connectionEventCallback) => void;
}

Expand Down Expand Up @@ -664,8 +681,8 @@ declare namespace Types {
}

class PushDeviceRegistrationsCallbacks {
save: (deviceDetails: DeviceDetails, callback?: (error: ErrorInfo, deviceDetails: DeviceDetails) => void) => void;
get: (deviceIdOrDetails: DeviceDetails | string, callback: (error: ErrorInfo, deviceDetails: DeviceDetails) => void) => void;
save: (deviceDetails: DeviceDetails, callback?: Types.StandardCallback<DeviceDetails>) => void;
get: (deviceIdOrDetails: DeviceDetails | string, callback: Types.StandardCallback<DeviceDetails>) => void;
list: (params: DeviceRegistrationParams, callback: paginatedResultCallback<DeviceDetails>) => void;
remove: (deviceIdOrDetails: DeviceDetails | string, callback?: errorCallback) => void;
removeWhere: (params: DeviceRegistrationParams, callback?: errorCallback) => void;
Expand All @@ -680,7 +697,7 @@ declare namespace Types {
}

class PushChannelSubscriptionsCallbacks {
save: (subscription: PushChannelSubscription, callback?: (error: ErrorInfo, subscription: PushChannelSubscription) => void) => void;
save: (subscription: PushChannelSubscription, callback?: Types.StandardCallback<PushChannelSubscription>) => void;
list: (params: PushChannelSubscriptionParams, callback: paginatedResultCallback<PushChannelSubscription>) => void;
listChannels: (params: PushChannelsParams, callback: paginatedResultCallback<string>) => void;
remove: (subscription: PushChannelSubscription, callback?: errorCallback) => void;
Expand Down