@empiricalrun/playwright-utils 0.65.1 → 0.66.0

package/dist/generated/api-worker-openapi.d.ts

@@ -799,6 +799,58 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/kv": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List KV entries
+         * @description Lists unexpired entries in key order, optionally filtered by key prefix. Values are omitted unless `include_values=true`; a page with values ends early once it holds about 8 MB, so always follow `next_cursor`.
+         */
+        get: operations["listKvEntries"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/kv/{key}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get a KV entry
+         * @description Returns the entry stored under `key`, if it has not expired.
+         */
+        get: operations["getKvEntry"];
+        /**
+         * Write a KV entry
+         * @description Creates or replaces the entry under `key` with a required TTL. Send `If-None-Match: *` to create only (e.g. acquire a lock) or `If-Match: <version>` to replace only an unchanged entry.
+         */
+        put: operations["putKvEntry"];
+        post?: never;
+        /**
+         * Delete a KV entry
+         * @description Deletes the entry under `key`. Send `If-Match: <version>` to delete only an unchanged entry (e.g. release a lock you still hold).
+         */
+        delete: operations["deleteKvEntry"];
+        options?: never;
+        head?: never;
+        /**
+         * Refresh a KV entry's TTL
+         * @description Resets the entry's TTL without resending its value, e.g. to extend a lock lease. Send `If-Match: <version>` to refresh only an unchanged entry.
+         */
+        patch: operations["refreshKvEntry"];
+        trace?: never;
+    };
     "/api/v1/analytics/test-cases": {
         parameters: {
             query?: never;
@@ -5839,12 +5891,14 @@ export interface paths {
         };
         /**
          * ⚙️ Read project KV value
+         * @deprecated
          * @description Reads a value from the scoped project's KV namespace.
          */
         get: operations["getProjectKv"];
         put?: never;
         /**
          * ⚙️ Write project KV value
+         * @deprecated
          * @description Writes a value into the scoped project's KV namespace with a bounded TTL.
          */
         post: operations["setProjectKv"];
@@ -10380,6 +10434,109 @@ export interface components {
             /** @description Error detail when ingestion fails. */
             error?: unknown;
         };
+        KvEntry: {
+            /** @description Key, 1-512 characters from `A-Z a-z 0-9 . _ : -`. Use `:` to namespace keys, e.g. `pw-lock:1234:user-settings`. */
+            key: string;
+            /** @description The stored JSON value. Omitted from list responses unless `include_values=true`. */
+            value?: (string | number | boolean | unknown[] | {
+                [key: string]: unknown;
+            }) | null;
+            /** @description Increments on every write. Send it as `If-Match` to make a write conditional. */
+            version: number;
+            /**
+             * Format: date-time
+             * @description ISO 8601 timestamp when the entry expires.
+             */
+            expires_at: string;
+            /**
+             * Format: date-time
+             * @description ISO 8601 timestamp when the entry was first written.
+             */
+            created_at: string;
+            /**
+             * Format: date-time
+             * @description ISO 8601 timestamp of the latest write or TTL refresh.
+             */
+            updated_at: string;
+            written_by: components["schemas"]["KvWriter"];
+        };
+        KvEntryResponse: {
+            /** @description Response payload. */
+            data: {
+                entry: components["schemas"]["KvEntry"];
+            };
+        };
+        KvListResponse: {
+            /** @description Response payload. */
+            data: {
+                entries: components["schemas"]["KvEntry"][];
+                /** @description Pass as `cursor` to load the next page; `null` at the end. */
+                next_cursor: string | null;
+            };
+        };
+        KvPreconditionFailedResponse: {
+            /** @description Always null for error responses. */
+            data: unknown;
+            /** @description Error details with the current entry. */
+            error: {
+                /** @description Human-readable error message. */
+                message: string;
+                /** @description The entry as it is now, or `null` if the key does not exist. */
+                current: {
+                    /** @description Key, 1-512 characters from `A-Z a-z 0-9 . _ : -`. Use `:` to namespace keys, e.g. `pw-lock:1234:user-settings`. */
+                    key: string;
+                    /** @description The stored JSON value. Omitted from list responses unless `include_values=true`. */
+                    value?: (string | number | boolean | unknown[] | {
+                        [key: string]: unknown;
+                    }) | null;
+                    /** @description Increments on every write. Send it as `If-Match` to make a write conditional. */
+                    version: number;
+                    /**
+                     * Format: date-time
+                     * @description ISO 8601 timestamp when the entry expires.
+                     */
+                    expires_at: string;
+                    /**
+                     * Format: date-time
+                     * @description ISO 8601 timestamp when the entry was first written.
+                     */
+                    created_at: string;
+                    /**
+                     * Format: date-time
+                     * @description ISO 8601 timestamp of the latest write or TTL refresh.
+                     */
+                    updated_at: string;
+                    written_by: components["schemas"]["KvWriter"];
+                } | null;
+            };
+        };
+        /** @description Who last wrote or refreshed the entry. */
+        KvWriter: {
+            /** @enum {string} */
+            kind: "user";
+            /** @description User ID. */
+            id: string;
+        } | {
+            /** @enum {string} */
+            kind: "chat_session";
+            /** @description Chat session ID. */
+            id: string;
+        } | {
+            /** @enum {string} */
+            kind: "test_run";
+            /** @description Test run ID. */
+            id: string;
+        } | {
+            /** @enum {string} */
+            kind: "api_key";
+            /** @description Project API key ID. */
+            id: string;
+        } | {
+            /** @enum {string} */
+            kind: "system";
+            /** @description Service name, when known. */
+            id: string | null;
+        };
         LastPassPerEnvEntry: {
             /** @description Environment ID the test last passed in. */
             environment_id: string;
@@ -11816,6 +11973,10 @@ export interface components {
             } | null;
             source_run_id?: number | null;
         };
+        PatchKvEntryRequest: {
+            /** @description Time-to-live in seconds (max 30 days). */
+            ttl: number;
+        };
         PatchProjectResponse: {
             /** @description Always true. */
             success: boolean;
@@ -12446,6 +12607,14 @@ export interface components {
             /** @description Rules that do not affect how Empirical merges, e.g. "Blocks force pushes". */
             other_rules: string[];
         };
+        PutKvEntryRequest: {
+            /** @description JSON value to store (max 1 MB serialized). */
+            value: (string | number | boolean | unknown[] | {
+                [key: string]: unknown;
+            }) | null;
+            /** @description Time-to-live in seconds (max 30 days). */
+            ttl: number;
+        };
         PutRunManifestRequest: {
             /** @description Structured scheduled tests. */
             tests: {
@@ -18608,6 +18777,314 @@ export interface operations {
             };
         };
     };
+    listKvEntries: {
+        parameters: {
+            query?: {
+                /** @description Only return keys that start with this prefix. */
+                prefix?: string;
+                /** @description Pass a previous page's `next_cursor` to continue listing. */
+                cursor?: string;
+                /** @description Maximum entries to return (max 1000). */
+                limit?: number;
+                /** @description Include each entry's value. */
+                include_values?: "true" | "false";
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description A page of entries. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["KvListResponse"];
+                };
+            };
+            /** @description Invalid request. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description KV store not configured. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    getKvEntry: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Key, 1-512 characters from `A-Z a-z 0-9 . _ : -`. Use `:` to namespace keys, e.g. `pw-lock:1234:user-settings`. */
+                key: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The entry. */
+            200: {
+                headers: {
+                    /** @description The entry's `version`, for use in `If-Match`. */
+                    ETag: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["KvEntryResponse"];
+                };
+            };
+            /** @description Invalid key. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description No entry under this key. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description KV store not configured. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    putKvEntry: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Apply only if the entry's current `version` equals this value (its `ETag`). */
+                "if-match"?: string;
+                /** @description Send `*` to write only if the key does not exist. */
+                "if-none-match"?: "*";
+            };
+            path: {
+                /** @description Key, 1-512 characters from `A-Z a-z 0-9 . _ : -`. Use `:` to namespace keys, e.g. `pw-lock:1234:user-settings`. */
+                key: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["PutKvEntryRequest"];
+            };
+        };
+        responses: {
+            /** @description The entry was replaced. */
+            200: {
+                headers: {
+                    /** @description The entry's `version`, for use in `If-Match`. */
+                    ETag: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["KvEntryResponse"];
+                };
+            };
+            /** @description The entry was created. */
+            201: {
+                headers: {
+                    /** @description The entry's `version`, for use in `If-Match`. */
+                    ETag: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["KvEntryResponse"];
+                };
+            };
+            /** @description Invalid request. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description The `If-Match` or `If-None-Match` condition did not hold. */
+            412: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["KvPreconditionFailedResponse"];
+                };
+            };
+            /** @description Value larger than 1 MB. */
+            413: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description KV store not configured. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    deleteKvEntry: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Apply only if the entry's current `version` equals this value (its `ETag`). */
+                "if-match"?: string;
+            };
+            path: {
+                /** @description Key, 1-512 characters from `A-Z a-z 0-9 . _ : -`. Use `:` to namespace keys, e.g. `pw-lock:1234:user-settings`. */
+                key: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Deleted. */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Invalid request. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description No entry under this key. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description The `If-Match` or `If-None-Match` condition did not hold. */
+            412: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["KvPreconditionFailedResponse"];
+                };
+            };
+            /** @description KV store not configured. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    refreshKvEntry: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Apply only if the entry's current `version` equals this value (its `ETag`). */
+                "if-match"?: string;
+            };
+            path: {
+                /** @description Key, 1-512 characters from `A-Z a-z 0-9 . _ : -`. Use `:` to namespace keys, e.g. `pw-lock:1234:user-settings`. */
+                key: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["PatchKvEntryRequest"];
+            };
+        };
+        responses: {
+            /** @description The refreshed entry. */
+            200: {
+                headers: {
+                    /** @description The entry's `version`, for use in `If-Match`. */
+                    ETag: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["KvEntryResponse"];
+                };
+            };
+            /** @description Invalid request. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description No entry under this key. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description The `If-Match` or `If-None-Match` condition did not hold. */
+            412: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["KvPreconditionFailedResponse"];
+                };
+            };
+            /** @description KV store not configured. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
     listTestCasesAnalyticsV1: {
         parameters: {
             query?: {
@@ -32554,7 +33031,7 @@ export interface operations {
                     key: string;
                     /** @description JSON value to store. */
                     value?: unknown;
-                    /** @description Time-to-live in seconds (max 2 days). */
+                    /** @description Time-to-live in seconds (max 30 days). */
                     ttl: number;
                 };
             };
@@ -32578,7 +33055,7 @@ export interface operations {
                     "application/json": components["schemas"]["ErrorResponse"];
                 };
             };
-            /** @description Value larger than 2 MB. */
+            /** @description Value larger than 1 MB. */
             413: {
                 headers: {
                     [name: string]: unknown;