🤖 Merge PR DefinitelyTyped#74185 [mokapi] Update typings to v0.30.0 by @marle3003

Author: marle3003

types/mokapi/http.d.ts

@@ -113,29 +113,7 @@ export function options(url: string, body?: JSONValue, args?: Args): Response;
  *   maxRedirects: 2
  * });
  */
-export function fetch(url: string, opts?: FetchOptions): Promise<Response>;
-
-/**
- * Request arguments.
- * Used to add headers to a request.
- */
-export interface Args {
-    /** Request headers. */
-    headers?: { [name: string]: string };
-    /**
-     * The number of redirects to follow for this request.
-     * @default 5
-     */
-    maxRedirects?: number;
-    /**
-     * Maximum time to wait for the request to complete. Default
-     * timeout is 60 seconds ("60s"). The type can also be a number, in which
-     * case Mokapi interprets it as milliseconds
-     * @example
-     * const res = get(url, { timeout: '5m' })
-     */
-    timeout?: number | string;
-}
+export function fetch(url: string, opts?: FetchOptions): Promise<Response>
 
 /**
  * Options for the {@link fetch} function.
@@ -187,6 +165,28 @@ export interface FetchOptions {
     timeout?: number | string;
 }
 
+/**
+ * Request arguments.
+ * Used to add headers to a request.
+ */
+export interface Args {
+    /** Request headers. */
+    headers?: { [name: string]: string };
+    /**
+     * The number of redirects to follow for this request.
+     * @default 5
+     */
+    maxRedirects?: number;
+    /**
+     * Maximum time to wait for the request to complete. Default
+     * timeout is 60 seconds ("60s"). The type can also be a number, in which
+     * case Mokapi interprets it as milliseconds
+     * @example
+     * const res = get(url, { timeout: '5m' })
+     */
+    timeout?: number | string;
+}
+
 /**
  * Response of an HTTP request
  * https://mokapi.io/docs/javascript-api/mokapi-http/httpresponse
@@ -209,4 +209,4 @@ export interface Response {
      * res.json()
      */
     json(): JSONValue;
-}
+}

types/mokapi/index.d.ts

@@ -162,6 +162,9 @@ export interface HttpRequest {
 
     /** OperationId defined in OpenAPI */
     readonly operationId: string;
+
+    /** Returns a string representing this HttpRequest object.  */
+    toString(): string
 }
 
 /**
@@ -170,7 +173,7 @@ export interface HttpRequest {
  */
 export interface HttpResponse {
     /** Object contains header parameters specified by OpenAPI header parameters. */
-    headers: { [key: string]: string };
+    headers: { [key: string]: any };
 
     /** Specifies the http status used to select the OpenAPI response definition. */
     statusCode: number;
@@ -192,11 +195,17 @@ export interface Url {
     /** URL host. */
     readonly host: string;
 
+    /** URL port */
+    readonly port: number;
+
     /** URL path. */
     readonly path: string;
 
     /** URL query string. */
     readonly query: string;
+
+    /** Returns a string representing this Url object.  */
+    toString(): string;
 }
 
 /**
@@ -429,20 +438,20 @@ export type DateLayout =
  */
 export interface EventArgs {
     /**
-     * Optional key-value pairs used to label the event in the dashboard.
+     * Adds or overrides existing tags used to label the event in dashboard
      */
     tags?: { [key: string]: string };
 
     /**
      * Set to `true` to enable tracking of this event handler in the dashboard.
-     * If omitted, Mokapi automatically checks whether the response object has
-     * been modified and tracks the handler only if a change is detected.
+     * Set to `false` to disable tracking. If omitted, Mokapi checks the response
+     * object to determine if the handler changed it, and tracks it accordingly.
      */
     track?: boolean;
 }
 
 /**
- * cheduledEventArgs is an object used by every and cron function.
+ * ScheduledEventHandler is an object used by every and cron function.
  * https://mokapi.io/docs/javascript-api/mokapi/eventhandler/scheduledeventargs
  * @example
  * export default function() {
@@ -631,4 +640,4 @@ export interface SharedMemory {
  * mokapi.log(`Current counter: ${count}`)
  * ```
  */
-export const shared: SharedMemory;
+export const shared: SharedMemory;

types/mokapi/test/mokapi-tests.ts

@@ -14,10 +14,10 @@ import {
     LdapSearchResponse,
     on,
     patch,
-    shared,
     sleep,
     SmtpEventHandler,
     SmtpEventMessage,
+    shared
 } from "mokapi";
 
 const handler = () => {};
@@ -47,9 +47,17 @@ on("http", handler, {});
 on("http", handler, { tags: { foo: "bar" } });
 on("http", handler, { track: true });
 on("http", async () => {});
-on("http", (request) => {
-    request.querystring;
-});
+on("http", (request) => { request.querystring });
+on("http", (request, response) => {
+    const s = request.toString();
+    const url = request.url.toString();
+
+    response.headers = {
+        "Content-Type": "application/json",
+    }
+    response.headers["Access-Control-Allow-Origin"] = "*";
+    response.headers["foo"] = { bar: 123 };
+})
 
 // @ts-expect-error
 every(12, () => {});
@@ -134,7 +142,6 @@ h = (req: HttpRequest, res: HttpResponse) => {
     res.data = 12;
     res.data = "foo";
     res.data = {};
-    // @ts-expect-error
     res.headers.foo = 12;
     res.headers.foo = "bar";
     res.headers["Content-Type"] = "application/json";