-
Notifications
You must be signed in to change notification settings - Fork 224
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add TypeScript typings (#926)
Add TypeScript typings for all public APIs and test that ES Modules work as expected with Babel, TypeScript, and core Node.js ESM support. With Babel being added to the devDependencies, this commit also had to stop listing support for a few broken versions of `apollo-server-express`. The removed versions all depend on `apollo-upload-server@5.0.0` which is broken because of a missing dependency: core-js The reason why it worked before was because one of our other devDependencies had the correct `core-js` dependency. With the added dev-dependency for Babel, this `core-js` dependency have now been updated to a version unsupported by `apollo-upload-server`, and so the tests for `apollo-server-express` <2.0.4 now fails.
- Loading branch information
Showing
17 changed files
with
549 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,288 @@ | ||
| /// <reference types="node" /> | ||
|
|
||
| import { IncomingMessage, ServerResponse } from 'http'; | ||
|
|
||
| export = agent; | ||
|
|
||
| declare const agent: Agent; | ||
|
|
||
| declare class Agent implements Taggable, StartSpanFn { | ||
| // Configuration | ||
| start (options?: AgentConfigOptions): Agent; | ||
| isStarted (): boolean; | ||
| addPatch (name: string, handler: string | PatchHandler): void; | ||
| removePatch (name: string, handler: string | PatchHandler): void; | ||
| clearPatches (name: string): void; | ||
|
|
||
| // Data collection hooks | ||
| middleware: { connect (): Connect.ErrorHandleFunction }; | ||
| lambda (handler: AwsLambda.Handler): AwsLambda.Handler; | ||
| lambda (type: string, handler: AwsLambda.Handler): AwsLambda.Handler; | ||
| handleUncaughtExceptions ( | ||
| fn: (err: Error) => void | ||
| ): void; | ||
|
|
||
| // Errors | ||
| captureError ( | ||
| err: Error | string | ParameterizedMessageObject, | ||
| callback?: CaptureErrorCallback | ||
| ): void; | ||
| captureError ( | ||
| err: Error | string | ParameterizedMessageObject, | ||
| options?: CaptureErrorOptions, | ||
| callback?: CaptureErrorCallback | ||
| ): void; | ||
|
|
||
| // Transactions | ||
| startTransaction ( | ||
| name?: string, | ||
| type?: string, | ||
| options?: TransactionOptions | ||
| ): Transaction | null; | ||
| setTransactionName (name: string): void; | ||
| endTransaction (result?: string | number, endTime?: number): void; | ||
| currentTransaction: Transaction | null; | ||
|
|
||
| // Spans | ||
| startSpan (name?: string, type?: string, options?: SpanOptions): Span | null; | ||
| currentSpan: Span | null; | ||
|
|
||
| // Context | ||
| setTag (name: string, value: TagValue): boolean; | ||
| addTags (tags: Tags): boolean; | ||
| setUserContext (user: UserObject): void; | ||
| setCustomContext (custom: object): void; | ||
|
|
||
| // Transport | ||
| addFilter (fn: FilterFn): void; | ||
| addErrorFilter (fn: FilterFn): void; | ||
| addSpanFilter (fn: FilterFn): void; | ||
| addTransactionFilter (fn: FilterFn): void; | ||
| flush (callback?: Function): void; | ||
| destroy (): void; | ||
|
|
||
| // Utils | ||
| logger: Logger; | ||
| } | ||
|
|
||
| declare class GenericSpan implements Taggable { | ||
| // The following properties and methods are currently not documented as their API isn't considered official: | ||
| // timestamp, ended, id, traceId, parentId, sampled, duration() | ||
|
|
||
| type: string; | ||
|
|
||
| setTag (name: string, value: TagValue): boolean; | ||
| addTags (tags: Tags): boolean; | ||
| } | ||
|
|
||
| declare class Transaction extends GenericSpan implements StartSpanFn { | ||
| // The following properties and methods are currently not documented as their API isn't considered official: | ||
| // setUserContext(), setCustomContext(), toJSON(), setDefaultName(), setDefaultNameFromRequest() | ||
|
|
||
| name: string; | ||
| result: string | number; | ||
|
|
||
| startSpan (name?: string, type?: string, options?: SpanOptions): Span | null; | ||
| ensureParentId (): string; | ||
| end (result?: string | number | null, endTime?: number): void; | ||
| } | ||
|
|
||
| declare class Span extends GenericSpan { | ||
| // The following properties and methods are currently not documented as their API isn't considered official: | ||
| // customStackTrace(), setDbContext() | ||
|
|
||
| transaction: Transaction; | ||
| name: string; | ||
|
|
||
| end (endTime?: number): void; | ||
| } | ||
|
|
||
| interface AgentConfigOptions { | ||
| abortedErrorThreshold?: string; // Also support `number`, but as we're removing this functionality soon, there's no need to advertise it | ||
| active?: boolean; | ||
| apiRequestSize?: string; // Also support `number`, but as we're removing this functionality soon, there's no need to advertise it | ||
| apiRequestTime?: string; // Also support `number`, but as we're removing this functionality soon, there's no need to advertise it | ||
| asyncHooks?: boolean; | ||
| captureBody?: CaptureBody; | ||
| captureErrorLogStackTraces?: CaptureErrorLogStackTraces; | ||
| captureExceptions?: boolean; | ||
| captureHeaders?: boolean; | ||
| captureSpanStackTraces?: boolean; | ||
| containerId?: string; | ||
| disableInstrumentations?: string | string[]; | ||
| errorMessageMaxLength?: string; // Also support `number`, but as we're removing this functionality soon, there's no need to advertise it | ||
| errorOnAbortedRequests?: boolean; | ||
| filterHttpHeaders?: boolean; | ||
| frameworkName?: string; | ||
| frameworkVersion?: string; | ||
| hostname?: string; | ||
| ignoreUrls?: Array<string | RegExp>; | ||
| ignoreUserAgents?: Array<string | RegExp>; | ||
| instrument?: boolean; | ||
| kubernetesNamespace?: string; | ||
| kubernetesNodeName?: string; | ||
| kubernetesPodName?: string; | ||
| kubernetesPodUID?: string; | ||
| logLevel?: LogLevel; | ||
| logger?: Logger; | ||
| metricsInterval?: string; // Also support `number`, but as we're removing this functionality soon, there's no need to advertise it | ||
| payloadLogFile?: string; | ||
| secretToken?: string; | ||
| serverTimeout?: string; // Also support `number`, but as we're removing this functionality soon, there's no need to advertise it | ||
| serverUrl?: string; | ||
| serviceName?: string; | ||
| serviceVersion?: string; | ||
| sourceLinesErrorAppFrames?: number; | ||
| sourceLinesErrorLibraryFrames?: number; | ||
| sourceLinesSpanAppFrames?: number; | ||
| sourceLinesSpanLibraryFrames?: number; | ||
| stackTraceLimit?: number; | ||
| transactionMaxSpans?: number; | ||
| transactionSampleRate?: number; | ||
| verifyServerCert?: boolean; | ||
| } | ||
|
|
||
| interface CaptureErrorOptions { | ||
| request?: IncomingMessage; | ||
| response?: ServerResponse; | ||
| timestamp?: number; | ||
| handled?: boolean; | ||
| user?: UserObject; | ||
| tags?: Tags; | ||
| custom?: object; | ||
| message?: string; | ||
| } | ||
|
|
||
| interface Tags { | ||
| [key: string]: TagValue; | ||
| } | ||
|
|
||
| interface UserObject { | ||
| id?: string | number; | ||
| username?: string; | ||
| email?: string; | ||
| } | ||
|
|
||
| interface ParameterizedMessageObject { | ||
| message: string; | ||
| params: Array<any>; | ||
| } | ||
|
|
||
| interface Logger { | ||
| fatal (msg: string, ...args: any[]): void; | ||
| fatal (obj: {}, msg?: string, ...args: any[]): void; | ||
| error (msg: string, ...args: any[]): void; | ||
| error (obj: {}, msg?: string, ...args: any[]): void; | ||
| warn (msg: string, ...args: any[]): void; | ||
| warn (obj: {}, msg?: string, ...args: any[]): void; | ||
| info (msg: string, ...args: any[]): void; | ||
| info (obj: {}, msg?: string, ...args: any[]): void; | ||
| debug (msg: string, ...args: any[]): void; | ||
| debug (obj: {}, msg?: string, ...args: any[]): void; | ||
| trace (msg: string, ...args: any[]): void; | ||
| trace (obj: {}, msg?: string, ...args: any[]): void; | ||
| [propName: string]: any; | ||
| } | ||
|
|
||
| interface TransactionOptions { | ||
| startTime?: number; | ||
| childOf?: Transaction | Span | string; | ||
| } | ||
|
|
||
| interface SpanOptions { | ||
| childOf?: Transaction | Span | string; | ||
| } | ||
|
|
||
| type CaptureBody = 'off' | 'errors' | 'transactions' | 'all'; | ||
| type CaptureErrorLogStackTraces = 'never' | 'messages' | 'always'; | ||
| type LogLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal'; | ||
|
|
||
| type CaptureErrorCallback = (err: Error | null, id: string) => void; | ||
| type FilterFn = (payload: Payload) => Payload | boolean | void; | ||
| type TagValue = string | number | boolean | null | undefined; | ||
|
|
||
| type Payload = { [propName: string]: any } | ||
|
|
||
| type PatchHandler = (exports: any, agent: Agent, options: PatchOptions) => any; | ||
|
|
||
| interface PatchOptions { | ||
| version: string | undefined, | ||
| enabled: boolean | ||
| } | ||
|
|
||
| interface Taggable { | ||
| setTag (name: string, value: TagValue): boolean; | ||
| addTags (tags: Tags): boolean; | ||
| } | ||
|
|
||
| interface StartSpanFn { | ||
| startSpan (name?: string, type?: string, options?: SpanOptions): Span | null; | ||
| } | ||
|
|
||
| // Inlined from @types/aws-lambda - start | ||
| declare namespace AwsLambda { | ||
| interface CognitoIdentity { | ||
| cognitoIdentityId: string; | ||
| cognitoIdentityPoolId: string; | ||
| } | ||
|
|
||
| interface ClientContext { | ||
| client: ClientContextClient; | ||
| custom?: any; | ||
| env: ClientContextEnv; | ||
| } | ||
|
|
||
| interface ClientContextClient { | ||
| installationId: string; | ||
| appTitle: string; | ||
| appVersionName: string; | ||
| appVersionCode: string; | ||
| appPackageName: string; | ||
| } | ||
|
|
||
| interface ClientContextEnv { | ||
| platformVersion: string; | ||
| platform: string; | ||
| make: string; | ||
| model: string; | ||
| locale: string; | ||
| } | ||
|
|
||
| type Callback<TResult = any> = (error?: Error | null | string, result?: TResult) => void; | ||
|
|
||
| interface Context { | ||
| // Properties | ||
| callbackWaitsForEmptyEventLoop: boolean; | ||
| functionName: string; | ||
| functionVersion: string; | ||
| invokedFunctionArn: string; | ||
| memoryLimitInMB: number; | ||
| awsRequestId: string; | ||
| logGroupName: string; | ||
| logStreamName: string; | ||
| identity?: CognitoIdentity; | ||
| clientContext?: ClientContext; | ||
|
|
||
| // Functions | ||
| getRemainingTimeInMillis(): number; | ||
|
|
||
| // Functions for compatibility with earlier Node.js Runtime v0.10.42 | ||
| // For more details see http://docs.aws.amazon.com/lambda/latest/dg/nodejs-prog-model-using-old-runtime.html#nodejs-prog-model-oldruntime-context-methods | ||
| done(error?: Error, result?: any): void; | ||
| fail(error: Error | string): void; | ||
| succeed(messageOrObject: any): void; | ||
| succeed(message: string, object: any): void; | ||
| } | ||
|
|
||
| type Handler<TEvent = any, TResult = any> = ( | ||
| event: TEvent, | ||
| context: Context, | ||
| callback: Callback<TResult>, | ||
| ) => void | Promise<TResult>; | ||
| } | ||
|
|
||
| // Inlined from @types/connect - start | ||
| declare namespace Connect { | ||
| type NextFunction = (err?: any) => void; | ||
| type ErrorHandleFunction = (err: any, req: IncomingMessage, res: ServerResponse, next: NextFunction) => void; | ||
| } |
Oops, something went wrong.