|
| 1 | +/// <reference path="../typings/tsd.d.ts" /> |
| 2 | +/// <reference path="stacktrace.d.ts" /> |
| 3 | +declare module Exceptionless { |
| 4 | + class ExceptionlessClient { |
| 5 | + config: Configuration; |
| 6 | + constructor(apiKey?: string, serverUrl?: string); |
| 7 | + createException(exception: Error): EventBuilder; |
| 8 | + submitException(exception: Error): Promise<any>; |
| 9 | + createUnhandledException(exception: Error): EventBuilder; |
| 10 | + submitUnhandledException(exception: Error): Promise<any>; |
| 11 | + createFeatureUsage(feature: string): EventBuilder; |
| 12 | + submitFeatureUsage(feature: string): Promise<any>; |
| 13 | + createLog(message: string): EventBuilder; |
| 14 | + createLog(source: string, message: string): EventBuilder; |
| 15 | + createLog(source: string, message: string, level: string): EventBuilder; |
| 16 | + submitLog(message: string): Promise<any>; |
| 17 | + submitLog(source: string, message: string): Promise<any>; |
| 18 | + submitLog(source: string, message: string, level: string): Promise<any>; |
| 19 | + createNotFound(resource: string): EventBuilder; |
| 20 | + submitNotFound(resource: string): Promise<any>; |
| 21 | + createSessionStart(sessionId: string): EventBuilder; |
| 22 | + submitSessionStart(sessionId: string): Promise<any>; |
| 23 | + createSessionEnd(sessionId: string): EventBuilder; |
| 24 | + submitSessionEnd(sessionId: string): Promise<any>; |
| 25 | + createEvent(pluginContextData?: ContextData): EventBuilder; |
| 26 | + submitEvent(event: IEvent, pluginContextData?: ContextData): Promise<any>; |
| 27 | + getLastReferenceId(): string; |
| 28 | + register(): void; |
| 29 | + private getSettingsFromScriptTag(); |
| 30 | + private static _instance; |
| 31 | + static default: ExceptionlessClient; |
| 32 | + } |
| 33 | + class Configuration { |
| 34 | + private _apiKey; |
| 35 | + private _enabled; |
| 36 | + private _serverUrl; |
| 37 | + private _plugins; |
| 38 | + lastReferenceIdManager: ILastReferenceIdManager; |
| 39 | + log: ILog; |
| 40 | + submissionBatchSize: number; |
| 41 | + submissionClient: ISubmissionClient; |
| 42 | + storage: IStorage<any>; |
| 43 | + queue: IEventQueue; |
| 44 | + defaultTags: string[]; |
| 45 | + defaultData: Object; |
| 46 | + constructor(apiKey: string, serverUrl?: string); |
| 47 | + apiKey: string; |
| 48 | + serverUrl: string; |
| 49 | + enabled: boolean; |
| 50 | + plugins: IEventPlugin[]; |
| 51 | + addPlugin(plugin: IEventPlugin): void; |
| 52 | + addPlugin(name: string, priority: number, pluginAction: (context: EventPluginContext) => void): void; |
| 53 | + removePlugin(plugin: IEventPlugin): void; |
| 54 | + removePlugin(name: string): void; |
| 55 | + useReferenceIds(): void; |
| 56 | + } |
| 57 | + interface ILog { |
| 58 | + info(message: string): any; |
| 59 | + warn(message: string): any; |
| 60 | + error(message: string): any; |
| 61 | + } |
| 62 | + class NullLog implements ILog { |
| 63 | + info(message: any): void; |
| 64 | + warn(message: any): void; |
| 65 | + error(message: any): void; |
| 66 | + } |
| 67 | + class ConsoleLog implements ILog { |
| 68 | + info(message: any): void; |
| 69 | + warn(message: any): void; |
| 70 | + error(message: any): void; |
| 71 | + } |
| 72 | + interface IEventQueue { |
| 73 | + enqueue(event: IEvent): any; |
| 74 | + process(): any; |
| 75 | + suspendProcessing(durationInMinutes?: number, discardFutureQueuedItems?: boolean, clearQueue?: boolean): any; |
| 76 | + } |
| 77 | + class EventQueue implements IEventQueue { |
| 78 | + private _config; |
| 79 | + private _suspendProcessingUntil; |
| 80 | + private _discardQueuedItemsUntil; |
| 81 | + private _processingQueue; |
| 82 | + private _queueTimer; |
| 83 | + constructor(config: Configuration); |
| 84 | + enqueue(event: IEvent): boolean; |
| 85 | + process(): void; |
| 86 | + private processSubmissionResponse(response, events); |
| 87 | + private ensureQueueTimer(); |
| 88 | + private onProcessQueue(); |
| 89 | + suspendProcessing(durationInMinutes?: number, discardFutureQueuedItems?: boolean, clearQueue?: boolean): void; |
| 90 | + private requeueEvents(events); |
| 91 | + private isQueueProcessingSuspended(); |
| 92 | + private areQueuedItemsDiscarded(); |
| 93 | + private queuePath(); |
| 94 | + } |
| 95 | + interface ISubmissionClient { |
| 96 | + submit(events: IEvent[], config: Configuration): Promise<SubmissionResponse>; |
| 97 | + submitDescription(referenceId: string, description: IUserDescription, config: Configuration): Promise<SubmissionResponse>; |
| 98 | + getSettings(config: Configuration): Promise<SettingsResponse>; |
| 99 | + } |
| 100 | + class SubmissionClient implements ISubmissionClient { |
| 101 | + submit(events: IEvent[], config: Configuration): Promise<SubmissionResponse>; |
| 102 | + submitDescription(referenceId: string, description: IUserDescription, config: Configuration): Promise<SubmissionResponse>; |
| 103 | + getSettings(config: Configuration): Promise<SettingsResponse>; |
| 104 | + private getResponseMessage(xhr); |
| 105 | + private createRequest(method, url); |
| 106 | + private sendRequest(method, url, data?); |
| 107 | + } |
| 108 | + class SubmissionResponse { |
| 109 | + success: boolean; |
| 110 | + badRequest: boolean; |
| 111 | + serviceUnavailable: boolean; |
| 112 | + paymentRequired: boolean; |
| 113 | + unableToAuthenticate: boolean; |
| 114 | + notFound: boolean; |
| 115 | + requestEntityTooLarge: boolean; |
| 116 | + statusCode: number; |
| 117 | + message: string; |
| 118 | + constructor(statusCode: number, message?: string); |
| 119 | + } |
| 120 | + class SettingsResponse { |
| 121 | + success: boolean; |
| 122 | + settings: any; |
| 123 | + settingsVersion: number; |
| 124 | + message: string; |
| 125 | + exception: any; |
| 126 | + constructor(success: boolean, settings: any, settingsVersion?: number, exception?: any, message?: string); |
| 127 | + } |
| 128 | + interface IStorage<T> { |
| 129 | + save<T>(path: string, value: T): boolean; |
| 130 | + get(searchPattern?: string, limit?: number): T[]; |
| 131 | + clear(searchPattern?: string): any; |
| 132 | + count(searchPattern?: string): number; |
| 133 | + } |
| 134 | + class InMemoryStorage<T> implements IStorage<T> { |
| 135 | + private _items; |
| 136 | + save<T>(path: string, value: T): boolean; |
| 137 | + get(searchPattern?: string, limit?: number): T[]; |
| 138 | + clear(searchPattern?: string): void; |
| 139 | + count(searchPattern?: string): number; |
| 140 | + } |
| 141 | + interface ILastReferenceIdManager { |
| 142 | + getLast(): string; |
| 143 | + clearLast(): void; |
| 144 | + setLast(eventId: string): void; |
| 145 | + } |
| 146 | + class InMemoryLastReferenceIdManager implements ILastReferenceIdManager { |
| 147 | + private _lastReferenceId; |
| 148 | + getLast(): string; |
| 149 | + clearLast(): void; |
| 150 | + setLast(eventId: string): void; |
| 151 | + } |
| 152 | + interface IEvent { |
| 153 | + type?: string; |
| 154 | + source?: string; |
| 155 | + date?: Date; |
| 156 | + tags?: string[]; |
| 157 | + message?: string; |
| 158 | + geo?: string; |
| 159 | + value?: number; |
| 160 | + data?: any; |
| 161 | + reference_id?: string; |
| 162 | + session_id?: string; |
| 163 | + } |
| 164 | + class EventBuilder { |
| 165 | + target: IEvent; |
| 166 | + client: ExceptionlessClient; |
| 167 | + pluginContextData: ContextData; |
| 168 | + constructor(event: IEvent, client: ExceptionlessClient, pluginContextData?: ContextData); |
| 169 | + setType(type: string): EventBuilder; |
| 170 | + setSource(source: string): EventBuilder; |
| 171 | + setSessionId(sessionId: string): EventBuilder; |
| 172 | + setReferenceId(referenceId: string): EventBuilder; |
| 173 | + setMessage(message: string): EventBuilder; |
| 174 | + setGeo(latitude: number, longitude: number): EventBuilder; |
| 175 | + setValue(value: number): EventBuilder; |
| 176 | + addTags(...tags: string[]): EventBuilder; |
| 177 | + setProperty(name: string, value: any): EventBuilder; |
| 178 | + markAsCritical(critical: boolean): EventBuilder; |
| 179 | + submit(): Promise<any>; |
| 180 | + private isValidIdentifier(value); |
| 181 | + } |
| 182 | + class ContextData { |
| 183 | + setException(exception: Error): void; |
| 184 | + hasException: boolean; |
| 185 | + getException(): Error; |
| 186 | + markAsUnhandledError(): void; |
| 187 | + isUnhandledError: boolean; |
| 188 | + setSubmissionMethod(method: string): void; |
| 189 | + getSubmissionMethod(): string; |
| 190 | + } |
| 191 | + class EventPluginContext { |
| 192 | + client: ExceptionlessClient; |
| 193 | + event: IEvent; |
| 194 | + contextData: ContextData; |
| 195 | + cancel: boolean; |
| 196 | + constructor(client: ExceptionlessClient, event: IEvent, contextData?: ContextData); |
| 197 | + log: ILog; |
| 198 | + } |
| 199 | + interface IEventPlugin { |
| 200 | + priority?: number; |
| 201 | + name?: string; |
| 202 | + run(context: EventPluginContext): Promise<any>; |
| 203 | + } |
| 204 | + interface IUserDescription { |
| 205 | + email_address?: string; |
| 206 | + description?: string; |
| 207 | + data?: any; |
| 208 | + } |
| 209 | + class Utils { |
| 210 | + static getHashCode(source: string): string; |
| 211 | + static guid(): string; |
| 212 | + static parseVersion(source: string): string; |
| 213 | + static parseQueryString(query: string): {}; |
| 214 | + static randomNumber(): number; |
| 215 | + } |
| 216 | +} |
0 commit comments