@types/artillery 1.6.3 → 1.7.0

artillery/README.md

@@ -6,28 +6,11 @@ This package contains type definitions for artillery (https://github.com/artille
 
 # Details
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/artillery.
-## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/artillery/index.d.ts)
-````ts
-// Type definitions for artillery 1.6
-// Project: https://github.com/artilleryio/artillery
-// Definitions by: DefinitelyTyped <https://github.com/DefinitelyTyped>
-// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.3
-import * as request from 'request';
-import * as events from 'events';
-
-export interface ScenarioContext { vars: {[key: string]: any}; }
-export type Next = (err?: Error) => void;
-export type ResponseRequest = request.ResponseRequest;
-export type RequestResponse = request.RequestResponse;
-export type EventEmitter = events.EventEmitter;
-
-````
 
 ### Additional Details
- * Last updated: Thu, 23 Dec 2021 23:34:15 GMT
- * Dependencies: [@types/request](https://npmjs.com/package/@types/request)
+ * Last updated: Thu, 12 Jan 2023 16:32:35 GMT
+ * Dependencies: [@types/got](https://npmjs.com/package/@types/got), [@types/node](https://npmjs.com/package/@types/node), [@types/node:events](https://npmjs.com/package/@types/node:events), [@types/tough-cookie](https://npmjs.com/package/@types/tough-cookie)
  * Global values: none
 
 # Credits
-These definitions were written by [DefinitelyTyped](https://github.com/DefinitelyTyped).
+These definitions were written by [BendingBender](https://github.com/BendingBender).

artillery/index.d.ts

@@ -1,13 +1,165 @@
-// Type definitions for artillery 1.6
+// Type definitions for artillery 1.7
 // Project: https://github.com/artilleryio/artillery
-// Definitions by: DefinitelyTyped <https://github.com/DefinitelyTyped>
+// Definitions by: BendingBender <https://github.com/BendingBender>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.3
-import * as request from 'request';
-import * as events from 'events';
 
-export interface ScenarioContext { vars: {[key: string]: any}; }
+/// <reference types="node" />
+
+import * as events from 'node:events';
+import { OptionsOfJSONResponseBody, OptionsOfTextResponseBody, OptionsOfUnknownResponseBody, Response } from 'got';
+import { CookieJar } from 'tough-cookie';
+
+export type ActionFn<
+    TContextVars extends Record<string, unknown> = Record<string, unknown>,
+    TContextFuncs extends Record<string, (...args: any[]) => any> = Record<string, (...args: any[]) => any>,
+> = (context: ScenarioContext<TContextVars, TContextFuncs>, ee: EventEmitter, next: Next) => void;
+
+export type BeforeScenarioFn<
+    TContextVars extends Record<string, unknown> = Record<string, unknown>,
+    TContextFuncs extends Record<string, (...args: any[]) => any> = Record<string, (...args: any[]) => any>,
+> = ActionFn<TContextVars, TContextFuncs>;
+
+export type AfterScenarioFn<
+    TContextVars extends Record<string, unknown> = Record<string, unknown>,
+    TContextFuncs extends Record<string, (...args: any[]) => any> = Record<string, (...args: any[]) => any>,
+> = ActionFn<TContextVars, TContextFuncs>;
+
+export type BeforeRequestFn<
+    TContextVars extends Record<string, unknown> = Record<string, unknown>,
+    TContextFuncs extends Record<string, (...args: any[]) => any> = Record<string, (...args: any[]) => any>,
+> = (
+    requestParams: RequestParams,
+    context: ScenarioContext<TContextVars, TContextFuncs>,
+    ee: EventEmitter,
+    next: Next,
+) => void;
+
+export type AfterResponseFn<
+    TContextVars extends Record<string, unknown> = Record<string, unknown>,
+    TContextFuncs extends Record<string, (...args: any[]) => any> = Record<string, (...args: any[]) => any>,
+> = (
+    requestConfig: OptionsOfTextResponseBody &
+        OptionsOfJSONResponseBody &
+        OptionsOfUnknownResponseBody &
+        Record<string, unknown>,
+    response: Response,
+    context: ScenarioContext<TContextVars, TContextFuncs>,
+    ee: EventEmitter,
+    next: Next,
+) => void;
+
+export interface ScenarioContext<
+    TContextVars extends Record<string, unknown> = Record<string, unknown>,
+    TContextFuncs extends Record<string, (...args: any[]) => any> = Record<string, (...args: any[]) => any>,
+> {
+    vars: TContextVars & ContextVars;
+    funcs: TContextFuncs & ContextFuncs;
+}
+
+export interface ContextVars {
+    target: string | undefined;
+    $environment: string | undefined;
+    $processEnvironment: Record<string, string>;
+    $uuid: string;
+}
+
+export interface ContextFuncs {
+    $randomNumber(max?: number): number;
+    // tslint:disable-next-line:unified-signatures
+    $randomNumber(min: number, max: number): number;
+    $randomString(length?: number): string;
+    $template<T>(input: T): T;
+}
 export type Next = (err?: Error) => void;
-export type ResponseRequest = request.ResponseRequest;
-export type RequestResponse = request.RequestResponse;
-export type EventEmitter = events.EventEmitter;
+export interface EventEmitter extends events.EventEmitter {
+    addListener(
+        eventName: 'counter' | 'histogram' | 'customStat',
+        listener: (name: string, value: number) => void,
+    ): this;
+    addListener(eventName: 'started' | 'request', listener: () => void): this;
+    addListener(eventName: 'error', listener: (error: unknown) => void): this;
+    addListener(eventName: 'match', listener: (success: boolean, match: Match) => void): this;
+    addListener(eventName: 'response', listener: (delta: number, code: number, uid: string) => void): this;
+    addListener(eventName: string | symbol, listener: (...args: unknown[]) => void): this;
+    on(eventName: 'counter' | 'histogram' | 'customStat', listener: (name: string, value: number) => void): this;
+    on(eventName: 'started' | 'request', listener: () => void): this;
+    on(eventName: 'error', listener: (error: unknown) => void): this;
+    on(eventName: 'match', listener: (success: boolean, match: Match) => void): this;
+    on(eventName: 'response', listener: (delta: number, code: number, uid: string) => void): this;
+    on(eventName: string | symbol, listener: (...args: unknown[]) => void): this;
+    once(eventName: 'counter' | 'histogram' | 'customStat', listener: (name: string, value: number) => void): this;
+    once(eventName: 'started' | 'request', listener: () => void): this;
+    once(eventName: 'error', listener: (error: unknown) => void): this;
+    once(eventName: 'match', listener: (success: boolean, match: Match) => void): this;
+    once(eventName: 'response', listener: (delta: number, code: number, uid: string) => void): this;
+    once(eventName: string | symbol, listener: (...args: unknown[]) => void): this;
+    removeListener(
+        eventName: 'counter' | 'histogram' | 'customStat',
+        listener: (name: string, value: number) => void,
+    ): this;
+    removeListener(eventName: 'started' | 'request', listener: () => void): this;
+    removeListener(eventName: 'error', listener: (error: unknown) => void): this;
+    removeListener(eventName: 'match', listener: (success: boolean, match: Match) => void): this;
+    removeListener(eventName: 'response', listener: (delta: number, code: number, uid: string) => void): this;
+    removeListener(eventName: string | symbol, listener: (...args: unknown[]) => void): this;
+    off(eventName: 'counter' | 'histogram' | 'customStat', listener: (name: string, value: number) => void): this;
+    off(eventName: 'started' | 'request', listener: () => void): this;
+    off(eventName: 'error', listener: (error: unknown) => void): this;
+    off(eventName: 'match', listener: (success: boolean, match: Match) => void): this;
+    off(eventName: 'response', listener: (delta: number, code: number, uid: string) => void): this;
+    off(eventName: string | symbol, listener: (...args: unknown[]) => void): this;
+    emit(eventName: 'counter' | 'histogram' | 'customStat', name: string, value: number): boolean;
+    emit(eventName: 'started' | 'request'): boolean;
+    emit(eventName: 'error', error: unknown): boolean;
+    emit(eventName: 'match', success: boolean, match: Match): boolean;
+    emit(eventName: 'response', delta: number, code: number, uid: string): boolean;
+    emit(eventName: string | symbol, ...args: unknown[]): boolean;
+    prependListener(
+        eventName: 'counter' | 'histogram' | 'customStat',
+        listener: (name: string, value: number) => void,
+    ): this;
+    prependListener(eventName: 'started' | 'request', listener: () => void): this;
+    prependListener(eventName: 'error', listener: (error: unknown) => void): this;
+    prependListener(eventName: 'match', listener: (success: boolean, match: Match) => void): this;
+    prependListener(eventName: 'response', listener: (delta: number, code: number, uid: string) => void): this;
+    prependListener(eventName: string | symbol, listener: (...args: unknown[]) => void): this;
+    prependOnceListener(
+        eventName: 'counter' | 'histogram' | 'customStat',
+        listener: (name: string, value: number) => void,
+    ): this;
+    prependOnceListener(eventName: 'started' | 'request', listener: () => void): this;
+    prependOnceListener(eventName: 'error', listener: (error: unknown) => void): this;
+    prependOnceListener(eventName: 'match', listener: (success: boolean, match: Match) => void): this;
+    prependOnceListener(eventName: 'response', listener: (delta: number, code: number, uid: string) => void): this;
+    prependOnceListener(eventName: string | symbol, listener: (...args: unknown[]) => void): this;
+}
+
+export interface Match {
+    expected: string;
+    got?: string;
+    expression: string;
+    strict?: boolean;
+}
+
+export interface RequestParams {
+    [key: string]: unknown;
+
+    url?: string;
+    uri?: string;
+    method: string;
+    headers: Record<string, string>;
+    timeout: number;
+    json?: Record<string | number, unknown>;
+    form?: Record<string | number, unknown>;
+    formData?: Record<string | number, unknown>;
+    cookieJar?: CookieJar;
+    https?: Record<string, unknown>;
+    body?: unknown;
+    name?: string;
+    followRedirect?: boolean;
+    followAllRedirects?: boolean;
+    auth?: {
+        user: string;
+        pass: string;
+    };
+}

artillery/package.json

@@ -1,14 +1,14 @@
 {
     "name": "@types/artillery",
-    "version": "1.6.3",
+    "version": "1.7.0",
     "description": "TypeScript definitions for artillery",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/artillery",
     "license": "MIT",
     "contributors": [
         {
-            "name": "DefinitelyTyped",
-            "url": "https://github.com/DefinitelyTyped",
-            "githubUsername": "DefinitelyTyped"
+            "name": "BendingBender",
+            "url": "https://github.com/BendingBender",
+            "githubUsername": "BendingBender"
         }
     ],
     "main": "",
@@ -20,8 +20,10 @@
     },
     "scripts": {},
     "dependencies": {
-        "@types/request": "*"
+        "@types/node": "*",
+        "@types/tough-cookie": "*",
+        "got": "^11.8.5"
     },
-    "typesPublisherContentHash": "18037e7f5fac0ddb17d3e5e1398e5226f9527590bc7341029fc0bad84e418dff",
-    "typeScriptVersion": "3.8"
+    "typesPublisherContentHash": "53436525ac5ab0f0147e388baf7dbda48f20cb4b51e0e07ef201949449dc00a1",
+    "typeScriptVersion": "4.2"
 }