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

Author: marle3003

types/mokapi/file.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Reads the contents of a file and returns it as a string.
+ *
+ * If the path is relative, it is resolved relative to the entry script file.
+ *
+ * @param path - Path to the file to read.
+ * @returns The contents of the file.
+ *
+ * @example
+ * export default function() {
+ *   const data = read('data.json')
+ *   console.log(data)
+ * }
+ */
+export function read(path: string): string;
+
+/**
+ * Writes a string to a file at the given path.
+ *
+ * If the path is relative, it is resolved relative to the entry script file.
+ * If the file does not exist, it will be created.
+ * If the file exists, it will be overwritten.
+ *
+ * @param path - Path to the file to write.
+ * @param s - The string content to write.
+ *
+ * @example
+ * export default function() {
+ *   writeString('data.json', 'Hello World')
+ * }
+ */
+export function writeString(path: string, s: string): void;
+
+/**
+ * Appends a string to a file at the given path.
+ *
+ * If the path is relative, it is resolved relative to the entry script file.
+ * If the file does not exist, it will be created.
+ * If the file exists, the string will be appended.
+ *
+ * @param path - Path to the file to append to.
+ * @param s - The string content to append.
+ *
+ * @example
+ * export default function() {
+ *   writeString('data.json', 'Hello')
+ *   appendString('data.json', ' World')
+ * }
+ */
+export function appendString(path: string, s: string): void;

types/mokapi/index.d.ts

@@ -1,6 +1,6 @@
 /**
  * Mokapi JavaScript API
- * https://mokapi.io/docs/guides/welcome
+ * https://mokapi.io/docs/welcome
  */
 
 import "./faker";
@@ -10,6 +10,7 @@ import "./mustache";
 import "./yaml";
 import "./encoding";
 import "./mail";
+import "./file";
 
 /**
  * Attaches an event handler for the given event.
@@ -157,6 +158,9 @@ export interface HttpRequest {
     /** Object contains querystring parameters specified by OpenAPI querystring parameters. */
     readonly querystring: any;
 
+    /** Name of the API, as defined in the OpenAPI `info.title` field */
+    readonly api: string;
+
     /** Path value specified by the OpenAPI path */
     readonly key: string;
 
@@ -183,6 +187,23 @@ export interface HttpResponse {
 
     /** Data will be encoded with the OpenAPI response definition. */
     data: any;
+
+    /**
+     * Rebuilds the entire HTTP response using the OpenAPI response definition for the given status code and content type
+     * @example
+     * import { on } from 'mokapi'
+     *
+     * export default function() {
+     *     on('http', (request, response) => {
+     *         if (request.path.petId === 10) {
+     *             // Switch to a different OpenAPI response.
+     *             response.rebuild(404, 'application/json')
+     *             response.data.message = 'Pet not found'
+     *         }
+     *     })
+     * }
+     */
+    rebuild: (statusCode?: number, contentType?: string) => void;
 }
 
 /**
@@ -421,10 +442,11 @@ export type DateLayout =
     | "RFC3339Nano";
 
 /**
- * EventArgs object contains additional arguments for an event handler.
+ * EventArgs provides optional configuration for an event handler.
  * https://mokapi.io/docs/javascript-api/mokapi/on
  *
- * Use this to customize how the event appears in the dashboard or to control tracking.
+ * Use this object to control how the event is tracked, labeled,
+ * and ordered in the execution pipeline.
  *
  * @example
  * export default function() {
@@ -438,16 +460,32 @@ export type DateLayout =
  */
 export interface EventArgs {
     /**
-     * Adds or overrides existing tags used to label the event in dashboard
+     * Adds or overrides tags used to label this event in the dashboard.
+     * Tags can be used for filtering, grouping, or ownership attribution.
      */
     tags?: { [key: string]: string };
 
     /**
-     * Set to `true` to enable tracking of this event handler in the dashboard.
-     * Set to `false` to disable tracking. If omitted, Mokapi checks the response
-     * object to determine if the handler changed it, and tracks it accordingly.
+     * Controls whether this event handler is tracked in the dashboard.
+     *
+     * - true: always track this handler
+     * - false: never track this handler
+     * - undefined: Mokapi determines tracking automatically based on
+     *   whether the response object was modified by the handler
      */
     track?: boolean;
+
+    /**
+     * Defines the execution order of the event handler.
+     *
+     * Handlers with higher priority values run first.
+     * Handlers with lower priority values run later.
+     *
+     * Use negative priorities (e.g. -1) to run a handler after
+     * the response has been fully populated by other handlers,
+     * such as for logging or recording purposes.
+     */
+    priority?: number;
 }
 
 /**

types/mokapi/package.json

@@ -1,7 +1,7 @@
 {
     "private": true,
     "name": "@types/mokapi",
-    "version": "0.29.9999",
+    "version": "0.34.9999",
     "nonNpm": true,
     "nonNpmDescription": "Mokapi",
     "projects": [

types/mokapi/test/file-test.ts

@@ -0,0 +1,16 @@
+import { appendString, read, writeString } from "mokapi/file";
+
+// @ts-expect-error
+read(123);
+read("data.json");
+// @ts-expect-error
+const i: number = read("data.json");
+const s: string = read("data.json");
+
+writeString("data.txt", "Hello World");
+// @ts-expect-error
+writeString("data.txt", 123);
+
+appendString("data.txt", "Hello Again");
+// @ts-expect-error
+appendString("data.txt", 123);

types/mokapi/test/mokapi-tests.ts

@@ -46,19 +46,29 @@ on("http", handler, "");
 on("http", handler, {});
 on("http", handler, { tags: { foo: "bar" } });
 on("http", handler, { track: true });
+on("http", handler, { priority: 12 });
+// @ts-expect-error
+on("http", handler, { priority: true });
 on("http", async () => {});
 on("http", (request) => {
     request.querystring;
 });
 on("http", (request, response) => {
     const s = request.toString();
     const url = request.url.toString();
+    const api: string = request.api;
 
     response.headers = {
         "Content-Type": "application/json",
     };
     response.headers["Access-Control-Allow-Origin"] = "*";
     response.headers["foo"] = { bar: 123 };
+
+    response.rebuild(200, "application/json");
+    // @ts-expect-error
+    response.rebuild("200", "application/json");
+    // @ts-expect-error
+    response.rebuild(200, {});
 });
 
 // @ts-expect-error