mary.my.id / atcute
a collection of lightweight TypeScript packages for AT Protocol, the protocol powering Bluesky
atproto bluesky typescript npm
101
fork

Configure Feed

Select the types of activity you want to include in your feed.

chore: remove oauth-cab packages (moved to feature/oauth-cab branch)

the CAB implementation isn't ready for release yet and shouldn't block
other releases. the work is preserved in the feature/oauth-cab branch.

Mary d38cf3e5 13f6c34f

-13408
-12
packages/oauth/cab-example/.gitignore
··· 1 - dist 2 - dist-ssr 3 - coverage 4 - *.local 5 - 6 - *.tsbuildinfo 7 - 8 - .wrangler 9 - .dev.vars* 10 - !.dev.vars.example 11 - .env* 12 - !.env.example
-89
packages/oauth/cab-example/README.md
··· 1 - # @atcute/oauth-cab example 2 - 3 - this example demonstrates a confidential OAuth browser client using `@atcute/oauth-cab` with 4 - Cloudflare Workers. 5 - 6 - ## requirements 7 - 8 - confidential OAuth clients must be accessible via **https** since the authorization server needs to 9 - fetch the client metadata and JWKS from the client_id URL. 10 - 11 - for local development, use a tunneling service like 12 - [Cloudflare Tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/). 13 - 14 - ## setup 15 - 16 - install dependencies: 17 - 18 - ```sh 19 - pnpm install 20 - ``` 21 - 22 - generate a fresh private key: 23 - 24 - ```sh 25 - pnpm run setup:env 26 - ``` 27 - 28 - then edit `.dev.vars` and set `PUBLIC_URL` to your public https URL. 29 - 30 - regenerate types: 31 - 32 - ```sh 33 - pnpm run cf-typegen 34 - ``` 35 - 36 - ## running with cloudflared 37 - 38 - 1. start a quick tunnel: 39 - 40 - ```sh 41 - cloudflared tunnel --url http://localhost:5173 42 - ``` 43 - 44 - 2. copy the https URL (e.g. `https://abc-xyz.trycloudflare.com`) 45 - 46 - 3. set `PUBLIC_URL` in `.dev.vars`: 47 - 48 - ``` 49 - PRIVATE_KEY_JWK={"kty":"EC",...} 50 - PUBLIC_URL=https://abc-xyz.trycloudflare.com 51 - ``` 52 - 53 - 4. regenerate types and start the dev server: 54 - 55 - ```sh 56 - pnpm run cf-typegen 57 - pnpm run dev 58 - ``` 59 - 60 - 5. open the tunnel URL in your browser 61 - 62 - ## environment variables 63 - 64 - - `PRIVATE_KEY_JWK` (required) - JSON Web Key used for client authentication 65 - - `PUBLIC_URL` (required) - the https URL where this app is accessible 66 - 67 - ## deployment 68 - 69 - deploy to Cloudflare Workers: 70 - 71 - ```sh 72 - pnpm run deploy 73 - ``` 74 - 75 - set secrets on the deployed worker: 76 - 77 - ```sh 78 - wrangler secret put PRIVATE_KEY_JWK 79 - wrangler secret put PUBLIC_URL 80 - ``` 81 - 82 - ## routes 83 - 84 - - `/` - home page with login form 85 - - `/oauth/callback` - OAuth callback handler 86 - - `/protected` - example protected resource (fetches session info) 87 - - `/oauth-client-metadata.json` - serves client metadata for discovery 88 - - `/jwks.json` - serves client JWKS (public keys) for discovery 89 - - `/xrpc/dev.atcute.oauth.getClientAssertion` - CAB endpoint
-1
packages/oauth/cab-example/env.d.ts
··· 1 - /// <reference types="vite/client" />
-13
packages/oauth/cab-example/index.html
··· 1 - <!doctype html> 2 - <html lang=""> 3 - <head> 4 - <meta charset="UTF-8" /> 5 - <link rel="icon" href="/favicon.ico" /> 6 - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> 7 - <title>Vite App</title> 8 - </head> 9 - <body> 10 - <div id="app"></div> 11 - <script type="module" src="/src/main.ts"></script> 12 - </body> 13 - </html>
-39
packages/oauth/cab-example/package.json
··· 1 - { 2 - "name": "cab-example", 3 - "version": "0.0.0", 4 - "private": true, 5 - "type": "module", 6 - "scripts": { 7 - "dev": "vite", 8 - "build": "run-p type-check \"build-only {@}\" --", 9 - "preview": "pnpm run build && wrangler dev", 10 - "build-only": "vite build", 11 - "type-check": "vue-tsc --build", 12 - "deploy": "pnpm run build && wrangler deploy", 13 - "cf-typegen": "wrangler types", 14 - "setup:env": "tsx scripts/setup-env.ts" 15 - }, 16 - "dependencies": { 17 - "@atcute/client": "workspace:*", 18 - "@atcute/identity-resolver": "workspace:*", 19 - "@atcute/lexicons": "workspace:*", 20 - "@atcute/oauth-browser-client": "workspace:*", 21 - "@atcute/oauth-cab": "workspace:*", 22 - "vue": "^3.5.26", 23 - "vue-router": "^4.6.4" 24 - }, 25 - "devDependencies": { 26 - "@cloudflare/vite-plugin": "^1.21.0", 27 - "@tsconfig/node24": "^24.0.3", 28 - "@types/node": "^24.10.4", 29 - "@vitejs/plugin-vue": "^6.0.3", 30 - "@vue/tsconfig": "^0.8.1", 31 - "npm-run-all2": "^8.0.4", 32 - "tsx": "^4.19.4", 33 - "typescript": "~5.9.3", 34 - "vite": "^7.3.0", 35 - "vite-plugin-vue-devtools": "^8.0.5", 36 - "vue-tsc": "^3.2.2", 37 - "wrangler": "^4.59.2" 38 - } 39 - }
packages/oauth/cab-example/public/favicon.ico

This is a binary file and will not be displayed.

-48
packages/oauth/cab-example/scripts/setup-env.ts
··· 1 - import { readFileSync, writeFileSync } from 'node:fs'; 2 - 3 - import { exportJwkKey, generatePrivateKey } from '@atcute/oauth-cab/server'; 4 - 5 - const upsertEnvVar = (input: string, key: string, value: string): string => { 6 - const line = `${key}=${value}`; 7 - const re = new RegExp(`^${key}=.*$`, 'm'); 8 - 9 - if (re.test(input)) { 10 - const match = input.match(re); 11 - const current = match ? match[0].slice(key.length + 1) : ''; 12 - const trimmed = current.trim(); 13 - 14 - // only replace if empty 15 - if (trimmed === '' || trimmed === `''` || trimmed === `""`) { 16 - return input.replace(re, line); 17 - } 18 - 19 - return input; 20 - } 21 - 22 - const suffix = input.endsWith('\n') || input.length === 0 ? '' : '\n'; 23 - return `${input}${suffix}${line}\n`; 24 - }; 25 - 26 - let devVars = ''; 27 - try { 28 - devVars = readFileSync('.env', 'utf8'); 29 - } catch { 30 - // file doesn't exist, start fresh 31 - } 32 - 33 - const privateKey = await generatePrivateKey('main', 'ES256'); 34 - const jwk = await exportJwkKey(privateKey); 35 - const jwkJson = JSON.stringify(jwk); 36 - 37 - let updated = devVars; 38 - updated = upsertEnvVar(updated, 'PRIVATE_KEY_JWK', jwkJson); 39 - updated = upsertEnvVar(updated, 'PUBLIC_URL', ''); 40 - 41 - writeFileSync('.env', updated); 42 - 43 - console.log('updated .env'); 44 - console.log(''); 45 - console.log('next steps:'); 46 - console.log(' 1. set PUBLIC_URL in .env to your tunnel URL (e.g. https://abc123.trycloudflare.com)'); 47 - console.log(' 2. run `pnpm run cf-typegen` to regenerate types'); 48 - console.log(' 3. run `pnpm run dev` to start the dev server');
-47
packages/oauth/cab-example/server/index.ts
··· 1 - import { buildClientMetadata, createCabHandler, importJwkKey, Keyset, scope } from '@atcute/oauth-cab/server'; 2 - 3 - import { env } from 'cloudflare:workers'; 4 - 5 - const keyset = new Keyset([await importJwkKey(env.PRIVATE_KEY_JWK)]); 6 - 7 - const metadata = buildClientMetadata( 8 - { 9 - client_id: new URL('/oauth-client-metadata.json', env.PUBLIC_URL).href, 10 - redirect_uris: [new URL('/oauth/callback', env.PUBLIC_URL).href], 11 - scope: [scope.repo({ collection: ['app.bsky.feed.post'] })], 12 - client_name: 'atcute oauth cab example', 13 - client_uri: env.PUBLIC_URL, 14 - jwks_uri: new URL('/jwks.json', env.PUBLIC_URL).href, 15 - }, 16 - keyset, 17 - ); 18 - 19 - const cabHandler = await createCabHandler({ 20 - client_id: metadata.client_id!, 21 - keyset, 22 - }); 23 - 24 - export default { 25 - async fetch(request: Request): Promise<Response> { 26 - const url = new URL(request.url); 27 - 28 - if (url.pathname === '/oauth-client-metadata.json') { 29 - return Response.json(metadata, { 30 - headers: { 'cache-control': 'public, max-age=3600' }, 31 - }); 32 - } 33 - 34 - if (url.pathname === '/jwks.json') { 35 - return Response.json(keyset.publicJwks, { 36 - headers: { 'cache-control': 'public, max-age=3600' }, 37 - }); 38 - } 39 - 40 - const response = cabHandler(request); 41 - if (response !== undefined) { 42 - return response; 43 - } 44 - 45 - return new Response(null, { status: 404 }); 46 - }, 47 - } satisfies ExportedHandler<Env>;
-32
packages/oauth/cab-example/src/App.vue
··· 1 - <script setup lang="ts"> 2 - import { RouterView } from 'vue-router'; 3 - </script> 4 - 5 - <template> 6 - <RouterView /> 7 - </template> 8 - 9 - <style> 10 - :root { 11 - color-scheme: light dark; 12 - } 13 - 14 - body { 15 - font-family: 16 - ui-sans-serif, 17 - system-ui, 18 - -apple-system, 19 - sans-serif; 20 - margin: 0; 21 - line-height: 1.5; 22 - } 23 - 24 - code, 25 - pre { 26 - font-family: ui-monospace, SFMono-Regular, Menlo, monospace; 27 - } 28 - 29 - a { 30 - color: inherit; 31 - } 32 - </style>
-31
packages/oauth/cab-example/src/lib/oauth.ts
··· 1 - import { 2 - CompositeDidDocumentResolver, 3 - LocalActorResolver, 4 - PlcDidDocumentResolver, 5 - WebDidDocumentResolver, 6 - XrpcHandleResolver, 7 - } from '@atcute/identity-resolver'; 8 - import { configureOAuth } from '@atcute/oauth-browser-client'; 9 - import { createCabFetcher } from '@atcute/oauth-cab/client'; 10 - 11 - const CLIENT_ID = import.meta.env.VITE_OAUTH_CLIENT_ID; 12 - const REDIRECT_URI = import.meta.env.VITE_OAUTH_REDIRECT_URI; 13 - 14 - configureOAuth({ 15 - metadata: { 16 - client_id: CLIENT_ID, 17 - redirect_uri: REDIRECT_URI, 18 - }, 19 - identityResolver: new LocalActorResolver({ 20 - handleResolver: new XrpcHandleResolver({ serviceUrl: 'https://public.api.bsky.app' }), 21 - didDocumentResolver: new CompositeDidDocumentResolver({ 22 - methods: { 23 - plc: new PlcDidDocumentResolver(), 24 - web: new WebDidDocumentResolver(), 25 - }, 26 - }), 27 - }), 28 - fetchClientAssertion: createCabFetcher(), 29 - }); 30 - 31 - export { CLIENT_ID, REDIRECT_URI };
-10
packages/oauth/cab-example/src/main.ts
··· 1 - import { createApp } from 'vue'; 2 - 3 - import App from './App.vue'; 4 - import router from './router'; 5 - 6 - const app = createApp(App); 7 - 8 - app.use(router); 9 - 10 - app.mount('#app');
-26
packages/oauth/cab-example/src/router/index.ts
··· 1 - import { createRouter, createWebHistory } from 'vue-router'; 2 - 3 - import HomeView from '../views/HomeView.vue'; 4 - 5 - const router = createRouter({ 6 - history: createWebHistory(import.meta.env.BASE_URL), 7 - routes: [ 8 - { 9 - path: '/', 10 - name: 'home', 11 - component: HomeView, 12 - }, 13 - { 14 - path: '/oauth/callback', 15 - name: 'callback', 16 - component: () => import('../views/CallbackView.vue'), 17 - }, 18 - { 19 - path: '/protected', 20 - name: 'protected', 21 - component: () => import('../views/ProtectedView.vue'), 22 - }, 23 - ], 24 - }); 25 - 26 - export default router;
-59
packages/oauth/cab-example/src/views/CallbackView.vue
··· 1 - <script setup lang="ts"> 2 - import { onMounted, ref } from 'vue'; 3 - import { useRouter } from 'vue-router'; 4 - 5 - import '../lib/oauth'; 6 - import { finalizeAuthorization } from '@atcute/oauth-browser-client'; 7 - 8 - const router = useRouter(); 9 - 10 - const error = ref(''); 11 - 12 - onMounted(async () => { 13 - try { 14 - // server redirects with params in hash 15 - const params = new URLSearchParams(location.hash.slice(1)); 16 - 17 - // scrub params from URL to prevent replay 18 - history.replaceState(null, '', location.pathname + location.search); 19 - 20 - const { session } = await finalizeAuthorization(params); 21 - 22 - // store DID for session tracking 23 - localStorage.setItem('session_did', session.did); 24 - 25 - router.replace('/protected'); 26 - } catch (err) { 27 - error.value = err instanceof Error ? err.message : 'callback failed'; 28 - } 29 - }); 30 - </script> 31 - 32 - <template> 33 - <main> 34 - <div v-if="error" class="error"> 35 - <h1>callback error</h1> 36 - <p>{{ error }}</p> 37 - <router-link to="/">back home</router-link> 38 - </div> 39 - <p v-else>completing authorization...</p> 40 - </main> 41 - </template> 42 - 43 - <style scoped> 44 - main { 45 - max-width: 40rem; 46 - margin: 2rem auto; 47 - padding: 0 1rem; 48 - } 49 - 50 - .error h1 { 51 - font-size: 1.25rem; 52 - margin-bottom: 0.5rem; 53 - } 54 - 55 - .error p { 56 - color: #e53935; 57 - margin-bottom: 1rem; 58 - } 59 - </style>
-178
packages/oauth/cab-example/src/views/HomeView.vue
··· 1 - <script setup lang="ts"> 2 - import { ref } from 'vue'; 3 - import { useRouter } from 'vue-router'; 4 - 5 - import '../lib/oauth'; 6 - import { createAuthorizationUrl, getSession } from '@atcute/oauth-browser-client'; 7 - import { isActorIdentifier } from '@atcute/lexicons/syntax'; 8 - 9 - const router = useRouter(); 10 - 11 - const identifier = ref(''); 12 - const error = ref(''); 13 - const loading = ref(false); 14 - const sessionDid = ref<string | null>(localStorage.getItem('session_did')); 15 - 16 - const login = async () => { 17 - const value = identifier.value.trim(); 18 - if (!value) { 19 - error.value = 'please enter a handle or DID'; 20 - return; 21 - } 22 - 23 - if (!isActorIdentifier(value)) { 24 - error.value = 'invalid handle or DID'; 25 - return; 26 - } 27 - 28 - error.value = ''; 29 - loading.value = true; 30 - 31 - try { 32 - const authUrl = await createAuthorizationUrl({ 33 - target: { type: 'account', identifier: value }, 34 - scope: 'atproto transition:generic', 35 - }); 36 - 37 - await new Promise((resolve) => setTimeout(resolve, 200)); 38 - window.location.assign(authUrl); 39 - } catch (err) { 40 - error.value = err instanceof Error ? err.message : 'authorization failed'; 41 - loading.value = false; 42 - } 43 - }; 44 - 45 - const logout = () => { 46 - localStorage.removeItem('session_did'); 47 - sessionDid.value = null; 48 - }; 49 - 50 - const goToProtected = async () => { 51 - if (!sessionDid.value) { 52 - return; 53 - } 54 - 55 - try { 56 - await getSession(sessionDid.value, { allowStale: true }); 57 - router.push('/protected'); 58 - } catch { 59 - logout(); 60 - } 61 - }; 62 - </script> 63 - 64 - <template> 65 - <main> 66 - <h1>atcute oauth cab example</h1> 67 - 68 - <div v-if="sessionDid" class="session"> 69 - <p> 70 - signed in as <code>{{ sessionDid }}</code> 71 - </p> 72 - <div class="actions"> 73 - <button @click="goToProtected">open protected page</button> 74 - <button @click="logout">logout</button> 75 - </div> 76 - </div> 77 - 78 - <form v-else @submit.prevent="login" class="login-form"> 79 - <input 80 - v-model="identifier" 81 - type="text" 82 - placeholder="handle (alice.bsky.social) or DID (did:plc:...)" 83 - :disabled="loading" 84 - /> 85 - <button type="submit" :disabled="loading"> 86 - {{ loading ? 'redirecting...' : 'login' }} 87 - </button> 88 - <p v-if="error" class="error">{{ error }}</p> 89 - </form> 90 - 91 - <hr /> 92 - 93 - <p class="muted"> 94 - debug: 95 - <a href="/oauth-client-metadata.json">client metadata</a>, 96 - <a href="/jwks.json">jwks</a> 97 - </p> 98 - </main> 99 - </template> 100 - 101 - <style scoped> 102 - main { 103 - max-width: 40rem; 104 - margin: 2rem auto; 105 - padding: 0 1rem; 106 - } 107 - 108 - h1 { 109 - font-size: 1.5rem; 110 - margin-bottom: 1.5rem; 111 - } 112 - 113 - .session { 114 - margin-bottom: 1.5rem; 115 - } 116 - 117 - .session code { 118 - font-size: 0.9em; 119 - background: var(--color-background-soft); 120 - padding: 0.2em 0.4em; 121 - border-radius: 4px; 122 - } 123 - 124 - .actions { 125 - display: flex; 126 - gap: 0.5rem; 127 - margin-top: 0.75rem; 128 - } 129 - 130 - .login-form { 131 - display: flex; 132 - flex-direction: column; 133 - gap: 0.75rem; 134 - max-width: 24rem; 135 - } 136 - 137 - .login-form input { 138 - padding: 0.6rem 0.8rem; 139 - border: 1px solid var(--color-border); 140 - border-radius: 4px; 141 - background: var(--color-background); 142 - color: var(--color-text); 143 - } 144 - 145 - button { 146 - padding: 0.6rem 0.8rem; 147 - border: none; 148 - border-radius: 4px; 149 - background: var(--color-heading); 150 - color: var(--color-background); 151 - cursor: pointer; 152 - } 153 - 154 - button:disabled { 155 - opacity: 0.6; 156 - cursor: not-allowed; 157 - } 158 - 159 - .error { 160 - color: #e53935; 161 - margin: 0; 162 - } 163 - 164 - hr { 165 - border: none; 166 - border-top: 1px solid var(--color-border); 167 - margin: 1.5rem 0; 168 - } 169 - 170 - .muted { 171 - opacity: 0.7; 172 - font-size: 0.9rem; 173 - } 174 - 175 - .muted a { 176 - color: inherit; 177 - } 178 - </style>
-149
packages/oauth/cab-example/src/views/ProtectedView.vue
··· 1 - <script setup lang="ts"> 2 - import { onMounted, ref } from 'vue'; 3 - import { useRouter } from 'vue-router'; 4 - 5 - import '../lib/oauth'; 6 - import { Client } from '@atcute/client'; 7 - import { deleteStoredSession, getSession, OAuthUserAgent } from '@atcute/oauth-browser-client'; 8 - 9 - const router = useRouter(); 10 - 11 - const sessionDid = ref(localStorage.getItem('session_did')); 12 - const tokenInfo = ref<object | null>(null); 13 - const pdsSession = ref<object | null>(null); 14 - const error = ref(''); 15 - 16 - const logout = async () => { 17 - if (!sessionDid.value) { 18 - return; 19 - } 20 - 21 - try { 22 - const session = await getSession(sessionDid.value, { allowStale: true }); 23 - const agent = new OAuthUserAgent(session); 24 - await agent.signOut(); 25 - } catch { 26 - deleteStoredSession(sessionDid.value); 27 - } 28 - 29 - localStorage.removeItem('session_did'); 30 - router.replace('/'); 31 - }; 32 - 33 - onMounted(async () => { 34 - if (!sessionDid.value) { 35 - router.replace('/'); 36 - return; 37 - } 38 - 39 - try { 40 - const session = await getSession(sessionDid.value, { allowStale: true }); 41 - const agent = new OAuthUserAgent(session); 42 - const rpc = new Client({ handler: agent }); 43 - 44 - tokenInfo.value = await session.getTokenInfo('auto'); 45 - 46 - const response = await rpc.get('com.atproto.server.getSession', {}); 47 - pdsSession.value = response.data; 48 - } catch (err) { 49 - error.value = err instanceof Error ? err.message : 'failed to load session'; 50 - } 51 - }); 52 - </script> 53 - 54 - <template> 55 - <main> 56 - <h1>protected</h1> 57 - 58 - <p class="desc">this page calls <code>com.atproto.server.getSession</code> using the OAuth session.</p> 59 - 60 - <div class="actions"> 61 - <router-link to="/">home</router-link> 62 - <button @click="logout">logout</button> 63 - </div> 64 - 65 - <div v-if="error" class="error"> 66 - <p>{{ error }}</p> 67 - </div> 68 - 69 - <template v-else-if="tokenInfo && pdsSession"> 70 - <section> 71 - <h2>token</h2> 72 - <pre>{{ JSON.stringify(tokenInfo, null, 2) }}</pre> 73 - </section> 74 - 75 - <section> 76 - <h2>pds session</h2> 77 - <pre>{{ JSON.stringify(pdsSession, null, 2) }}</pre> 78 - </section> 79 - </template> 80 - 81 - <p v-else>loading...</p> 82 - </main> 83 - </template> 84 - 85 - <style scoped> 86 - main { 87 - max-width: 40rem; 88 - margin: 2rem auto; 89 - padding: 0 1rem; 90 - } 91 - 92 - h1 { 93 - font-size: 1.5rem; 94 - margin-bottom: 0.5rem; 95 - } 96 - 97 - h2 { 98 - font-size: 1.1rem; 99 - margin-bottom: 0.5rem; 100 - } 101 - 102 - .desc { 103 - margin-bottom: 1rem; 104 - opacity: 0.8; 105 - } 106 - 107 - .desc code { 108 - font-size: 0.9em; 109 - background: var(--color-background-soft); 110 - padding: 0.2em 0.4em; 111 - border-radius: 4px; 112 - } 113 - 114 - .actions { 115 - display: flex; 116 - gap: 1rem; 117 - align-items: center; 118 - margin-bottom: 1.5rem; 119 - } 120 - 121 - .actions a { 122 - color: var(--color-text); 123 - } 124 - 125 - button { 126 - padding: 0.5rem 0.75rem; 127 - border: none; 128 - border-radius: 4px; 129 - background: var(--color-heading); 130 - color: var(--color-background); 131 - cursor: pointer; 132 - } 133 - 134 - section { 135 - margin-bottom: 1.5rem; 136 - } 137 - 138 - pre { 139 - background: var(--color-background-soft); 140 - padding: 1rem; 141 - border-radius: 4px; 142 - overflow-x: auto; 143 - font-size: 0.85rem; 144 - } 145 - 146 - .error p { 147 - color: #e53935; 148 - } 149 - </style>
-12
packages/oauth/cab-example/tsconfig.app.json
··· 1 - { 2 - "extends": "@vue/tsconfig/tsconfig.dom.json", 3 - "include": ["env.d.ts", "src/**/*", "src/**/*.vue"], 4 - "exclude": ["src/**/__tests__/*"], 5 - "compilerOptions": { 6 - "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo", 7 - 8 - "paths": { 9 - "@/*": ["./src/*"] 10 - } 11 - } 12 - }
-17
packages/oauth/cab-example/tsconfig.json
··· 1 - { 2 - "files": [], 3 - "references": [ 4 - { 5 - "path": "./tsconfig.node.json" 6 - }, 7 - { 8 - "path": "./tsconfig.app.json" 9 - }, 10 - { 11 - "path": "./tsconfig.worker.json" 12 - } 13 - ], 14 - "compilerOptions": { 15 - "types": ["./worker-configuration.d.ts"] 16 - } 17 - }
-20
packages/oauth/cab-example/tsconfig.node.json
··· 1 - { 2 - "extends": "@tsconfig/node24/tsconfig.json", 3 - "include": [ 4 - "scripts/", 5 - "vite.config.*", 6 - "vitest.config.*", 7 - "cypress.config.*", 8 - "nightwatch.conf.*", 9 - "playwright.config.*", 10 - "eslint.config.*" 11 - ], 12 - "compilerOptions": { 13 - "noEmit": true, 14 - "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo", 15 - 16 - "module": "ESNext", 17 - "moduleResolution": "Bundler", 18 - "types": ["node"] 19 - } 20 - }
-8
packages/oauth/cab-example/tsconfig.worker.json
··· 1 - { 2 - "extends": "./tsconfig.node.json", 3 - "compilerOptions": { 4 - "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.worker.tsbuildinfo", 5 - "types": ["./worker-configuration.d.ts", "vite/client"] 6 - }, 7 - "include": ["server"] 8 - }
-27
packages/oauth/cab-example/vite.config.ts
··· 1 - import { fileURLToPath, URL } from 'node:url'; 2 - 3 - import { cloudflare } from '@cloudflare/vite-plugin'; 4 - import vue from '@vitejs/plugin-vue'; 5 - import { defineConfig } from 'vite'; 6 - 7 - // https://vite.dev/config/ 8 - export default defineConfig({ 9 - plugins: [ 10 - vue(), 11 - cloudflare(), 12 - { 13 - name: 'oauth-env', 14 - config() { 15 - const publicUrl = process.env.PUBLIC_URL; 16 - 17 - process.env.VITE_OAUTH_CLIENT_ID = `${publicUrl}/oauth-client-metadata.json`; 18 - process.env.VITE_OAUTH_REDIRECT_URI = `${publicUrl}/oauth/callback`; 19 - }, 20 - }, 21 - ], 22 - resolve: { 23 - alias: { 24 - '@': fileURLToPath(new URL('./src', import.meta.url)), 25 - }, 26 - }, 27 - });
-11831
packages/oauth/cab-example/worker-configuration.d.ts
··· 1 - /* eslint-disable */ 2 - // Generated by Wrangler by running `wrangler types` (hash: 2f3ce4ce60686ce07ea717c381194a1b) 3 - // Runtime types generated with workerd@1.20260114.0 2025-09-27 4 - declare namespace Cloudflare { 5 - interface GlobalProps { 6 - mainModule: typeof import('./server/index'); 7 - } 8 - interface Env { 9 - PRIVATE_KEY_JWK: string; 10 - PUBLIC_URL: string; 11 - } 12 - } 13 - interface Env extends Cloudflare.Env {} 14 - 15 - // Begin runtime types 16 - /*! ***************************************************************************** 17 - Copyright (c) Cloudflare. All rights reserved. 18 - Copyright (c) Microsoft Corporation. All rights reserved. 19 - 20 - Licensed under the Apache License, Version 2.0 (the "License"); you may not use 21 - this file except in compliance with the License. You may obtain a copy of the 22 - License at http://www.apache.org/licenses/LICENSE-2.0 23 - THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 24 - KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED 25 - WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE, 26 - MERCHANTABLITY OR NON-INFRINGEMENT. 27 - See the Apache Version 2.0 License for specific language governing permissions 28 - and limitations under the License. 29 - ***************************************************************************** */ 30 - /* eslint-disable */ 31 - // noinspection JSUnusedGlobalSymbols 32 - declare var onmessage: never; 33 - /** 34 - * The **`DOMException`** interface represents an abnormal event (called an **exception**) that occurs as a result of calling a method or accessing a property of a web API. 35 - * 36 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException) 37 - */ 38 - declare class DOMException extends Error { 39 - constructor(message?: string, name?: string); 40 - /** 41 - * The **`message`** read-only property of the a message or description associated with the given error name. 42 - * 43 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException/message) 44 - */ 45 - readonly message: string; 46 - /** 47 - * The **`name`** read-only property of the one of the strings associated with an error name. 48 - * 49 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException/name) 50 - */ 51 - readonly name: string; 52 - /** 53 - * The **`code`** read-only property of the DOMException interface returns one of the legacy error code constants, or `0` if none match. 54 - * @deprecated 55 - * 56 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException/code) 57 - */ 58 - readonly code: number; 59 - static readonly INDEX_SIZE_ERR: number; 60 - static readonly DOMSTRING_SIZE_ERR: number; 61 - static readonly HIERARCHY_REQUEST_ERR: number; 62 - static readonly WRONG_DOCUMENT_ERR: number; 63 - static readonly INVALID_CHARACTER_ERR: number; 64 - static readonly NO_DATA_ALLOWED_ERR: number; 65 - static readonly NO_MODIFICATION_ALLOWED_ERR: number; 66 - static readonly NOT_FOUND_ERR: number; 67 - static readonly NOT_SUPPORTED_ERR: number; 68 - static readonly INUSE_ATTRIBUTE_ERR: number; 69 - static readonly INVALID_STATE_ERR: number; 70 - static readonly SYNTAX_ERR: number; 71 - static readonly INVALID_MODIFICATION_ERR: number; 72 - static readonly NAMESPACE_ERR: number; 73 - static readonly INVALID_ACCESS_ERR: number; 74 - static readonly VALIDATION_ERR: number; 75 - static readonly TYPE_MISMATCH_ERR: number; 76 - static readonly SECURITY_ERR: number; 77 - static readonly NETWORK_ERR: number; 78 - static readonly ABORT_ERR: number; 79 - static readonly URL_MISMATCH_ERR: number; 80 - static readonly QUOTA_EXCEEDED_ERR: number; 81 - static readonly TIMEOUT_ERR: number; 82 - static readonly INVALID_NODE_TYPE_ERR: number; 83 - static readonly DATA_CLONE_ERR: number; 84 - get stack(): any; 85 - set stack(value: any); 86 - } 87 - type WorkerGlobalScopeEventMap = { 88 - fetch: FetchEvent; 89 - scheduled: ScheduledEvent; 90 - queue: QueueEvent; 91 - unhandledrejection: PromiseRejectionEvent; 92 - rejectionhandled: PromiseRejectionEvent; 93 - }; 94 - declare abstract class WorkerGlobalScope extends EventTarget<WorkerGlobalScopeEventMap> { 95 - EventTarget: typeof EventTarget; 96 - } 97 - /* The **`console`** object provides access to the debugging console (e.g., the Web console in Firefox). * 98 - * The **`console`** object provides access to the debugging console (e.g., the Web console in Firefox). 99 - * 100 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console) 101 - */ 102 - interface Console { 103 - 'assert'(condition?: boolean, ...data: any[]): void; 104 - /** 105 - * The **`console.clear()`** static method clears the console if possible. 106 - * 107 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/clear_static) 108 - */ 109 - clear(): void; 110 - /** 111 - * The **`console.count()`** static method logs the number of times that this particular call to `count()` has been called. 112 - * 113 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/count_static) 114 - */ 115 - count(label?: string): void; 116 - /** 117 - * The **`console.countReset()`** static method resets counter used with console/count_static. 118 - * 119 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/countReset_static) 120 - */ 121 - countReset(label?: string): void; 122 - /** 123 - * The **`console.debug()`** static method outputs a message to the console at the 'debug' log level. 124 - * 125 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/debug_static) 126 - */ 127 - debug(...data: any[]): void; 128 - /** 129 - * The **`console.dir()`** static method displays a list of the properties of the specified JavaScript object. 130 - * 131 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/dir_static) 132 - */ 133 - dir(item?: any, options?: any): void; 134 - /** 135 - * The **`console.dirxml()`** static method displays an interactive tree of the descendant elements of the specified XML/HTML element. 136 - * 137 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/dirxml_static) 138 - */ 139 - dirxml(...data: any[]): void; 140 - /** 141 - * The **`console.error()`** static method outputs a message to the console at the 'error' log level. 142 - * 143 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/error_static) 144 - */ 145 - error(...data: any[]): void; 146 - /** 147 - * The **`console.group()`** static method creates a new inline group in the Web console log, causing any subsequent console messages to be indented by an additional level, until console/groupEnd_static is called. 148 - * 149 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/group_static) 150 - */ 151 - group(...data: any[]): void; 152 - /** 153 - * The **`console.groupCollapsed()`** static method creates a new inline group in the console. 154 - * 155 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/groupCollapsed_static) 156 - */ 157 - groupCollapsed(...data: any[]): void; 158 - /** 159 - * The **`console.groupEnd()`** static method exits the current inline group in the console. 160 - * 161 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/groupEnd_static) 162 - */ 163 - groupEnd(): void; 164 - /** 165 - * The **`console.info()`** static method outputs a message to the console at the 'info' log level. 166 - * 167 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/info_static) 168 - */ 169 - info(...data: any[]): void; 170 - /** 171 - * The **`console.log()`** static method outputs a message to the console. 172 - * 173 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/log_static) 174 - */ 175 - log(...data: any[]): void; 176 - /** 177 - * The **`console.table()`** static method displays tabular data as a table. 178 - * 179 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/table_static) 180 - */ 181 - table(tabularData?: any, properties?: string[]): void; 182 - /** 183 - * The **`console.time()`** static method starts a timer you can use to track how long an operation takes. 184 - * 185 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/time_static) 186 - */ 187 - time(label?: string): void; 188 - /** 189 - * The **`console.timeEnd()`** static method stops a timer that was previously started by calling console/time_static. 190 - * 191 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/timeEnd_static) 192 - */ 193 - timeEnd(label?: string): void; 194 - /** 195 - * The **`console.timeLog()`** static method logs the current value of a timer that was previously started by calling console/time_static. 196 - * 197 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/timeLog_static) 198 - */ 199 - timeLog(label?: string, ...data: any[]): void; 200 - timeStamp(label?: string): void; 201 - /** 202 - * The **`console.trace()`** static method outputs a stack trace to the console. 203 - * 204 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/trace_static) 205 - */ 206 - trace(...data: any[]): void; 207 - /** 208 - * The **`console.warn()`** static method outputs a warning message to the console at the 'warning' log level. 209 - * 210 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/warn_static) 211 - */ 212 - warn(...data: any[]): void; 213 - } 214 - declare const console: Console; 215 - type BufferSource = ArrayBufferView | ArrayBuffer; 216 - type TypedArray = 217 - | Int8Array 218 - | Uint8Array 219 - | Uint8ClampedArray 220 - | Int16Array 221 - | Uint16Array 222 - | Int32Array 223 - | Uint32Array 224 - | Float32Array 225 - | Float64Array 226 - | BigInt64Array 227 - | BigUint64Array; 228 - declare namespace WebAssembly { 229 - class CompileError extends Error { 230 - constructor(message?: string); 231 - } 232 - class RuntimeError extends Error { 233 - constructor(message?: string); 234 - } 235 - type ValueType = 'anyfunc' | 'externref' | 'f32' | 'f64' | 'i32' | 'i64' | 'v128'; 236 - interface GlobalDescriptor { 237 - value: ValueType; 238 - mutable?: boolean; 239 - } 240 - class Global { 241 - constructor(descriptor: GlobalDescriptor, value?: any); 242 - value: any; 243 - valueOf(): any; 244 - } 245 - type ImportValue = ExportValue | number; 246 - type ModuleImports = Record<string, ImportValue>; 247 - type Imports = Record<string, ModuleImports>; 248 - type ExportValue = Function | Global | Memory | Table; 249 - type Exports = Record<string, ExportValue>; 250 - class Instance { 251 - constructor(module: Module, imports?: Imports); 252 - readonly exports: Exports; 253 - } 254 - interface MemoryDescriptor { 255 - initial: number; 256 - maximum?: number; 257 - shared?: boolean; 258 - } 259 - class Memory { 260 - constructor(descriptor: MemoryDescriptor); 261 - readonly buffer: ArrayBuffer; 262 - grow(delta: number): number; 263 - } 264 - type ImportExportKind = 'function' | 'global' | 'memory' | 'table'; 265 - interface ModuleExportDescriptor { 266 - kind: ImportExportKind; 267 - name: string; 268 - } 269 - interface ModuleImportDescriptor { 270 - kind: ImportExportKind; 271 - module: string; 272 - name: string; 273 - } 274 - abstract class Module { 275 - static customSections(module: Module, sectionName: string): ArrayBuffer[]; 276 - static exports(module: Module): ModuleExportDescriptor[]; 277 - static imports(module: Module): ModuleImportDescriptor[]; 278 - } 279 - type TableKind = 'anyfunc' | 'externref'; 280 - interface TableDescriptor { 281 - element: TableKind; 282 - initial: number; 283 - maximum?: number; 284 - } 285 - class Table { 286 - constructor(descriptor: TableDescriptor, value?: any); 287 - readonly length: number; 288 - get(index: number): any; 289 - grow(delta: number, value?: any): number; 290 - set(index: number, value?: any): void; 291 - } 292 - function instantiate(module: Module, imports?: Imports): Promise<Instance>; 293 - function validate(bytes: BufferSource): boolean; 294 - } 295 - /** 296 - * The **`ServiceWorkerGlobalScope`** interface of the Service Worker API represents the global execution context of a service worker. 297 - * Available only in secure contexts. 298 - * 299 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ServiceWorkerGlobalScope) 300 - */ 301 - interface ServiceWorkerGlobalScope extends WorkerGlobalScope { 302 - DOMException: typeof DOMException; 303 - WorkerGlobalScope: typeof WorkerGlobalScope; 304 - btoa(data: string): string; 305 - atob(data: string): string; 306 - setTimeout(callback: (...args: any[]) => void, msDelay?: number): number; 307 - setTimeout<Args extends any[]>(callback: (...args: Args) => void, msDelay?: number, ...args: Args): number; 308 - clearTimeout(timeoutId: number | null): void; 309 - setInterval(callback: (...args: any[]) => void, msDelay?: number): number; 310 - setInterval<Args extends any[]>(callback: (...args: Args) => void, msDelay?: number, ...args: Args): number; 311 - clearInterval(timeoutId: number | null): void; 312 - queueMicrotask(task: Function): void; 313 - structuredClone<T>(value: T, options?: StructuredSerializeOptions): T; 314 - reportError(error: any): void; 315 - fetch(input: RequestInfo | URL, init?: RequestInit<RequestInitCfProperties>): Promise<Response>; 316 - self: ServiceWorkerGlobalScope; 317 - crypto: Crypto; 318 - caches: CacheStorage; 319 - scheduler: Scheduler; 320 - performance: Performance; 321 - Cloudflare: Cloudflare; 322 - readonly origin: string; 323 - Event: typeof Event; 324 - ExtendableEvent: typeof ExtendableEvent; 325 - CustomEvent: typeof CustomEvent; 326 - PromiseRejectionEvent: typeof PromiseRejectionEvent; 327 - FetchEvent: typeof FetchEvent; 328 - TailEvent: typeof TailEvent; 329 - TraceEvent: typeof TailEvent; 330 - ScheduledEvent: typeof ScheduledEvent; 331 - MessageEvent: typeof MessageEvent; 332 - CloseEvent: typeof CloseEvent; 333 - ReadableStreamDefaultReader: typeof ReadableStreamDefaultReader; 334 - ReadableStreamBYOBReader: typeof ReadableStreamBYOBReader; 335 - ReadableStream: typeof ReadableStream; 336 - WritableStream: typeof WritableStream; 337 - WritableStreamDefaultWriter: typeof WritableStreamDefaultWriter; 338 - TransformStream: typeof TransformStream; 339 - ByteLengthQueuingStrategy: typeof ByteLengthQueuingStrategy; 340 - CountQueuingStrategy: typeof CountQueuingStrategy; 341 - ErrorEvent: typeof ErrorEvent; 342 - MessageChannel: typeof MessageChannel; 343 - MessagePort: typeof MessagePort; 344 - EventSource: typeof EventSource; 345 - ReadableStreamBYOBRequest: typeof ReadableStreamBYOBRequest; 346 - ReadableStreamDefaultController: typeof ReadableStreamDefaultController; 347 - ReadableByteStreamController: typeof ReadableByteStreamController; 348 - WritableStreamDefaultController: typeof WritableStreamDefaultController; 349 - TransformStreamDefaultController: typeof TransformStreamDefaultController; 350 - CompressionStream: typeof CompressionStream; 351 - DecompressionStream: typeof DecompressionStream; 352 - TextEncoderStream: typeof TextEncoderStream; 353 - TextDecoderStream: typeof TextDecoderStream; 354 - Headers: typeof Headers; 355 - Body: typeof Body; 356 - Request: typeof Request; 357 - Response: typeof Response; 358 - WebSocket: typeof WebSocket; 359 - WebSocketPair: typeof WebSocketPair; 360 - WebSocketRequestResponsePair: typeof WebSocketRequestResponsePair; 361 - AbortController: typeof AbortController; 362 - AbortSignal: typeof AbortSignal; 363 - TextDecoder: typeof TextDecoder; 364 - TextEncoder: typeof TextEncoder; 365 - navigator: Navigator; 366 - Navigator: typeof Navigator; 367 - URL: typeof URL; 368 - URLSearchParams: typeof URLSearchParams; 369 - URLPattern: typeof URLPattern; 370 - Blob: typeof Blob; 371 - File: typeof File; 372 - FormData: typeof FormData; 373 - Crypto: typeof Crypto; 374 - SubtleCrypto: typeof SubtleCrypto; 375 - CryptoKey: typeof CryptoKey; 376 - CacheStorage: typeof CacheStorage; 377 - Cache: typeof Cache; 378 - FixedLengthStream: typeof FixedLengthStream; 379 - IdentityTransformStream: typeof IdentityTransformStream; 380 - HTMLRewriter: typeof HTMLRewriter; 381 - } 382 - declare function addEventListener<Type extends keyof WorkerGlobalScopeEventMap>( 383 - type: Type, 384 - handler: EventListenerOrEventListenerObject<WorkerGlobalScopeEventMap[Type]>, 385 - options?: EventTargetAddEventListenerOptions | boolean, 386 - ): void; 387 - declare function removeEventListener<Type extends keyof WorkerGlobalScopeEventMap>( 388 - type: Type, 389 - handler: EventListenerOrEventListenerObject<WorkerGlobalScopeEventMap[Type]>, 390 - options?: EventTargetEventListenerOptions | boolean, 391 - ): void; 392 - /** 393 - * The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. 394 - * 395 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent) 396 - */ 397 - declare function dispatchEvent(event: WorkerGlobalScopeEventMap[keyof WorkerGlobalScopeEventMap]): boolean; 398 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/btoa) */ 399 - declare function btoa(data: string): string; 400 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/atob) */ 401 - declare function atob(data: string): string; 402 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/setTimeout) */ 403 - declare function setTimeout(callback: (...args: any[]) => void, msDelay?: number): number; 404 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/setTimeout) */ 405 - declare function setTimeout<Args extends any[]>( 406 - callback: (...args: Args) => void, 407 - msDelay?: number, 408 - ...args: Args 409 - ): number; 410 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/clearTimeout) */ 411 - declare function clearTimeout(timeoutId: number | null): void; 412 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/setInterval) */ 413 - declare function setInterval(callback: (...args: any[]) => void, msDelay?: number): number; 414 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/setInterval) */ 415 - declare function setInterval<Args extends any[]>( 416 - callback: (...args: Args) => void, 417 - msDelay?: number, 418 - ...args: Args 419 - ): number; 420 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/clearInterval) */ 421 - declare function clearInterval(timeoutId: number | null): void; 422 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/queueMicrotask) */ 423 - declare function queueMicrotask(task: Function): void; 424 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/structuredClone) */ 425 - declare function structuredClone<T>(value: T, options?: StructuredSerializeOptions): T; 426 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/reportError) */ 427 - declare function reportError(error: any): void; 428 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch) */ 429 - declare function fetch( 430 - input: RequestInfo | URL, 431 - init?: RequestInit<RequestInitCfProperties>, 432 - ): Promise<Response>; 433 - declare const self: ServiceWorkerGlobalScope; 434 - /** 435 - * The Web Crypto API provides a set of low-level functions for common cryptographic tasks. 436 - * The Workers runtime implements the full surface of this API, but with some differences in 437 - * the [supported algorithms](https://developers.cloudflare.com/workers/runtime-apis/web-crypto/#supported-algorithms) 438 - * compared to those implemented in most browsers. 439 - * 440 - * [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/web-crypto/) 441 - */ 442 - declare const crypto: Crypto; 443 - /** 444 - * The Cache API allows fine grained control of reading and writing from the Cloudflare global network cache. 445 - * 446 - * [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/cache/) 447 - */ 448 - declare const caches: CacheStorage; 449 - declare const scheduler: Scheduler; 450 - /** 451 - * The Workers runtime supports a subset of the Performance API, used to measure timing and performance, 452 - * as well as timing of subrequests and other operations. 453 - * 454 - * [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/performance/) 455 - */ 456 - declare const performance: Performance; 457 - declare const Cloudflare: Cloudflare; 458 - declare const origin: string; 459 - declare const navigator: Navigator; 460 - interface TestController {} 461 - interface ExecutionContext<Props = unknown> { 462 - waitUntil(promise: Promise<any>): void; 463 - passThroughOnException(): void; 464 - readonly props: Props; 465 - } 466 - type ExportedHandlerFetchHandler<Env = unknown, CfHostMetadata = unknown> = ( 467 - request: Request<CfHostMetadata, IncomingRequestCfProperties<CfHostMetadata>>, 468 - env: Env, 469 - ctx: ExecutionContext, 470 - ) => Response | Promise<Response>; 471 - type ExportedHandlerTailHandler<Env = unknown> = ( 472 - events: TraceItem[], 473 - env: Env, 474 - ctx: ExecutionContext, 475 - ) => void | Promise<void>; 476 - type ExportedHandlerTraceHandler<Env = unknown> = ( 477 - traces: TraceItem[], 478 - env: Env, 479 - ctx: ExecutionContext, 480 - ) => void | Promise<void>; 481 - type ExportedHandlerTailStreamHandler<Env = unknown> = ( 482 - event: TailStream.TailEvent<TailStream.Onset>, 483 - env: Env, 484 - ctx: ExecutionContext, 485 - ) => TailStream.TailEventHandlerType | Promise<TailStream.TailEventHandlerType>; 486 - type ExportedHandlerScheduledHandler<Env = unknown> = ( 487 - controller: ScheduledController, 488 - env: Env, 489 - ctx: ExecutionContext, 490 - ) => void | Promise<void>; 491 - type ExportedHandlerQueueHandler<Env = unknown, Message = unknown> = ( 492 - batch: MessageBatch<Message>, 493 - env: Env, 494 - ctx: ExecutionContext, 495 - ) => void | Promise<void>; 496 - type ExportedHandlerTestHandler<Env = unknown> = ( 497 - controller: TestController, 498 - env: Env, 499 - ctx: ExecutionContext, 500 - ) => void | Promise<void>; 501 - interface ExportedHandler<Env = unknown, QueueHandlerMessage = unknown, CfHostMetadata = unknown> { 502 - fetch?: ExportedHandlerFetchHandler<Env, CfHostMetadata>; 503 - tail?: ExportedHandlerTailHandler<Env>; 504 - trace?: ExportedHandlerTraceHandler<Env>; 505 - tailStream?: ExportedHandlerTailStreamHandler<Env>; 506 - scheduled?: ExportedHandlerScheduledHandler<Env>; 507 - test?: ExportedHandlerTestHandler<Env>; 508 - email?: EmailExportedHandler<Env>; 509 - queue?: ExportedHandlerQueueHandler<Env, QueueHandlerMessage>; 510 - } 511 - interface StructuredSerializeOptions { 512 - transfer?: any[]; 513 - } 514 - declare abstract class Navigator { 515 - sendBeacon(url: string, body?: BodyInit): boolean; 516 - readonly userAgent: string; 517 - readonly hardwareConcurrency: number; 518 - readonly language: string; 519 - readonly languages: string[]; 520 - } 521 - interface AlarmInvocationInfo { 522 - readonly isRetry: boolean; 523 - readonly retryCount: number; 524 - } 525 - interface Cloudflare { 526 - readonly compatibilityFlags: Record<string, boolean>; 527 - } 528 - interface DurableObject { 529 - fetch(request: Request): Response | Promise<Response>; 530 - alarm?(alarmInfo?: AlarmInvocationInfo): void | Promise<void>; 531 - webSocketMessage?(ws: WebSocket, message: string | ArrayBuffer): void | Promise<void>; 532 - webSocketClose?(ws: WebSocket, code: number, reason: string, wasClean: boolean): void | Promise<void>; 533 - webSocketError?(ws: WebSocket, error: unknown): void | Promise<void>; 534 - } 535 - type DurableObjectStub<T extends Rpc.DurableObjectBranded | undefined = undefined> = Fetcher< 536 - T, 537 - 'alarm' | 'webSocketMessage' | 'webSocketClose' | 'webSocketError' 538 - > & { 539 - readonly id: DurableObjectId; 540 - readonly name?: string; 541 - }; 542 - interface DurableObjectId { 543 - toString(): string; 544 - equals(other: DurableObjectId): boolean; 545 - readonly name?: string; 546 - } 547 - declare abstract class DurableObjectNamespace<T extends Rpc.DurableObjectBranded | undefined = undefined> { 548 - newUniqueId(options?: DurableObjectNamespaceNewUniqueIdOptions): DurableObjectId; 549 - idFromName(name: string): DurableObjectId; 550 - idFromString(id: string): DurableObjectId; 551 - get(id: DurableObjectId, options?: DurableObjectNamespaceGetDurableObjectOptions): DurableObjectStub<T>; 552 - getByName(name: string, options?: DurableObjectNamespaceGetDurableObjectOptions): DurableObjectStub<T>; 553 - jurisdiction(jurisdiction: DurableObjectJurisdiction): DurableObjectNamespace<T>; 554 - } 555 - type DurableObjectJurisdiction = 'eu' | 'fedramp' | 'fedramp-high'; 556 - interface DurableObjectNamespaceNewUniqueIdOptions { 557 - jurisdiction?: DurableObjectJurisdiction; 558 - } 559 - type DurableObjectLocationHint = 'wnam' | 'enam' | 'sam' | 'weur' | 'eeur' | 'apac' | 'oc' | 'afr' | 'me'; 560 - type DurableObjectRoutingMode = 'primary-only'; 561 - interface DurableObjectNamespaceGetDurableObjectOptions { 562 - locationHint?: DurableObjectLocationHint; 563 - routingMode?: DurableObjectRoutingMode; 564 - } 565 - interface DurableObjectClass<_T extends Rpc.DurableObjectBranded | undefined = undefined> {} 566 - interface DurableObjectState<Props = unknown> { 567 - waitUntil(promise: Promise<any>): void; 568 - readonly props: Props; 569 - readonly id: DurableObjectId; 570 - readonly storage: DurableObjectStorage; 571 - container?: Container; 572 - blockConcurrencyWhile<T>(callback: () => Promise<T>): Promise<T>; 573 - acceptWebSocket(ws: WebSocket, tags?: string[]): void; 574 - getWebSockets(tag?: string): WebSocket[]; 575 - setWebSocketAutoResponse(maybeReqResp?: WebSocketRequestResponsePair): void; 576 - getWebSocketAutoResponse(): WebSocketRequestResponsePair | null; 577 - getWebSocketAutoResponseTimestamp(ws: WebSocket): Date | null; 578 - setHibernatableWebSocketEventTimeout(timeoutMs?: number): void; 579 - getHibernatableWebSocketEventTimeout(): number | null; 580 - getTags(ws: WebSocket): string[]; 581 - abort(reason?: string): void; 582 - } 583 - interface DurableObjectTransaction { 584 - get<T = unknown>(key: string, options?: DurableObjectGetOptions): Promise<T | undefined>; 585 - get<T = unknown>(keys: string[], options?: DurableObjectGetOptions): Promise<Map<string, T>>; 586 - list<T = unknown>(options?: DurableObjectListOptions): Promise<Map<string, T>>; 587 - put<T>(key: string, value: T, options?: DurableObjectPutOptions): Promise<void>; 588 - put<T>(entries: Record<string, T>, options?: DurableObjectPutOptions): Promise<void>; 589 - delete(key: string, options?: DurableObjectPutOptions): Promise<boolean>; 590 - delete(keys: string[], options?: DurableObjectPutOptions): Promise<number>; 591 - rollback(): void; 592 - getAlarm(options?: DurableObjectGetAlarmOptions): Promise<number | null>; 593 - setAlarm(scheduledTime: number | Date, options?: DurableObjectSetAlarmOptions): Promise<void>; 594 - deleteAlarm(options?: DurableObjectSetAlarmOptions): Promise<void>; 595 - } 596 - interface DurableObjectStorage { 597 - get<T = unknown>(key: string, options?: DurableObjectGetOptions): Promise<T | undefined>; 598 - get<T = unknown>(keys: string[], options?: DurableObjectGetOptions): Promise<Map<string, T>>; 599 - list<T = unknown>(options?: DurableObjectListOptions): Promise<Map<string, T>>; 600 - put<T>(key: string, value: T, options?: DurableObjectPutOptions): Promise<void>; 601 - put<T>(entries: Record<string, T>, options?: DurableObjectPutOptions): Promise<void>; 602 - delete(key: string, options?: DurableObjectPutOptions): Promise<boolean>; 603 - delete(keys: string[], options?: DurableObjectPutOptions): Promise<number>; 604 - deleteAll(options?: DurableObjectPutOptions): Promise<void>; 605 - transaction<T>(closure: (txn: DurableObjectTransaction) => Promise<T>): Promise<T>; 606 - getAlarm(options?: DurableObjectGetAlarmOptions): Promise<number | null>; 607 - setAlarm(scheduledTime: number | Date, options?: DurableObjectSetAlarmOptions): Promise<void>; 608 - deleteAlarm(options?: DurableObjectSetAlarmOptions): Promise<void>; 609 - sync(): Promise<void>; 610 - sql: SqlStorage; 611 - kv: SyncKvStorage; 612 - transactionSync<T>(closure: () => T): T; 613 - getCurrentBookmark(): Promise<string>; 614 - getBookmarkForTime(timestamp: number | Date): Promise<string>; 615 - onNextSessionRestoreBookmark(bookmark: string): Promise<string>; 616 - } 617 - interface DurableObjectListOptions { 618 - start?: string; 619 - startAfter?: string; 620 - end?: string; 621 - prefix?: string; 622 - reverse?: boolean; 623 - limit?: number; 624 - allowConcurrency?: boolean; 625 - noCache?: boolean; 626 - } 627 - interface DurableObjectGetOptions { 628 - allowConcurrency?: boolean; 629 - noCache?: boolean; 630 - } 631 - interface DurableObjectGetAlarmOptions { 632 - allowConcurrency?: boolean; 633 - } 634 - interface DurableObjectPutOptions { 635 - allowConcurrency?: boolean; 636 - allowUnconfirmed?: boolean; 637 - noCache?: boolean; 638 - } 639 - interface DurableObjectSetAlarmOptions { 640 - allowConcurrency?: boolean; 641 - allowUnconfirmed?: boolean; 642 - } 643 - declare class WebSocketRequestResponsePair { 644 - constructor(request: string, response: string); 645 - get request(): string; 646 - get response(): string; 647 - } 648 - interface AnalyticsEngineDataset { 649 - writeDataPoint(event?: AnalyticsEngineDataPoint): void; 650 - } 651 - interface AnalyticsEngineDataPoint { 652 - indexes?: ((ArrayBuffer | string) | null)[]; 653 - doubles?: number[]; 654 - blobs?: ((ArrayBuffer | string) | null)[]; 655 - } 656 - /** 657 - * The **`Event`** interface represents an event which takes place on an `EventTarget`. 658 - * 659 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event) 660 - */ 661 - declare class Event { 662 - constructor(type: string, init?: EventInit); 663 - /** 664 - * The **`type`** read-only property of the Event interface returns a string containing the event's type. 665 - * 666 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/type) 667 - */ 668 - get type(): string; 669 - /** 670 - * The **`eventPhase`** read-only property of the being evaluated. 671 - * 672 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase) 673 - */ 674 - get eventPhase(): number; 675 - /** 676 - * The read-only **`composed`** property of the or not the event will propagate across the shadow DOM boundary into the standard DOM. 677 - * 678 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composed) 679 - */ 680 - get composed(): boolean; 681 - /** 682 - * The **`bubbles`** read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not. 683 - * 684 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/bubbles) 685 - */ 686 - get bubbles(): boolean; 687 - /** 688 - * The **`cancelable`** read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened. 689 - * 690 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelable) 691 - */ 692 - get cancelable(): boolean; 693 - /** 694 - * The **`defaultPrevented`** read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event. 695 - * 696 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/defaultPrevented) 697 - */ 698 - get defaultPrevented(): boolean; 699 - /** 700 - * The Event property **`returnValue`** indicates whether the default action for this event has been prevented or not. 701 - * @deprecated 702 - * 703 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/returnValue) 704 - */ 705 - get returnValue(): boolean; 706 - /** 707 - * The **`currentTarget`** read-only property of the Event interface identifies the element to which the event handler has been attached. 708 - * 709 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/currentTarget) 710 - */ 711 - get currentTarget(): EventTarget | undefined; 712 - /** 713 - * The read-only **`target`** property of the dispatched. 714 - * 715 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target) 716 - */ 717 - get target(): EventTarget | undefined; 718 - /** 719 - * The deprecated **`Event.srcElement`** is an alias for the Event.target property. 720 - * @deprecated 721 - * 722 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/srcElement) 723 - */ 724 - get srcElement(): EventTarget | undefined; 725 - /** 726 - * The **`timeStamp`** read-only property of the Event interface returns the time (in milliseconds) at which the event was created. 727 - * 728 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/timeStamp) 729 - */ 730 - get timeStamp(): number; 731 - /** 732 - * The **`isTrusted`** read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and `false` when the event was dispatched via The only exception is the `click` event, which initializes the `isTrusted` property to `false` in user agents. 733 - * 734 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted) 735 - */ 736 - get isTrusted(): boolean; 737 - /** 738 - * The **`cancelBubble`** property of the Event interface is deprecated. 739 - * @deprecated 740 - * 741 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble) 742 - */ 743 - get cancelBubble(): boolean; 744 - /** 745 - * The **`cancelBubble`** property of the Event interface is deprecated. 746 - * @deprecated 747 - * 748 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble) 749 - */ 750 - set cancelBubble(value: boolean); 751 - /** 752 - * The **`stopImmediatePropagation()`** method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added. 753 - * 754 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation) 755 - */ 756 - stopImmediatePropagation(): void; 757 - /** 758 - * The **`preventDefault()`** method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be. 759 - * 760 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/preventDefault) 761 - */ 762 - preventDefault(): void; 763 - /** 764 - * The **`stopPropagation()`** method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases. 765 - * 766 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopPropagation) 767 - */ 768 - stopPropagation(): void; 769 - /** 770 - * The **`composedPath()`** method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked. 771 - * 772 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composedPath) 773 - */ 774 - composedPath(): EventTarget[]; 775 - static readonly NONE: number; 776 - static readonly CAPTURING_PHASE: number; 777 - static readonly AT_TARGET: number; 778 - static readonly BUBBLING_PHASE: number; 779 - } 780 - interface EventInit { 781 - bubbles?: boolean; 782 - cancelable?: boolean; 783 - composed?: boolean; 784 - } 785 - type EventListener<EventType extends Event = Event> = (event: EventType) => void; 786 - interface EventListenerObject<EventType extends Event = Event> { 787 - handleEvent(event: EventType): void; 788 - } 789 - type EventListenerOrEventListenerObject<EventType extends Event = Event> = 790 - | EventListener<EventType> 791 - | EventListenerObject<EventType>; 792 - /** 793 - * The **`EventTarget`** interface is implemented by objects that can receive events and may have listeners for them. 794 - * 795 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget) 796 - */ 797 - declare class EventTarget<EventMap extends Record<string, Event> = Record<string, Event>> { 798 - constructor(); 799 - /** 800 - * The **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target. 801 - * 802 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener) 803 - */ 804 - addEventListener<Type extends keyof EventMap>( 805 - type: Type, 806 - handler: EventListenerOrEventListenerObject<EventMap[Type]>, 807 - options?: EventTargetAddEventListenerOptions | boolean, 808 - ): void; 809 - /** 810 - * The **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. 811 - * 812 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener) 813 - */ 814 - removeEventListener<Type extends keyof EventMap>( 815 - type: Type, 816 - handler: EventListenerOrEventListenerObject<EventMap[Type]>, 817 - options?: EventTargetEventListenerOptions | boolean, 818 - ): void; 819 - /** 820 - * The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. 821 - * 822 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent) 823 - */ 824 - dispatchEvent(event: EventMap[keyof EventMap]): boolean; 825 - } 826 - interface EventTargetEventListenerOptions { 827 - capture?: boolean; 828 - } 829 - interface EventTargetAddEventListenerOptions { 830 - capture?: boolean; 831 - passive?: boolean; 832 - once?: boolean; 833 - signal?: AbortSignal; 834 - } 835 - interface EventTargetHandlerObject { 836 - handleEvent: (event: Event) => any | undefined; 837 - } 838 - /** 839 - * The **`AbortController`** interface represents a controller object that allows you to abort one or more Web requests as and when desired. 840 - * 841 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortController) 842 - */ 843 - declare class AbortController { 844 - constructor(); 845 - /** 846 - * The **`signal`** read-only property of the AbortController interface returns an AbortSignal object instance, which can be used to communicate with/abort an asynchronous operation as desired. 847 - * 848 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortController/signal) 849 - */ 850 - get signal(): AbortSignal; 851 - /** 852 - * The **`abort()`** method of the AbortController interface aborts an asynchronous operation before it has completed. 853 - * 854 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortController/abort) 855 - */ 856 - abort(reason?: any): void; 857 - } 858 - /** 859 - * The **`AbortSignal`** interface represents a signal object that allows you to communicate with an asynchronous operation (such as a fetch request) and abort it if required via an AbortController object. 860 - * 861 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal) 862 - */ 863 - declare abstract class AbortSignal extends EventTarget { 864 - /** 865 - * The **`AbortSignal.abort()`** static method returns an AbortSignal that is already set as aborted (and which does not trigger an AbortSignal/abort_event event). 866 - * 867 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/abort_static) 868 - */ 869 - static abort(reason?: any): AbortSignal; 870 - /** 871 - * The **`AbortSignal.timeout()`** static method returns an AbortSignal that will automatically abort after a specified time. 872 - * 873 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/timeout_static) 874 - */ 875 - static timeout(delay: number): AbortSignal; 876 - /** 877 - * The **`AbortSignal.any()`** static method takes an iterable of abort signals and returns an AbortSignal. 878 - * 879 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/any_static) 880 - */ 881 - static any(signals: AbortSignal[]): AbortSignal; 882 - /** 883 - * The **`aborted`** read-only property returns a value that indicates whether the asynchronous operations the signal is communicating with are aborted (`true`) or not (`false`). 884 - * 885 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/aborted) 886 - */ 887 - get aborted(): boolean; 888 - /** 889 - * The **`reason`** read-only property returns a JavaScript value that indicates the abort reason. 890 - * 891 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/reason) 892 - */ 893 - get reason(): any; 894 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/abort_event) */ 895 - get onabort(): any | null; 896 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/abort_event) */ 897 - set onabort(value: any | null); 898 - /** 899 - * The **`throwIfAborted()`** method throws the signal's abort AbortSignal.reason if the signal has been aborted; otherwise it does nothing. 900 - * 901 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/throwIfAborted) 902 - */ 903 - throwIfAborted(): void; 904 - } 905 - interface Scheduler { 906 - wait(delay: number, maybeOptions?: SchedulerWaitOptions): Promise<void>; 907 - } 908 - interface SchedulerWaitOptions { 909 - signal?: AbortSignal; 910 - } 911 - /** 912 - * The **`ExtendableEvent`** interface extends the lifetime of the `install` and `activate` events dispatched on the global scope as part of the service worker lifecycle. 913 - * 914 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ExtendableEvent) 915 - */ 916 - declare abstract class ExtendableEvent extends Event { 917 - /** 918 - * The **`ExtendableEvent.waitUntil()`** method tells the event dispatcher that work is ongoing. 919 - * 920 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ExtendableEvent/waitUntil) 921 - */ 922 - waitUntil(promise: Promise<any>): void; 923 - } 924 - /** 925 - * The **`CustomEvent`** interface represents events initialized by an application for any purpose. 926 - * 927 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomEvent) 928 - */ 929 - declare class CustomEvent<T = any> extends Event { 930 - constructor(type: string, init?: CustomEventCustomEventInit); 931 - /** 932 - * The read-only **`detail`** property of the CustomEvent interface returns any data passed when initializing the event. 933 - * 934 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomEvent/detail) 935 - */ 936 - get detail(): T; 937 - } 938 - interface CustomEventCustomEventInit { 939 - bubbles?: boolean; 940 - cancelable?: boolean; 941 - composed?: boolean; 942 - detail?: any; 943 - } 944 - /** 945 - * The **`Blob`** interface represents a blob, which is a file-like object of immutable, raw data; they can be read as text or binary data, or converted into a ReadableStream so its methods can be used for processing the data. 946 - * 947 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob) 948 - */ 949 - declare class Blob { 950 - constructor(type?: ((ArrayBuffer | ArrayBufferView) | string | Blob)[], options?: BlobOptions); 951 - /** 952 - * The **`size`** read-only property of the Blob interface returns the size of the Blob or File in bytes. 953 - * 954 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/size) 955 - */ 956 - get size(): number; 957 - /** 958 - * The **`type`** read-only property of the Blob interface returns the MIME type of the file. 959 - * 960 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/type) 961 - */ 962 - get type(): string; 963 - /** 964 - * The **`slice()`** method of the Blob interface creates and returns a new `Blob` object which contains data from a subset of the blob on which it's called. 965 - * 966 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/slice) 967 - */ 968 - slice(start?: number, end?: number, type?: string): Blob; 969 - /** 970 - * The **`arrayBuffer()`** method of the Blob interface returns a Promise that resolves with the contents of the blob as binary data contained in an ArrayBuffer. 971 - * 972 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/arrayBuffer) 973 - */ 974 - arrayBuffer(): Promise<ArrayBuffer>; 975 - /** 976 - * The **`bytes()`** method of the Blob interface returns a Promise that resolves with a Uint8Array containing the contents of the blob as an array of bytes. 977 - * 978 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/bytes) 979 - */ 980 - bytes(): Promise<Uint8Array>; 981 - /** 982 - * The **`text()`** method of the string containing the contents of the blob, interpreted as UTF-8. 983 - * 984 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/text) 985 - */ 986 - text(): Promise<string>; 987 - /** 988 - * The **`stream()`** method of the Blob interface returns a ReadableStream which upon reading returns the data contained within the `Blob`. 989 - * 990 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/stream) 991 - */ 992 - stream(): ReadableStream; 993 - } 994 - interface BlobOptions { 995 - type?: string; 996 - } 997 - /** 998 - * The **`File`** interface provides information about files and allows JavaScript in a web page to access their content. 999 - * 1000 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/File) 1001 - */ 1002 - declare class File extends Blob { 1003 - constructor( 1004 - bits: ((ArrayBuffer | ArrayBufferView) | string | Blob)[] | undefined, 1005 - name: string, 1006 - options?: FileOptions, 1007 - ); 1008 - /** 1009 - * The **`name`** read-only property of the File interface returns the name of the file represented by a File object. 1010 - * 1011 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/name) 1012 - */ 1013 - get name(): string; 1014 - /** 1015 - * The **`lastModified`** read-only property of the File interface provides the last modified date of the file as the number of milliseconds since the Unix epoch (January 1, 1970 at midnight). 1016 - * 1017 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/lastModified) 1018 - */ 1019 - get lastModified(): number; 1020 - } 1021 - interface FileOptions { 1022 - type?: string; 1023 - lastModified?: number; 1024 - } 1025 - /** 1026 - * The Cache API allows fine grained control of reading and writing from the Cloudflare global network cache. 1027 - * 1028 - * [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/cache/) 1029 - */ 1030 - declare abstract class CacheStorage { 1031 - /** 1032 - * The **`open()`** method of the the Cache object matching the `cacheName`. 1033 - * 1034 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CacheStorage/open) 1035 - */ 1036 - open(cacheName: string): Promise<Cache>; 1037 - readonly default: Cache; 1038 - } 1039 - /** 1040 - * The Cache API allows fine grained control of reading and writing from the Cloudflare global network cache. 1041 - * 1042 - * [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/cache/) 1043 - */ 1044 - declare abstract class Cache { 1045 - /* [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/cache/#delete) */ 1046 - delete(request: RequestInfo | URL, options?: CacheQueryOptions): Promise<boolean>; 1047 - /* [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/cache/#match) */ 1048 - match(request: RequestInfo | URL, options?: CacheQueryOptions): Promise<Response | undefined>; 1049 - /* [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/cache/#put) */ 1050 - put(request: RequestInfo | URL, response: Response): Promise<void>; 1051 - } 1052 - interface CacheQueryOptions { 1053 - ignoreMethod?: boolean; 1054 - } 1055 - /** 1056 - * The Web Crypto API provides a set of low-level functions for common cryptographic tasks. 1057 - * The Workers runtime implements the full surface of this API, but with some differences in 1058 - * the [supported algorithms](https://developers.cloudflare.com/workers/runtime-apis/web-crypto/#supported-algorithms) 1059 - * compared to those implemented in most browsers. 1060 - * 1061 - * [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/web-crypto/) 1062 - */ 1063 - declare abstract class Crypto { 1064 - /** 1065 - * The **`Crypto.subtle`** read-only property returns a cryptographic operations. 1066 - * Available only in secure contexts. 1067 - * 1068 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Crypto/subtle) 1069 - */ 1070 - get subtle(): SubtleCrypto; 1071 - /** 1072 - * The **`Crypto.getRandomValues()`** method lets you get cryptographically strong random values. 1073 - * 1074 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Crypto/getRandomValues) 1075 - */ 1076 - getRandomValues< 1077 - T extends 1078 - | Int8Array 1079 - | Uint8Array 1080 - | Int16Array 1081 - | Uint16Array 1082 - | Int32Array 1083 - | Uint32Array 1084 - | BigInt64Array 1085 - | BigUint64Array, 1086 - >(buffer: T): T; 1087 - /** 1088 - * The **`randomUUID()`** method of the Crypto interface is used to generate a v4 UUID using a cryptographically secure random number generator. 1089 - * Available only in secure contexts. 1090 - * 1091 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Crypto/randomUUID) 1092 - */ 1093 - randomUUID(): string; 1094 - DigestStream: typeof DigestStream; 1095 - } 1096 - /** 1097 - * The **`SubtleCrypto`** interface of the Web Crypto API provides a number of low-level cryptographic functions. 1098 - * Available only in secure contexts. 1099 - * 1100 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto) 1101 - */ 1102 - declare abstract class SubtleCrypto { 1103 - /** 1104 - * The **`encrypt()`** method of the SubtleCrypto interface encrypts data. 1105 - * 1106 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/encrypt) 1107 - */ 1108 - encrypt( 1109 - algorithm: string | SubtleCryptoEncryptAlgorithm, 1110 - key: CryptoKey, 1111 - plainText: ArrayBuffer | ArrayBufferView, 1112 - ): Promise<ArrayBuffer>; 1113 - /** 1114 - * The **`decrypt()`** method of the SubtleCrypto interface decrypts some encrypted data. 1115 - * 1116 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/decrypt) 1117 - */ 1118 - decrypt( 1119 - algorithm: string | SubtleCryptoEncryptAlgorithm, 1120 - key: CryptoKey, 1121 - cipherText: ArrayBuffer | ArrayBufferView, 1122 - ): Promise<ArrayBuffer>; 1123 - /** 1124 - * The **`sign()`** method of the SubtleCrypto interface generates a digital signature. 1125 - * 1126 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/sign) 1127 - */ 1128 - sign( 1129 - algorithm: string | SubtleCryptoSignAlgorithm, 1130 - key: CryptoKey, 1131 - data: ArrayBuffer | ArrayBufferView, 1132 - ): Promise<ArrayBuffer>; 1133 - /** 1134 - * The **`verify()`** method of the SubtleCrypto interface verifies a digital signature. 1135 - * 1136 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/verify) 1137 - */ 1138 - verify( 1139 - algorithm: string | SubtleCryptoSignAlgorithm, 1140 - key: CryptoKey, 1141 - signature: ArrayBuffer | ArrayBufferView, 1142 - data: ArrayBuffer | ArrayBufferView, 1143 - ): Promise<boolean>; 1144 - /** 1145 - * The **`digest()`** method of the SubtleCrypto interface generates a _digest_ of the given data, using the specified hash function. 1146 - * 1147 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/digest) 1148 - */ 1149 - digest( 1150 - algorithm: string | SubtleCryptoHashAlgorithm, 1151 - data: ArrayBuffer | ArrayBufferView, 1152 - ): Promise<ArrayBuffer>; 1153 - /** 1154 - * The **`generateKey()`** method of the SubtleCrypto interface is used to generate a new key (for symmetric algorithms) or key pair (for public-key algorithms). 1155 - * 1156 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/generateKey) 1157 - */ 1158 - generateKey( 1159 - algorithm: string | SubtleCryptoGenerateKeyAlgorithm, 1160 - extractable: boolean, 1161 - keyUsages: string[], 1162 - ): Promise<CryptoKey | CryptoKeyPair>; 1163 - /** 1164 - * The **`deriveKey()`** method of the SubtleCrypto interface can be used to derive a secret key from a master key. 1165 - * 1166 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/deriveKey) 1167 - */ 1168 - deriveKey( 1169 - algorithm: string | SubtleCryptoDeriveKeyAlgorithm, 1170 - baseKey: CryptoKey, 1171 - derivedKeyAlgorithm: string | SubtleCryptoImportKeyAlgorithm, 1172 - extractable: boolean, 1173 - keyUsages: string[], 1174 - ): Promise<CryptoKey>; 1175 - /** 1176 - * The **`deriveBits()`** method of the key. 1177 - * 1178 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/deriveBits) 1179 - */ 1180 - deriveBits( 1181 - algorithm: string | SubtleCryptoDeriveKeyAlgorithm, 1182 - baseKey: CryptoKey, 1183 - length?: number | null, 1184 - ): Promise<ArrayBuffer>; 1185 - /** 1186 - * The **`importKey()`** method of the SubtleCrypto interface imports a key: that is, it takes as input a key in an external, portable format and gives you a CryptoKey object that you can use in the Web Crypto API. 1187 - * 1188 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/importKey) 1189 - */ 1190 - importKey( 1191 - format: string, 1192 - keyData: (ArrayBuffer | ArrayBufferView) | JsonWebKey, 1193 - algorithm: string | SubtleCryptoImportKeyAlgorithm, 1194 - extractable: boolean, 1195 - keyUsages: string[], 1196 - ): Promise<CryptoKey>; 1197 - /** 1198 - * The **`exportKey()`** method of the SubtleCrypto interface exports a key: that is, it takes as input a CryptoKey object and gives you the key in an external, portable format. 1199 - * 1200 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/exportKey) 1201 - */ 1202 - exportKey(format: string, key: CryptoKey): Promise<ArrayBuffer | JsonWebKey>; 1203 - /** 1204 - * The **`wrapKey()`** method of the SubtleCrypto interface 'wraps' a key. 1205 - * 1206 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/wrapKey) 1207 - */ 1208 - wrapKey( 1209 - format: string, 1210 - key: CryptoKey, 1211 - wrappingKey: CryptoKey, 1212 - wrapAlgorithm: string | SubtleCryptoEncryptAlgorithm, 1213 - ): Promise<ArrayBuffer>; 1214 - /** 1215 - * The **`unwrapKey()`** method of the SubtleCrypto interface 'unwraps' a key. 1216 - * 1217 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/unwrapKey) 1218 - */ 1219 - unwrapKey( 1220 - format: string, 1221 - wrappedKey: ArrayBuffer | ArrayBufferView, 1222 - unwrappingKey: CryptoKey, 1223 - unwrapAlgorithm: string | SubtleCryptoEncryptAlgorithm, 1224 - unwrappedKeyAlgorithm: string | SubtleCryptoImportKeyAlgorithm, 1225 - extractable: boolean, 1226 - keyUsages: string[], 1227 - ): Promise<CryptoKey>; 1228 - timingSafeEqual(a: ArrayBuffer | ArrayBufferView, b: ArrayBuffer | ArrayBufferView): boolean; 1229 - } 1230 - /** 1231 - * The **`CryptoKey`** interface of the Web Crypto API represents a cryptographic key obtained from one of the SubtleCrypto methods SubtleCrypto.generateKey, SubtleCrypto.deriveKey, SubtleCrypto.importKey, or SubtleCrypto.unwrapKey. 1232 - * Available only in secure contexts. 1233 - * 1234 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey) 1235 - */ 1236 - declare abstract class CryptoKey { 1237 - /** 1238 - * The read-only **`type`** property of the CryptoKey interface indicates which kind of key is represented by the object. 1239 - * 1240 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey/type) 1241 - */ 1242 - readonly type: string; 1243 - /** 1244 - * The read-only **`extractable`** property of the CryptoKey interface indicates whether or not the key may be extracted using `SubtleCrypto.exportKey()` or `SubtleCrypto.wrapKey()`. 1245 - * 1246 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey/extractable) 1247 - */ 1248 - readonly extractable: boolean; 1249 - /** 1250 - * The read-only **`algorithm`** property of the CryptoKey interface returns an object describing the algorithm for which this key can be used, and any associated extra parameters. 1251 - * 1252 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey/algorithm) 1253 - */ 1254 - readonly algorithm: 1255 - | CryptoKeyKeyAlgorithm 1256 - | CryptoKeyAesKeyAlgorithm 1257 - | CryptoKeyHmacKeyAlgorithm 1258 - | CryptoKeyRsaKeyAlgorithm 1259 - | CryptoKeyEllipticKeyAlgorithm 1260 - | CryptoKeyArbitraryKeyAlgorithm; 1261 - /** 1262 - * The read-only **`usages`** property of the CryptoKey interface indicates what can be done with the key. 1263 - * 1264 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey/usages) 1265 - */ 1266 - readonly usages: string[]; 1267 - } 1268 - interface CryptoKeyPair { 1269 - publicKey: CryptoKey; 1270 - privateKey: CryptoKey; 1271 - } 1272 - interface JsonWebKey { 1273 - kty: string; 1274 - use?: string; 1275 - key_ops?: string[]; 1276 - alg?: string; 1277 - ext?: boolean; 1278 - crv?: string; 1279 - x?: string; 1280 - y?: string; 1281 - d?: string; 1282 - n?: string; 1283 - e?: string; 1284 - p?: string; 1285 - q?: string; 1286 - dp?: string; 1287 - dq?: string; 1288 - qi?: string; 1289 - oth?: RsaOtherPrimesInfo[]; 1290 - k?: string; 1291 - } 1292 - interface RsaOtherPrimesInfo { 1293 - r?: string; 1294 - d?: string; 1295 - t?: string; 1296 - } 1297 - interface SubtleCryptoDeriveKeyAlgorithm { 1298 - name: string; 1299 - salt?: ArrayBuffer | ArrayBufferView; 1300 - iterations?: number; 1301 - hash?: string | SubtleCryptoHashAlgorithm; 1302 - $public?: CryptoKey; 1303 - info?: ArrayBuffer | ArrayBufferView; 1304 - } 1305 - interface SubtleCryptoEncryptAlgorithm { 1306 - name: string; 1307 - iv?: ArrayBuffer | ArrayBufferView; 1308 - additionalData?: ArrayBuffer | ArrayBufferView; 1309 - tagLength?: number; 1310 - counter?: ArrayBuffer | ArrayBufferView; 1311 - length?: number; 1312 - label?: ArrayBuffer | ArrayBufferView; 1313 - } 1314 - interface SubtleCryptoGenerateKeyAlgorithm { 1315 - name: string; 1316 - hash?: string | SubtleCryptoHashAlgorithm; 1317 - modulusLength?: number; 1318 - publicExponent?: ArrayBuffer | ArrayBufferView; 1319 - length?: number; 1320 - namedCurve?: string; 1321 - } 1322 - interface SubtleCryptoHashAlgorithm { 1323 - name: string; 1324 - } 1325 - interface SubtleCryptoImportKeyAlgorithm { 1326 - name: string; 1327 - hash?: string | SubtleCryptoHashAlgorithm; 1328 - length?: number; 1329 - namedCurve?: string; 1330 - compressed?: boolean; 1331 - } 1332 - interface SubtleCryptoSignAlgorithm { 1333 - name: string; 1334 - hash?: string | SubtleCryptoHashAlgorithm; 1335 - dataLength?: number; 1336 - saltLength?: number; 1337 - } 1338 - interface CryptoKeyKeyAlgorithm { 1339 - name: string; 1340 - } 1341 - interface CryptoKeyAesKeyAlgorithm { 1342 - name: string; 1343 - length: number; 1344 - } 1345 - interface CryptoKeyHmacKeyAlgorithm { 1346 - name: string; 1347 - hash: CryptoKeyKeyAlgorithm; 1348 - length: number; 1349 - } 1350 - interface CryptoKeyRsaKeyAlgorithm { 1351 - name: string; 1352 - modulusLength: number; 1353 - publicExponent: ArrayBuffer | ArrayBufferView; 1354 - hash?: CryptoKeyKeyAlgorithm; 1355 - } 1356 - interface CryptoKeyEllipticKeyAlgorithm { 1357 - name: string; 1358 - namedCurve: string; 1359 - } 1360 - interface CryptoKeyArbitraryKeyAlgorithm { 1361 - name: string; 1362 - hash?: CryptoKeyKeyAlgorithm; 1363 - namedCurve?: string; 1364 - length?: number; 1365 - } 1366 - declare class DigestStream extends WritableStream<ArrayBuffer | ArrayBufferView> { 1367 - constructor(algorithm: string | SubtleCryptoHashAlgorithm); 1368 - readonly digest: Promise<ArrayBuffer>; 1369 - get bytesWritten(): number | bigint; 1370 - } 1371 - /** 1372 - * The **`TextDecoder`** interface represents a decoder for a specific text encoding, such as `UTF-8`, `ISO-8859-2`, `KOI8-R`, `GBK`, etc. 1373 - * 1374 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextDecoder) 1375 - */ 1376 - declare class TextDecoder { 1377 - constructor(label?: string, options?: TextDecoderConstructorOptions); 1378 - /** 1379 - * The **`TextDecoder.decode()`** method returns a string containing text decoded from the buffer passed as a parameter. 1380 - * 1381 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextDecoder/decode) 1382 - */ 1383 - decode(input?: ArrayBuffer | ArrayBufferView, options?: TextDecoderDecodeOptions): string; 1384 - get encoding(): string; 1385 - get fatal(): boolean; 1386 - get ignoreBOM(): boolean; 1387 - } 1388 - /** 1389 - * The **`TextEncoder`** interface takes a stream of code points as input and emits a stream of UTF-8 bytes. 1390 - * 1391 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextEncoder) 1392 - */ 1393 - declare class TextEncoder { 1394 - constructor(); 1395 - /** 1396 - * The **`TextEncoder.encode()`** method takes a string as input, and returns a Global_Objects/Uint8Array containing the text given in parameters encoded with the specific method for that TextEncoder object. 1397 - * 1398 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextEncoder/encode) 1399 - */ 1400 - encode(input?: string): Uint8Array; 1401 - /** 1402 - * The **`TextEncoder.encodeInto()`** method takes a string to encode and a destination Uint8Array to put resulting UTF-8 encoded text into, and returns a dictionary object indicating the progress of the encoding. 1403 - * 1404 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextEncoder/encodeInto) 1405 - */ 1406 - encodeInto(input: string, buffer: Uint8Array): TextEncoderEncodeIntoResult; 1407 - get encoding(): string; 1408 - } 1409 - interface TextDecoderConstructorOptions { 1410 - fatal: boolean; 1411 - ignoreBOM: boolean; 1412 - } 1413 - interface TextDecoderDecodeOptions { 1414 - stream: boolean; 1415 - } 1416 - interface TextEncoderEncodeIntoResult { 1417 - read: number; 1418 - written: number; 1419 - } 1420 - /** 1421 - * The **`ErrorEvent`** interface represents events providing information related to errors in scripts or in files. 1422 - * 1423 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent) 1424 - */ 1425 - declare class ErrorEvent extends Event { 1426 - constructor(type: string, init?: ErrorEventErrorEventInit); 1427 - /** 1428 - * The **`filename`** read-only property of the ErrorEvent interface returns a string containing the name of the script file in which the error occurred. 1429 - * 1430 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/filename) 1431 - */ 1432 - get filename(): string; 1433 - /** 1434 - * The **`message`** read-only property of the ErrorEvent interface returns a string containing a human-readable error message describing the problem. 1435 - * 1436 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/message) 1437 - */ 1438 - get message(): string; 1439 - /** 1440 - * The **`lineno`** read-only property of the ErrorEvent interface returns an integer containing the line number of the script file on which the error occurred. 1441 - * 1442 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/lineno) 1443 - */ 1444 - get lineno(): number; 1445 - /** 1446 - * The **`colno`** read-only property of the ErrorEvent interface returns an integer containing the column number of the script file on which the error occurred. 1447 - * 1448 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/colno) 1449 - */ 1450 - get colno(): number; 1451 - /** 1452 - * The **`error`** read-only property of the ErrorEvent interface returns a JavaScript value, such as an Error or DOMException, representing the error associated with this event. 1453 - * 1454 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/error) 1455 - */ 1456 - get error(): any; 1457 - } 1458 - interface ErrorEventErrorEventInit { 1459 - message?: string; 1460 - filename?: string; 1461 - lineno?: number; 1462 - colno?: number; 1463 - error?: any; 1464 - } 1465 - /** 1466 - * The **`MessageEvent`** interface represents a message received by a target object. 1467 - * 1468 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent) 1469 - */ 1470 - declare class MessageEvent extends Event { 1471 - constructor(type: string, initializer: MessageEventInit); 1472 - /** 1473 - * The **`data`** read-only property of the The data sent by the message emitter; this can be any data type, depending on what originated this event. 1474 - * 1475 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/data) 1476 - */ 1477 - readonly data: any; 1478 - /** 1479 - * The **`origin`** read-only property of the origin of the message emitter. 1480 - * 1481 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/origin) 1482 - */ 1483 - readonly origin: string | null; 1484 - /** 1485 - * The **`lastEventId`** read-only property of the unique ID for the event. 1486 - * 1487 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/lastEventId) 1488 - */ 1489 - readonly lastEventId: string; 1490 - /** 1491 - * The **`source`** read-only property of the a WindowProxy, MessagePort, or a `MessageEventSource` (which can be a WindowProxy, message emitter. 1492 - * 1493 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/source) 1494 - */ 1495 - readonly source: MessagePort | null; 1496 - /** 1497 - * The **`ports`** read-only property of the containing all MessagePort objects sent with the message, in order. 1498 - * 1499 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/ports) 1500 - */ 1501 - readonly ports: MessagePort[]; 1502 - } 1503 - interface MessageEventInit { 1504 - data: ArrayBuffer | string; 1505 - } 1506 - /** 1507 - * The **`PromiseRejectionEvent`** interface represents events which are sent to the global script context when JavaScript Promises are rejected. 1508 - * 1509 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/PromiseRejectionEvent) 1510 - */ 1511 - declare abstract class PromiseRejectionEvent extends Event { 1512 - /** 1513 - * The PromiseRejectionEvent interface's **`promise`** read-only property indicates the JavaScript rejected. 1514 - * 1515 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/PromiseRejectionEvent/promise) 1516 - */ 1517 - readonly promise: Promise<any>; 1518 - /** 1519 - * The PromiseRejectionEvent **`reason`** read-only property is any JavaScript value or Object which provides the reason passed into Promise.reject(). 1520 - * 1521 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/PromiseRejectionEvent/reason) 1522 - */ 1523 - readonly reason: any; 1524 - } 1525 - /** 1526 - * The **`FormData`** interface provides a way to construct a set of key/value pairs representing form fields and their values, which can be sent using the Window/fetch, XMLHttpRequest.send() or navigator.sendBeacon() methods. 1527 - * 1528 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData) 1529 - */ 1530 - declare class FormData { 1531 - constructor(); 1532 - /** 1533 - * The **`append()`** method of the FormData interface appends a new value onto an existing key inside a `FormData` object, or adds the key if it does not already exist. 1534 - * 1535 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/append) 1536 - */ 1537 - append(name: string, value: string): void; 1538 - /** 1539 - * The **`append()`** method of the FormData interface appends a new value onto an existing key inside a `FormData` object, or adds the key if it does not already exist. 1540 - * 1541 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/append) 1542 - */ 1543 - append(name: string, value: Blob, filename?: string): void; 1544 - /** 1545 - * The **`delete()`** method of the FormData interface deletes a key and its value(s) from a `FormData` object. 1546 - * 1547 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/delete) 1548 - */ 1549 - delete(name: string): void; 1550 - /** 1551 - * The **`get()`** method of the FormData interface returns the first value associated with a given key from within a `FormData` object. 1552 - * 1553 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/get) 1554 - */ 1555 - get(name: string): (File | string) | null; 1556 - /** 1557 - * The **`getAll()`** method of the FormData interface returns all the values associated with a given key from within a `FormData` object. 1558 - * 1559 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/getAll) 1560 - */ 1561 - getAll(name: string): (File | string)[]; 1562 - /** 1563 - * The **`has()`** method of the FormData interface returns whether a `FormData` object contains a certain key. 1564 - * 1565 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/has) 1566 - */ 1567 - has(name: string): boolean; 1568 - /** 1569 - * The **`set()`** method of the FormData interface sets a new value for an existing key inside a `FormData` object, or adds the key/value if it does not already exist. 1570 - * 1571 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/set) 1572 - */ 1573 - set(name: string, value: string): void; 1574 - /** 1575 - * The **`set()`** method of the FormData interface sets a new value for an existing key inside a `FormData` object, or adds the key/value if it does not already exist. 1576 - * 1577 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/set) 1578 - */ 1579 - set(name: string, value: Blob, filename?: string): void; 1580 - /* Returns an array of key, value pairs for every entry in the list. */ 1581 - entries(): IterableIterator<[key: string, value: File | string]>; 1582 - /* Returns a list of keys in the list. */ 1583 - keys(): IterableIterator<string>; 1584 - /* Returns a list of values in the list. */ 1585 - values(): IterableIterator<File | string>; 1586 - forEach<This = unknown>( 1587 - callback: (this: This, value: File | string, key: string, parent: FormData) => void, 1588 - thisArg?: This, 1589 - ): void; 1590 - [Symbol.iterator](): IterableIterator<[key: string, value: File | string]>; 1591 - } 1592 - interface ContentOptions { 1593 - html?: boolean; 1594 - } 1595 - declare class HTMLRewriter { 1596 - constructor(); 1597 - on(selector: string, handlers: HTMLRewriterElementContentHandlers): HTMLRewriter; 1598 - onDocument(handlers: HTMLRewriterDocumentContentHandlers): HTMLRewriter; 1599 - transform(response: Response): Response; 1600 - } 1601 - interface HTMLRewriterElementContentHandlers { 1602 - element?(element: Element): void | Promise<void>; 1603 - comments?(comment: Comment): void | Promise<void>; 1604 - text?(element: Text): void | Promise<void>; 1605 - } 1606 - interface HTMLRewriterDocumentContentHandlers { 1607 - doctype?(doctype: Doctype): void | Promise<void>; 1608 - comments?(comment: Comment): void | Promise<void>; 1609 - text?(text: Text): void | Promise<void>; 1610 - end?(end: DocumentEnd): void | Promise<void>; 1611 - } 1612 - interface Doctype { 1613 - readonly name: string | null; 1614 - readonly publicId: string | null; 1615 - readonly systemId: string | null; 1616 - } 1617 - interface Element { 1618 - tagName: string; 1619 - readonly attributes: IterableIterator<string[]>; 1620 - readonly removed: boolean; 1621 - readonly namespaceURI: string; 1622 - getAttribute(name: string): string | null; 1623 - hasAttribute(name: string): boolean; 1624 - setAttribute(name: string, value: string): Element; 1625 - removeAttribute(name: string): Element; 1626 - before(content: string | ReadableStream | Response, options?: ContentOptions): Element; 1627 - after(content: string | ReadableStream | Response, options?: ContentOptions): Element; 1628 - prepend(content: string | ReadableStream | Response, options?: ContentOptions): Element; 1629 - append(content: string | ReadableStream | Response, options?: ContentOptions): Element; 1630 - replace(content: string | ReadableStream | Response, options?: ContentOptions): Element; 1631 - remove(): Element; 1632 - removeAndKeepContent(): Element; 1633 - setInnerContent(content: string | ReadableStream | Response, options?: ContentOptions): Element; 1634 - onEndTag(handler: (tag: EndTag) => void | Promise<void>): void; 1635 - } 1636 - interface EndTag { 1637 - name: string; 1638 - before(content: string | ReadableStream | Response, options?: ContentOptions): EndTag; 1639 - after(content: string | ReadableStream | Response, options?: ContentOptions): EndTag; 1640 - remove(): EndTag; 1641 - } 1642 - interface Comment { 1643 - text: string; 1644 - readonly removed: boolean; 1645 - before(content: string, options?: ContentOptions): Comment; 1646 - after(content: string, options?: ContentOptions): Comment; 1647 - replace(content: string, options?: ContentOptions): Comment; 1648 - remove(): Comment; 1649 - } 1650 - interface Text { 1651 - readonly text: string; 1652 - readonly lastInTextNode: boolean; 1653 - readonly removed: boolean; 1654 - before(content: string | ReadableStream | Response, options?: ContentOptions): Text; 1655 - after(content: string | ReadableStream | Response, options?: ContentOptions): Text; 1656 - replace(content: string | ReadableStream | Response, options?: ContentOptions): Text; 1657 - remove(): Text; 1658 - } 1659 - interface DocumentEnd { 1660 - append(content: string, options?: ContentOptions): DocumentEnd; 1661 - } 1662 - /** 1663 - * This is the event type for `fetch` events dispatched on the ServiceWorkerGlobalScope. 1664 - * 1665 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FetchEvent) 1666 - */ 1667 - declare abstract class FetchEvent extends ExtendableEvent { 1668 - /** 1669 - * The **`request`** read-only property of the the event handler. 1670 - * 1671 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FetchEvent/request) 1672 - */ 1673 - readonly request: Request; 1674 - /** 1675 - * The **`respondWith()`** method of allows you to provide a promise for a Response yourself. 1676 - * 1677 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/FetchEvent/respondWith) 1678 - */ 1679 - respondWith(promise: Response | Promise<Response>): void; 1680 - passThroughOnException(): void; 1681 - } 1682 - type HeadersInit = Headers | Iterable<Iterable<string>> | Record<string, string>; 1683 - /** 1684 - * The **`Headers`** interface of the Fetch API allows you to perform various actions on HTTP request and response headers. 1685 - * 1686 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers) 1687 - */ 1688 - declare class Headers { 1689 - constructor(init?: HeadersInit); 1690 - /** 1691 - * The **`get()`** method of the Headers interface returns a byte string of all the values of a header within a `Headers` object with a given name. 1692 - * 1693 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/get) 1694 - */ 1695 - get(name: string): string | null; 1696 - getAll(name: string): string[]; 1697 - /** 1698 - * The **`getSetCookie()`** method of the Headers interface returns an array containing the values of all Set-Cookie headers associated with a response. 1699 - * 1700 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/getSetCookie) 1701 - */ 1702 - getSetCookie(): string[]; 1703 - /** 1704 - * The **`has()`** method of the Headers interface returns a boolean stating whether a `Headers` object contains a certain header. 1705 - * 1706 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/has) 1707 - */ 1708 - has(name: string): boolean; 1709 - /** 1710 - * The **`set()`** method of the Headers interface sets a new value for an existing header inside a `Headers` object, or adds the header if it does not already exist. 1711 - * 1712 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/set) 1713 - */ 1714 - set(name: string, value: string): void; 1715 - /** 1716 - * The **`append()`** method of the Headers interface appends a new value onto an existing header inside a `Headers` object, or adds the header if it does not already exist. 1717 - * 1718 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/append) 1719 - */ 1720 - append(name: string, value: string): void; 1721 - /** 1722 - * The **`delete()`** method of the Headers interface deletes a header from the current `Headers` object. 1723 - * 1724 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/delete) 1725 - */ 1726 - delete(name: string): void; 1727 - forEach<This = unknown>( 1728 - callback: (this: This, value: string, key: string, parent: Headers) => void, 1729 - thisArg?: This, 1730 - ): void; 1731 - /* Returns an iterator allowing to go through all key/value pairs contained in this object. */ 1732 - entries(): IterableIterator<[key: string, value: string]>; 1733 - /* Returns an iterator allowing to go through all keys of the key/value pairs contained in this object. */ 1734 - keys(): IterableIterator<string>; 1735 - /* Returns an iterator allowing to go through all values of the key/value pairs contained in this object. */ 1736 - values(): IterableIterator<string>; 1737 - [Symbol.iterator](): IterableIterator<[key: string, value: string]>; 1738 - } 1739 - type BodyInit = 1740 - | ReadableStream<Uint8Array> 1741 - | string 1742 - | ArrayBuffer 1743 - | ArrayBufferView 1744 - | Blob 1745 - | URLSearchParams 1746 - | FormData; 1747 - declare abstract class Body { 1748 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/body) */ 1749 - get body(): ReadableStream | null; 1750 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bodyUsed) */ 1751 - get bodyUsed(): boolean; 1752 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/arrayBuffer) */ 1753 - arrayBuffer(): Promise<ArrayBuffer>; 1754 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bytes) */ 1755 - bytes(): Promise<Uint8Array>; 1756 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/text) */ 1757 - text(): Promise<string>; 1758 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/json) */ 1759 - json<T>(): Promise<T>; 1760 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/formData) */ 1761 - formData(): Promise<FormData>; 1762 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/blob) */ 1763 - blob(): Promise<Blob>; 1764 - } 1765 - /** 1766 - * The **`Response`** interface of the Fetch API represents the response to a request. 1767 - * 1768 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response) 1769 - */ 1770 - declare var Response: { 1771 - prototype: Response; 1772 - new (body?: BodyInit | null, init?: ResponseInit): Response; 1773 - error(): Response; 1774 - redirect(url: string, status?: number): Response; 1775 - json(any: any, maybeInit?: ResponseInit | Response): Response; 1776 - }; 1777 - /** 1778 - * The **`Response`** interface of the Fetch API represents the response to a request. 1779 - * 1780 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response) 1781 - */ 1782 - interface Response extends Body { 1783 - /** 1784 - * The **`clone()`** method of the Response interface creates a clone of a response object, identical in every way, but stored in a different variable. 1785 - * 1786 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/clone) 1787 - */ 1788 - clone(): Response; 1789 - /** 1790 - * The **`status`** read-only property of the Response interface contains the HTTP status codes of the response. 1791 - * 1792 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/status) 1793 - */ 1794 - status: number; 1795 - /** 1796 - * The **`statusText`** read-only property of the Response interface contains the status message corresponding to the HTTP status code in Response.status. 1797 - * 1798 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/statusText) 1799 - */ 1800 - statusText: string; 1801 - /** 1802 - * The **`headers`** read-only property of the with the response. 1803 - * 1804 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/headers) 1805 - */ 1806 - headers: Headers; 1807 - /** 1808 - * The **`ok`** read-only property of the Response interface contains a Boolean stating whether the response was successful (status in the range 200-299) or not. 1809 - * 1810 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/ok) 1811 - */ 1812 - ok: boolean; 1813 - /** 1814 - * The **`redirected`** read-only property of the Response interface indicates whether or not the response is the result of a request you made which was redirected. 1815 - * 1816 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/redirected) 1817 - */ 1818 - redirected: boolean; 1819 - /** 1820 - * The **`url`** read-only property of the Response interface contains the URL of the response. 1821 - * 1822 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/url) 1823 - */ 1824 - url: string; 1825 - webSocket: WebSocket | null; 1826 - cf: any | undefined; 1827 - /** 1828 - * The **`type`** read-only property of the Response interface contains the type of the response. 1829 - * 1830 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/type) 1831 - */ 1832 - type: 'default' | 'error'; 1833 - } 1834 - interface ResponseInit { 1835 - status?: number; 1836 - statusText?: string; 1837 - headers?: HeadersInit; 1838 - cf?: any; 1839 - webSocket?: WebSocket | null; 1840 - encodeBody?: 'automatic' | 'manual'; 1841 - } 1842 - type RequestInfo<CfHostMetadata = unknown, Cf = CfProperties<CfHostMetadata>> = 1843 - | Request<CfHostMetadata, Cf> 1844 - | string; 1845 - /** 1846 - * The **`Request`** interface of the Fetch API represents a resource request. 1847 - * 1848 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request) 1849 - */ 1850 - declare var Request: { 1851 - prototype: Request; 1852 - new <CfHostMetadata = unknown, Cf = CfProperties<CfHostMetadata>>( 1853 - input: RequestInfo<CfProperties> | URL, 1854 - init?: RequestInit<Cf>, 1855 - ): Request<CfHostMetadata, Cf>; 1856 - }; 1857 - /** 1858 - * The **`Request`** interface of the Fetch API represents a resource request. 1859 - * 1860 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request) 1861 - */ 1862 - interface Request<CfHostMetadata = unknown, Cf = CfProperties<CfHostMetadata>> extends Body { 1863 - /** 1864 - * The **`clone()`** method of the Request interface creates a copy of the current `Request` object. 1865 - * 1866 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/clone) 1867 - */ 1868 - clone(): Request<CfHostMetadata, Cf>; 1869 - /** 1870 - * The **`method`** read-only property of the `POST`, etc.) A String indicating the method of the request. 1871 - * 1872 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/method) 1873 - */ 1874 - method: string; 1875 - /** 1876 - * The **`url`** read-only property of the Request interface contains the URL of the request. 1877 - * 1878 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/url) 1879 - */ 1880 - url: string; 1881 - /** 1882 - * The **`headers`** read-only property of the with the request. 1883 - * 1884 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/headers) 1885 - */ 1886 - headers: Headers; 1887 - /** 1888 - * The **`redirect`** read-only property of the Request interface contains the mode for how redirects are handled. 1889 - * 1890 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/redirect) 1891 - */ 1892 - redirect: string; 1893 - fetcher: Fetcher | null; 1894 - /** 1895 - * The read-only **`signal`** property of the Request interface returns the AbortSignal associated with the request. 1896 - * 1897 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/signal) 1898 - */ 1899 - signal: AbortSignal; 1900 - cf: Cf | undefined; 1901 - /** 1902 - * The **`integrity`** read-only property of the Request interface contains the subresource integrity value of the request. 1903 - * 1904 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/integrity) 1905 - */ 1906 - integrity: string; 1907 - /** 1908 - * The **`keepalive`** read-only property of the Request interface contains the request's `keepalive` setting (`true` or `false`), which indicates whether the browser will keep the associated request alive if the page that initiated it is unloaded before the request is complete. 1909 - * 1910 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/keepalive) 1911 - */ 1912 - keepalive: boolean; 1913 - /** 1914 - * The **`cache`** read-only property of the Request interface contains the cache mode of the request. 1915 - * 1916 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/cache) 1917 - */ 1918 - cache?: 'no-store' | 'no-cache'; 1919 - } 1920 - interface RequestInit<Cf = CfProperties> { 1921 - /* A string to set request's method. */ 1922 - method?: string; 1923 - /* A Headers object, an object literal, or an array of two-item arrays to set request's headers. */ 1924 - headers?: HeadersInit; 1925 - /* A BodyInit object or null to set request's body. */ 1926 - body?: BodyInit | null; 1927 - /* A string indicating whether request follows redirects, results in an error upon encountering a redirect, or returns the redirect (in an opaque fashion). Sets request's redirect. */ 1928 - redirect?: string; 1929 - fetcher?: Fetcher | null; 1930 - cf?: Cf; 1931 - /* A string indicating how the request will interact with the browser's cache to set request's cache. */ 1932 - cache?: 'no-store' | 'no-cache'; 1933 - /* A cryptographic hash of the resource to be fetched by request. Sets request's integrity. */ 1934 - integrity?: string; 1935 - /* An AbortSignal to set request's signal. */ 1936 - signal?: AbortSignal | null; 1937 - encodeResponseBody?: 'automatic' | 'manual'; 1938 - } 1939 - type Service< 1940 - T extends 1941 - | (new (...args: any[]) => Rpc.WorkerEntrypointBranded) 1942 - | Rpc.WorkerEntrypointBranded 1943 - | ExportedHandler<any, any, any> 1944 - | undefined = undefined, 1945 - > = T extends new (...args: any[]) => Rpc.WorkerEntrypointBranded 1946 - ? Fetcher<InstanceType<T>> 1947 - : T extends Rpc.WorkerEntrypointBranded 1948 - ? Fetcher<T> 1949 - : T extends Exclude<Rpc.EntrypointBranded, Rpc.WorkerEntrypointBranded> 1950 - ? never 1951 - : Fetcher<undefined>; 1952 - type Fetcher< 1953 - T extends Rpc.EntrypointBranded | undefined = undefined, 1954 - Reserved extends string = never, 1955 - > = (T extends Rpc.EntrypointBranded ? Rpc.Provider<T, Reserved | 'fetch' | 'connect'> : unknown) & { 1956 - fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response>; 1957 - connect(address: SocketAddress | string, options?: SocketOptions): Socket; 1958 - }; 1959 - interface KVNamespaceListKey<Metadata, Key extends string = string> { 1960 - name: Key; 1961 - expiration?: number; 1962 - metadata?: Metadata; 1963 - } 1964 - type KVNamespaceListResult<Metadata, Key extends string = string> = 1965 - | { 1966 - list_complete: false; 1967 - keys: KVNamespaceListKey<Metadata, Key>[]; 1968 - cursor: string; 1969 - cacheStatus: string | null; 1970 - } 1971 - | { 1972 - list_complete: true; 1973 - keys: KVNamespaceListKey<Metadata, Key>[]; 1974 - cacheStatus: string | null; 1975 - }; 1976 - interface KVNamespace<Key extends string = string> { 1977 - get(key: Key, options?: Partial<KVNamespaceGetOptions<undefined>>): Promise<string | null>; 1978 - get(key: Key, type: 'text'): Promise<string | null>; 1979 - get<ExpectedValue = unknown>(key: Key, type: 'json'): Promise<ExpectedValue | null>; 1980 - get(key: Key, type: 'arrayBuffer'): Promise<ArrayBuffer | null>; 1981 - get(key: Key, type: 'stream'): Promise<ReadableStream | null>; 1982 - get(key: Key, options?: KVNamespaceGetOptions<'text'>): Promise<string | null>; 1983 - get<ExpectedValue = unknown>( 1984 - key: Key, 1985 - options?: KVNamespaceGetOptions<'json'>, 1986 - ): Promise<ExpectedValue | null>; 1987 - get(key: Key, options?: KVNamespaceGetOptions<'arrayBuffer'>): Promise<ArrayBuffer | null>; 1988 - get(key: Key, options?: KVNamespaceGetOptions<'stream'>): Promise<ReadableStream | null>; 1989 - get(key: Array<Key>, type: 'text'): Promise<Map<string, string | null>>; 1990 - get<ExpectedValue = unknown>(key: Array<Key>, type: 'json'): Promise<Map<string, ExpectedValue | null>>; 1991 - get( 1992 - key: Array<Key>, 1993 - options?: Partial<KVNamespaceGetOptions<undefined>>, 1994 - ): Promise<Map<string, string | null>>; 1995 - get(key: Array<Key>, options?: KVNamespaceGetOptions<'text'>): Promise<Map<string, string | null>>; 1996 - get<ExpectedValue = unknown>( 1997 - key: Array<Key>, 1998 - options?: KVNamespaceGetOptions<'json'>, 1999 - ): Promise<Map<string, ExpectedValue | null>>; 2000 - list<Metadata = unknown>(options?: KVNamespaceListOptions): Promise<KVNamespaceListResult<Metadata, Key>>; 2001 - put( 2002 - key: Key, 2003 - value: string | ArrayBuffer | ArrayBufferView | ReadableStream, 2004 - options?: KVNamespacePutOptions, 2005 - ): Promise<void>; 2006 - getWithMetadata<Metadata = unknown>( 2007 - key: Key, 2008 - options?: Partial<KVNamespaceGetOptions<undefined>>, 2009 - ): Promise<KVNamespaceGetWithMetadataResult<string, Metadata>>; 2010 - getWithMetadata<Metadata = unknown>( 2011 - key: Key, 2012 - type: 'text', 2013 - ): Promise<KVNamespaceGetWithMetadataResult<string, Metadata>>; 2014 - getWithMetadata<ExpectedValue = unknown, Metadata = unknown>( 2015 - key: Key, 2016 - type: 'json', 2017 - ): Promise<KVNamespaceGetWithMetadataResult<ExpectedValue, Metadata>>; 2018 - getWithMetadata<Metadata = unknown>( 2019 - key: Key, 2020 - type: 'arrayBuffer', 2021 - ): Promise<KVNamespaceGetWithMetadataResult<ArrayBuffer, Metadata>>; 2022 - getWithMetadata<Metadata = unknown>( 2023 - key: Key, 2024 - type: 'stream', 2025 - ): Promise<KVNamespaceGetWithMetadataResult<ReadableStream, Metadata>>; 2026 - getWithMetadata<Metadata = unknown>( 2027 - key: Key, 2028 - options: KVNamespaceGetOptions<'text'>, 2029 - ): Promise<KVNamespaceGetWithMetadataResult<string, Metadata>>; 2030 - getWithMetadata<ExpectedValue = unknown, Metadata = unknown>( 2031 - key: Key, 2032 - options: KVNamespaceGetOptions<'json'>, 2033 - ): Promise<KVNamespaceGetWithMetadataResult<ExpectedValue, Metadata>>; 2034 - getWithMetadata<Metadata = unknown>( 2035 - key: Key, 2036 - options: KVNamespaceGetOptions<'arrayBuffer'>, 2037 - ): Promise<KVNamespaceGetWithMetadataResult<ArrayBuffer, Metadata>>; 2038 - getWithMetadata<Metadata = unknown>( 2039 - key: Key, 2040 - options: KVNamespaceGetOptions<'stream'>, 2041 - ): Promise<KVNamespaceGetWithMetadataResult<ReadableStream, Metadata>>; 2042 - getWithMetadata<Metadata = unknown>( 2043 - key: Array<Key>, 2044 - type: 'text', 2045 - ): Promise<Map<string, KVNamespaceGetWithMetadataResult<string, Metadata>>>; 2046 - getWithMetadata<ExpectedValue = unknown, Metadata = unknown>( 2047 - key: Array<Key>, 2048 - type: 'json', 2049 - ): Promise<Map<string, KVNamespaceGetWithMetadataResult<ExpectedValue, Metadata>>>; 2050 - getWithMetadata<Metadata = unknown>( 2051 - key: Array<Key>, 2052 - options?: Partial<KVNamespaceGetOptions<undefined>>, 2053 - ): Promise<Map<string, KVNamespaceGetWithMetadataResult<string, Metadata>>>; 2054 - getWithMetadata<Metadata = unknown>( 2055 - key: Array<Key>, 2056 - options?: KVNamespaceGetOptions<'text'>, 2057 - ): Promise<Map<string, KVNamespaceGetWithMetadataResult<string, Metadata>>>; 2058 - getWithMetadata<ExpectedValue = unknown, Metadata = unknown>( 2059 - key: Array<Key>, 2060 - options?: KVNamespaceGetOptions<'json'>, 2061 - ): Promise<Map<string, KVNamespaceGetWithMetadataResult<ExpectedValue, Metadata>>>; 2062 - delete(key: Key): Promise<void>; 2063 - } 2064 - interface KVNamespaceListOptions { 2065 - limit?: number; 2066 - prefix?: string | null; 2067 - cursor?: string | null; 2068 - } 2069 - interface KVNamespaceGetOptions<Type> { 2070 - type: Type; 2071 - cacheTtl?: number; 2072 - } 2073 - interface KVNamespacePutOptions { 2074 - expiration?: number; 2075 - expirationTtl?: number; 2076 - metadata?: any | null; 2077 - } 2078 - interface KVNamespaceGetWithMetadataResult<Value, Metadata> { 2079 - value: Value | null; 2080 - metadata: Metadata | null; 2081 - cacheStatus: string | null; 2082 - } 2083 - type QueueContentType = 'text' | 'bytes' | 'json' | 'v8'; 2084 - interface Queue<Body = unknown> { 2085 - send(message: Body, options?: QueueSendOptions): Promise<void>; 2086 - sendBatch(messages: Iterable<MessageSendRequest<Body>>, options?: QueueSendBatchOptions): Promise<void>; 2087 - } 2088 - interface QueueSendOptions { 2089 - contentType?: QueueContentType; 2090 - delaySeconds?: number; 2091 - } 2092 - interface QueueSendBatchOptions { 2093 - delaySeconds?: number; 2094 - } 2095 - interface MessageSendRequest<Body = unknown> { 2096 - body: Body; 2097 - contentType?: QueueContentType; 2098 - delaySeconds?: number; 2099 - } 2100 - interface QueueRetryOptions { 2101 - delaySeconds?: number; 2102 - } 2103 - interface Message<Body = unknown> { 2104 - readonly id: string; 2105 - readonly timestamp: Date; 2106 - readonly body: Body; 2107 - readonly attempts: number; 2108 - retry(options?: QueueRetryOptions): void; 2109 - ack(): void; 2110 - } 2111 - interface QueueEvent<Body = unknown> extends ExtendableEvent { 2112 - readonly messages: readonly Message<Body>[]; 2113 - readonly queue: string; 2114 - retryAll(options?: QueueRetryOptions): void; 2115 - ackAll(): void; 2116 - } 2117 - interface MessageBatch<Body = unknown> { 2118 - readonly messages: readonly Message<Body>[]; 2119 - readonly queue: string; 2120 - retryAll(options?: QueueRetryOptions): void; 2121 - ackAll(): void; 2122 - } 2123 - interface R2Error extends Error { 2124 - readonly name: string; 2125 - readonly code: number; 2126 - readonly message: string; 2127 - readonly action: string; 2128 - readonly stack: any; 2129 - } 2130 - interface R2ListOptions { 2131 - limit?: number; 2132 - prefix?: string; 2133 - cursor?: string; 2134 - delimiter?: string; 2135 - startAfter?: string; 2136 - include?: ('httpMetadata' | 'customMetadata')[]; 2137 - } 2138 - declare abstract class R2Bucket { 2139 - head(key: string): Promise<R2Object | null>; 2140 - get( 2141 - key: string, 2142 - options: R2GetOptions & { 2143 - onlyIf: R2Conditional | Headers; 2144 - }, 2145 - ): Promise<R2ObjectBody | R2Object | null>; 2146 - get(key: string, options?: R2GetOptions): Promise<R2ObjectBody | null>; 2147 - put( 2148 - key: string, 2149 - value: ReadableStream | ArrayBuffer | ArrayBufferView | string | null | Blob, 2150 - options?: R2PutOptions & { 2151 - onlyIf: R2Conditional | Headers; 2152 - }, 2153 - ): Promise<R2Object | null>; 2154 - put( 2155 - key: string, 2156 - value: ReadableStream | ArrayBuffer | ArrayBufferView | string | null | Blob, 2157 - options?: R2PutOptions, 2158 - ): Promise<R2Object>; 2159 - createMultipartUpload(key: string, options?: R2MultipartOptions): Promise<R2MultipartUpload>; 2160 - resumeMultipartUpload(key: string, uploadId: string): R2MultipartUpload; 2161 - delete(keys: string | string[]): Promise<void>; 2162 - list(options?: R2ListOptions): Promise<R2Objects>; 2163 - } 2164 - interface R2MultipartUpload { 2165 - readonly key: string; 2166 - readonly uploadId: string; 2167 - uploadPart( 2168 - partNumber: number, 2169 - value: ReadableStream | (ArrayBuffer | ArrayBufferView) | string | Blob, 2170 - options?: R2UploadPartOptions, 2171 - ): Promise<R2UploadedPart>; 2172 - abort(): Promise<void>; 2173 - complete(uploadedParts: R2UploadedPart[]): Promise<R2Object>; 2174 - } 2175 - interface R2UploadedPart { 2176 - partNumber: number; 2177 - etag: string; 2178 - } 2179 - declare abstract class R2Object { 2180 - readonly key: string; 2181 - readonly version: string; 2182 - readonly size: number; 2183 - readonly etag: string; 2184 - readonly httpEtag: string; 2185 - readonly checksums: R2Checksums; 2186 - readonly uploaded: Date; 2187 - readonly httpMetadata?: R2HTTPMetadata; 2188 - readonly customMetadata?: Record<string, string>; 2189 - readonly range?: R2Range; 2190 - readonly storageClass: string; 2191 - readonly ssecKeyMd5?: string; 2192 - writeHttpMetadata(headers: Headers): void; 2193 - } 2194 - interface R2ObjectBody extends R2Object { 2195 - get body(): ReadableStream; 2196 - get bodyUsed(): boolean; 2197 - arrayBuffer(): Promise<ArrayBuffer>; 2198 - bytes(): Promise<Uint8Array>; 2199 - text(): Promise<string>; 2200 - json<T>(): Promise<T>; 2201 - blob(): Promise<Blob>; 2202 - } 2203 - type R2Range = 2204 - | { 2205 - offset: number; 2206 - length?: number; 2207 - } 2208 - | { 2209 - offset?: number; 2210 - length: number; 2211 - } 2212 - | { 2213 - suffix: number; 2214 - }; 2215 - interface R2Conditional { 2216 - etagMatches?: string; 2217 - etagDoesNotMatch?: string; 2218 - uploadedBefore?: Date; 2219 - uploadedAfter?: Date; 2220 - secondsGranularity?: boolean; 2221 - } 2222 - interface R2GetOptions { 2223 - onlyIf?: R2Conditional | Headers; 2224 - range?: R2Range | Headers; 2225 - ssecKey?: ArrayBuffer | string; 2226 - } 2227 - interface R2PutOptions { 2228 - onlyIf?: R2Conditional | Headers; 2229 - httpMetadata?: R2HTTPMetadata | Headers; 2230 - customMetadata?: Record<string, string>; 2231 - md5?: (ArrayBuffer | ArrayBufferView) | string; 2232 - sha1?: (ArrayBuffer | ArrayBufferView) | string; 2233 - sha256?: (ArrayBuffer | ArrayBufferView) | string; 2234 - sha384?: (ArrayBuffer | ArrayBufferView) | string; 2235 - sha512?: (ArrayBuffer | ArrayBufferView) | string; 2236 - storageClass?: string; 2237 - ssecKey?: ArrayBuffer | string; 2238 - } 2239 - interface R2MultipartOptions { 2240 - httpMetadata?: R2HTTPMetadata | Headers; 2241 - customMetadata?: Record<string, string>; 2242 - storageClass?: string; 2243 - ssecKey?: ArrayBuffer | string; 2244 - } 2245 - interface R2Checksums { 2246 - readonly md5?: ArrayBuffer; 2247 - readonly sha1?: ArrayBuffer; 2248 - readonly sha256?: ArrayBuffer; 2249 - readonly sha384?: ArrayBuffer; 2250 - readonly sha512?: ArrayBuffer; 2251 - toJSON(): R2StringChecksums; 2252 - } 2253 - interface R2StringChecksums { 2254 - md5?: string; 2255 - sha1?: string; 2256 - sha256?: string; 2257 - sha384?: string; 2258 - sha512?: string; 2259 - } 2260 - interface R2HTTPMetadata { 2261 - contentType?: string; 2262 - contentLanguage?: string; 2263 - contentDisposition?: string; 2264 - contentEncoding?: string; 2265 - cacheControl?: string; 2266 - cacheExpiry?: Date; 2267 - } 2268 - type R2Objects = { 2269 - objects: R2Object[]; 2270 - delimitedPrefixes: string[]; 2271 - } & ( 2272 - | { 2273 - truncated: true; 2274 - cursor: string; 2275 - } 2276 - | { 2277 - truncated: false; 2278 - } 2279 - ); 2280 - interface R2UploadPartOptions { 2281 - ssecKey?: ArrayBuffer | string; 2282 - } 2283 - declare abstract class ScheduledEvent extends ExtendableEvent { 2284 - readonly scheduledTime: number; 2285 - readonly cron: string; 2286 - noRetry(): void; 2287 - } 2288 - interface ScheduledController { 2289 - readonly scheduledTime: number; 2290 - readonly cron: string; 2291 - noRetry(): void; 2292 - } 2293 - interface QueuingStrategy<T = any> { 2294 - highWaterMark?: number | bigint; 2295 - size?: (chunk: T) => number | bigint; 2296 - } 2297 - interface UnderlyingSink<W = any> { 2298 - type?: string; 2299 - start?: (controller: WritableStreamDefaultController) => void | Promise<void>; 2300 - write?: (chunk: W, controller: WritableStreamDefaultController) => void | Promise<void>; 2301 - abort?: (reason: any) => void | Promise<void>; 2302 - close?: () => void | Promise<void>; 2303 - } 2304 - interface UnderlyingByteSource { 2305 - type: 'bytes'; 2306 - autoAllocateChunkSize?: number; 2307 - start?: (controller: ReadableByteStreamController) => void | Promise<void>; 2308 - pull?: (controller: ReadableByteStreamController) => void | Promise<void>; 2309 - cancel?: (reason: any) => void | Promise<void>; 2310 - } 2311 - interface UnderlyingSource<R = any> { 2312 - type?: '' | undefined; 2313 - start?: (controller: ReadableStreamDefaultController<R>) => void | Promise<void>; 2314 - pull?: (controller: ReadableStreamDefaultController<R>) => void | Promise<void>; 2315 - cancel?: (reason: any) => void | Promise<void>; 2316 - expectedLength?: number | bigint; 2317 - } 2318 - interface Transformer<I = any, O = any> { 2319 - readableType?: string; 2320 - writableType?: string; 2321 - start?: (controller: TransformStreamDefaultController<O>) => void | Promise<void>; 2322 - transform?: (chunk: I, controller: TransformStreamDefaultController<O>) => void | Promise<void>; 2323 - flush?: (controller: TransformStreamDefaultController<O>) => void | Promise<void>; 2324 - cancel?: (reason: any) => void | Promise<void>; 2325 - expectedLength?: number; 2326 - } 2327 - interface StreamPipeOptions { 2328 - preventAbort?: boolean; 2329 - preventCancel?: boolean; 2330 - /** 2331 - * Pipes this readable stream to a given writable stream destination. The way in which the piping process behaves under various error conditions can be customized with a number of passed options. It returns a promise that fulfills when the piping process completes successfully, or rejects if any errors were encountered. 2332 - * 2333 - * Piping a stream will lock it for the duration of the pipe, preventing any other consumer from acquiring a reader. 2334 - * 2335 - * Errors and closures of the source and destination streams propagate as follows: 2336 - * 2337 - * An error in this source readable stream will abort destination, unless preventAbort is truthy. The returned promise will be rejected with the source's error, or with any error that occurs during aborting the destination. 2338 - * 2339 - * An error in destination will cancel this source readable stream, unless preventCancel is truthy. The returned promise will be rejected with the destination's error, or with any error that occurs during canceling the source. 2340 - * 2341 - * When this source readable stream closes, destination will be closed, unless preventClose is truthy. The returned promise will be fulfilled once this process completes, unless an error is encountered while closing the destination, in which case it will be rejected with that error. 2342 - * 2343 - * If destination starts out closed or closing, this source readable stream will be canceled, unless preventCancel is true. The returned promise will be rejected with an error indicating piping to a closed stream failed, or with any error that occurs during canceling the source. 2344 - * 2345 - * The signal option can be set to an AbortSignal to allow aborting an ongoing pipe operation via the corresponding AbortController. In this case, this source readable stream will be canceled, and destination aborted, unless the respective options preventCancel or preventAbort are set. 2346 - */ 2347 - preventClose?: boolean; 2348 - signal?: AbortSignal; 2349 - } 2350 - type ReadableStreamReadResult<R = any> = 2351 - | { 2352 - done: false; 2353 - value: R; 2354 - } 2355 - | { 2356 - done: true; 2357 - value?: undefined; 2358 - }; 2359 - /** 2360 - * The `ReadableStream` interface of the Streams API represents a readable stream of byte data. 2361 - * 2362 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream) 2363 - */ 2364 - interface ReadableStream<R = any> { 2365 - /** 2366 - * The **`locked`** read-only property of the ReadableStream interface returns whether or not the readable stream is locked to a reader. 2367 - * 2368 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/locked) 2369 - */ 2370 - get locked(): boolean; 2371 - /** 2372 - * The **`cancel()`** method of the ReadableStream interface returns a Promise that resolves when the stream is canceled. 2373 - * 2374 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/cancel) 2375 - */ 2376 - cancel(reason?: any): Promise<void>; 2377 - /** 2378 - * The **`getReader()`** method of the ReadableStream interface creates a reader and locks the stream to it. 2379 - * 2380 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/getReader) 2381 - */ 2382 - getReader(): ReadableStreamDefaultReader<R>; 2383 - /** 2384 - * The **`getReader()`** method of the ReadableStream interface creates a reader and locks the stream to it. 2385 - * 2386 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/getReader) 2387 - */ 2388 - getReader(options: ReadableStreamGetReaderOptions): ReadableStreamBYOBReader; 2389 - /** 2390 - * The **`pipeThrough()`** method of the ReadableStream interface provides a chainable way of piping the current stream through a transform stream or any other writable/readable pair. 2391 - * 2392 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/pipeThrough) 2393 - */ 2394 - pipeThrough<T>(transform: ReadableWritablePair<T, R>, options?: StreamPipeOptions): ReadableStream<T>; 2395 - /** 2396 - * The **`pipeTo()`** method of the ReadableStream interface pipes the current `ReadableStream` to a given WritableStream and returns a Promise that fulfills when the piping process completes successfully, or rejects if any errors were encountered. 2397 - * 2398 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/pipeTo) 2399 - */ 2400 - pipeTo(destination: WritableStream<R>, options?: StreamPipeOptions): Promise<void>; 2401 - /** 2402 - * The **`tee()`** method of the two-element array containing the two resulting branches as new ReadableStream instances. 2403 - * 2404 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/tee) 2405 - */ 2406 - tee(): [ReadableStream<R>, ReadableStream<R>]; 2407 - values(options?: ReadableStreamValuesOptions): AsyncIterableIterator<R>; 2408 - [Symbol.asyncIterator](options?: ReadableStreamValuesOptions): AsyncIterableIterator<R>; 2409 - } 2410 - /** 2411 - * The `ReadableStream` interface of the Streams API represents a readable stream of byte data. 2412 - * 2413 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream) 2414 - */ 2415 - declare const ReadableStream: { 2416 - prototype: ReadableStream; 2417 - new ( 2418 - underlyingSource: UnderlyingByteSource, 2419 - strategy?: QueuingStrategy<Uint8Array>, 2420 - ): ReadableStream<Uint8Array>; 2421 - new <R = any>(underlyingSource?: UnderlyingSource<R>, strategy?: QueuingStrategy<R>): ReadableStream<R>; 2422 - }; 2423 - /** 2424 - * The **`ReadableStreamDefaultReader`** interface of the Streams API represents a default reader that can be used to read stream data supplied from a network (such as a fetch request). 2425 - * 2426 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader) 2427 - */ 2428 - declare class ReadableStreamDefaultReader<R = any> { 2429 - constructor(stream: ReadableStream); 2430 - get closed(): Promise<void>; 2431 - cancel(reason?: any): Promise<void>; 2432 - /** 2433 - * The **`read()`** method of the ReadableStreamDefaultReader interface returns a Promise providing access to the next chunk in the stream's internal queue. 2434 - * 2435 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader/read) 2436 - */ 2437 - read(): Promise<ReadableStreamReadResult<R>>; 2438 - /** 2439 - * The **`releaseLock()`** method of the ReadableStreamDefaultReader interface releases the reader's lock on the stream. 2440 - * 2441 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader/releaseLock) 2442 - */ 2443 - releaseLock(): void; 2444 - } 2445 - /** 2446 - * The `ReadableStreamBYOBReader` interface of the Streams API defines a reader for a ReadableStream that supports zero-copy reading from an underlying byte source. 2447 - * 2448 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader) 2449 - */ 2450 - declare class ReadableStreamBYOBReader { 2451 - constructor(stream: ReadableStream); 2452 - get closed(): Promise<void>; 2453 - cancel(reason?: any): Promise<void>; 2454 - /** 2455 - * The **`read()`** method of the ReadableStreamBYOBReader interface is used to read data into a view on a user-supplied buffer from an associated readable byte stream. 2456 - * 2457 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/read) 2458 - */ 2459 - read<T extends ArrayBufferView>(view: T): Promise<ReadableStreamReadResult<T>>; 2460 - /** 2461 - * The **`releaseLock()`** method of the ReadableStreamBYOBReader interface releases the reader's lock on the stream. 2462 - * 2463 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/releaseLock) 2464 - */ 2465 - releaseLock(): void; 2466 - readAtLeast<T extends ArrayBufferView>(minElements: number, view: T): Promise<ReadableStreamReadResult<T>>; 2467 - } 2468 - interface ReadableStreamBYOBReaderReadableStreamBYOBReaderReadOptions { 2469 - min?: number; 2470 - } 2471 - interface ReadableStreamGetReaderOptions { 2472 - /** 2473 - * Creates a ReadableStreamBYOBReader and locks the stream to the new reader. 2474 - * 2475 - * This call behaves the same way as the no-argument variant, except that it only works on readable byte streams, i.e. streams which were constructed specifically with the ability to handle "bring your own buffer" reading. The returned BYOB reader provides the ability to directly read individual chunks from the stream via its read() method, into developer-supplied buffers, allowing more precise control over allocation. 2476 - */ 2477 - mode: 'byob'; 2478 - } 2479 - /** 2480 - * The **`ReadableStreamBYOBRequest`** interface of the Streams API represents a 'pull request' for data from an underlying source that will made as a zero-copy transfer to a consumer (bypassing the stream's internal queues). 2481 - * 2482 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest) 2483 - */ 2484 - declare abstract class ReadableStreamBYOBRequest { 2485 - /** 2486 - * The **`view`** getter property of the ReadableStreamBYOBRequest interface returns the current view. 2487 - * 2488 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/view) 2489 - */ 2490 - get view(): Uint8Array | null; 2491 - /** 2492 - * The **`respond()`** method of the ReadableStreamBYOBRequest interface is used to signal to the associated readable byte stream that the specified number of bytes were written into the ReadableStreamBYOBRequest.view. 2493 - * 2494 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/respond) 2495 - */ 2496 - respond(bytesWritten: number): void; 2497 - /** 2498 - * The **`respondWithNewView()`** method of the ReadableStreamBYOBRequest interface specifies a new view that the consumer of the associated readable byte stream should write to instead of ReadableStreamBYOBRequest.view. 2499 - * 2500 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/respondWithNewView) 2501 - */ 2502 - respondWithNewView(view: ArrayBuffer | ArrayBufferView): void; 2503 - get atLeast(): number | null; 2504 - } 2505 - /** 2506 - * The **`ReadableStreamDefaultController`** interface of the Streams API represents a controller allowing control of a ReadableStream's state and internal queue. 2507 - * 2508 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController) 2509 - */ 2510 - declare abstract class ReadableStreamDefaultController<R = any> { 2511 - /** 2512 - * The **`desiredSize`** read-only property of the required to fill the stream's internal queue. 2513 - * 2514 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/desiredSize) 2515 - */ 2516 - get desiredSize(): number | null; 2517 - /** 2518 - * The **`close()`** method of the ReadableStreamDefaultController interface closes the associated stream. 2519 - * 2520 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/close) 2521 - */ 2522 - close(): void; 2523 - /** 2524 - * The **`enqueue()`** method of the ```js-nolint enqueue(chunk) ``` - `chunk` - : The chunk to enqueue. 2525 - * 2526 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/enqueue) 2527 - */ 2528 - enqueue(chunk?: R): void; 2529 - /** 2530 - * The **`error()`** method of the with the associated stream to error. 2531 - * 2532 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/error) 2533 - */ 2534 - error(reason: any): void; 2535 - } 2536 - /** 2537 - * The **`ReadableByteStreamController`** interface of the Streams API represents a controller for a readable byte stream. 2538 - * 2539 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController) 2540 - */ 2541 - declare abstract class ReadableByteStreamController { 2542 - /** 2543 - * The **`byobRequest`** read-only property of the ReadableByteStreamController interface returns the current BYOB request, or `null` if there are no pending requests. 2544 - * 2545 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/byobRequest) 2546 - */ 2547 - get byobRequest(): ReadableStreamBYOBRequest | null; 2548 - /** 2549 - * The **`desiredSize`** read-only property of the ReadableByteStreamController interface returns the number of bytes required to fill the stream's internal queue to its 'desired size'. 2550 - * 2551 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/desiredSize) 2552 - */ 2553 - get desiredSize(): number | null; 2554 - /** 2555 - * The **`close()`** method of the ReadableByteStreamController interface closes the associated stream. 2556 - * 2557 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/close) 2558 - */ 2559 - close(): void; 2560 - /** 2561 - * The **`enqueue()`** method of the ReadableByteStreamController interface enqueues a given chunk on the associated readable byte stream (the chunk is copied into the stream's internal queues). 2562 - * 2563 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/enqueue) 2564 - */ 2565 - enqueue(chunk: ArrayBuffer | ArrayBufferView): void; 2566 - /** 2567 - * The **`error()`** method of the ReadableByteStreamController interface causes any future interactions with the associated stream to error with the specified reason. 2568 - * 2569 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/error) 2570 - */ 2571 - error(reason: any): void; 2572 - } 2573 - /** 2574 - * The **`WritableStreamDefaultController`** interface of the Streams API represents a controller allowing control of a WritableStream's state. 2575 - * 2576 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultController) 2577 - */ 2578 - declare abstract class WritableStreamDefaultController { 2579 - /** 2580 - * The read-only **`signal`** property of the WritableStreamDefaultController interface returns the AbortSignal associated with the controller. 2581 - * 2582 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultController/signal) 2583 - */ 2584 - get signal(): AbortSignal; 2585 - /** 2586 - * The **`error()`** method of the with the associated stream to error. 2587 - * 2588 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultController/error) 2589 - */ 2590 - error(reason?: any): void; 2591 - } 2592 - /** 2593 - * The **`TransformStreamDefaultController`** interface of the Streams API provides methods to manipulate the associated ReadableStream and WritableStream. 2594 - * 2595 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStreamDefaultController) 2596 - */ 2597 - declare abstract class TransformStreamDefaultController<O = any> { 2598 - /** 2599 - * The **`desiredSize`** read-only property of the TransformStreamDefaultController interface returns the desired size to fill the queue of the associated ReadableStream. 2600 - * 2601 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStreamDefaultController/desiredSize) 2602 - */ 2603 - get desiredSize(): number | null; 2604 - /** 2605 - * The **`enqueue()`** method of the TransformStreamDefaultController interface enqueues the given chunk in the readable side of the stream. 2606 - * 2607 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStreamDefaultController/enqueue) 2608 - */ 2609 - enqueue(chunk?: O): void; 2610 - /** 2611 - * The **`error()`** method of the TransformStreamDefaultController interface errors both sides of the stream. 2612 - * 2613 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStreamDefaultController/error) 2614 - */ 2615 - error(reason: any): void; 2616 - /** 2617 - * The **`terminate()`** method of the TransformStreamDefaultController interface closes the readable side and errors the writable side of the stream. 2618 - * 2619 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStreamDefaultController/terminate) 2620 - */ 2621 - terminate(): void; 2622 - } 2623 - interface ReadableWritablePair<R = any, W = any> { 2624 - readable: ReadableStream<R>; 2625 - /** 2626 - * Provides a convenient, chainable way of piping this readable stream through a transform stream (or any other { writable, readable } pair). It simply pipes the stream into the writable side of the supplied pair, and returns the readable side for further use. 2627 - * 2628 - * Piping a stream will lock it for the duration of the pipe, preventing any other consumer from acquiring a reader. 2629 - */ 2630 - writable: WritableStream<W>; 2631 - } 2632 - /** 2633 - * The **`WritableStream`** interface of the Streams API provides a standard abstraction for writing streaming data to a destination, known as a sink. 2634 - * 2635 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream) 2636 - */ 2637 - declare class WritableStream<W = any> { 2638 - constructor(underlyingSink?: UnderlyingSink, queuingStrategy?: QueuingStrategy); 2639 - /** 2640 - * The **`locked`** read-only property of the WritableStream interface returns a boolean indicating whether the `WritableStream` is locked to a writer. 2641 - * 2642 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/locked) 2643 - */ 2644 - get locked(): boolean; 2645 - /** 2646 - * The **`abort()`** method of the WritableStream interface aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded. 2647 - * 2648 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/abort) 2649 - */ 2650 - abort(reason?: any): Promise<void>; 2651 - /** 2652 - * The **`close()`** method of the WritableStream interface closes the associated stream. 2653 - * 2654 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/close) 2655 - */ 2656 - close(): Promise<void>; 2657 - /** 2658 - * The **`getWriter()`** method of the WritableStream interface returns a new instance of WritableStreamDefaultWriter and locks the stream to that instance. 2659 - * 2660 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/getWriter) 2661 - */ 2662 - getWriter(): WritableStreamDefaultWriter<W>; 2663 - } 2664 - /** 2665 - * The **`WritableStreamDefaultWriter`** interface of the Streams API is the object returned by WritableStream.getWriter() and once created locks the writer to the `WritableStream` ensuring that no other streams can write to the underlying sink. 2666 - * 2667 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter) 2668 - */ 2669 - declare class WritableStreamDefaultWriter<W = any> { 2670 - constructor(stream: WritableStream); 2671 - /** 2672 - * The **`closed`** read-only property of the the stream errors or the writer's lock is released. 2673 - * 2674 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/closed) 2675 - */ 2676 - get closed(): Promise<void>; 2677 - /** 2678 - * The **`ready`** read-only property of the that resolves when the desired size of the stream's internal queue transitions from non-positive to positive, signaling that it is no longer applying backpressure. 2679 - * 2680 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/ready) 2681 - */ 2682 - get ready(): Promise<void>; 2683 - /** 2684 - * The **`desiredSize`** read-only property of the to fill the stream's internal queue. 2685 - * 2686 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/desiredSize) 2687 - */ 2688 - get desiredSize(): number | null; 2689 - /** 2690 - * The **`abort()`** method of the the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded. 2691 - * 2692 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/abort) 2693 - */ 2694 - abort(reason?: any): Promise<void>; 2695 - /** 2696 - * The **`close()`** method of the stream. 2697 - * 2698 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/close) 2699 - */ 2700 - close(): Promise<void>; 2701 - /** 2702 - * The **`write()`** method of the operation. 2703 - * 2704 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/write) 2705 - */ 2706 - write(chunk?: W): Promise<void>; 2707 - /** 2708 - * The **`releaseLock()`** method of the corresponding stream. 2709 - * 2710 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/releaseLock) 2711 - */ 2712 - releaseLock(): void; 2713 - } 2714 - /** 2715 - * The **`TransformStream`** interface of the Streams API represents a concrete implementation of the pipe chain _transform stream_ concept. 2716 - * 2717 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStream) 2718 - */ 2719 - declare class TransformStream<I = any, O = any> { 2720 - constructor( 2721 - transformer?: Transformer<I, O>, 2722 - writableStrategy?: QueuingStrategy<I>, 2723 - readableStrategy?: QueuingStrategy<O>, 2724 - ); 2725 - /** 2726 - * The **`readable`** read-only property of the TransformStream interface returns the ReadableStream instance controlled by this `TransformStream`. 2727 - * 2728 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStream/readable) 2729 - */ 2730 - get readable(): ReadableStream<O>; 2731 - /** 2732 - * The **`writable`** read-only property of the TransformStream interface returns the WritableStream instance controlled by this `TransformStream`. 2733 - * 2734 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStream/writable) 2735 - */ 2736 - get writable(): WritableStream<I>; 2737 - } 2738 - declare class FixedLengthStream extends IdentityTransformStream { 2739 - constructor(expectedLength: number | bigint, queuingStrategy?: IdentityTransformStreamQueuingStrategy); 2740 - } 2741 - declare class IdentityTransformStream extends TransformStream<ArrayBuffer | ArrayBufferView, Uint8Array> { 2742 - constructor(queuingStrategy?: IdentityTransformStreamQueuingStrategy); 2743 - } 2744 - interface IdentityTransformStreamQueuingStrategy { 2745 - highWaterMark?: number | bigint; 2746 - } 2747 - interface ReadableStreamValuesOptions { 2748 - preventCancel?: boolean; 2749 - } 2750 - /** 2751 - * The **`CompressionStream`** interface of the Compression Streams API is an API for compressing a stream of data. 2752 - * 2753 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CompressionStream) 2754 - */ 2755 - declare class CompressionStream extends TransformStream<ArrayBuffer | ArrayBufferView, Uint8Array> { 2756 - constructor(format: 'gzip' | 'deflate' | 'deflate-raw'); 2757 - } 2758 - /** 2759 - * The **`DecompressionStream`** interface of the Compression Streams API is an API for decompressing a stream of data. 2760 - * 2761 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/DecompressionStream) 2762 - */ 2763 - declare class DecompressionStream extends TransformStream<ArrayBuffer | ArrayBufferView, Uint8Array> { 2764 - constructor(format: 'gzip' | 'deflate' | 'deflate-raw'); 2765 - } 2766 - /** 2767 - * The **`TextEncoderStream`** interface of the Encoding API converts a stream of strings into bytes in the UTF-8 encoding. 2768 - * 2769 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextEncoderStream) 2770 - */ 2771 - declare class TextEncoderStream extends TransformStream<string, Uint8Array> { 2772 - constructor(); 2773 - get encoding(): string; 2774 - } 2775 - /** 2776 - * The **`TextDecoderStream`** interface of the Encoding API converts a stream of text in a binary encoding, such as UTF-8 etc., to a stream of strings. 2777 - * 2778 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextDecoderStream) 2779 - */ 2780 - declare class TextDecoderStream extends TransformStream<ArrayBuffer | ArrayBufferView, string> { 2781 - constructor(label?: string, options?: TextDecoderStreamTextDecoderStreamInit); 2782 - get encoding(): string; 2783 - get fatal(): boolean; 2784 - get ignoreBOM(): boolean; 2785 - } 2786 - interface TextDecoderStreamTextDecoderStreamInit { 2787 - fatal?: boolean; 2788 - ignoreBOM?: boolean; 2789 - } 2790 - /** 2791 - * The **`ByteLengthQueuingStrategy`** interface of the Streams API provides a built-in byte length queuing strategy that can be used when constructing streams. 2792 - * 2793 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ByteLengthQueuingStrategy) 2794 - */ 2795 - declare class ByteLengthQueuingStrategy implements QueuingStrategy<ArrayBufferView> { 2796 - constructor(init: QueuingStrategyInit); 2797 - /** 2798 - * The read-only **`ByteLengthQueuingStrategy.highWaterMark`** property returns the total number of bytes that can be contained in the internal queue before backpressure is applied. 2799 - * 2800 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ByteLengthQueuingStrategy/highWaterMark) 2801 - */ 2802 - get highWaterMark(): number; 2803 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ByteLengthQueuingStrategy/size) */ 2804 - get size(): (chunk?: any) => number; 2805 - } 2806 - /** 2807 - * The **`CountQueuingStrategy`** interface of the Streams API provides a built-in chunk counting queuing strategy that can be used when constructing streams. 2808 - * 2809 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CountQueuingStrategy) 2810 - */ 2811 - declare class CountQueuingStrategy implements QueuingStrategy { 2812 - constructor(init: QueuingStrategyInit); 2813 - /** 2814 - * The read-only **`CountQueuingStrategy.highWaterMark`** property returns the total number of chunks that can be contained in the internal queue before backpressure is applied. 2815 - * 2816 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CountQueuingStrategy/highWaterMark) 2817 - */ 2818 - get highWaterMark(): number; 2819 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/CountQueuingStrategy/size) */ 2820 - get size(): (chunk?: any) => number; 2821 - } 2822 - interface QueuingStrategyInit { 2823 - /** 2824 - * Creates a new ByteLengthQueuingStrategy with the provided high water mark. 2825 - * 2826 - * Note that the provided high water mark will not be validated ahead of time. Instead, if it is negative, NaN, or not a number, the resulting ByteLengthQueuingStrategy will cause the corresponding stream constructor to throw. 2827 - */ 2828 - highWaterMark: number; 2829 - } 2830 - interface ScriptVersion { 2831 - id?: string; 2832 - tag?: string; 2833 - message?: string; 2834 - } 2835 - declare abstract class TailEvent extends ExtendableEvent { 2836 - readonly events: TraceItem[]; 2837 - readonly traces: TraceItem[]; 2838 - } 2839 - interface TraceItem { 2840 - readonly event: 2841 - | ( 2842 - | TraceItemFetchEventInfo 2843 - | TraceItemJsRpcEventInfo 2844 - | TraceItemScheduledEventInfo 2845 - | TraceItemAlarmEventInfo 2846 - | TraceItemQueueEventInfo 2847 - | TraceItemEmailEventInfo 2848 - | TraceItemTailEventInfo 2849 - | TraceItemCustomEventInfo 2850 - | TraceItemHibernatableWebSocketEventInfo 2851 - ) 2852 - | null; 2853 - readonly eventTimestamp: number | null; 2854 - readonly logs: TraceLog[]; 2855 - readonly exceptions: TraceException[]; 2856 - readonly diagnosticsChannelEvents: TraceDiagnosticChannelEvent[]; 2857 - readonly scriptName: string | null; 2858 - readonly entrypoint?: string; 2859 - readonly scriptVersion?: ScriptVersion; 2860 - readonly dispatchNamespace?: string; 2861 - readonly scriptTags?: string[]; 2862 - readonly durableObjectId?: string; 2863 - readonly outcome: string; 2864 - readonly executionModel: string; 2865 - readonly truncated: boolean; 2866 - readonly cpuTime: number; 2867 - readonly wallTime: number; 2868 - } 2869 - interface TraceItemAlarmEventInfo { 2870 - readonly scheduledTime: Date; 2871 - } 2872 - interface TraceItemCustomEventInfo {} 2873 - interface TraceItemScheduledEventInfo { 2874 - readonly scheduledTime: number; 2875 - readonly cron: string; 2876 - } 2877 - interface TraceItemQueueEventInfo { 2878 - readonly queue: string; 2879 - readonly batchSize: number; 2880 - } 2881 - interface TraceItemEmailEventInfo { 2882 - readonly mailFrom: string; 2883 - readonly rcptTo: string; 2884 - readonly rawSize: number; 2885 - } 2886 - interface TraceItemTailEventInfo { 2887 - readonly consumedEvents: TraceItemTailEventInfoTailItem[]; 2888 - } 2889 - interface TraceItemTailEventInfoTailItem { 2890 - readonly scriptName: string | null; 2891 - } 2892 - interface TraceItemFetchEventInfo { 2893 - readonly response?: TraceItemFetchEventInfoResponse; 2894 - readonly request: TraceItemFetchEventInfoRequest; 2895 - } 2896 - interface TraceItemFetchEventInfoRequest { 2897 - readonly cf?: any; 2898 - readonly headers: Record<string, string>; 2899 - readonly method: string; 2900 - readonly url: string; 2901 - getUnredacted(): TraceItemFetchEventInfoRequest; 2902 - } 2903 - interface TraceItemFetchEventInfoResponse { 2904 - readonly status: number; 2905 - } 2906 - interface TraceItemJsRpcEventInfo { 2907 - readonly rpcMethod: string; 2908 - } 2909 - interface TraceItemHibernatableWebSocketEventInfo { 2910 - readonly getWebSocketEvent: 2911 - | TraceItemHibernatableWebSocketEventInfoMessage 2912 - | TraceItemHibernatableWebSocketEventInfoClose 2913 - | TraceItemHibernatableWebSocketEventInfoError; 2914 - } 2915 - interface TraceItemHibernatableWebSocketEventInfoMessage { 2916 - readonly webSocketEventType: string; 2917 - } 2918 - interface TraceItemHibernatableWebSocketEventInfoClose { 2919 - readonly webSocketEventType: string; 2920 - readonly code: number; 2921 - readonly wasClean: boolean; 2922 - } 2923 - interface TraceItemHibernatableWebSocketEventInfoError { 2924 - readonly webSocketEventType: string; 2925 - } 2926 - interface TraceLog { 2927 - readonly timestamp: number; 2928 - readonly level: string; 2929 - readonly message: any; 2930 - } 2931 - interface TraceException { 2932 - readonly timestamp: number; 2933 - readonly message: string; 2934 - readonly name: string; 2935 - readonly stack?: string; 2936 - } 2937 - interface TraceDiagnosticChannelEvent { 2938 - readonly timestamp: number; 2939 - readonly channel: string; 2940 - readonly message: any; 2941 - } 2942 - interface TraceMetrics { 2943 - readonly cpuTime: number; 2944 - readonly wallTime: number; 2945 - } 2946 - interface UnsafeTraceMetrics { 2947 - fromTrace(item: TraceItem): TraceMetrics; 2948 - } 2949 - /** 2950 - * The **`URL`** interface is used to parse, construct, normalize, and encode URL. 2951 - * 2952 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL) 2953 - */ 2954 - declare class URL { 2955 - constructor(url: string | URL, base?: string | URL); 2956 - /** 2957 - * The **`origin`** read-only property of the URL interface returns a string containing the Unicode serialization of the origin of the represented URL. 2958 - * 2959 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/origin) 2960 - */ 2961 - get origin(): string; 2962 - /** 2963 - * The **`href`** property of the URL interface is a string containing the whole URL. 2964 - * 2965 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/href) 2966 - */ 2967 - get href(): string; 2968 - /** 2969 - * The **`href`** property of the URL interface is a string containing the whole URL. 2970 - * 2971 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/href) 2972 - */ 2973 - set href(value: string); 2974 - /** 2975 - * The **`protocol`** property of the URL interface is a string containing the protocol or scheme of the URL, including the final `':'`. 2976 - * 2977 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/protocol) 2978 - */ 2979 - get protocol(): string; 2980 - /** 2981 - * The **`protocol`** property of the URL interface is a string containing the protocol or scheme of the URL, including the final `':'`. 2982 - * 2983 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/protocol) 2984 - */ 2985 - set protocol(value: string); 2986 - /** 2987 - * The **`username`** property of the URL interface is a string containing the username component of the URL. 2988 - * 2989 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/username) 2990 - */ 2991 - get username(): string; 2992 - /** 2993 - * The **`username`** property of the URL interface is a string containing the username component of the URL. 2994 - * 2995 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/username) 2996 - */ 2997 - set username(value: string); 2998 - /** 2999 - * The **`password`** property of the URL interface is a string containing the password component of the URL. 3000 - * 3001 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/password) 3002 - */ 3003 - get password(): string; 3004 - /** 3005 - * The **`password`** property of the URL interface is a string containing the password component of the URL. 3006 - * 3007 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/password) 3008 - */ 3009 - set password(value: string); 3010 - /** 3011 - * The **`host`** property of the URL interface is a string containing the host, which is the URL.hostname, and then, if the port of the URL is nonempty, a `':'`, followed by the URL.port of the URL. 3012 - * 3013 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/host) 3014 - */ 3015 - get host(): string; 3016 - /** 3017 - * The **`host`** property of the URL interface is a string containing the host, which is the URL.hostname, and then, if the port of the URL is nonempty, a `':'`, followed by the URL.port of the URL. 3018 - * 3019 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/host) 3020 - */ 3021 - set host(value: string); 3022 - /** 3023 - * The **`hostname`** property of the URL interface is a string containing either the domain name or IP address of the URL. 3024 - * 3025 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/hostname) 3026 - */ 3027 - get hostname(): string; 3028 - /** 3029 - * The **`hostname`** property of the URL interface is a string containing either the domain name or IP address of the URL. 3030 - * 3031 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/hostname) 3032 - */ 3033 - set hostname(value: string); 3034 - /** 3035 - * The **`port`** property of the URL interface is a string containing the port number of the URL. 3036 - * 3037 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/port) 3038 - */ 3039 - get port(): string; 3040 - /** 3041 - * The **`port`** property of the URL interface is a string containing the port number of the URL. 3042 - * 3043 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/port) 3044 - */ 3045 - set port(value: string); 3046 - /** 3047 - * The **`pathname`** property of the URL interface represents a location in a hierarchical structure. 3048 - * 3049 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/pathname) 3050 - */ 3051 - get pathname(): string; 3052 - /** 3053 - * The **`pathname`** property of the URL interface represents a location in a hierarchical structure. 3054 - * 3055 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/pathname) 3056 - */ 3057 - set pathname(value: string); 3058 - /** 3059 - * The **`search`** property of the URL interface is a search string, also called a _query string_, that is a string containing a `'?'` followed by the parameters of the URL. 3060 - * 3061 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/search) 3062 - */ 3063 - get search(): string; 3064 - /** 3065 - * The **`search`** property of the URL interface is a search string, also called a _query string_, that is a string containing a `'?'` followed by the parameters of the URL. 3066 - * 3067 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/search) 3068 - */ 3069 - set search(value: string); 3070 - /** 3071 - * The **`hash`** property of the URL interface is a string containing a `'#'` followed by the fragment identifier of the URL. 3072 - * 3073 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/hash) 3074 - */ 3075 - get hash(): string; 3076 - /** 3077 - * The **`hash`** property of the URL interface is a string containing a `'#'` followed by the fragment identifier of the URL. 3078 - * 3079 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/hash) 3080 - */ 3081 - set hash(value: string); 3082 - /** 3083 - * The **`searchParams`** read-only property of the access to the [MISSING: httpmethod('GET')] decoded query arguments contained in the URL. 3084 - * 3085 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/searchParams) 3086 - */ 3087 - get searchParams(): URLSearchParams; 3088 - /** 3089 - * The **`toJSON()`** method of the URL interface returns a string containing a serialized version of the URL, although in practice it seems to have the same effect as ```js-nolint toJSON() ``` None. 3090 - * 3091 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/toJSON) 3092 - */ 3093 - toJSON(): string; 3094 - /*function toString() { [native code] }*/ 3095 - toString(): string; 3096 - /** 3097 - * The **`URL.canParse()`** static method of the URL interface returns a boolean indicating whether or not an absolute URL, or a relative URL combined with a base URL, are parsable and valid. 3098 - * 3099 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/canParse_static) 3100 - */ 3101 - static canParse(url: string, base?: string): boolean; 3102 - /** 3103 - * The **`URL.parse()`** static method of the URL interface returns a newly created URL object representing the URL defined by the parameters. 3104 - * 3105 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/parse_static) 3106 - */ 3107 - static parse(url: string, base?: string): URL | null; 3108 - /** 3109 - * The **`createObjectURL()`** static method of the URL interface creates a string containing a URL representing the object given in the parameter. 3110 - * 3111 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/createObjectURL_static) 3112 - */ 3113 - static createObjectURL(object: File | Blob): string; 3114 - /** 3115 - * The **`revokeObjectURL()`** static method of the URL interface releases an existing object URL which was previously created by calling Call this method when you've finished using an object URL to let the browser know not to keep the reference to the file any longer. 3116 - * 3117 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/revokeObjectURL_static) 3118 - */ 3119 - static revokeObjectURL(object_url: string): void; 3120 - } 3121 - /** 3122 - * The **`URLSearchParams`** interface defines utility methods to work with the query string of a URL. 3123 - * 3124 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams) 3125 - */ 3126 - declare class URLSearchParams { 3127 - constructor(init?: Iterable<Iterable<string>> | Record<string, string> | string); 3128 - /** 3129 - * The **`size`** read-only property of the URLSearchParams interface indicates the total number of search parameter entries. 3130 - * 3131 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/size) 3132 - */ 3133 - get size(): number; 3134 - /** 3135 - * The **`append()`** method of the URLSearchParams interface appends a specified key/value pair as a new search parameter. 3136 - * 3137 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/append) 3138 - */ 3139 - append(name: string, value: string): void; 3140 - /** 3141 - * The **`delete()`** method of the URLSearchParams interface deletes specified parameters and their associated value(s) from the list of all search parameters. 3142 - * 3143 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/delete) 3144 - */ 3145 - delete(name: string, value?: string): void; 3146 - /** 3147 - * The **`get()`** method of the URLSearchParams interface returns the first value associated to the given search parameter. 3148 - * 3149 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/get) 3150 - */ 3151 - get(name: string): string | null; 3152 - /** 3153 - * The **`getAll()`** method of the URLSearchParams interface returns all the values associated with a given search parameter as an array. 3154 - * 3155 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/getAll) 3156 - */ 3157 - getAll(name: string): string[]; 3158 - /** 3159 - * The **`has()`** method of the URLSearchParams interface returns a boolean value that indicates whether the specified parameter is in the search parameters. 3160 - * 3161 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/has) 3162 - */ 3163 - has(name: string, value?: string): boolean; 3164 - /** 3165 - * The **`set()`** method of the URLSearchParams interface sets the value associated with a given search parameter to the given value. 3166 - * 3167 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/set) 3168 - */ 3169 - set(name: string, value: string): void; 3170 - /** 3171 - * The **`URLSearchParams.sort()`** method sorts all key/value pairs contained in this object in place and returns `undefined`. 3172 - * 3173 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/sort) 3174 - */ 3175 - sort(): void; 3176 - /* Returns an array of key, value pairs for every entry in the search params. */ 3177 - entries(): IterableIterator<[key: string, value: string]>; 3178 - /* Returns a list of keys in the search params. */ 3179 - keys(): IterableIterator<string>; 3180 - /* Returns a list of values in the search params. */ 3181 - values(): IterableIterator<string>; 3182 - forEach<This = unknown>( 3183 - callback: (this: This, value: string, key: string, parent: URLSearchParams) => void, 3184 - thisArg?: This, 3185 - ): void; 3186 - /*function toString() { [native code] }*/ 3187 - toString(): string; 3188 - [Symbol.iterator](): IterableIterator<[key: string, value: string]>; 3189 - } 3190 - declare class URLPattern { 3191 - constructor( 3192 - input?: string | URLPatternInit, 3193 - baseURL?: string | URLPatternOptions, 3194 - patternOptions?: URLPatternOptions, 3195 - ); 3196 - get protocol(): string; 3197 - get username(): string; 3198 - get password(): string; 3199 - get hostname(): string; 3200 - get port(): string; 3201 - get pathname(): string; 3202 - get search(): string; 3203 - get hash(): string; 3204 - get hasRegExpGroups(): boolean; 3205 - test(input?: string | URLPatternInit, baseURL?: string): boolean; 3206 - exec(input?: string | URLPatternInit, baseURL?: string): URLPatternResult | null; 3207 - } 3208 - interface URLPatternInit { 3209 - protocol?: string; 3210 - username?: string; 3211 - password?: string; 3212 - hostname?: string; 3213 - port?: string; 3214 - pathname?: string; 3215 - search?: string; 3216 - hash?: string; 3217 - baseURL?: string; 3218 - } 3219 - interface URLPatternComponentResult { 3220 - input: string; 3221 - groups: Record<string, string>; 3222 - } 3223 - interface URLPatternResult { 3224 - inputs: (string | URLPatternInit)[]; 3225 - protocol: URLPatternComponentResult; 3226 - username: URLPatternComponentResult; 3227 - password: URLPatternComponentResult; 3228 - hostname: URLPatternComponentResult; 3229 - port: URLPatternComponentResult; 3230 - pathname: URLPatternComponentResult; 3231 - search: URLPatternComponentResult; 3232 - hash: URLPatternComponentResult; 3233 - } 3234 - interface URLPatternOptions { 3235 - ignoreCase?: boolean; 3236 - } 3237 - /** 3238 - * A `CloseEvent` is sent to clients using WebSockets when the connection is closed. 3239 - * 3240 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CloseEvent) 3241 - */ 3242 - declare class CloseEvent extends Event { 3243 - constructor(type: string, initializer?: CloseEventInit); 3244 - /** 3245 - * The **`code`** read-only property of the CloseEvent interface returns a WebSocket connection close code indicating the reason the connection was closed. 3246 - * 3247 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CloseEvent/code) 3248 - */ 3249 - readonly code: number; 3250 - /** 3251 - * The **`reason`** read-only property of the CloseEvent interface returns the WebSocket connection close reason the server gave for closing the connection; that is, a concise human-readable prose explanation for the closure. 3252 - * 3253 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CloseEvent/reason) 3254 - */ 3255 - readonly reason: string; 3256 - /** 3257 - * The **`wasClean`** read-only property of the CloseEvent interface returns `true` if the connection closed cleanly. 3258 - * 3259 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CloseEvent/wasClean) 3260 - */ 3261 - readonly wasClean: boolean; 3262 - } 3263 - interface CloseEventInit { 3264 - code?: number; 3265 - reason?: string; 3266 - wasClean?: boolean; 3267 - } 3268 - type WebSocketEventMap = { 3269 - close: CloseEvent; 3270 - message: MessageEvent; 3271 - open: Event; 3272 - error: ErrorEvent; 3273 - }; 3274 - /** 3275 - * The `WebSocket` object provides the API for creating and managing a WebSocket connection to a server, as well as for sending and receiving data on the connection. 3276 - * 3277 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket) 3278 - */ 3279 - declare var WebSocket: { 3280 - prototype: WebSocket; 3281 - new (url: string, protocols?: string[] | string): WebSocket; 3282 - readonly READY_STATE_CONNECTING: number; 3283 - readonly CONNECTING: number; 3284 - readonly READY_STATE_OPEN: number; 3285 - readonly OPEN: number; 3286 - readonly READY_STATE_CLOSING: number; 3287 - readonly CLOSING: number; 3288 - readonly READY_STATE_CLOSED: number; 3289 - readonly CLOSED: number; 3290 - }; 3291 - /** 3292 - * The `WebSocket` object provides the API for creating and managing a WebSocket connection to a server, as well as for sending and receiving data on the connection. 3293 - * 3294 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket) 3295 - */ 3296 - interface WebSocket extends EventTarget<WebSocketEventMap> { 3297 - accept(): void; 3298 - /** 3299 - * The **`WebSocket.send()`** method enqueues the specified data to be transmitted to the server over the WebSocket connection, increasing the value of `bufferedAmount` by the number of bytes needed to contain the data. 3300 - * 3301 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/send) 3302 - */ 3303 - send(message: (ArrayBuffer | ArrayBufferView) | string): void; 3304 - /** 3305 - * The **`WebSocket.close()`** method closes the already `CLOSED`, this method does nothing. 3306 - * 3307 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/close) 3308 - */ 3309 - close(code?: number, reason?: string): void; 3310 - serializeAttachment(attachment: any): void; 3311 - deserializeAttachment(): any | null; 3312 - /** 3313 - * The **`WebSocket.readyState`** read-only property returns the current state of the WebSocket connection. 3314 - * 3315 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/readyState) 3316 - */ 3317 - readyState: number; 3318 - /** 3319 - * The **`WebSocket.url`** read-only property returns the absolute URL of the WebSocket as resolved by the constructor. 3320 - * 3321 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/url) 3322 - */ 3323 - url: string | null; 3324 - /** 3325 - * The **`WebSocket.protocol`** read-only property returns the name of the sub-protocol the server selected; this will be one of the strings specified in the `protocols` parameter when creating the WebSocket object, or the empty string if no connection is established. 3326 - * 3327 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/protocol) 3328 - */ 3329 - protocol: string | null; 3330 - /** 3331 - * The **`WebSocket.extensions`** read-only property returns the extensions selected by the server. 3332 - * 3333 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/extensions) 3334 - */ 3335 - extensions: string | null; 3336 - } 3337 - declare const WebSocketPair: { 3338 - new (): { 3339 - 0: WebSocket; 3340 - 1: WebSocket; 3341 - }; 3342 - }; 3343 - interface SqlStorage { 3344 - exec<T extends Record<string, SqlStorageValue>>(query: string, ...bindings: any[]): SqlStorageCursor<T>; 3345 - get databaseSize(): number; 3346 - Cursor: typeof SqlStorageCursor; 3347 - Statement: typeof SqlStorageStatement; 3348 - } 3349 - declare abstract class SqlStorageStatement {} 3350 - type SqlStorageValue = ArrayBuffer | string | number | null; 3351 - declare abstract class SqlStorageCursor<T extends Record<string, SqlStorageValue>> { 3352 - next(): 3353 - | { 3354 - done?: false; 3355 - value: T; 3356 - } 3357 - | { 3358 - done: true; 3359 - value?: never; 3360 - }; 3361 - toArray(): T[]; 3362 - one(): T; 3363 - raw<U extends SqlStorageValue[]>(): IterableIterator<U>; 3364 - columnNames: string[]; 3365 - get rowsRead(): number; 3366 - get rowsWritten(): number; 3367 - [Symbol.iterator](): IterableIterator<T>; 3368 - } 3369 - interface Socket { 3370 - get readable(): ReadableStream; 3371 - get writable(): WritableStream; 3372 - get closed(): Promise<void>; 3373 - get opened(): Promise<SocketInfo>; 3374 - get upgraded(): boolean; 3375 - get secureTransport(): 'on' | 'off' | 'starttls'; 3376 - close(): Promise<void>; 3377 - startTls(options?: TlsOptions): Socket; 3378 - } 3379 - interface SocketOptions { 3380 - secureTransport?: string; 3381 - allowHalfOpen: boolean; 3382 - highWaterMark?: number | bigint; 3383 - } 3384 - interface SocketAddress { 3385 - hostname: string; 3386 - port: number; 3387 - } 3388 - interface TlsOptions { 3389 - expectedServerHostname?: string; 3390 - } 3391 - interface SocketInfo { 3392 - remoteAddress?: string; 3393 - localAddress?: string; 3394 - } 3395 - /** 3396 - * The **`EventSource`** interface is web content's interface to server-sent events. 3397 - * 3398 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource) 3399 - */ 3400 - declare class EventSource extends EventTarget { 3401 - constructor(url: string, init?: EventSourceEventSourceInit); 3402 - /** 3403 - * The **`close()`** method of the EventSource interface closes the connection, if one is made, and sets the ```js-nolint close() ``` None. 3404 - * 3405 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/close) 3406 - */ 3407 - close(): void; 3408 - /** 3409 - * The **`url`** read-only property of the URL of the source. 3410 - * 3411 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/url) 3412 - */ 3413 - get url(): string; 3414 - /** 3415 - * The **`withCredentials`** read-only property of the the `EventSource` object was instantiated with CORS credentials set. 3416 - * 3417 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/withCredentials) 3418 - */ 3419 - get withCredentials(): boolean; 3420 - /** 3421 - * The **`readyState`** read-only property of the connection. 3422 - * 3423 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/readyState) 3424 - */ 3425 - get readyState(): number; 3426 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/open_event) */ 3427 - get onopen(): any | null; 3428 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/open_event) */ 3429 - set onopen(value: any | null); 3430 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/message_event) */ 3431 - get onmessage(): any | null; 3432 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/message_event) */ 3433 - set onmessage(value: any | null); 3434 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/error_event) */ 3435 - get onerror(): any | null; 3436 - /* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/error_event) */ 3437 - set onerror(value: any | null); 3438 - static readonly CONNECTING: number; 3439 - static readonly OPEN: number; 3440 - static readonly CLOSED: number; 3441 - static from(stream: ReadableStream): EventSource; 3442 - } 3443 - interface EventSourceEventSourceInit { 3444 - withCredentials?: boolean; 3445 - fetcher?: Fetcher; 3446 - } 3447 - interface Container { 3448 - get running(): boolean; 3449 - start(options?: ContainerStartupOptions): void; 3450 - monitor(): Promise<void>; 3451 - destroy(error?: any): Promise<void>; 3452 - signal(signo: number): void; 3453 - getTcpPort(port: number): Fetcher; 3454 - setInactivityTimeout(durationMs: number | bigint): Promise<void>; 3455 - } 3456 - interface ContainerStartupOptions { 3457 - entrypoint?: string[]; 3458 - enableInternet: boolean; 3459 - env?: Record<string, string>; 3460 - hardTimeout?: number | bigint; 3461 - } 3462 - /** 3463 - * The **`MessagePort`** interface of the Channel Messaging API represents one of the two ports of a MessageChannel, allowing messages to be sent from one port and listening out for them arriving at the other. 3464 - * 3465 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessagePort) 3466 - */ 3467 - declare abstract class MessagePort extends EventTarget { 3468 - /** 3469 - * The **`postMessage()`** method of the transfers ownership of objects to other browsing contexts. 3470 - * 3471 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessagePort/postMessage) 3472 - */ 3473 - postMessage(data?: any, options?: any[] | MessagePortPostMessageOptions): void; 3474 - /** 3475 - * The **`close()`** method of the MessagePort interface disconnects the port, so it is no longer active. 3476 - * 3477 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessagePort/close) 3478 - */ 3479 - close(): void; 3480 - /** 3481 - * The **`start()`** method of the MessagePort interface starts the sending of messages queued on the port. 3482 - * 3483 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessagePort/start) 3484 - */ 3485 - start(): void; 3486 - get onmessage(): any | null; 3487 - set onmessage(value: any | null); 3488 - } 3489 - /** 3490 - * The **`MessageChannel`** interface of the Channel Messaging API allows us to create a new message channel and send data through it via its two MessagePort properties. 3491 - * 3492 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageChannel) 3493 - */ 3494 - declare class MessageChannel { 3495 - constructor(); 3496 - /** 3497 - * The **`port1`** read-only property of the the port attached to the context that originated the channel. 3498 - * 3499 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageChannel/port1) 3500 - */ 3501 - readonly port1: MessagePort; 3502 - /** 3503 - * The **`port2`** read-only property of the the port attached to the context at the other end of the channel, which the message is initially sent to. 3504 - * 3505 - * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageChannel/port2) 3506 - */ 3507 - readonly port2: MessagePort; 3508 - } 3509 - interface MessagePortPostMessageOptions { 3510 - transfer?: any[]; 3511 - } 3512 - type LoopbackForExport< 3513 - T extends (new (...args: any[]) => Rpc.EntrypointBranded) | ExportedHandler<any, any, any> | undefined = 3514 - undefined, 3515 - > = T extends new (...args: any[]) => Rpc.WorkerEntrypointBranded 3516 - ? LoopbackServiceStub<InstanceType<T>> 3517 - : T extends new (...args: any[]) => Rpc.DurableObjectBranded 3518 - ? LoopbackDurableObjectClass<InstanceType<T>> 3519 - : T extends ExportedHandler<any, any, any> 3520 - ? LoopbackServiceStub<undefined> 3521 - : undefined; 3522 - type LoopbackServiceStub<T extends Rpc.WorkerEntrypointBranded | undefined = undefined> = Fetcher<T> & 3523 - (T extends CloudflareWorkersModule.WorkerEntrypoint<any, infer Props> 3524 - ? (opts: { props?: Props }) => Fetcher<T> 3525 - : (opts: { props?: any }) => Fetcher<T>); 3526 - type LoopbackDurableObjectClass<T extends Rpc.DurableObjectBranded | undefined = undefined> = 3527 - DurableObjectClass<T> & 3528 - (T extends CloudflareWorkersModule.DurableObject<any, infer Props> 3529 - ? (opts: { props?: Props }) => DurableObjectClass<T> 3530 - : (opts: { props?: any }) => DurableObjectClass<T>); 3531 - interface SyncKvStorage { 3532 - get<T = unknown>(key: string): T | undefined; 3533 - list<T = unknown>(options?: SyncKvListOptions): Iterable<[string, T]>; 3534 - put<T>(key: string, value: T): void; 3535 - delete(key: string): boolean; 3536 - } 3537 - interface SyncKvListOptions { 3538 - start?: string; 3539 - startAfter?: string; 3540 - end?: string; 3541 - prefix?: string; 3542 - reverse?: boolean; 3543 - limit?: number; 3544 - } 3545 - interface WorkerStub { 3546 - getEntrypoint<T extends Rpc.WorkerEntrypointBranded | undefined>( 3547 - name?: string, 3548 - options?: WorkerStubEntrypointOptions, 3549 - ): Fetcher<T>; 3550 - } 3551 - interface WorkerStubEntrypointOptions { 3552 - props?: any; 3553 - } 3554 - interface WorkerLoader { 3555 - get( 3556 - name: string | null, 3557 - getCode: () => WorkerLoaderWorkerCode | Promise<WorkerLoaderWorkerCode>, 3558 - ): WorkerStub; 3559 - } 3560 - interface WorkerLoaderModule { 3561 - js?: string; 3562 - cjs?: string; 3563 - text?: string; 3564 - data?: ArrayBuffer; 3565 - json?: any; 3566 - py?: string; 3567 - wasm?: ArrayBuffer; 3568 - } 3569 - interface WorkerLoaderWorkerCode { 3570 - compatibilityDate: string; 3571 - compatibilityFlags?: string[]; 3572 - allowExperimental?: boolean; 3573 - mainModule: string; 3574 - modules: Record<string, WorkerLoaderModule | string>; 3575 - env?: any; 3576 - globalOutbound?: Fetcher | null; 3577 - tails?: Fetcher[]; 3578 - streamingTails?: Fetcher[]; 3579 - } 3580 - /** 3581 - * The Workers runtime supports a subset of the Performance API, used to measure timing and performance, 3582 - * as well as timing of subrequests and other operations. 3583 - * 3584 - * [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/performance/) 3585 - */ 3586 - declare abstract class Performance { 3587 - /* [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/performance/#performancetimeorigin) */ 3588 - get timeOrigin(): number; 3589 - /* [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/performance/#performancenow) */ 3590 - now(): number; 3591 - } 3592 - type AiImageClassificationInput = { 3593 - image: number[]; 3594 - }; 3595 - type AiImageClassificationOutput = { 3596 - score?: number; 3597 - label?: string; 3598 - }[]; 3599 - declare abstract class BaseAiImageClassification { 3600 - inputs: AiImageClassificationInput; 3601 - postProcessedOutputs: AiImageClassificationOutput; 3602 - } 3603 - type AiImageToTextInput = { 3604 - image: number[]; 3605 - prompt?: string; 3606 - max_tokens?: number; 3607 - temperature?: number; 3608 - top_p?: number; 3609 - top_k?: number; 3610 - seed?: number; 3611 - repetition_penalty?: number; 3612 - frequency_penalty?: number; 3613 - presence_penalty?: number; 3614 - raw?: boolean; 3615 - messages?: RoleScopedChatInput[]; 3616 - }; 3617 - type AiImageToTextOutput = { 3618 - description: string; 3619 - }; 3620 - declare abstract class BaseAiImageToText { 3621 - inputs: AiImageToTextInput; 3622 - postProcessedOutputs: AiImageToTextOutput; 3623 - } 3624 - type AiImageTextToTextInput = { 3625 - image: string; 3626 - prompt?: string; 3627 - max_tokens?: number; 3628 - temperature?: number; 3629 - ignore_eos?: boolean; 3630 - top_p?: number; 3631 - top_k?: number; 3632 - seed?: number; 3633 - repetition_penalty?: number; 3634 - frequency_penalty?: number; 3635 - presence_penalty?: number; 3636 - raw?: boolean; 3637 - messages?: RoleScopedChatInput[]; 3638 - }; 3639 - type AiImageTextToTextOutput = { 3640 - description: string; 3641 - }; 3642 - declare abstract class BaseAiImageTextToText { 3643 - inputs: AiImageTextToTextInput; 3644 - postProcessedOutputs: AiImageTextToTextOutput; 3645 - } 3646 - type AiMultimodalEmbeddingsInput = { 3647 - image: string; 3648 - text: string[]; 3649 - }; 3650 - type AiIMultimodalEmbeddingsOutput = { 3651 - data: number[][]; 3652 - shape: number[]; 3653 - }; 3654 - declare abstract class BaseAiMultimodalEmbeddings { 3655 - inputs: AiImageTextToTextInput; 3656 - postProcessedOutputs: AiImageTextToTextOutput; 3657 - } 3658 - type AiObjectDetectionInput = { 3659 - image: number[]; 3660 - }; 3661 - type AiObjectDetectionOutput = { 3662 - score?: number; 3663 - label?: string; 3664 - }[]; 3665 - declare abstract class BaseAiObjectDetection { 3666 - inputs: AiObjectDetectionInput; 3667 - postProcessedOutputs: AiObjectDetectionOutput; 3668 - } 3669 - type AiSentenceSimilarityInput = { 3670 - source: string; 3671 - sentences: string[]; 3672 - }; 3673 - type AiSentenceSimilarityOutput = number[]; 3674 - declare abstract class BaseAiSentenceSimilarity { 3675 - inputs: AiSentenceSimilarityInput; 3676 - postProcessedOutputs: AiSentenceSimilarityOutput; 3677 - } 3678 - type AiAutomaticSpeechRecognitionInput = { 3679 - audio: number[]; 3680 - }; 3681 - type AiAutomaticSpeechRecognitionOutput = { 3682 - text?: string; 3683 - words?: { 3684 - word: string; 3685 - start: number; 3686 - end: number; 3687 - }[]; 3688 - vtt?: string; 3689 - }; 3690 - declare abstract class BaseAiAutomaticSpeechRecognition { 3691 - inputs: AiAutomaticSpeechRecognitionInput; 3692 - postProcessedOutputs: AiAutomaticSpeechRecognitionOutput; 3693 - } 3694 - type AiSummarizationInput = { 3695 - input_text: string; 3696 - max_length?: number; 3697 - }; 3698 - type AiSummarizationOutput = { 3699 - summary: string; 3700 - }; 3701 - declare abstract class BaseAiSummarization { 3702 - inputs: AiSummarizationInput; 3703 - postProcessedOutputs: AiSummarizationOutput; 3704 - } 3705 - type AiTextClassificationInput = { 3706 - text: string; 3707 - }; 3708 - type AiTextClassificationOutput = { 3709 - score?: number; 3710 - label?: string; 3711 - }[]; 3712 - declare abstract class BaseAiTextClassification { 3713 - inputs: AiTextClassificationInput; 3714 - postProcessedOutputs: AiTextClassificationOutput; 3715 - } 3716 - type AiTextEmbeddingsInput = { 3717 - text: string | string[]; 3718 - }; 3719 - type AiTextEmbeddingsOutput = { 3720 - shape: number[]; 3721 - data: number[][]; 3722 - }; 3723 - declare abstract class BaseAiTextEmbeddings { 3724 - inputs: AiTextEmbeddingsInput; 3725 - postProcessedOutputs: AiTextEmbeddingsOutput; 3726 - } 3727 - type RoleScopedChatInput = { 3728 - role: 'user' | 'assistant' | 'system' | 'tool' | (string & NonNullable<unknown>); 3729 - content: string; 3730 - name?: string; 3731 - }; 3732 - type AiTextGenerationToolLegacyInput = { 3733 - name: string; 3734 - description: string; 3735 - parameters?: { 3736 - type: 'object' | (string & NonNullable<unknown>); 3737 - properties: { 3738 - [key: string]: { 3739 - type: string; 3740 - description?: string; 3741 - }; 3742 - }; 3743 - required: string[]; 3744 - }; 3745 - }; 3746 - type AiTextGenerationToolInput = { 3747 - type: 'function' | (string & NonNullable<unknown>); 3748 - function: { 3749 - name: string; 3750 - description: string; 3751 - parameters?: { 3752 - type: 'object' | (string & NonNullable<unknown>); 3753 - properties: { 3754 - [key: string]: { 3755 - type: string; 3756 - description?: string; 3757 - }; 3758 - }; 3759 - required: string[]; 3760 - }; 3761 - }; 3762 - }; 3763 - type AiTextGenerationFunctionsInput = { 3764 - name: string; 3765 - code: string; 3766 - }; 3767 - type AiTextGenerationResponseFormat = { 3768 - type: string; 3769 - json_schema?: any; 3770 - }; 3771 - type AiTextGenerationInput = { 3772 - prompt?: string; 3773 - raw?: boolean; 3774 - stream?: boolean; 3775 - max_tokens?: number; 3776 - temperature?: number; 3777 - top_p?: number; 3778 - top_k?: number; 3779 - seed?: number; 3780 - repetition_penalty?: number; 3781 - frequency_penalty?: number; 3782 - presence_penalty?: number; 3783 - messages?: RoleScopedChatInput[]; 3784 - response_format?: AiTextGenerationResponseFormat; 3785 - tools?: AiTextGenerationToolInput[] | AiTextGenerationToolLegacyInput[] | (object & NonNullable<unknown>); 3786 - functions?: AiTextGenerationFunctionsInput[]; 3787 - }; 3788 - type AiTextGenerationToolLegacyOutput = { 3789 - name: string; 3790 - arguments: unknown; 3791 - }; 3792 - type AiTextGenerationToolOutput = { 3793 - id: string; 3794 - type: 'function'; 3795 - function: { 3796 - name: string; 3797 - arguments: string; 3798 - }; 3799 - }; 3800 - type UsageTags = { 3801 - prompt_tokens: number; 3802 - completion_tokens: number; 3803 - total_tokens: number; 3804 - }; 3805 - type AiTextGenerationOutput = { 3806 - response?: string; 3807 - tool_calls?: AiTextGenerationToolLegacyOutput[] & AiTextGenerationToolOutput[]; 3808 - usage?: UsageTags; 3809 - }; 3810 - declare abstract class BaseAiTextGeneration { 3811 - inputs: AiTextGenerationInput; 3812 - postProcessedOutputs: AiTextGenerationOutput; 3813 - } 3814 - type AiTextToSpeechInput = { 3815 - prompt: string; 3816 - lang?: string; 3817 - }; 3818 - type AiTextToSpeechOutput = 3819 - | Uint8Array 3820 - | { 3821 - audio: string; 3822 - }; 3823 - declare abstract class BaseAiTextToSpeech { 3824 - inputs: AiTextToSpeechInput; 3825 - postProcessedOutputs: AiTextToSpeechOutput; 3826 - } 3827 - type AiTextToImageInput = { 3828 - prompt: string; 3829 - negative_prompt?: string; 3830 - height?: number; 3831 - width?: number; 3832 - image?: number[]; 3833 - image_b64?: string; 3834 - mask?: number[]; 3835 - num_steps?: number; 3836 - strength?: number; 3837 - guidance?: number; 3838 - seed?: number; 3839 - }; 3840 - type AiTextToImageOutput = ReadableStream<Uint8Array>; 3841 - declare abstract class BaseAiTextToImage { 3842 - inputs: AiTextToImageInput; 3843 - postProcessedOutputs: AiTextToImageOutput; 3844 - } 3845 - type AiTranslationInput = { 3846 - text: string; 3847 - target_lang: string; 3848 - source_lang?: string; 3849 - }; 3850 - type AiTranslationOutput = { 3851 - translated_text?: string; 3852 - }; 3853 - declare abstract class BaseAiTranslation { 3854 - inputs: AiTranslationInput; 3855 - postProcessedOutputs: AiTranslationOutput; 3856 - } 3857 - /** 3858 - * Workers AI support for OpenAI's Responses API 3859 - * Reference: https://github.com/openai/openai-node/blob/master/src/resources/responses/responses.ts 3860 - * 3861 - * It's a stripped down version from its source. 3862 - * It currently supports basic function calling, json mode and accepts images as input. 3863 - * 3864 - * It does not include types for WebSearch, CodeInterpreter, FileInputs, MCP, CustomTools. 3865 - * We plan to add those incrementally as model + platform capabilities evolve. 3866 - */ 3867 - type ResponsesInput = { 3868 - background?: boolean | null; 3869 - conversation?: string | ResponseConversationParam | null; 3870 - include?: Array<ResponseIncludable> | null; 3871 - input?: string | ResponseInput; 3872 - instructions?: string | null; 3873 - max_output_tokens?: number | null; 3874 - parallel_tool_calls?: boolean | null; 3875 - previous_response_id?: string | null; 3876 - prompt_cache_key?: string; 3877 - reasoning?: Reasoning | null; 3878 - safety_identifier?: string; 3879 - service_tier?: 'auto' | 'default' | 'flex' | 'scale' | 'priority' | null; 3880 - stream?: boolean | null; 3881 - stream_options?: StreamOptions | null; 3882 - temperature?: number | null; 3883 - text?: ResponseTextConfig; 3884 - tool_choice?: ToolChoiceOptions | ToolChoiceFunction; 3885 - tools?: Array<Tool>; 3886 - top_p?: number | null; 3887 - truncation?: 'auto' | 'disabled' | null; 3888 - }; 3889 - type ResponsesOutput = { 3890 - id?: string; 3891 - created_at?: number; 3892 - output_text?: string; 3893 - error?: ResponseError | null; 3894 - incomplete_details?: ResponseIncompleteDetails | null; 3895 - instructions?: string | Array<ResponseInputItem> | null; 3896 - object?: 'response'; 3897 - output?: Array<ResponseOutputItem>; 3898 - parallel_tool_calls?: boolean; 3899 - temperature?: number | null; 3900 - tool_choice?: ToolChoiceOptions | ToolChoiceFunction; 3901 - tools?: Array<Tool>; 3902 - top_p?: number | null; 3903 - max_output_tokens?: number | null; 3904 - previous_response_id?: string | null; 3905 - prompt?: ResponsePrompt | null; 3906 - reasoning?: Reasoning | null; 3907 - safety_identifier?: string; 3908 - service_tier?: 'auto' | 'default' | 'flex' | 'scale' | 'priority' | null; 3909 - status?: ResponseStatus; 3910 - text?: ResponseTextConfig; 3911 - truncation?: 'auto' | 'disabled' | null; 3912 - usage?: ResponseUsage; 3913 - }; 3914 - type EasyInputMessage = { 3915 - content: string | ResponseInputMessageContentList; 3916 - role: 'user' | 'assistant' | 'system' | 'developer'; 3917 - type?: 'message'; 3918 - }; 3919 - type ResponsesFunctionTool = { 3920 - name: string; 3921 - parameters: { 3922 - [key: string]: unknown; 3923 - } | null; 3924 - strict: boolean | null; 3925 - type: 'function'; 3926 - description?: string | null; 3927 - }; 3928 - type ResponseIncompleteDetails = { 3929 - reason?: 'max_output_tokens' | 'content_filter'; 3930 - }; 3931 - type ResponsePrompt = { 3932 - id: string; 3933 - variables?: { 3934 - [key: string]: string | ResponseInputText | ResponseInputImage; 3935 - } | null; 3936 - version?: string | null; 3937 - }; 3938 - type Reasoning = { 3939 - effort?: ReasoningEffort | null; 3940 - generate_summary?: 'auto' | 'concise' | 'detailed' | null; 3941 - summary?: 'auto' | 'concise' | 'detailed' | null; 3942 - }; 3943 - type ResponseContent = 3944 - | ResponseInputText 3945 - | ResponseInputImage 3946 - | ResponseOutputText 3947 - | ResponseOutputRefusal 3948 - | ResponseContentReasoningText; 3949 - type ResponseContentReasoningText = { 3950 - text: string; 3951 - type: 'reasoning_text'; 3952 - }; 3953 - type ResponseConversationParam = { 3954 - id: string; 3955 - }; 3956 - type ResponseCreatedEvent = { 3957 - response: Response; 3958 - sequence_number: number; 3959 - type: 'response.created'; 3960 - }; 3961 - type ResponseCustomToolCallOutput = { 3962 - call_id: string; 3963 - output: string | Array<ResponseInputText | ResponseInputImage>; 3964 - type: 'custom_tool_call_output'; 3965 - id?: string; 3966 - }; 3967 - type ResponseError = { 3968 - code: 3969 - | 'server_error' 3970 - | 'rate_limit_exceeded' 3971 - | 'invalid_prompt' 3972 - | 'vector_store_timeout' 3973 - | 'invalid_image' 3974 - | 'invalid_image_format' 3975 - | 'invalid_base64_image' 3976 - | 'invalid_image_url' 3977 - | 'image_too_large' 3978 - | 'image_too_small' 3979 - | 'image_parse_error' 3980 - | 'image_content_policy_violation' 3981 - | 'invalid_image_mode' 3982 - | 'image_file_too_large' 3983 - | 'unsupported_image_media_type' 3984 - | 'empty_image_file' 3985 - | 'failed_to_download_image' 3986 - | 'image_file_not_found'; 3987 - message: string; 3988 - }; 3989 - type ResponseErrorEvent = { 3990 - code: string | null; 3991 - message: string; 3992 - param: string | null; 3993 - sequence_number: number; 3994 - type: 'error'; 3995 - }; 3996 - type ResponseFailedEvent = { 3997 - response: Response; 3998 - sequence_number: number; 3999 - type: 'response.failed'; 4000 - }; 4001 - type ResponseFormatText = { 4002 - type: 'text'; 4003 - }; 4004 - type ResponseFormatJSONObject = { 4005 - type: 'json_object'; 4006 - }; 4007 - type ResponseFormatTextConfig = 4008 - | ResponseFormatText 4009 - | ResponseFormatTextJSONSchemaConfig 4010 - | ResponseFormatJSONObject; 4011 - type ResponseFormatTextJSONSchemaConfig = { 4012 - name: string; 4013 - schema: { 4014 - [key: string]: unknown; 4015 - }; 4016 - type: 'json_schema'; 4017 - description?: string; 4018 - strict?: boolean | null; 4019 - }; 4020 - type ResponseFunctionCallArgumentsDeltaEvent = { 4021 - delta: string; 4022 - item_id: string; 4023 - output_index: number; 4024 - sequence_number: number; 4025 - type: 'response.function_call_arguments.delta'; 4026 - }; 4027 - type ResponseFunctionCallArgumentsDoneEvent = { 4028 - arguments: string; 4029 - item_id: string; 4030 - name: string; 4031 - output_index: number; 4032 - sequence_number: number; 4033 - type: 'response.function_call_arguments.done'; 4034 - }; 4035 - type ResponseFunctionCallOutputItem = ResponseInputTextContent | ResponseInputImageContent; 4036 - type ResponseFunctionCallOutputItemList = Array<ResponseFunctionCallOutputItem>; 4037 - type ResponseFunctionToolCall = { 4038 - arguments: string; 4039 - call_id: string; 4040 - name: string; 4041 - type: 'function_call'; 4042 - id?: string; 4043 - status?: 'in_progress' | 'completed' | 'incomplete'; 4044 - }; 4045 - interface ResponseFunctionToolCallItem extends ResponseFunctionToolCall { 4046 - id: string; 4047 - } 4048 - type ResponseFunctionToolCallOutputItem = { 4049 - id: string; 4050 - call_id: string; 4051 - output: string | Array<ResponseInputText | ResponseInputImage>; 4052 - type: 'function_call_output'; 4053 - status?: 'in_progress' | 'completed' | 'incomplete'; 4054 - }; 4055 - type ResponseIncludable = 'message.input_image.image_url' | 'message.output_text.logprobs'; 4056 - type ResponseIncompleteEvent = { 4057 - response: Response; 4058 - sequence_number: number; 4059 - type: 'response.incomplete'; 4060 - }; 4061 - type ResponseInput = Array<ResponseInputItem>; 4062 - type ResponseInputContent = ResponseInputText | ResponseInputImage; 4063 - type ResponseInputImage = { 4064 - detail: 'low' | 'high' | 'auto'; 4065 - type: 'input_image'; 4066 - /** 4067 - * Base64 encoded image 4068 - */ 4069 - image_url?: string | null; 4070 - }; 4071 - type ResponseInputImageContent = { 4072 - type: 'input_image'; 4073 - detail?: 'low' | 'high' | 'auto' | null; 4074 - /** 4075 - * Base64 encoded image 4076 - */ 4077 - image_url?: string | null; 4078 - }; 4079 - type ResponseInputItem = 4080 - | EasyInputMessage 4081 - | ResponseInputItemMessage 4082 - | ResponseOutputMessage 4083 - | ResponseFunctionToolCall 4084 - | ResponseInputItemFunctionCallOutput 4085 - | ResponseReasoningItem; 4086 - type ResponseInputItemFunctionCallOutput = { 4087 - call_id: string; 4088 - output: string | ResponseFunctionCallOutputItemList; 4089 - type: 'function_call_output'; 4090 - id?: string | null; 4091 - status?: 'in_progress' | 'completed' | 'incomplete' | null; 4092 - }; 4093 - type ResponseInputItemMessage = { 4094 - content: ResponseInputMessageContentList; 4095 - role: 'user' | 'system' | 'developer'; 4096 - status?: 'in_progress' | 'completed' | 'incomplete'; 4097 - type?: 'message'; 4098 - }; 4099 - type ResponseInputMessageContentList = Array<ResponseInputContent>; 4100 - type ResponseInputMessageItem = { 4101 - id: string; 4102 - content: ResponseInputMessageContentList; 4103 - role: 'user' | 'system' | 'developer'; 4104 - status?: 'in_progress' | 'completed' | 'incomplete'; 4105 - type?: 'message'; 4106 - }; 4107 - type ResponseInputText = { 4108 - text: string; 4109 - type: 'input_text'; 4110 - }; 4111 - type ResponseInputTextContent = { 4112 - text: string; 4113 - type: 'input_text'; 4114 - }; 4115 - type ResponseItem = 4116 - | ResponseInputMessageItem 4117 - | ResponseOutputMessage 4118 - | ResponseFunctionToolCallItem 4119 - | ResponseFunctionToolCallOutputItem; 4120 - type ResponseOutputItem = ResponseOutputMessage | ResponseFunctionToolCall | ResponseReasoningItem; 4121 - type ResponseOutputItemAddedEvent = { 4122 - item: ResponseOutputItem; 4123 - output_index: number; 4124 - sequence_number: number; 4125 - type: 'response.output_item.added'; 4126 - }; 4127 - type ResponseOutputItemDoneEvent = { 4128 - item: ResponseOutputItem; 4129 - output_index: number; 4130 - sequence_number: number; 4131 - type: 'response.output_item.done'; 4132 - }; 4133 - type ResponseOutputMessage = { 4134 - id: string; 4135 - content: Array<ResponseOutputText | ResponseOutputRefusal>; 4136 - role: 'assistant'; 4137 - status: 'in_progress' | 'completed' | 'incomplete'; 4138 - type: 'message'; 4139 - }; 4140 - type ResponseOutputRefusal = { 4141 - refusal: string; 4142 - type: 'refusal'; 4143 - }; 4144 - type ResponseOutputText = { 4145 - text: string; 4146 - type: 'output_text'; 4147 - logprobs?: Array<Logprob>; 4148 - }; 4149 - type ResponseReasoningItem = { 4150 - id: string; 4151 - summary: Array<ResponseReasoningSummaryItem>; 4152 - type: 'reasoning'; 4153 - content?: Array<ResponseReasoningContentItem>; 4154 - encrypted_content?: string | null; 4155 - status?: 'in_progress' | 'completed' | 'incomplete'; 4156 - }; 4157 - type ResponseReasoningSummaryItem = { 4158 - text: string; 4159 - type: 'summary_text'; 4160 - }; 4161 - type ResponseReasoningContentItem = { 4162 - text: string; 4163 - type: 'reasoning_text'; 4164 - }; 4165 - type ResponseReasoningTextDeltaEvent = { 4166 - content_index: number; 4167 - delta: string; 4168 - item_id: string; 4169 - output_index: number; 4170 - sequence_number: number; 4171 - type: 'response.reasoning_text.delta'; 4172 - }; 4173 - type ResponseReasoningTextDoneEvent = { 4174 - content_index: number; 4175 - item_id: string; 4176 - output_index: number; 4177 - sequence_number: number; 4178 - text: string; 4179 - type: 'response.reasoning_text.done'; 4180 - }; 4181 - type ResponseRefusalDeltaEvent = { 4182 - content_index: number; 4183 - delta: string; 4184 - item_id: string; 4185 - output_index: number; 4186 - sequence_number: number; 4187 - type: 'response.refusal.delta'; 4188 - }; 4189 - type ResponseRefusalDoneEvent = { 4190 - content_index: number; 4191 - item_id: string; 4192 - output_index: number; 4193 - refusal: string; 4194 - sequence_number: number; 4195 - type: 'response.refusal.done'; 4196 - }; 4197 - type ResponseStatus = 'completed' | 'failed' | 'in_progress' | 'cancelled' | 'queued' | 'incomplete'; 4198 - type ResponseStreamEvent = 4199 - | ResponseCompletedEvent 4200 - | ResponseCreatedEvent 4201 - | ResponseErrorEvent 4202 - | ResponseFunctionCallArgumentsDeltaEvent 4203 - | ResponseFunctionCallArgumentsDoneEvent 4204 - | ResponseFailedEvent 4205 - | ResponseIncompleteEvent 4206 - | ResponseOutputItemAddedEvent 4207 - | ResponseOutputItemDoneEvent 4208 - | ResponseReasoningTextDeltaEvent 4209 - | ResponseReasoningTextDoneEvent 4210 - | ResponseRefusalDeltaEvent 4211 - | ResponseRefusalDoneEvent 4212 - | ResponseTextDeltaEvent 4213 - | ResponseTextDoneEvent; 4214 - type ResponseCompletedEvent = { 4215 - response: Response; 4216 - sequence_number: number; 4217 - type: 'response.completed'; 4218 - }; 4219 - type ResponseTextConfig = { 4220 - format?: ResponseFormatTextConfig; 4221 - verbosity?: 'low' | 'medium' | 'high' | null; 4222 - }; 4223 - type ResponseTextDeltaEvent = { 4224 - content_index: number; 4225 - delta: string; 4226 - item_id: string; 4227 - logprobs: Array<Logprob>; 4228 - output_index: number; 4229 - sequence_number: number; 4230 - type: 'response.output_text.delta'; 4231 - }; 4232 - type ResponseTextDoneEvent = { 4233 - content_index: number; 4234 - item_id: string; 4235 - logprobs: Array<Logprob>; 4236 - output_index: number; 4237 - sequence_number: number; 4238 - text: string; 4239 - type: 'response.output_text.done'; 4240 - }; 4241 - type Logprob = { 4242 - token: string; 4243 - logprob: number; 4244 - top_logprobs?: Array<TopLogprob>; 4245 - }; 4246 - type TopLogprob = { 4247 - token?: string; 4248 - logprob?: number; 4249 - }; 4250 - type ResponseUsage = { 4251 - input_tokens: number; 4252 - output_tokens: number; 4253 - total_tokens: number; 4254 - }; 4255 - type Tool = ResponsesFunctionTool; 4256 - type ToolChoiceFunction = { 4257 - name: string; 4258 - type: 'function'; 4259 - }; 4260 - type ToolChoiceOptions = 'none'; 4261 - type ReasoningEffort = 'minimal' | 'low' | 'medium' | 'high' | null; 4262 - type StreamOptions = { 4263 - include_obfuscation?: boolean; 4264 - }; 4265 - type Ai_Cf_Baai_Bge_Base_En_V1_5_Input = 4266 - | { 4267 - text: string | string[]; 4268 - /** 4269 - * The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. 4270 - */ 4271 - pooling?: 'mean' | 'cls'; 4272 - } 4273 - | { 4274 - /** 4275 - * Batch of the embeddings requests to run using async-queue 4276 - */ 4277 - requests: { 4278 - text: string | string[]; 4279 - /** 4280 - * The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. 4281 - */ 4282 - pooling?: 'mean' | 'cls'; 4283 - }[]; 4284 - }; 4285 - type Ai_Cf_Baai_Bge_Base_En_V1_5_Output = 4286 - | { 4287 - shape?: number[]; 4288 - /** 4289 - * Embeddings of the requested text values 4290 - */ 4291 - data?: number[][]; 4292 - /** 4293 - * The pooling method used in the embedding process. 4294 - */ 4295 - pooling?: 'mean' | 'cls'; 4296 - } 4297 - | Ai_Cf_Baai_Bge_Base_En_V1_5_AsyncResponse; 4298 - interface Ai_Cf_Baai_Bge_Base_En_V1_5_AsyncResponse { 4299 - /** 4300 - * The async request id that can be used to obtain the results. 4301 - */ 4302 - request_id?: string; 4303 - } 4304 - declare abstract class Base_Ai_Cf_Baai_Bge_Base_En_V1_5 { 4305 - inputs: Ai_Cf_Baai_Bge_Base_En_V1_5_Input; 4306 - postProcessedOutputs: Ai_Cf_Baai_Bge_Base_En_V1_5_Output; 4307 - } 4308 - type Ai_Cf_Openai_Whisper_Input = 4309 - | string 4310 - | { 4311 - /** 4312 - * An array of integers that represent the audio data constrained to 8-bit unsigned integer values 4313 - */ 4314 - audio: number[]; 4315 - }; 4316 - interface Ai_Cf_Openai_Whisper_Output { 4317 - /** 4318 - * The transcription 4319 - */ 4320 - text: string; 4321 - word_count?: number; 4322 - words?: { 4323 - word?: string; 4324 - /** 4325 - * The second this word begins in the recording 4326 - */ 4327 - start?: number; 4328 - /** 4329 - * The ending second when the word completes 4330 - */ 4331 - end?: number; 4332 - }[]; 4333 - vtt?: string; 4334 - } 4335 - declare abstract class Base_Ai_Cf_Openai_Whisper { 4336 - inputs: Ai_Cf_Openai_Whisper_Input; 4337 - postProcessedOutputs: Ai_Cf_Openai_Whisper_Output; 4338 - } 4339 - type Ai_Cf_Meta_M2M100_1_2B_Input = 4340 - | { 4341 - /** 4342 - * The text to be translated 4343 - */ 4344 - text: string; 4345 - /** 4346 - * The language code of the source text (e.g., 'en' for English). Defaults to 'en' if not specified 4347 - */ 4348 - source_lang?: string; 4349 - /** 4350 - * The language code to translate the text into (e.g., 'es' for Spanish) 4351 - */ 4352 - target_lang: string; 4353 - } 4354 - | { 4355 - /** 4356 - * Batch of the embeddings requests to run using async-queue 4357 - */ 4358 - requests: { 4359 - /** 4360 - * The text to be translated 4361 - */ 4362 - text: string; 4363 - /** 4364 - * The language code of the source text (e.g., 'en' for English). Defaults to 'en' if not specified 4365 - */ 4366 - source_lang?: string; 4367 - /** 4368 - * The language code to translate the text into (e.g., 'es' for Spanish) 4369 - */ 4370 - target_lang: string; 4371 - }[]; 4372 - }; 4373 - type Ai_Cf_Meta_M2M100_1_2B_Output = 4374 - | { 4375 - /** 4376 - * The translated text in the target language 4377 - */ 4378 - translated_text?: string; 4379 - } 4380 - | Ai_Cf_Meta_M2M100_1_2B_AsyncResponse; 4381 - interface Ai_Cf_Meta_M2M100_1_2B_AsyncResponse { 4382 - /** 4383 - * The async request id that can be used to obtain the results. 4384 - */ 4385 - request_id?: string; 4386 - } 4387 - declare abstract class Base_Ai_Cf_Meta_M2M100_1_2B { 4388 - inputs: Ai_Cf_Meta_M2M100_1_2B_Input; 4389 - postProcessedOutputs: Ai_Cf_Meta_M2M100_1_2B_Output; 4390 - } 4391 - type Ai_Cf_Baai_Bge_Small_En_V1_5_Input = 4392 - | { 4393 - text: string | string[]; 4394 - /** 4395 - * The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. 4396 - */ 4397 - pooling?: 'mean' | 'cls'; 4398 - } 4399 - | { 4400 - /** 4401 - * Batch of the embeddings requests to run using async-queue 4402 - */ 4403 - requests: { 4404 - text: string | string[]; 4405 - /** 4406 - * The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. 4407 - */ 4408 - pooling?: 'mean' | 'cls'; 4409 - }[]; 4410 - }; 4411 - type Ai_Cf_Baai_Bge_Small_En_V1_5_Output = 4412 - | { 4413 - shape?: number[]; 4414 - /** 4415 - * Embeddings of the requested text values 4416 - */ 4417 - data?: number[][]; 4418 - /** 4419 - * The pooling method used in the embedding process. 4420 - */ 4421 - pooling?: 'mean' | 'cls'; 4422 - } 4423 - | Ai_Cf_Baai_Bge_Small_En_V1_5_AsyncResponse; 4424 - interface Ai_Cf_Baai_Bge_Small_En_V1_5_AsyncResponse { 4425 - /** 4426 - * The async request id that can be used to obtain the results. 4427 - */ 4428 - request_id?: string; 4429 - } 4430 - declare abstract class Base_Ai_Cf_Baai_Bge_Small_En_V1_5 { 4431 - inputs: Ai_Cf_Baai_Bge_Small_En_V1_5_Input; 4432 - postProcessedOutputs: Ai_Cf_Baai_Bge_Small_En_V1_5_Output; 4433 - } 4434 - type Ai_Cf_Baai_Bge_Large_En_V1_5_Input = 4435 - | { 4436 - text: string | string[]; 4437 - /** 4438 - * The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. 4439 - */ 4440 - pooling?: 'mean' | 'cls'; 4441 - } 4442 - | { 4443 - /** 4444 - * Batch of the embeddings requests to run using async-queue 4445 - */ 4446 - requests: { 4447 - text: string | string[]; 4448 - /** 4449 - * The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy. 4450 - */ 4451 - pooling?: 'mean' | 'cls'; 4452 - }[]; 4453 - }; 4454 - type Ai_Cf_Baai_Bge_Large_En_V1_5_Output = 4455 - | { 4456 - shape?: number[]; 4457 - /** 4458 - * Embeddings of the requested text values 4459 - */ 4460 - data?: number[][]; 4461 - /** 4462 - * The pooling method used in the embedding process. 4463 - */ 4464 - pooling?: 'mean' | 'cls'; 4465 - } 4466 - | Ai_Cf_Baai_Bge_Large_En_V1_5_AsyncResponse; 4467 - interface Ai_Cf_Baai_Bge_Large_En_V1_5_AsyncResponse { 4468 - /** 4469 - * The async request id that can be used to obtain the results. 4470 - */ 4471 - request_id?: string; 4472 - } 4473 - declare abstract class Base_Ai_Cf_Baai_Bge_Large_En_V1_5 { 4474 - inputs: Ai_Cf_Baai_Bge_Large_En_V1_5_Input; 4475 - postProcessedOutputs: Ai_Cf_Baai_Bge_Large_En_V1_5_Output; 4476 - } 4477 - type Ai_Cf_Unum_Uform_Gen2_Qwen_500M_Input = 4478 - | string 4479 - | { 4480 - /** 4481 - * The input text prompt for the model to generate a response. 4482 - */ 4483 - prompt?: string; 4484 - /** 4485 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 4486 - */ 4487 - raw?: boolean; 4488 - /** 4489 - * Controls the creativity of the AI's responses by adjusting how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 4490 - */ 4491 - top_p?: number; 4492 - /** 4493 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 4494 - */ 4495 - top_k?: number; 4496 - /** 4497 - * Random seed for reproducibility of the generation. 4498 - */ 4499 - seed?: number; 4500 - /** 4501 - * Penalty for repeated tokens; higher values discourage repetition. 4502 - */ 4503 - repetition_penalty?: number; 4504 - /** 4505 - * Decreases the likelihood of the model repeating the same lines verbatim. 4506 - */ 4507 - frequency_penalty?: number; 4508 - /** 4509 - * Increases the likelihood of the model introducing new topics. 4510 - */ 4511 - presence_penalty?: number; 4512 - image: number[] | (string & NonNullable<unknown>); 4513 - /** 4514 - * The maximum number of tokens to generate in the response. 4515 - */ 4516 - max_tokens?: number; 4517 - }; 4518 - interface Ai_Cf_Unum_Uform_Gen2_Qwen_500M_Output { 4519 - description?: string; 4520 - } 4521 - declare abstract class Base_Ai_Cf_Unum_Uform_Gen2_Qwen_500M { 4522 - inputs: Ai_Cf_Unum_Uform_Gen2_Qwen_500M_Input; 4523 - postProcessedOutputs: Ai_Cf_Unum_Uform_Gen2_Qwen_500M_Output; 4524 - } 4525 - type Ai_Cf_Openai_Whisper_Tiny_En_Input = 4526 - | string 4527 - | { 4528 - /** 4529 - * An array of integers that represent the audio data constrained to 8-bit unsigned integer values 4530 - */ 4531 - audio: number[]; 4532 - }; 4533 - interface Ai_Cf_Openai_Whisper_Tiny_En_Output { 4534 - /** 4535 - * The transcription 4536 - */ 4537 - text: string; 4538 - word_count?: number; 4539 - words?: { 4540 - word?: string; 4541 - /** 4542 - * The second this word begins in the recording 4543 - */ 4544 - start?: number; 4545 - /** 4546 - * The ending second when the word completes 4547 - */ 4548 - end?: number; 4549 - }[]; 4550 - vtt?: string; 4551 - } 4552 - declare abstract class Base_Ai_Cf_Openai_Whisper_Tiny_En { 4553 - inputs: Ai_Cf_Openai_Whisper_Tiny_En_Input; 4554 - postProcessedOutputs: Ai_Cf_Openai_Whisper_Tiny_En_Output; 4555 - } 4556 - interface Ai_Cf_Openai_Whisper_Large_V3_Turbo_Input { 4557 - /** 4558 - * Base64 encoded value of the audio data. 4559 - */ 4560 - audio: string; 4561 - /** 4562 - * Supported tasks are 'translate' or 'transcribe'. 4563 - */ 4564 - task?: string; 4565 - /** 4566 - * The language of the audio being transcribed or translated. 4567 - */ 4568 - language?: string; 4569 - /** 4570 - * Preprocess the audio with a voice activity detection model. 4571 - */ 4572 - vad_filter?: boolean; 4573 - /** 4574 - * A text prompt to help provide context to the model on the contents of the audio. 4575 - */ 4576 - initial_prompt?: string; 4577 - /** 4578 - * The prefix it appended the the beginning of the output of the transcription and can guide the transcription result. 4579 - */ 4580 - prefix?: string; 4581 - } 4582 - interface Ai_Cf_Openai_Whisper_Large_V3_Turbo_Output { 4583 - transcription_info?: { 4584 - /** 4585 - * The language of the audio being transcribed or translated. 4586 - */ 4587 - language?: string; 4588 - /** 4589 - * The confidence level or probability of the detected language being accurate, represented as a decimal between 0 and 1. 4590 - */ 4591 - language_probability?: number; 4592 - /** 4593 - * The total duration of the original audio file, in seconds. 4594 - */ 4595 - duration?: number; 4596 - /** 4597 - * The duration of the audio after applying Voice Activity Detection (VAD) to remove silent or irrelevant sections, in seconds. 4598 - */ 4599 - duration_after_vad?: number; 4600 - }; 4601 - /** 4602 - * The complete transcription of the audio. 4603 - */ 4604 - text: string; 4605 - /** 4606 - * The total number of words in the transcription. 4607 - */ 4608 - word_count?: number; 4609 - segments?: { 4610 - /** 4611 - * The starting time of the segment within the audio, in seconds. 4612 - */ 4613 - start?: number; 4614 - /** 4615 - * The ending time of the segment within the audio, in seconds. 4616 - */ 4617 - end?: number; 4618 - /** 4619 - * The transcription of the segment. 4620 - */ 4621 - text?: string; 4622 - /** 4623 - * The temperature used in the decoding process, controlling randomness in predictions. Lower values result in more deterministic outputs. 4624 - */ 4625 - temperature?: number; 4626 - /** 4627 - * The average log probability of the predictions for the words in this segment, indicating overall confidence. 4628 - */ 4629 - avg_logprob?: number; 4630 - /** 4631 - * The compression ratio of the input to the output, measuring how much the text was compressed during the transcription process. 4632 - */ 4633 - compression_ratio?: number; 4634 - /** 4635 - * The probability that the segment contains no speech, represented as a decimal between 0 and 1. 4636 - */ 4637 - no_speech_prob?: number; 4638 - words?: { 4639 - /** 4640 - * The individual word transcribed from the audio. 4641 - */ 4642 - word?: string; 4643 - /** 4644 - * The starting time of the word within the audio, in seconds. 4645 - */ 4646 - start?: number; 4647 - /** 4648 - * The ending time of the word within the audio, in seconds. 4649 - */ 4650 - end?: number; 4651 - }[]; 4652 - }[]; 4653 - /** 4654 - * The transcription in WebVTT format, which includes timing and text information for use in subtitles. 4655 - */ 4656 - vtt?: string; 4657 - } 4658 - declare abstract class Base_Ai_Cf_Openai_Whisper_Large_V3_Turbo { 4659 - inputs: Ai_Cf_Openai_Whisper_Large_V3_Turbo_Input; 4660 - postProcessedOutputs: Ai_Cf_Openai_Whisper_Large_V3_Turbo_Output; 4661 - } 4662 - type Ai_Cf_Baai_Bge_M3_Input = 4663 - | Ai_Cf_Baai_Bge_M3_Input_QueryAnd_Contexts 4664 - | Ai_Cf_Baai_Bge_M3_Input_Embedding 4665 - | { 4666 - /** 4667 - * Batch of the embeddings requests to run using async-queue 4668 - */ 4669 - requests: (Ai_Cf_Baai_Bge_M3_Input_QueryAnd_Contexts_1 | Ai_Cf_Baai_Bge_M3_Input_Embedding_1)[]; 4670 - }; 4671 - interface Ai_Cf_Baai_Bge_M3_Input_QueryAnd_Contexts { 4672 - /** 4673 - * A query you wish to perform against the provided contexts. If no query is provided the model with respond with embeddings for contexts 4674 - */ 4675 - query?: string; 4676 - /** 4677 - * List of provided contexts. Note that the index in this array is important, as the response will refer to it. 4678 - */ 4679 - contexts: { 4680 - /** 4681 - * One of the provided context content 4682 - */ 4683 - text?: string; 4684 - }[]; 4685 - /** 4686 - * When provided with too long context should the model error out or truncate the context to fit? 4687 - */ 4688 - truncate_inputs?: boolean; 4689 - } 4690 - interface Ai_Cf_Baai_Bge_M3_Input_Embedding { 4691 - text: string | string[]; 4692 - /** 4693 - * When provided with too long context should the model error out or truncate the context to fit? 4694 - */ 4695 - truncate_inputs?: boolean; 4696 - } 4697 - interface Ai_Cf_Baai_Bge_M3_Input_QueryAnd_Contexts_1 { 4698 - /** 4699 - * A query you wish to perform against the provided contexts. If no query is provided the model with respond with embeddings for contexts 4700 - */ 4701 - query?: string; 4702 - /** 4703 - * List of provided contexts. Note that the index in this array is important, as the response will refer to it. 4704 - */ 4705 - contexts: { 4706 - /** 4707 - * One of the provided context content 4708 - */ 4709 - text?: string; 4710 - }[]; 4711 - /** 4712 - * When provided with too long context should the model error out or truncate the context to fit? 4713 - */ 4714 - truncate_inputs?: boolean; 4715 - } 4716 - interface Ai_Cf_Baai_Bge_M3_Input_Embedding_1 { 4717 - text: string | string[]; 4718 - /** 4719 - * When provided with too long context should the model error out or truncate the context to fit? 4720 - */ 4721 - truncate_inputs?: boolean; 4722 - } 4723 - type Ai_Cf_Baai_Bge_M3_Output = 4724 - | Ai_Cf_Baai_Bge_M3_Ouput_Query 4725 - | Ai_Cf_Baai_Bge_M3_Output_EmbeddingFor_Contexts 4726 - | Ai_Cf_Baai_Bge_M3_Ouput_Embedding 4727 - | Ai_Cf_Baai_Bge_M3_AsyncResponse; 4728 - interface Ai_Cf_Baai_Bge_M3_Ouput_Query { 4729 - response?: { 4730 - /** 4731 - * Index of the context in the request 4732 - */ 4733 - id?: number; 4734 - /** 4735 - * Score of the context under the index. 4736 - */ 4737 - score?: number; 4738 - }[]; 4739 - } 4740 - interface Ai_Cf_Baai_Bge_M3_Output_EmbeddingFor_Contexts { 4741 - response?: number[][]; 4742 - shape?: number[]; 4743 - /** 4744 - * The pooling method used in the embedding process. 4745 - */ 4746 - pooling?: 'mean' | 'cls'; 4747 - } 4748 - interface Ai_Cf_Baai_Bge_M3_Ouput_Embedding { 4749 - shape?: number[]; 4750 - /** 4751 - * Embeddings of the requested text values 4752 - */ 4753 - data?: number[][]; 4754 - /** 4755 - * The pooling method used in the embedding process. 4756 - */ 4757 - pooling?: 'mean' | 'cls'; 4758 - } 4759 - interface Ai_Cf_Baai_Bge_M3_AsyncResponse { 4760 - /** 4761 - * The async request id that can be used to obtain the results. 4762 - */ 4763 - request_id?: string; 4764 - } 4765 - declare abstract class Base_Ai_Cf_Baai_Bge_M3 { 4766 - inputs: Ai_Cf_Baai_Bge_M3_Input; 4767 - postProcessedOutputs: Ai_Cf_Baai_Bge_M3_Output; 4768 - } 4769 - interface Ai_Cf_Black_Forest_Labs_Flux_1_Schnell_Input { 4770 - /** 4771 - * A text description of the image you want to generate. 4772 - */ 4773 - prompt: string; 4774 - /** 4775 - * The number of diffusion steps; higher values can improve quality but take longer. 4776 - */ 4777 - steps?: number; 4778 - } 4779 - interface Ai_Cf_Black_Forest_Labs_Flux_1_Schnell_Output { 4780 - /** 4781 - * The generated image in Base64 format. 4782 - */ 4783 - image?: string; 4784 - } 4785 - declare abstract class Base_Ai_Cf_Black_Forest_Labs_Flux_1_Schnell { 4786 - inputs: Ai_Cf_Black_Forest_Labs_Flux_1_Schnell_Input; 4787 - postProcessedOutputs: Ai_Cf_Black_Forest_Labs_Flux_1_Schnell_Output; 4788 - } 4789 - type Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct_Input = 4790 - | Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct_Prompt 4791 - | Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct_Messages; 4792 - interface Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct_Prompt { 4793 - /** 4794 - * The input text prompt for the model to generate a response. 4795 - */ 4796 - prompt: string; 4797 - image?: number[] | (string & NonNullable<unknown>); 4798 - /** 4799 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 4800 - */ 4801 - raw?: boolean; 4802 - /** 4803 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 4804 - */ 4805 - stream?: boolean; 4806 - /** 4807 - * The maximum number of tokens to generate in the response. 4808 - */ 4809 - max_tokens?: number; 4810 - /** 4811 - * Controls the randomness of the output; higher values produce more random results. 4812 - */ 4813 - temperature?: number; 4814 - /** 4815 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 4816 - */ 4817 - top_p?: number; 4818 - /** 4819 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 4820 - */ 4821 - top_k?: number; 4822 - /** 4823 - * Random seed for reproducibility of the generation. 4824 - */ 4825 - seed?: number; 4826 - /** 4827 - * Penalty for repeated tokens; higher values discourage repetition. 4828 - */ 4829 - repetition_penalty?: number; 4830 - /** 4831 - * Decreases the likelihood of the model repeating the same lines verbatim. 4832 - */ 4833 - frequency_penalty?: number; 4834 - /** 4835 - * Increases the likelihood of the model introducing new topics. 4836 - */ 4837 - presence_penalty?: number; 4838 - /** 4839 - * Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. 4840 - */ 4841 - lora?: string; 4842 - } 4843 - interface Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct_Messages { 4844 - /** 4845 - * An array of message objects representing the conversation history. 4846 - */ 4847 - messages: { 4848 - /** 4849 - * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). 4850 - */ 4851 - role?: string; 4852 - /** 4853 - * The tool call id. Must be supplied for tool calls for Mistral-3. If you don't know what to put here you can fall back to 000000001 4854 - */ 4855 - tool_call_id?: string; 4856 - content?: 4857 - | string 4858 - | { 4859 - /** 4860 - * Type of the content provided 4861 - */ 4862 - type?: string; 4863 - text?: string; 4864 - image_url?: { 4865 - /** 4866 - * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted 4867 - */ 4868 - url?: string; 4869 - }; 4870 - }[] 4871 - | { 4872 - /** 4873 - * Type of the content provided 4874 - */ 4875 - type?: string; 4876 - text?: string; 4877 - image_url?: { 4878 - /** 4879 - * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted 4880 - */ 4881 - url?: string; 4882 - }; 4883 - }; 4884 - }[]; 4885 - image?: number[] | (string & NonNullable<unknown>); 4886 - functions?: { 4887 - name: string; 4888 - code: string; 4889 - }[]; 4890 - /** 4891 - * A list of tools available for the assistant to use. 4892 - */ 4893 - tools?: ( 4894 - | { 4895 - /** 4896 - * The name of the tool. More descriptive the better. 4897 - */ 4898 - name: string; 4899 - /** 4900 - * A brief description of what the tool does. 4901 - */ 4902 - description: string; 4903 - /** 4904 - * Schema defining the parameters accepted by the tool. 4905 - */ 4906 - parameters: { 4907 - /** 4908 - * The type of the parameters object (usually 'object'). 4909 - */ 4910 - type: string; 4911 - /** 4912 - * List of required parameter names. 4913 - */ 4914 - required?: string[]; 4915 - /** 4916 - * Definitions of each parameter. 4917 - */ 4918 - properties: { 4919 - [k: string]: { 4920 - /** 4921 - * The data type of the parameter. 4922 - */ 4923 - type: string; 4924 - /** 4925 - * A description of the expected parameter. 4926 - */ 4927 - description: string; 4928 - }; 4929 - }; 4930 - }; 4931 - } 4932 - | { 4933 - /** 4934 - * Specifies the type of tool (e.g., 'function'). 4935 - */ 4936 - type: string; 4937 - /** 4938 - * Details of the function tool. 4939 - */ 4940 - function: { 4941 - /** 4942 - * The name of the function. 4943 - */ 4944 - name: string; 4945 - /** 4946 - * A brief description of what the function does. 4947 - */ 4948 - description: string; 4949 - /** 4950 - * Schema defining the parameters accepted by the function. 4951 - */ 4952 - parameters: { 4953 - /** 4954 - * The type of the parameters object (usually 'object'). 4955 - */ 4956 - type: string; 4957 - /** 4958 - * List of required parameter names. 4959 - */ 4960 - required?: string[]; 4961 - /** 4962 - * Definitions of each parameter. 4963 - */ 4964 - properties: { 4965 - [k: string]: { 4966 - /** 4967 - * The data type of the parameter. 4968 - */ 4969 - type: string; 4970 - /** 4971 - * A description of the expected parameter. 4972 - */ 4973 - description: string; 4974 - }; 4975 - }; 4976 - }; 4977 - }; 4978 - } 4979 - )[]; 4980 - /** 4981 - * If true, the response will be streamed back incrementally. 4982 - */ 4983 - stream?: boolean; 4984 - /** 4985 - * The maximum number of tokens to generate in the response. 4986 - */ 4987 - max_tokens?: number; 4988 - /** 4989 - * Controls the randomness of the output; higher values produce more random results. 4990 - */ 4991 - temperature?: number; 4992 - /** 4993 - * Controls the creativity of the AI's responses by adjusting how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 4994 - */ 4995 - top_p?: number; 4996 - /** 4997 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 4998 - */ 4999 - top_k?: number; 5000 - /** 5001 - * Random seed for reproducibility of the generation. 5002 - */ 5003 - seed?: number; 5004 - /** 5005 - * Penalty for repeated tokens; higher values discourage repetition. 5006 - */ 5007 - repetition_penalty?: number; 5008 - /** 5009 - * Decreases the likelihood of the model repeating the same lines verbatim. 5010 - */ 5011 - frequency_penalty?: number; 5012 - /** 5013 - * Increases the likelihood of the model introducing new topics. 5014 - */ 5015 - presence_penalty?: number; 5016 - } 5017 - type Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct_Output = { 5018 - /** 5019 - * The generated text response from the model 5020 - */ 5021 - response?: string; 5022 - /** 5023 - * An array of tool calls requests made during the response generation 5024 - */ 5025 - tool_calls?: { 5026 - /** 5027 - * The arguments passed to be passed to the tool call request 5028 - */ 5029 - arguments?: object; 5030 - /** 5031 - * The name of the tool to be called 5032 - */ 5033 - name?: string; 5034 - }[]; 5035 - }; 5036 - declare abstract class Base_Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct { 5037 - inputs: Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct_Input; 5038 - postProcessedOutputs: Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct_Output; 5039 - } 5040 - type Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Input = 5041 - | Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Prompt 5042 - | Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Messages 5043 - | Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Async_Batch; 5044 - interface Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Prompt { 5045 - /** 5046 - * The input text prompt for the model to generate a response. 5047 - */ 5048 - prompt: string; 5049 - /** 5050 - * Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. 5051 - */ 5052 - lora?: string; 5053 - response_format?: Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_JSON_Mode; 5054 - /** 5055 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 5056 - */ 5057 - raw?: boolean; 5058 - /** 5059 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 5060 - */ 5061 - stream?: boolean; 5062 - /** 5063 - * The maximum number of tokens to generate in the response. 5064 - */ 5065 - max_tokens?: number; 5066 - /** 5067 - * Controls the randomness of the output; higher values produce more random results. 5068 - */ 5069 - temperature?: number; 5070 - /** 5071 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 5072 - */ 5073 - top_p?: number; 5074 - /** 5075 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 5076 - */ 5077 - top_k?: number; 5078 - /** 5079 - * Random seed for reproducibility of the generation. 5080 - */ 5081 - seed?: number; 5082 - /** 5083 - * Penalty for repeated tokens; higher values discourage repetition. 5084 - */ 5085 - repetition_penalty?: number; 5086 - /** 5087 - * Decreases the likelihood of the model repeating the same lines verbatim. 5088 - */ 5089 - frequency_penalty?: number; 5090 - /** 5091 - * Increases the likelihood of the model introducing new topics. 5092 - */ 5093 - presence_penalty?: number; 5094 - } 5095 - interface Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_JSON_Mode { 5096 - type?: 'json_object' | 'json_schema'; 5097 - json_schema?: unknown; 5098 - } 5099 - interface Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Messages { 5100 - /** 5101 - * An array of message objects representing the conversation history. 5102 - */ 5103 - messages: { 5104 - /** 5105 - * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). 5106 - */ 5107 - role: string; 5108 - /** 5109 - * The content of the message as a string. 5110 - */ 5111 - content: string; 5112 - }[]; 5113 - functions?: { 5114 - name: string; 5115 - code: string; 5116 - }[]; 5117 - /** 5118 - * A list of tools available for the assistant to use. 5119 - */ 5120 - tools?: ( 5121 - | { 5122 - /** 5123 - * The name of the tool. More descriptive the better. 5124 - */ 5125 - name: string; 5126 - /** 5127 - * A brief description of what the tool does. 5128 - */ 5129 - description: string; 5130 - /** 5131 - * Schema defining the parameters accepted by the tool. 5132 - */ 5133 - parameters: { 5134 - /** 5135 - * The type of the parameters object (usually 'object'). 5136 - */ 5137 - type: string; 5138 - /** 5139 - * List of required parameter names. 5140 - */ 5141 - required?: string[]; 5142 - /** 5143 - * Definitions of each parameter. 5144 - */ 5145 - properties: { 5146 - [k: string]: { 5147 - /** 5148 - * The data type of the parameter. 5149 - */ 5150 - type: string; 5151 - /** 5152 - * A description of the expected parameter. 5153 - */ 5154 - description: string; 5155 - }; 5156 - }; 5157 - }; 5158 - } 5159 - | { 5160 - /** 5161 - * Specifies the type of tool (e.g., 'function'). 5162 - */ 5163 - type: string; 5164 - /** 5165 - * Details of the function tool. 5166 - */ 5167 - function: { 5168 - /** 5169 - * The name of the function. 5170 - */ 5171 - name: string; 5172 - /** 5173 - * A brief description of what the function does. 5174 - */ 5175 - description: string; 5176 - /** 5177 - * Schema defining the parameters accepted by the function. 5178 - */ 5179 - parameters: { 5180 - /** 5181 - * The type of the parameters object (usually 'object'). 5182 - */ 5183 - type: string; 5184 - /** 5185 - * List of required parameter names. 5186 - */ 5187 - required?: string[]; 5188 - /** 5189 - * Definitions of each parameter. 5190 - */ 5191 - properties: { 5192 - [k: string]: { 5193 - /** 5194 - * The data type of the parameter. 5195 - */ 5196 - type: string; 5197 - /** 5198 - * A description of the expected parameter. 5199 - */ 5200 - description: string; 5201 - }; 5202 - }; 5203 - }; 5204 - }; 5205 - } 5206 - )[]; 5207 - response_format?: Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_JSON_Mode_1; 5208 - /** 5209 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 5210 - */ 5211 - raw?: boolean; 5212 - /** 5213 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 5214 - */ 5215 - stream?: boolean; 5216 - /** 5217 - * The maximum number of tokens to generate in the response. 5218 - */ 5219 - max_tokens?: number; 5220 - /** 5221 - * Controls the randomness of the output; higher values produce more random results. 5222 - */ 5223 - temperature?: number; 5224 - /** 5225 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 5226 - */ 5227 - top_p?: number; 5228 - /** 5229 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 5230 - */ 5231 - top_k?: number; 5232 - /** 5233 - * Random seed for reproducibility of the generation. 5234 - */ 5235 - seed?: number; 5236 - /** 5237 - * Penalty for repeated tokens; higher values discourage repetition. 5238 - */ 5239 - repetition_penalty?: number; 5240 - /** 5241 - * Decreases the likelihood of the model repeating the same lines verbatim. 5242 - */ 5243 - frequency_penalty?: number; 5244 - /** 5245 - * Increases the likelihood of the model introducing new topics. 5246 - */ 5247 - presence_penalty?: number; 5248 - } 5249 - interface Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_JSON_Mode_1 { 5250 - type?: 'json_object' | 'json_schema'; 5251 - json_schema?: unknown; 5252 - } 5253 - interface Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Async_Batch { 5254 - requests?: { 5255 - /** 5256 - * User-supplied reference. This field will be present in the response as well it can be used to reference the request and response. It's NOT validated to be unique. 5257 - */ 5258 - external_reference?: string; 5259 - /** 5260 - * Prompt for the text generation model 5261 - */ 5262 - prompt?: string; 5263 - /** 5264 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 5265 - */ 5266 - stream?: boolean; 5267 - /** 5268 - * The maximum number of tokens to generate in the response. 5269 - */ 5270 - max_tokens?: number; 5271 - /** 5272 - * Controls the randomness of the output; higher values produce more random results. 5273 - */ 5274 - temperature?: number; 5275 - /** 5276 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 5277 - */ 5278 - top_p?: number; 5279 - /** 5280 - * Random seed for reproducibility of the generation. 5281 - */ 5282 - seed?: number; 5283 - /** 5284 - * Penalty for repeated tokens; higher values discourage repetition. 5285 - */ 5286 - repetition_penalty?: number; 5287 - /** 5288 - * Decreases the likelihood of the model repeating the same lines verbatim. 5289 - */ 5290 - frequency_penalty?: number; 5291 - /** 5292 - * Increases the likelihood of the model introducing new topics. 5293 - */ 5294 - presence_penalty?: number; 5295 - response_format?: Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_JSON_Mode_2; 5296 - }[]; 5297 - } 5298 - interface Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_JSON_Mode_2 { 5299 - type?: 'json_object' | 'json_schema'; 5300 - json_schema?: unknown; 5301 - } 5302 - type Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Output = 5303 - | { 5304 - /** 5305 - * The generated text response from the model 5306 - */ 5307 - response: string; 5308 - /** 5309 - * Usage statistics for the inference request 5310 - */ 5311 - usage?: { 5312 - /** 5313 - * Total number of tokens in input 5314 - */ 5315 - prompt_tokens?: number; 5316 - /** 5317 - * Total number of tokens in output 5318 - */ 5319 - completion_tokens?: number; 5320 - /** 5321 - * Total number of input and output tokens 5322 - */ 5323 - total_tokens?: number; 5324 - }; 5325 - /** 5326 - * An array of tool calls requests made during the response generation 5327 - */ 5328 - tool_calls?: { 5329 - /** 5330 - * The arguments passed to be passed to the tool call request 5331 - */ 5332 - arguments?: object; 5333 - /** 5334 - * The name of the tool to be called 5335 - */ 5336 - name?: string; 5337 - }[]; 5338 - } 5339 - | string 5340 - | Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_AsyncResponse; 5341 - interface Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_AsyncResponse { 5342 - /** 5343 - * The async request id that can be used to obtain the results. 5344 - */ 5345 - request_id?: string; 5346 - } 5347 - declare abstract class Base_Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast { 5348 - inputs: Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Input; 5349 - postProcessedOutputs: Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Output; 5350 - } 5351 - interface Ai_Cf_Meta_Llama_Guard_3_8B_Input { 5352 - /** 5353 - * An array of message objects representing the conversation history. 5354 - */ 5355 - messages: { 5356 - /** 5357 - * The role of the message sender must alternate between 'user' and 'assistant'. 5358 - */ 5359 - role: 'user' | 'assistant'; 5360 - /** 5361 - * The content of the message as a string. 5362 - */ 5363 - content: string; 5364 - }[]; 5365 - /** 5366 - * The maximum number of tokens to generate in the response. 5367 - */ 5368 - max_tokens?: number; 5369 - /** 5370 - * Controls the randomness of the output; higher values produce more random results. 5371 - */ 5372 - temperature?: number; 5373 - /** 5374 - * Dictate the output format of the generated response. 5375 - */ 5376 - response_format?: { 5377 - /** 5378 - * Set to json_object to process and output generated text as JSON. 5379 - */ 5380 - type?: string; 5381 - }; 5382 - } 5383 - interface Ai_Cf_Meta_Llama_Guard_3_8B_Output { 5384 - response?: 5385 - | string 5386 - | { 5387 - /** 5388 - * Whether the conversation is safe or not. 5389 - */ 5390 - safe?: boolean; 5391 - /** 5392 - * A list of what hazard categories predicted for the conversation, if the conversation is deemed unsafe. 5393 - */ 5394 - categories?: string[]; 5395 - }; 5396 - /** 5397 - * Usage statistics for the inference request 5398 - */ 5399 - usage?: { 5400 - /** 5401 - * Total number of tokens in input 5402 - */ 5403 - prompt_tokens?: number; 5404 - /** 5405 - * Total number of tokens in output 5406 - */ 5407 - completion_tokens?: number; 5408 - /** 5409 - * Total number of input and output tokens 5410 - */ 5411 - total_tokens?: number; 5412 - }; 5413 - } 5414 - declare abstract class Base_Ai_Cf_Meta_Llama_Guard_3_8B { 5415 - inputs: Ai_Cf_Meta_Llama_Guard_3_8B_Input; 5416 - postProcessedOutputs: Ai_Cf_Meta_Llama_Guard_3_8B_Output; 5417 - } 5418 - interface Ai_Cf_Baai_Bge_Reranker_Base_Input { 5419 - /** 5420 - * A query you wish to perform against the provided contexts. 5421 - */ 5422 - /** 5423 - * Number of returned results starting with the best score. 5424 - */ 5425 - top_k?: number; 5426 - /** 5427 - * List of provided contexts. Note that the index in this array is important, as the response will refer to it. 5428 - */ 5429 - contexts: { 5430 - /** 5431 - * One of the provided context content 5432 - */ 5433 - text?: string; 5434 - }[]; 5435 - } 5436 - interface Ai_Cf_Baai_Bge_Reranker_Base_Output { 5437 - response?: { 5438 - /** 5439 - * Index of the context in the request 5440 - */ 5441 - id?: number; 5442 - /** 5443 - * Score of the context under the index. 5444 - */ 5445 - score?: number; 5446 - }[]; 5447 - } 5448 - declare abstract class Base_Ai_Cf_Baai_Bge_Reranker_Base { 5449 - inputs: Ai_Cf_Baai_Bge_Reranker_Base_Input; 5450 - postProcessedOutputs: Ai_Cf_Baai_Bge_Reranker_Base_Output; 5451 - } 5452 - type Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_Input = 5453 - | Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_Prompt 5454 - | Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_Messages; 5455 - interface Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_Prompt { 5456 - /** 5457 - * The input text prompt for the model to generate a response. 5458 - */ 5459 - prompt: string; 5460 - /** 5461 - * Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. 5462 - */ 5463 - lora?: string; 5464 - response_format?: Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_JSON_Mode; 5465 - /** 5466 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 5467 - */ 5468 - raw?: boolean; 5469 - /** 5470 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 5471 - */ 5472 - stream?: boolean; 5473 - /** 5474 - * The maximum number of tokens to generate in the response. 5475 - */ 5476 - max_tokens?: number; 5477 - /** 5478 - * Controls the randomness of the output; higher values produce more random results. 5479 - */ 5480 - temperature?: number; 5481 - /** 5482 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 5483 - */ 5484 - top_p?: number; 5485 - /** 5486 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 5487 - */ 5488 - top_k?: number; 5489 - /** 5490 - * Random seed for reproducibility of the generation. 5491 - */ 5492 - seed?: number; 5493 - /** 5494 - * Penalty for repeated tokens; higher values discourage repetition. 5495 - */ 5496 - repetition_penalty?: number; 5497 - /** 5498 - * Decreases the likelihood of the model repeating the same lines verbatim. 5499 - */ 5500 - frequency_penalty?: number; 5501 - /** 5502 - * Increases the likelihood of the model introducing new topics. 5503 - */ 5504 - presence_penalty?: number; 5505 - } 5506 - interface Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_JSON_Mode { 5507 - type?: 'json_object' | 'json_schema'; 5508 - json_schema?: unknown; 5509 - } 5510 - interface Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_Messages { 5511 - /** 5512 - * An array of message objects representing the conversation history. 5513 - */ 5514 - messages: { 5515 - /** 5516 - * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). 5517 - */ 5518 - role: string; 5519 - /** 5520 - * The content of the message as a string. 5521 - */ 5522 - content: string; 5523 - }[]; 5524 - functions?: { 5525 - name: string; 5526 - code: string; 5527 - }[]; 5528 - /** 5529 - * A list of tools available for the assistant to use. 5530 - */ 5531 - tools?: ( 5532 - | { 5533 - /** 5534 - * The name of the tool. More descriptive the better. 5535 - */ 5536 - name: string; 5537 - /** 5538 - * A brief description of what the tool does. 5539 - */ 5540 - description: string; 5541 - /** 5542 - * Schema defining the parameters accepted by the tool. 5543 - */ 5544 - parameters: { 5545 - /** 5546 - * The type of the parameters object (usually 'object'). 5547 - */ 5548 - type: string; 5549 - /** 5550 - * List of required parameter names. 5551 - */ 5552 - required?: string[]; 5553 - /** 5554 - * Definitions of each parameter. 5555 - */ 5556 - properties: { 5557 - [k: string]: { 5558 - /** 5559 - * The data type of the parameter. 5560 - */ 5561 - type: string; 5562 - /** 5563 - * A description of the expected parameter. 5564 - */ 5565 - description: string; 5566 - }; 5567 - }; 5568 - }; 5569 - } 5570 - | { 5571 - /** 5572 - * Specifies the type of tool (e.g., 'function'). 5573 - */ 5574 - type: string; 5575 - /** 5576 - * Details of the function tool. 5577 - */ 5578 - function: { 5579 - /** 5580 - * The name of the function. 5581 - */ 5582 - name: string; 5583 - /** 5584 - * A brief description of what the function does. 5585 - */ 5586 - description: string; 5587 - /** 5588 - * Schema defining the parameters accepted by the function. 5589 - */ 5590 - parameters: { 5591 - /** 5592 - * The type of the parameters object (usually 'object'). 5593 - */ 5594 - type: string; 5595 - /** 5596 - * List of required parameter names. 5597 - */ 5598 - required?: string[]; 5599 - /** 5600 - * Definitions of each parameter. 5601 - */ 5602 - properties: { 5603 - [k: string]: { 5604 - /** 5605 - * The data type of the parameter. 5606 - */ 5607 - type: string; 5608 - /** 5609 - * A description of the expected parameter. 5610 - */ 5611 - description: string; 5612 - }; 5613 - }; 5614 - }; 5615 - }; 5616 - } 5617 - )[]; 5618 - response_format?: Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_JSON_Mode_1; 5619 - /** 5620 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 5621 - */ 5622 - raw?: boolean; 5623 - /** 5624 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 5625 - */ 5626 - stream?: boolean; 5627 - /** 5628 - * The maximum number of tokens to generate in the response. 5629 - */ 5630 - max_tokens?: number; 5631 - /** 5632 - * Controls the randomness of the output; higher values produce more random results. 5633 - */ 5634 - temperature?: number; 5635 - /** 5636 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 5637 - */ 5638 - top_p?: number; 5639 - /** 5640 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 5641 - */ 5642 - top_k?: number; 5643 - /** 5644 - * Random seed for reproducibility of the generation. 5645 - */ 5646 - seed?: number; 5647 - /** 5648 - * Penalty for repeated tokens; higher values discourage repetition. 5649 - */ 5650 - repetition_penalty?: number; 5651 - /** 5652 - * Decreases the likelihood of the model repeating the same lines verbatim. 5653 - */ 5654 - frequency_penalty?: number; 5655 - /** 5656 - * Increases the likelihood of the model introducing new topics. 5657 - */ 5658 - presence_penalty?: number; 5659 - } 5660 - interface Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_JSON_Mode_1 { 5661 - type?: 'json_object' | 'json_schema'; 5662 - json_schema?: unknown; 5663 - } 5664 - type Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_Output = { 5665 - /** 5666 - * The generated text response from the model 5667 - */ 5668 - response: string; 5669 - /** 5670 - * Usage statistics for the inference request 5671 - */ 5672 - usage?: { 5673 - /** 5674 - * Total number of tokens in input 5675 - */ 5676 - prompt_tokens?: number; 5677 - /** 5678 - * Total number of tokens in output 5679 - */ 5680 - completion_tokens?: number; 5681 - /** 5682 - * Total number of input and output tokens 5683 - */ 5684 - total_tokens?: number; 5685 - }; 5686 - /** 5687 - * An array of tool calls requests made during the response generation 5688 - */ 5689 - tool_calls?: { 5690 - /** 5691 - * The arguments passed to be passed to the tool call request 5692 - */ 5693 - arguments?: object; 5694 - /** 5695 - * The name of the tool to be called 5696 - */ 5697 - name?: string; 5698 - }[]; 5699 - }; 5700 - declare abstract class Base_Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct { 5701 - inputs: Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_Input; 5702 - postProcessedOutputs: Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_Output; 5703 - } 5704 - type Ai_Cf_Qwen_Qwq_32B_Input = Ai_Cf_Qwen_Qwq_32B_Prompt | Ai_Cf_Qwen_Qwq_32B_Messages; 5705 - interface Ai_Cf_Qwen_Qwq_32B_Prompt { 5706 - /** 5707 - * The input text prompt for the model to generate a response. 5708 - */ 5709 - prompt: string; 5710 - /** 5711 - * JSON schema that should be fulfilled for the response. 5712 - */ 5713 - guided_json?: object; 5714 - /** 5715 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 5716 - */ 5717 - raw?: boolean; 5718 - /** 5719 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 5720 - */ 5721 - stream?: boolean; 5722 - /** 5723 - * The maximum number of tokens to generate in the response. 5724 - */ 5725 - max_tokens?: number; 5726 - /** 5727 - * Controls the randomness of the output; higher values produce more random results. 5728 - */ 5729 - temperature?: number; 5730 - /** 5731 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 5732 - */ 5733 - top_p?: number; 5734 - /** 5735 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 5736 - */ 5737 - top_k?: number; 5738 - /** 5739 - * Random seed for reproducibility of the generation. 5740 - */ 5741 - seed?: number; 5742 - /** 5743 - * Penalty for repeated tokens; higher values discourage repetition. 5744 - */ 5745 - repetition_penalty?: number; 5746 - /** 5747 - * Decreases the likelihood of the model repeating the same lines verbatim. 5748 - */ 5749 - frequency_penalty?: number; 5750 - /** 5751 - * Increases the likelihood of the model introducing new topics. 5752 - */ 5753 - presence_penalty?: number; 5754 - } 5755 - interface Ai_Cf_Qwen_Qwq_32B_Messages { 5756 - /** 5757 - * An array of message objects representing the conversation history. 5758 - */ 5759 - messages: { 5760 - /** 5761 - * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). 5762 - */ 5763 - role?: string; 5764 - /** 5765 - * The tool call id. Must be supplied for tool calls for Mistral-3. If you don't know what to put here you can fall back to 000000001 5766 - */ 5767 - tool_call_id?: string; 5768 - content?: 5769 - | string 5770 - | { 5771 - /** 5772 - * Type of the content provided 5773 - */ 5774 - type?: string; 5775 - text?: string; 5776 - image_url?: { 5777 - /** 5778 - * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted 5779 - */ 5780 - url?: string; 5781 - }; 5782 - }[] 5783 - | { 5784 - /** 5785 - * Type of the content provided 5786 - */ 5787 - type?: string; 5788 - text?: string; 5789 - image_url?: { 5790 - /** 5791 - * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted 5792 - */ 5793 - url?: string; 5794 - }; 5795 - }; 5796 - }[]; 5797 - functions?: { 5798 - name: string; 5799 - code: string; 5800 - }[]; 5801 - /** 5802 - * A list of tools available for the assistant to use. 5803 - */ 5804 - tools?: ( 5805 - | { 5806 - /** 5807 - * The name of the tool. More descriptive the better. 5808 - */ 5809 - name: string; 5810 - /** 5811 - * A brief description of what the tool does. 5812 - */ 5813 - description: string; 5814 - /** 5815 - * Schema defining the parameters accepted by the tool. 5816 - */ 5817 - parameters: { 5818 - /** 5819 - * The type of the parameters object (usually 'object'). 5820 - */ 5821 - type: string; 5822 - /** 5823 - * List of required parameter names. 5824 - */ 5825 - required?: string[]; 5826 - /** 5827 - * Definitions of each parameter. 5828 - */ 5829 - properties: { 5830 - [k: string]: { 5831 - /** 5832 - * The data type of the parameter. 5833 - */ 5834 - type: string; 5835 - /** 5836 - * A description of the expected parameter. 5837 - */ 5838 - description: string; 5839 - }; 5840 - }; 5841 - }; 5842 - } 5843 - | { 5844 - /** 5845 - * Specifies the type of tool (e.g., 'function'). 5846 - */ 5847 - type: string; 5848 - /** 5849 - * Details of the function tool. 5850 - */ 5851 - function: { 5852 - /** 5853 - * The name of the function. 5854 - */ 5855 - name: string; 5856 - /** 5857 - * A brief description of what the function does. 5858 - */ 5859 - description: string; 5860 - /** 5861 - * Schema defining the parameters accepted by the function. 5862 - */ 5863 - parameters: { 5864 - /** 5865 - * The type of the parameters object (usually 'object'). 5866 - */ 5867 - type: string; 5868 - /** 5869 - * List of required parameter names. 5870 - */ 5871 - required?: string[]; 5872 - /** 5873 - * Definitions of each parameter. 5874 - */ 5875 - properties: { 5876 - [k: string]: { 5877 - /** 5878 - * The data type of the parameter. 5879 - */ 5880 - type: string; 5881 - /** 5882 - * A description of the expected parameter. 5883 - */ 5884 - description: string; 5885 - }; 5886 - }; 5887 - }; 5888 - }; 5889 - } 5890 - )[]; 5891 - /** 5892 - * JSON schema that should be fulfilled for the response. 5893 - */ 5894 - guided_json?: object; 5895 - /** 5896 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 5897 - */ 5898 - raw?: boolean; 5899 - /** 5900 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 5901 - */ 5902 - stream?: boolean; 5903 - /** 5904 - * The maximum number of tokens to generate in the response. 5905 - */ 5906 - max_tokens?: number; 5907 - /** 5908 - * Controls the randomness of the output; higher values produce more random results. 5909 - */ 5910 - temperature?: number; 5911 - /** 5912 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 5913 - */ 5914 - top_p?: number; 5915 - /** 5916 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 5917 - */ 5918 - top_k?: number; 5919 - /** 5920 - * Random seed for reproducibility of the generation. 5921 - */ 5922 - seed?: number; 5923 - /** 5924 - * Penalty for repeated tokens; higher values discourage repetition. 5925 - */ 5926 - repetition_penalty?: number; 5927 - /** 5928 - * Decreases the likelihood of the model repeating the same lines verbatim. 5929 - */ 5930 - frequency_penalty?: number; 5931 - /** 5932 - * Increases the likelihood of the model introducing new topics. 5933 - */ 5934 - presence_penalty?: number; 5935 - } 5936 - type Ai_Cf_Qwen_Qwq_32B_Output = { 5937 - /** 5938 - * The generated text response from the model 5939 - */ 5940 - response: string; 5941 - /** 5942 - * Usage statistics for the inference request 5943 - */ 5944 - usage?: { 5945 - /** 5946 - * Total number of tokens in input 5947 - */ 5948 - prompt_tokens?: number; 5949 - /** 5950 - * Total number of tokens in output 5951 - */ 5952 - completion_tokens?: number; 5953 - /** 5954 - * Total number of input and output tokens 5955 - */ 5956 - total_tokens?: number; 5957 - }; 5958 - /** 5959 - * An array of tool calls requests made during the response generation 5960 - */ 5961 - tool_calls?: { 5962 - /** 5963 - * The arguments passed to be passed to the tool call request 5964 - */ 5965 - arguments?: object; 5966 - /** 5967 - * The name of the tool to be called 5968 - */ 5969 - name?: string; 5970 - }[]; 5971 - }; 5972 - declare abstract class Base_Ai_Cf_Qwen_Qwq_32B { 5973 - inputs: Ai_Cf_Qwen_Qwq_32B_Input; 5974 - postProcessedOutputs: Ai_Cf_Qwen_Qwq_32B_Output; 5975 - } 5976 - type Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruct_Input = 5977 - | Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruct_Prompt 5978 - | Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruct_Messages; 5979 - interface Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruct_Prompt { 5980 - /** 5981 - * The input text prompt for the model to generate a response. 5982 - */ 5983 - prompt: string; 5984 - /** 5985 - * JSON schema that should be fulfilled for the response. 5986 - */ 5987 - guided_json?: object; 5988 - /** 5989 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 5990 - */ 5991 - raw?: boolean; 5992 - /** 5993 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 5994 - */ 5995 - stream?: boolean; 5996 - /** 5997 - * The maximum number of tokens to generate in the response. 5998 - */ 5999 - max_tokens?: number; 6000 - /** 6001 - * Controls the randomness of the output; higher values produce more random results. 6002 - */ 6003 - temperature?: number; 6004 - /** 6005 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 6006 - */ 6007 - top_p?: number; 6008 - /** 6009 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 6010 - */ 6011 - top_k?: number; 6012 - /** 6013 - * Random seed for reproducibility of the generation. 6014 - */ 6015 - seed?: number; 6016 - /** 6017 - * Penalty for repeated tokens; higher values discourage repetition. 6018 - */ 6019 - repetition_penalty?: number; 6020 - /** 6021 - * Decreases the likelihood of the model repeating the same lines verbatim. 6022 - */ 6023 - frequency_penalty?: number; 6024 - /** 6025 - * Increases the likelihood of the model introducing new topics. 6026 - */ 6027 - presence_penalty?: number; 6028 - } 6029 - interface Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruct_Messages { 6030 - /** 6031 - * An array of message objects representing the conversation history. 6032 - */ 6033 - messages: { 6034 - /** 6035 - * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). 6036 - */ 6037 - role?: string; 6038 - /** 6039 - * The tool call id. Must be supplied for tool calls for Mistral-3. If you don't know what to put here you can fall back to 000000001 6040 - */ 6041 - tool_call_id?: string; 6042 - content?: 6043 - | string 6044 - | { 6045 - /** 6046 - * Type of the content provided 6047 - */ 6048 - type?: string; 6049 - text?: string; 6050 - image_url?: { 6051 - /** 6052 - * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted 6053 - */ 6054 - url?: string; 6055 - }; 6056 - }[] 6057 - | { 6058 - /** 6059 - * Type of the content provided 6060 - */ 6061 - type?: string; 6062 - text?: string; 6063 - image_url?: { 6064 - /** 6065 - * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted 6066 - */ 6067 - url?: string; 6068 - }; 6069 - }; 6070 - }[]; 6071 - functions?: { 6072 - name: string; 6073 - code: string; 6074 - }[]; 6075 - /** 6076 - * A list of tools available for the assistant to use. 6077 - */ 6078 - tools?: ( 6079 - | { 6080 - /** 6081 - * The name of the tool. More descriptive the better. 6082 - */ 6083 - name: string; 6084 - /** 6085 - * A brief description of what the tool does. 6086 - */ 6087 - description: string; 6088 - /** 6089 - * Schema defining the parameters accepted by the tool. 6090 - */ 6091 - parameters: { 6092 - /** 6093 - * The type of the parameters object (usually 'object'). 6094 - */ 6095 - type: string; 6096 - /** 6097 - * List of required parameter names. 6098 - */ 6099 - required?: string[]; 6100 - /** 6101 - * Definitions of each parameter. 6102 - */ 6103 - properties: { 6104 - [k: string]: { 6105 - /** 6106 - * The data type of the parameter. 6107 - */ 6108 - type: string; 6109 - /** 6110 - * A description of the expected parameter. 6111 - */ 6112 - description: string; 6113 - }; 6114 - }; 6115 - }; 6116 - } 6117 - | { 6118 - /** 6119 - * Specifies the type of tool (e.g., 'function'). 6120 - */ 6121 - type: string; 6122 - /** 6123 - * Details of the function tool. 6124 - */ 6125 - function: { 6126 - /** 6127 - * The name of the function. 6128 - */ 6129 - name: string; 6130 - /** 6131 - * A brief description of what the function does. 6132 - */ 6133 - description: string; 6134 - /** 6135 - * Schema defining the parameters accepted by the function. 6136 - */ 6137 - parameters: { 6138 - /** 6139 - * The type of the parameters object (usually 'object'). 6140 - */ 6141 - type: string; 6142 - /** 6143 - * List of required parameter names. 6144 - */ 6145 - required?: string[]; 6146 - /** 6147 - * Definitions of each parameter. 6148 - */ 6149 - properties: { 6150 - [k: string]: { 6151 - /** 6152 - * The data type of the parameter. 6153 - */ 6154 - type: string; 6155 - /** 6156 - * A description of the expected parameter. 6157 - */ 6158 - description: string; 6159 - }; 6160 - }; 6161 - }; 6162 - }; 6163 - } 6164 - )[]; 6165 - /** 6166 - * JSON schema that should be fulfilled for the response. 6167 - */ 6168 - guided_json?: object; 6169 - /** 6170 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 6171 - */ 6172 - raw?: boolean; 6173 - /** 6174 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 6175 - */ 6176 - stream?: boolean; 6177 - /** 6178 - * The maximum number of tokens to generate in the response. 6179 - */ 6180 - max_tokens?: number; 6181 - /** 6182 - * Controls the randomness of the output; higher values produce more random results. 6183 - */ 6184 - temperature?: number; 6185 - /** 6186 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 6187 - */ 6188 - top_p?: number; 6189 - /** 6190 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 6191 - */ 6192 - top_k?: number; 6193 - /** 6194 - * Random seed for reproducibility of the generation. 6195 - */ 6196 - seed?: number; 6197 - /** 6198 - * Penalty for repeated tokens; higher values discourage repetition. 6199 - */ 6200 - repetition_penalty?: number; 6201 - /** 6202 - * Decreases the likelihood of the model repeating the same lines verbatim. 6203 - */ 6204 - frequency_penalty?: number; 6205 - /** 6206 - * Increases the likelihood of the model introducing new topics. 6207 - */ 6208 - presence_penalty?: number; 6209 - } 6210 - type Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruct_Output = { 6211 - /** 6212 - * The generated text response from the model 6213 - */ 6214 - response: string; 6215 - /** 6216 - * Usage statistics for the inference request 6217 - */ 6218 - usage?: { 6219 - /** 6220 - * Total number of tokens in input 6221 - */ 6222 - prompt_tokens?: number; 6223 - /** 6224 - * Total number of tokens in output 6225 - */ 6226 - completion_tokens?: number; 6227 - /** 6228 - * Total number of input and output tokens 6229 - */ 6230 - total_tokens?: number; 6231 - }; 6232 - /** 6233 - * An array of tool calls requests made during the response generation 6234 - */ 6235 - tool_calls?: { 6236 - /** 6237 - * The arguments passed to be passed to the tool call request 6238 - */ 6239 - arguments?: object; 6240 - /** 6241 - * The name of the tool to be called 6242 - */ 6243 - name?: string; 6244 - }[]; 6245 - }; 6246 - declare abstract class Base_Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruct { 6247 - inputs: Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruct_Input; 6248 - postProcessedOutputs: Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruct_Output; 6249 - } 6250 - type Ai_Cf_Google_Gemma_3_12B_It_Input = 6251 - | Ai_Cf_Google_Gemma_3_12B_It_Prompt 6252 - | Ai_Cf_Google_Gemma_3_12B_It_Messages; 6253 - interface Ai_Cf_Google_Gemma_3_12B_It_Prompt { 6254 - /** 6255 - * The input text prompt for the model to generate a response. 6256 - */ 6257 - prompt: string; 6258 - /** 6259 - * JSON schema that should be fulfilled for the response. 6260 - */ 6261 - guided_json?: object; 6262 - /** 6263 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 6264 - */ 6265 - raw?: boolean; 6266 - /** 6267 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 6268 - */ 6269 - stream?: boolean; 6270 - /** 6271 - * The maximum number of tokens to generate in the response. 6272 - */ 6273 - max_tokens?: number; 6274 - /** 6275 - * Controls the randomness of the output; higher values produce more random results. 6276 - */ 6277 - temperature?: number; 6278 - /** 6279 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 6280 - */ 6281 - top_p?: number; 6282 - /** 6283 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 6284 - */ 6285 - top_k?: number; 6286 - /** 6287 - * Random seed for reproducibility of the generation. 6288 - */ 6289 - seed?: number; 6290 - /** 6291 - * Penalty for repeated tokens; higher values discourage repetition. 6292 - */ 6293 - repetition_penalty?: number; 6294 - /** 6295 - * Decreases the likelihood of the model repeating the same lines verbatim. 6296 - */ 6297 - frequency_penalty?: number; 6298 - /** 6299 - * Increases the likelihood of the model introducing new topics. 6300 - */ 6301 - presence_penalty?: number; 6302 - } 6303 - interface Ai_Cf_Google_Gemma_3_12B_It_Messages { 6304 - /** 6305 - * An array of message objects representing the conversation history. 6306 - */ 6307 - messages: { 6308 - /** 6309 - * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). 6310 - */ 6311 - role?: string; 6312 - content?: 6313 - | string 6314 - | { 6315 - /** 6316 - * Type of the content provided 6317 - */ 6318 - type?: string; 6319 - text?: string; 6320 - image_url?: { 6321 - /** 6322 - * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted 6323 - */ 6324 - url?: string; 6325 - }; 6326 - }[]; 6327 - }[]; 6328 - functions?: { 6329 - name: string; 6330 - code: string; 6331 - }[]; 6332 - /** 6333 - * A list of tools available for the assistant to use. 6334 - */ 6335 - tools?: ( 6336 - | { 6337 - /** 6338 - * The name of the tool. More descriptive the better. 6339 - */ 6340 - name: string; 6341 - /** 6342 - * A brief description of what the tool does. 6343 - */ 6344 - description: string; 6345 - /** 6346 - * Schema defining the parameters accepted by the tool. 6347 - */ 6348 - parameters: { 6349 - /** 6350 - * The type of the parameters object (usually 'object'). 6351 - */ 6352 - type: string; 6353 - /** 6354 - * List of required parameter names. 6355 - */ 6356 - required?: string[]; 6357 - /** 6358 - * Definitions of each parameter. 6359 - */ 6360 - properties: { 6361 - [k: string]: { 6362 - /** 6363 - * The data type of the parameter. 6364 - */ 6365 - type: string; 6366 - /** 6367 - * A description of the expected parameter. 6368 - */ 6369 - description: string; 6370 - }; 6371 - }; 6372 - }; 6373 - } 6374 - | { 6375 - /** 6376 - * Specifies the type of tool (e.g., 'function'). 6377 - */ 6378 - type: string; 6379 - /** 6380 - * Details of the function tool. 6381 - */ 6382 - function: { 6383 - /** 6384 - * The name of the function. 6385 - */ 6386 - name: string; 6387 - /** 6388 - * A brief description of what the function does. 6389 - */ 6390 - description: string; 6391 - /** 6392 - * Schema defining the parameters accepted by the function. 6393 - */ 6394 - parameters: { 6395 - /** 6396 - * The type of the parameters object (usually 'object'). 6397 - */ 6398 - type: string; 6399 - /** 6400 - * List of required parameter names. 6401 - */ 6402 - required?: string[]; 6403 - /** 6404 - * Definitions of each parameter. 6405 - */ 6406 - properties: { 6407 - [k: string]: { 6408 - /** 6409 - * The data type of the parameter. 6410 - */ 6411 - type: string; 6412 - /** 6413 - * A description of the expected parameter. 6414 - */ 6415 - description: string; 6416 - }; 6417 - }; 6418 - }; 6419 - }; 6420 - } 6421 - )[]; 6422 - /** 6423 - * JSON schema that should be fulfilled for the response. 6424 - */ 6425 - guided_json?: object; 6426 - /** 6427 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 6428 - */ 6429 - raw?: boolean; 6430 - /** 6431 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 6432 - */ 6433 - stream?: boolean; 6434 - /** 6435 - * The maximum number of tokens to generate in the response. 6436 - */ 6437 - max_tokens?: number; 6438 - /** 6439 - * Controls the randomness of the output; higher values produce more random results. 6440 - */ 6441 - temperature?: number; 6442 - /** 6443 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 6444 - */ 6445 - top_p?: number; 6446 - /** 6447 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 6448 - */ 6449 - top_k?: number; 6450 - /** 6451 - * Random seed for reproducibility of the generation. 6452 - */ 6453 - seed?: number; 6454 - /** 6455 - * Penalty for repeated tokens; higher values discourage repetition. 6456 - */ 6457 - repetition_penalty?: number; 6458 - /** 6459 - * Decreases the likelihood of the model repeating the same lines verbatim. 6460 - */ 6461 - frequency_penalty?: number; 6462 - /** 6463 - * Increases the likelihood of the model introducing new topics. 6464 - */ 6465 - presence_penalty?: number; 6466 - } 6467 - type Ai_Cf_Google_Gemma_3_12B_It_Output = { 6468 - /** 6469 - * The generated text response from the model 6470 - */ 6471 - response: string; 6472 - /** 6473 - * Usage statistics for the inference request 6474 - */ 6475 - usage?: { 6476 - /** 6477 - * Total number of tokens in input 6478 - */ 6479 - prompt_tokens?: number; 6480 - /** 6481 - * Total number of tokens in output 6482 - */ 6483 - completion_tokens?: number; 6484 - /** 6485 - * Total number of input and output tokens 6486 - */ 6487 - total_tokens?: number; 6488 - }; 6489 - /** 6490 - * An array of tool calls requests made during the response generation 6491 - */ 6492 - tool_calls?: { 6493 - /** 6494 - * The arguments passed to be passed to the tool call request 6495 - */ 6496 - arguments?: object; 6497 - /** 6498 - * The name of the tool to be called 6499 - */ 6500 - name?: string; 6501 - }[]; 6502 - }; 6503 - declare abstract class Base_Ai_Cf_Google_Gemma_3_12B_It { 6504 - inputs: Ai_Cf_Google_Gemma_3_12B_It_Input; 6505 - postProcessedOutputs: Ai_Cf_Google_Gemma_3_12B_It_Output; 6506 - } 6507 - type Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Input = 6508 - | Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Prompt 6509 - | Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Messages 6510 - | Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Async_Batch; 6511 - interface Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Prompt { 6512 - /** 6513 - * The input text prompt for the model to generate a response. 6514 - */ 6515 - prompt: string; 6516 - /** 6517 - * JSON schema that should be fulfilled for the response. 6518 - */ 6519 - guided_json?: object; 6520 - response_format?: Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_JSON_Mode; 6521 - /** 6522 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 6523 - */ 6524 - raw?: boolean; 6525 - /** 6526 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 6527 - */ 6528 - stream?: boolean; 6529 - /** 6530 - * The maximum number of tokens to generate in the response. 6531 - */ 6532 - max_tokens?: number; 6533 - /** 6534 - * Controls the randomness of the output; higher values produce more random results. 6535 - */ 6536 - temperature?: number; 6537 - /** 6538 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 6539 - */ 6540 - top_p?: number; 6541 - /** 6542 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 6543 - */ 6544 - top_k?: number; 6545 - /** 6546 - * Random seed for reproducibility of the generation. 6547 - */ 6548 - seed?: number; 6549 - /** 6550 - * Penalty for repeated tokens; higher values discourage repetition. 6551 - */ 6552 - repetition_penalty?: number; 6553 - /** 6554 - * Decreases the likelihood of the model repeating the same lines verbatim. 6555 - */ 6556 - frequency_penalty?: number; 6557 - /** 6558 - * Increases the likelihood of the model introducing new topics. 6559 - */ 6560 - presence_penalty?: number; 6561 - } 6562 - interface Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_JSON_Mode { 6563 - type?: 'json_object' | 'json_schema'; 6564 - json_schema?: unknown; 6565 - } 6566 - interface Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Messages { 6567 - /** 6568 - * An array of message objects representing the conversation history. 6569 - */ 6570 - messages: { 6571 - /** 6572 - * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). 6573 - */ 6574 - role?: string; 6575 - /** 6576 - * The tool call id. If you don't know what to put here you can fall back to 000000001 6577 - */ 6578 - tool_call_id?: string; 6579 - content?: 6580 - | string 6581 - | { 6582 - /** 6583 - * Type of the content provided 6584 - */ 6585 - type?: string; 6586 - text?: string; 6587 - image_url?: { 6588 - /** 6589 - * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted 6590 - */ 6591 - url?: string; 6592 - }; 6593 - }[] 6594 - | { 6595 - /** 6596 - * Type of the content provided 6597 - */ 6598 - type?: string; 6599 - text?: string; 6600 - image_url?: { 6601 - /** 6602 - * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted 6603 - */ 6604 - url?: string; 6605 - }; 6606 - }; 6607 - }[]; 6608 - functions?: { 6609 - name: string; 6610 - code: string; 6611 - }[]; 6612 - /** 6613 - * A list of tools available for the assistant to use. 6614 - */ 6615 - tools?: ( 6616 - | { 6617 - /** 6618 - * The name of the tool. More descriptive the better. 6619 - */ 6620 - name: string; 6621 - /** 6622 - * A brief description of what the tool does. 6623 - */ 6624 - description: string; 6625 - /** 6626 - * Schema defining the parameters accepted by the tool. 6627 - */ 6628 - parameters: { 6629 - /** 6630 - * The type of the parameters object (usually 'object'). 6631 - */ 6632 - type: string; 6633 - /** 6634 - * List of required parameter names. 6635 - */ 6636 - required?: string[]; 6637 - /** 6638 - * Definitions of each parameter. 6639 - */ 6640 - properties: { 6641 - [k: string]: { 6642 - /** 6643 - * The data type of the parameter. 6644 - */ 6645 - type: string; 6646 - /** 6647 - * A description of the expected parameter. 6648 - */ 6649 - description: string; 6650 - }; 6651 - }; 6652 - }; 6653 - } 6654 - | { 6655 - /** 6656 - * Specifies the type of tool (e.g., 'function'). 6657 - */ 6658 - type: string; 6659 - /** 6660 - * Details of the function tool. 6661 - */ 6662 - function: { 6663 - /** 6664 - * The name of the function. 6665 - */ 6666 - name: string; 6667 - /** 6668 - * A brief description of what the function does. 6669 - */ 6670 - description: string; 6671 - /** 6672 - * Schema defining the parameters accepted by the function. 6673 - */ 6674 - parameters: { 6675 - /** 6676 - * The type of the parameters object (usually 'object'). 6677 - */ 6678 - type: string; 6679 - /** 6680 - * List of required parameter names. 6681 - */ 6682 - required?: string[]; 6683 - /** 6684 - * Definitions of each parameter. 6685 - */ 6686 - properties: { 6687 - [k: string]: { 6688 - /** 6689 - * The data type of the parameter. 6690 - */ 6691 - type: string; 6692 - /** 6693 - * A description of the expected parameter. 6694 - */ 6695 - description: string; 6696 - }; 6697 - }; 6698 - }; 6699 - }; 6700 - } 6701 - )[]; 6702 - response_format?: Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_JSON_Mode; 6703 - /** 6704 - * JSON schema that should be fulfilled for the response. 6705 - */ 6706 - guided_json?: object; 6707 - /** 6708 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 6709 - */ 6710 - raw?: boolean; 6711 - /** 6712 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 6713 - */ 6714 - stream?: boolean; 6715 - /** 6716 - * The maximum number of tokens to generate in the response. 6717 - */ 6718 - max_tokens?: number; 6719 - /** 6720 - * Controls the randomness of the output; higher values produce more random results. 6721 - */ 6722 - temperature?: number; 6723 - /** 6724 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 6725 - */ 6726 - top_p?: number; 6727 - /** 6728 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 6729 - */ 6730 - top_k?: number; 6731 - /** 6732 - * Random seed for reproducibility of the generation. 6733 - */ 6734 - seed?: number; 6735 - /** 6736 - * Penalty for repeated tokens; higher values discourage repetition. 6737 - */ 6738 - repetition_penalty?: number; 6739 - /** 6740 - * Decreases the likelihood of the model repeating the same lines verbatim. 6741 - */ 6742 - frequency_penalty?: number; 6743 - /** 6744 - * Increases the likelihood of the model introducing new topics. 6745 - */ 6746 - presence_penalty?: number; 6747 - } 6748 - interface Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Async_Batch { 6749 - requests: ( 6750 - | Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Prompt_Inner 6751 - | Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Messages_Inner 6752 - )[]; 6753 - } 6754 - interface Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Prompt_Inner { 6755 - /** 6756 - * The input text prompt for the model to generate a response. 6757 - */ 6758 - prompt: string; 6759 - /** 6760 - * JSON schema that should be fulfilled for the response. 6761 - */ 6762 - guided_json?: object; 6763 - response_format?: Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_JSON_Mode; 6764 - /** 6765 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 6766 - */ 6767 - raw?: boolean; 6768 - /** 6769 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 6770 - */ 6771 - stream?: boolean; 6772 - /** 6773 - * The maximum number of tokens to generate in the response. 6774 - */ 6775 - max_tokens?: number; 6776 - /** 6777 - * Controls the randomness of the output; higher values produce more random results. 6778 - */ 6779 - temperature?: number; 6780 - /** 6781 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 6782 - */ 6783 - top_p?: number; 6784 - /** 6785 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 6786 - */ 6787 - top_k?: number; 6788 - /** 6789 - * Random seed for reproducibility of the generation. 6790 - */ 6791 - seed?: number; 6792 - /** 6793 - * Penalty for repeated tokens; higher values discourage repetition. 6794 - */ 6795 - repetition_penalty?: number; 6796 - /** 6797 - * Decreases the likelihood of the model repeating the same lines verbatim. 6798 - */ 6799 - frequency_penalty?: number; 6800 - /** 6801 - * Increases the likelihood of the model introducing new topics. 6802 - */ 6803 - presence_penalty?: number; 6804 - } 6805 - interface Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Messages_Inner { 6806 - /** 6807 - * An array of message objects representing the conversation history. 6808 - */ 6809 - messages: { 6810 - /** 6811 - * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). 6812 - */ 6813 - role?: string; 6814 - /** 6815 - * The tool call id. If you don't know what to put here you can fall back to 000000001 6816 - */ 6817 - tool_call_id?: string; 6818 - content?: 6819 - | string 6820 - | { 6821 - /** 6822 - * Type of the content provided 6823 - */ 6824 - type?: string; 6825 - text?: string; 6826 - image_url?: { 6827 - /** 6828 - * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted 6829 - */ 6830 - url?: string; 6831 - }; 6832 - }[] 6833 - | { 6834 - /** 6835 - * Type of the content provided 6836 - */ 6837 - type?: string; 6838 - text?: string; 6839 - image_url?: { 6840 - /** 6841 - * image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted 6842 - */ 6843 - url?: string; 6844 - }; 6845 - }; 6846 - }[]; 6847 - functions?: { 6848 - name: string; 6849 - code: string; 6850 - }[]; 6851 - /** 6852 - * A list of tools available for the assistant to use. 6853 - */ 6854 - tools?: ( 6855 - | { 6856 - /** 6857 - * The name of the tool. More descriptive the better. 6858 - */ 6859 - name: string; 6860 - /** 6861 - * A brief description of what the tool does. 6862 - */ 6863 - description: string; 6864 - /** 6865 - * Schema defining the parameters accepted by the tool. 6866 - */ 6867 - parameters: { 6868 - /** 6869 - * The type of the parameters object (usually 'object'). 6870 - */ 6871 - type: string; 6872 - /** 6873 - * List of required parameter names. 6874 - */ 6875 - required?: string[]; 6876 - /** 6877 - * Definitions of each parameter. 6878 - */ 6879 - properties: { 6880 - [k: string]: { 6881 - /** 6882 - * The data type of the parameter. 6883 - */ 6884 - type: string; 6885 - /** 6886 - * A description of the expected parameter. 6887 - */ 6888 - description: string; 6889 - }; 6890 - }; 6891 - }; 6892 - } 6893 - | { 6894 - /** 6895 - * Specifies the type of tool (e.g., 'function'). 6896 - */ 6897 - type: string; 6898 - /** 6899 - * Details of the function tool. 6900 - */ 6901 - function: { 6902 - /** 6903 - * The name of the function. 6904 - */ 6905 - name: string; 6906 - /** 6907 - * A brief description of what the function does. 6908 - */ 6909 - description: string; 6910 - /** 6911 - * Schema defining the parameters accepted by the function. 6912 - */ 6913 - parameters: { 6914 - /** 6915 - * The type of the parameters object (usually 'object'). 6916 - */ 6917 - type: string; 6918 - /** 6919 - * List of required parameter names. 6920 - */ 6921 - required?: string[]; 6922 - /** 6923 - * Definitions of each parameter. 6924 - */ 6925 - properties: { 6926 - [k: string]: { 6927 - /** 6928 - * The data type of the parameter. 6929 - */ 6930 - type: string; 6931 - /** 6932 - * A description of the expected parameter. 6933 - */ 6934 - description: string; 6935 - }; 6936 - }; 6937 - }; 6938 - }; 6939 - } 6940 - )[]; 6941 - response_format?: Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_JSON_Mode; 6942 - /** 6943 - * JSON schema that should be fulfilled for the response. 6944 - */ 6945 - guided_json?: object; 6946 - /** 6947 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 6948 - */ 6949 - raw?: boolean; 6950 - /** 6951 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 6952 - */ 6953 - stream?: boolean; 6954 - /** 6955 - * The maximum number of tokens to generate in the response. 6956 - */ 6957 - max_tokens?: number; 6958 - /** 6959 - * Controls the randomness of the output; higher values produce more random results. 6960 - */ 6961 - temperature?: number; 6962 - /** 6963 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 6964 - */ 6965 - top_p?: number; 6966 - /** 6967 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 6968 - */ 6969 - top_k?: number; 6970 - /** 6971 - * Random seed for reproducibility of the generation. 6972 - */ 6973 - seed?: number; 6974 - /** 6975 - * Penalty for repeated tokens; higher values discourage repetition. 6976 - */ 6977 - repetition_penalty?: number; 6978 - /** 6979 - * Decreases the likelihood of the model repeating the same lines verbatim. 6980 - */ 6981 - frequency_penalty?: number; 6982 - /** 6983 - * Increases the likelihood of the model introducing new topics. 6984 - */ 6985 - presence_penalty?: number; 6986 - } 6987 - type Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Output = { 6988 - /** 6989 - * The generated text response from the model 6990 - */ 6991 - response: string; 6992 - /** 6993 - * Usage statistics for the inference request 6994 - */ 6995 - usage?: { 6996 - /** 6997 - * Total number of tokens in input 6998 - */ 6999 - prompt_tokens?: number; 7000 - /** 7001 - * Total number of tokens in output 7002 - */ 7003 - completion_tokens?: number; 7004 - /** 7005 - * Total number of input and output tokens 7006 - */ 7007 - total_tokens?: number; 7008 - }; 7009 - /** 7010 - * An array of tool calls requests made during the response generation 7011 - */ 7012 - tool_calls?: { 7013 - /** 7014 - * The tool call id. 7015 - */ 7016 - id?: string; 7017 - /** 7018 - * Specifies the type of tool (e.g., 'function'). 7019 - */ 7020 - type?: string; 7021 - /** 7022 - * Details of the function tool. 7023 - */ 7024 - function?: { 7025 - /** 7026 - * The name of the tool to be called 7027 - */ 7028 - name?: string; 7029 - /** 7030 - * The arguments passed to be passed to the tool call request 7031 - */ 7032 - arguments?: object; 7033 - }; 7034 - }[]; 7035 - }; 7036 - declare abstract class Base_Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct { 7037 - inputs: Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Input; 7038 - postProcessedOutputs: Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct_Output; 7039 - } 7040 - type Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Input = 7041 - | Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Prompt 7042 - | Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Messages 7043 - | Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Async_Batch; 7044 - interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Prompt { 7045 - /** 7046 - * The input text prompt for the model to generate a response. 7047 - */ 7048 - prompt: string; 7049 - /** 7050 - * Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. 7051 - */ 7052 - lora?: string; 7053 - response_format?: Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_JSON_Mode; 7054 - /** 7055 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 7056 - */ 7057 - raw?: boolean; 7058 - /** 7059 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 7060 - */ 7061 - stream?: boolean; 7062 - /** 7063 - * The maximum number of tokens to generate in the response. 7064 - */ 7065 - max_tokens?: number; 7066 - /** 7067 - * Controls the randomness of the output; higher values produce more random results. 7068 - */ 7069 - temperature?: number; 7070 - /** 7071 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 7072 - */ 7073 - top_p?: number; 7074 - /** 7075 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 7076 - */ 7077 - top_k?: number; 7078 - /** 7079 - * Random seed for reproducibility of the generation. 7080 - */ 7081 - seed?: number; 7082 - /** 7083 - * Penalty for repeated tokens; higher values discourage repetition. 7084 - */ 7085 - repetition_penalty?: number; 7086 - /** 7087 - * Decreases the likelihood of the model repeating the same lines verbatim. 7088 - */ 7089 - frequency_penalty?: number; 7090 - /** 7091 - * Increases the likelihood of the model introducing new topics. 7092 - */ 7093 - presence_penalty?: number; 7094 - } 7095 - interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_JSON_Mode { 7096 - type?: 'json_object' | 'json_schema'; 7097 - json_schema?: unknown; 7098 - } 7099 - interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Messages { 7100 - /** 7101 - * An array of message objects representing the conversation history. 7102 - */ 7103 - messages: { 7104 - /** 7105 - * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). 7106 - */ 7107 - role: string; 7108 - /** 7109 - * The content of the message as a string. 7110 - */ 7111 - content: string; 7112 - }[]; 7113 - functions?: { 7114 - name: string; 7115 - code: string; 7116 - }[]; 7117 - /** 7118 - * A list of tools available for the assistant to use. 7119 - */ 7120 - tools?: ( 7121 - | { 7122 - /** 7123 - * The name of the tool. More descriptive the better. 7124 - */ 7125 - name: string; 7126 - /** 7127 - * A brief description of what the tool does. 7128 - */ 7129 - description: string; 7130 - /** 7131 - * Schema defining the parameters accepted by the tool. 7132 - */ 7133 - parameters: { 7134 - /** 7135 - * The type of the parameters object (usually 'object'). 7136 - */ 7137 - type: string; 7138 - /** 7139 - * List of required parameter names. 7140 - */ 7141 - required?: string[]; 7142 - /** 7143 - * Definitions of each parameter. 7144 - */ 7145 - properties: { 7146 - [k: string]: { 7147 - /** 7148 - * The data type of the parameter. 7149 - */ 7150 - type: string; 7151 - /** 7152 - * A description of the expected parameter. 7153 - */ 7154 - description: string; 7155 - }; 7156 - }; 7157 - }; 7158 - } 7159 - | { 7160 - /** 7161 - * Specifies the type of tool (e.g., 'function'). 7162 - */ 7163 - type: string; 7164 - /** 7165 - * Details of the function tool. 7166 - */ 7167 - function: { 7168 - /** 7169 - * The name of the function. 7170 - */ 7171 - name: string; 7172 - /** 7173 - * A brief description of what the function does. 7174 - */ 7175 - description: string; 7176 - /** 7177 - * Schema defining the parameters accepted by the function. 7178 - */ 7179 - parameters: { 7180 - /** 7181 - * The type of the parameters object (usually 'object'). 7182 - */ 7183 - type: string; 7184 - /** 7185 - * List of required parameter names. 7186 - */ 7187 - required?: string[]; 7188 - /** 7189 - * Definitions of each parameter. 7190 - */ 7191 - properties: { 7192 - [k: string]: { 7193 - /** 7194 - * The data type of the parameter. 7195 - */ 7196 - type: string; 7197 - /** 7198 - * A description of the expected parameter. 7199 - */ 7200 - description: string; 7201 - }; 7202 - }; 7203 - }; 7204 - }; 7205 - } 7206 - )[]; 7207 - response_format?: Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_JSON_Mode_1; 7208 - /** 7209 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 7210 - */ 7211 - raw?: boolean; 7212 - /** 7213 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 7214 - */ 7215 - stream?: boolean; 7216 - /** 7217 - * The maximum number of tokens to generate in the response. 7218 - */ 7219 - max_tokens?: number; 7220 - /** 7221 - * Controls the randomness of the output; higher values produce more random results. 7222 - */ 7223 - temperature?: number; 7224 - /** 7225 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 7226 - */ 7227 - top_p?: number; 7228 - /** 7229 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 7230 - */ 7231 - top_k?: number; 7232 - /** 7233 - * Random seed for reproducibility of the generation. 7234 - */ 7235 - seed?: number; 7236 - /** 7237 - * Penalty for repeated tokens; higher values discourage repetition. 7238 - */ 7239 - repetition_penalty?: number; 7240 - /** 7241 - * Decreases the likelihood of the model repeating the same lines verbatim. 7242 - */ 7243 - frequency_penalty?: number; 7244 - /** 7245 - * Increases the likelihood of the model introducing new topics. 7246 - */ 7247 - presence_penalty?: number; 7248 - } 7249 - interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_JSON_Mode_1 { 7250 - type?: 'json_object' | 'json_schema'; 7251 - json_schema?: unknown; 7252 - } 7253 - interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Async_Batch { 7254 - requests: (Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Prompt_1 | Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Messages_1)[]; 7255 - } 7256 - interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Prompt_1 { 7257 - /** 7258 - * The input text prompt for the model to generate a response. 7259 - */ 7260 - prompt: string; 7261 - /** 7262 - * Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. 7263 - */ 7264 - lora?: string; 7265 - response_format?: Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_JSON_Mode_2; 7266 - /** 7267 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 7268 - */ 7269 - raw?: boolean; 7270 - /** 7271 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 7272 - */ 7273 - stream?: boolean; 7274 - /** 7275 - * The maximum number of tokens to generate in the response. 7276 - */ 7277 - max_tokens?: number; 7278 - /** 7279 - * Controls the randomness of the output; higher values produce more random results. 7280 - */ 7281 - temperature?: number; 7282 - /** 7283 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 7284 - */ 7285 - top_p?: number; 7286 - /** 7287 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 7288 - */ 7289 - top_k?: number; 7290 - /** 7291 - * Random seed for reproducibility of the generation. 7292 - */ 7293 - seed?: number; 7294 - /** 7295 - * Penalty for repeated tokens; higher values discourage repetition. 7296 - */ 7297 - repetition_penalty?: number; 7298 - /** 7299 - * Decreases the likelihood of the model repeating the same lines verbatim. 7300 - */ 7301 - frequency_penalty?: number; 7302 - /** 7303 - * Increases the likelihood of the model introducing new topics. 7304 - */ 7305 - presence_penalty?: number; 7306 - } 7307 - interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_JSON_Mode_2 { 7308 - type?: 'json_object' | 'json_schema'; 7309 - json_schema?: unknown; 7310 - } 7311 - interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Messages_1 { 7312 - /** 7313 - * An array of message objects representing the conversation history. 7314 - */ 7315 - messages: { 7316 - /** 7317 - * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). 7318 - */ 7319 - role: string; 7320 - /** 7321 - * The content of the message as a string. 7322 - */ 7323 - content: string; 7324 - }[]; 7325 - functions?: { 7326 - name: string; 7327 - code: string; 7328 - }[]; 7329 - /** 7330 - * A list of tools available for the assistant to use. 7331 - */ 7332 - tools?: ( 7333 - | { 7334 - /** 7335 - * The name of the tool. More descriptive the better. 7336 - */ 7337 - name: string; 7338 - /** 7339 - * A brief description of what the tool does. 7340 - */ 7341 - description: string; 7342 - /** 7343 - * Schema defining the parameters accepted by the tool. 7344 - */ 7345 - parameters: { 7346 - /** 7347 - * The type of the parameters object (usually 'object'). 7348 - */ 7349 - type: string; 7350 - /** 7351 - * List of required parameter names. 7352 - */ 7353 - required?: string[]; 7354 - /** 7355 - * Definitions of each parameter. 7356 - */ 7357 - properties: { 7358 - [k: string]: { 7359 - /** 7360 - * The data type of the parameter. 7361 - */ 7362 - type: string; 7363 - /** 7364 - * A description of the expected parameter. 7365 - */ 7366 - description: string; 7367 - }; 7368 - }; 7369 - }; 7370 - } 7371 - | { 7372 - /** 7373 - * Specifies the type of tool (e.g., 'function'). 7374 - */ 7375 - type: string; 7376 - /** 7377 - * Details of the function tool. 7378 - */ 7379 - function: { 7380 - /** 7381 - * The name of the function. 7382 - */ 7383 - name: string; 7384 - /** 7385 - * A brief description of what the function does. 7386 - */ 7387 - description: string; 7388 - /** 7389 - * Schema defining the parameters accepted by the function. 7390 - */ 7391 - parameters: { 7392 - /** 7393 - * The type of the parameters object (usually 'object'). 7394 - */ 7395 - type: string; 7396 - /** 7397 - * List of required parameter names. 7398 - */ 7399 - required?: string[]; 7400 - /** 7401 - * Definitions of each parameter. 7402 - */ 7403 - properties: { 7404 - [k: string]: { 7405 - /** 7406 - * The data type of the parameter. 7407 - */ 7408 - type: string; 7409 - /** 7410 - * A description of the expected parameter. 7411 - */ 7412 - description: string; 7413 - }; 7414 - }; 7415 - }; 7416 - }; 7417 - } 7418 - )[]; 7419 - response_format?: Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_JSON_Mode_3; 7420 - /** 7421 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 7422 - */ 7423 - raw?: boolean; 7424 - /** 7425 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 7426 - */ 7427 - stream?: boolean; 7428 - /** 7429 - * The maximum number of tokens to generate in the response. 7430 - */ 7431 - max_tokens?: number; 7432 - /** 7433 - * Controls the randomness of the output; higher values produce more random results. 7434 - */ 7435 - temperature?: number; 7436 - /** 7437 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 7438 - */ 7439 - top_p?: number; 7440 - /** 7441 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 7442 - */ 7443 - top_k?: number; 7444 - /** 7445 - * Random seed for reproducibility of the generation. 7446 - */ 7447 - seed?: number; 7448 - /** 7449 - * Penalty for repeated tokens; higher values discourage repetition. 7450 - */ 7451 - repetition_penalty?: number; 7452 - /** 7453 - * Decreases the likelihood of the model repeating the same lines verbatim. 7454 - */ 7455 - frequency_penalty?: number; 7456 - /** 7457 - * Increases the likelihood of the model introducing new topics. 7458 - */ 7459 - presence_penalty?: number; 7460 - } 7461 - interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_JSON_Mode_3 { 7462 - type?: 'json_object' | 'json_schema'; 7463 - json_schema?: unknown; 7464 - } 7465 - type Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Output = 7466 - | Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Chat_Completion_Response 7467 - | Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Text_Completion_Response 7468 - | string 7469 - | Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_AsyncResponse; 7470 - interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Chat_Completion_Response { 7471 - /** 7472 - * Unique identifier for the completion 7473 - */ 7474 - id?: string; 7475 - /** 7476 - * Object type identifier 7477 - */ 7478 - object?: 'chat.completion'; 7479 - /** 7480 - * Unix timestamp of when the completion was created 7481 - */ 7482 - created?: number; 7483 - /** 7484 - * Model used for the completion 7485 - */ 7486 - model?: string; 7487 - /** 7488 - * List of completion choices 7489 - */ 7490 - choices?: { 7491 - /** 7492 - * Index of the choice in the list 7493 - */ 7494 - index?: number; 7495 - /** 7496 - * The message generated by the model 7497 - */ 7498 - message?: { 7499 - /** 7500 - * Role of the message author 7501 - */ 7502 - role: string; 7503 - /** 7504 - * The content of the message 7505 - */ 7506 - content: string; 7507 - /** 7508 - * Internal reasoning content (if available) 7509 - */ 7510 - reasoning_content?: string; 7511 - /** 7512 - * Tool calls made by the assistant 7513 - */ 7514 - tool_calls?: { 7515 - /** 7516 - * Unique identifier for the tool call 7517 - */ 7518 - id: string; 7519 - /** 7520 - * Type of tool call 7521 - */ 7522 - type: 'function'; 7523 - function: { 7524 - /** 7525 - * Name of the function to call 7526 - */ 7527 - name: string; 7528 - /** 7529 - * JSON string of arguments for the function 7530 - */ 7531 - arguments: string; 7532 - }; 7533 - }[]; 7534 - }; 7535 - /** 7536 - * Reason why the model stopped generating 7537 - */ 7538 - finish_reason?: string; 7539 - /** 7540 - * Stop reason (may be null) 7541 - */ 7542 - stop_reason?: string | null; 7543 - /** 7544 - * Log probabilities (if requested) 7545 - */ 7546 - logprobs?: {} | null; 7547 - }[]; 7548 - /** 7549 - * Usage statistics for the inference request 7550 - */ 7551 - usage?: { 7552 - /** 7553 - * Total number of tokens in input 7554 - */ 7555 - prompt_tokens?: number; 7556 - /** 7557 - * Total number of tokens in output 7558 - */ 7559 - completion_tokens?: number; 7560 - /** 7561 - * Total number of input and output tokens 7562 - */ 7563 - total_tokens?: number; 7564 - }; 7565 - /** 7566 - * Log probabilities for the prompt (if requested) 7567 - */ 7568 - prompt_logprobs?: {} | null; 7569 - } 7570 - interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Text_Completion_Response { 7571 - /** 7572 - * Unique identifier for the completion 7573 - */ 7574 - id?: string; 7575 - /** 7576 - * Object type identifier 7577 - */ 7578 - object?: 'text_completion'; 7579 - /** 7580 - * Unix timestamp of when the completion was created 7581 - */ 7582 - created?: number; 7583 - /** 7584 - * Model used for the completion 7585 - */ 7586 - model?: string; 7587 - /** 7588 - * List of completion choices 7589 - */ 7590 - choices?: { 7591 - /** 7592 - * Index of the choice in the list 7593 - */ 7594 - index: number; 7595 - /** 7596 - * The generated text completion 7597 - */ 7598 - text: string; 7599 - /** 7600 - * Reason why the model stopped generating 7601 - */ 7602 - finish_reason: string; 7603 - /** 7604 - * Stop reason (may be null) 7605 - */ 7606 - stop_reason?: string | null; 7607 - /** 7608 - * Log probabilities (if requested) 7609 - */ 7610 - logprobs?: {} | null; 7611 - /** 7612 - * Log probabilities for the prompt (if requested) 7613 - */ 7614 - prompt_logprobs?: {} | null; 7615 - }[]; 7616 - /** 7617 - * Usage statistics for the inference request 7618 - */ 7619 - usage?: { 7620 - /** 7621 - * Total number of tokens in input 7622 - */ 7623 - prompt_tokens?: number; 7624 - /** 7625 - * Total number of tokens in output 7626 - */ 7627 - completion_tokens?: number; 7628 - /** 7629 - * Total number of input and output tokens 7630 - */ 7631 - total_tokens?: number; 7632 - }; 7633 - } 7634 - interface Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_AsyncResponse { 7635 - /** 7636 - * The async request id that can be used to obtain the results. 7637 - */ 7638 - request_id?: string; 7639 - } 7640 - declare abstract class Base_Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8 { 7641 - inputs: Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Input; 7642 - postProcessedOutputs: Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8_Output; 7643 - } 7644 - interface Ai_Cf_Deepgram_Nova_3_Input { 7645 - audio: { 7646 - body: object; 7647 - contentType: string; 7648 - }; 7649 - /** 7650 - * Sets how the model will interpret strings submitted to the custom_topic param. When strict, the model will only return topics submitted using the custom_topic param. When extended, the model will return its own detected topics in addition to those submitted using the custom_topic param. 7651 - */ 7652 - custom_topic_mode?: 'extended' | 'strict'; 7653 - /** 7654 - * Custom topics you want the model to detect within your input audio or text if present Submit up to 100 7655 - */ 7656 - custom_topic?: string; 7657 - /** 7658 - * Sets how the model will interpret intents submitted to the custom_intent param. When strict, the model will only return intents submitted using the custom_intent param. When extended, the model will return its own detected intents in addition those submitted using the custom_intents param 7659 - */ 7660 - custom_intent_mode?: 'extended' | 'strict'; 7661 - /** 7662 - * Custom intents you want the model to detect within your input audio if present 7663 - */ 7664 - custom_intent?: string; 7665 - /** 7666 - * Identifies and extracts key entities from content in submitted audio 7667 - */ 7668 - detect_entities?: boolean; 7669 - /** 7670 - * Identifies the dominant language spoken in submitted audio 7671 - */ 7672 - detect_language?: boolean; 7673 - /** 7674 - * Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0 7675 - */ 7676 - diarize?: boolean; 7677 - /** 7678 - * Identify and extract key entities from content in submitted audio 7679 - */ 7680 - dictation?: boolean; 7681 - /** 7682 - * Specify the expected encoding of your submitted audio 7683 - */ 7684 - encoding?: 'linear16' | 'flac' | 'mulaw' | 'amr-nb' | 'amr-wb' | 'opus' | 'speex' | 'g729'; 7685 - /** 7686 - * Arbitrary key-value pairs that are attached to the API response for usage in downstream processing 7687 - */ 7688 - extra?: string; 7689 - /** 7690 - * Filler Words can help transcribe interruptions in your audio, like 'uh' and 'um' 7691 - */ 7692 - filler_words?: boolean; 7693 - /** 7694 - * Key term prompting can boost or suppress specialized terminology and brands. 7695 - */ 7696 - keyterm?: string; 7697 - /** 7698 - * Keywords can boost or suppress specialized terminology and brands. 7699 - */ 7700 - keywords?: string; 7701 - /** 7702 - * The BCP-47 language tag that hints at the primary spoken language. Depending on the Model and API endpoint you choose only certain languages are available. 7703 - */ 7704 - language?: string; 7705 - /** 7706 - * Spoken measurements will be converted to their corresponding abbreviations. 7707 - */ 7708 - measurements?: boolean; 7709 - /** 7710 - * Opts out requests from the Deepgram Model Improvement Program. Refer to our Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip. 7711 - */ 7712 - mip_opt_out?: boolean; 7713 - /** 7714 - * Mode of operation for the model representing broad area of topic that will be talked about in the supplied audio 7715 - */ 7716 - mode?: 'general' | 'medical' | 'finance'; 7717 - /** 7718 - * Transcribe each audio channel independently. 7719 - */ 7720 - multichannel?: boolean; 7721 - /** 7722 - * Numerals converts numbers from written format to numerical format. 7723 - */ 7724 - numerals?: boolean; 7725 - /** 7726 - * Splits audio into paragraphs to improve transcript readability. 7727 - */ 7728 - paragraphs?: boolean; 7729 - /** 7730 - * Profanity Filter looks for recognized profanity and converts it to the nearest recognized non-profane word or removes it from the transcript completely. 7731 - */ 7732 - profanity_filter?: boolean; 7733 - /** 7734 - * Add punctuation and capitalization to the transcript. 7735 - */ 7736 - punctuate?: boolean; 7737 - /** 7738 - * Redaction removes sensitive information from your transcripts. 7739 - */ 7740 - redact?: string; 7741 - /** 7742 - * Search for terms or phrases in submitted audio and replaces them. 7743 - */ 7744 - replace?: string; 7745 - /** 7746 - * Search for terms or phrases in submitted audio. 7747 - */ 7748 - search?: string; 7749 - /** 7750 - * Recognizes the sentiment throughout a transcript or text. 7751 - */ 7752 - sentiment?: boolean; 7753 - /** 7754 - * Apply formatting to transcript output. When set to true, additional formatting will be applied to transcripts to improve readability. 7755 - */ 7756 - smart_format?: boolean; 7757 - /** 7758 - * Detect topics throughout a transcript or text. 7759 - */ 7760 - topics?: boolean; 7761 - /** 7762 - * Segments speech into meaningful semantic units. 7763 - */ 7764 - utterances?: boolean; 7765 - /** 7766 - * Seconds to wait before detecting a pause between words in submitted audio. 7767 - */ 7768 - utt_split?: number; 7769 - /** 7770 - * The number of channels in the submitted audio 7771 - */ 7772 - channels?: number; 7773 - /** 7774 - * Specifies whether the streaming endpoint should provide ongoing transcription updates as more audio is received. When set to true, the endpoint sends continuous updates, meaning transcription results may evolve over time. Note: Supported only for webosockets. 7775 - */ 7776 - interim_results?: boolean; 7777 - /** 7778 - * Indicates how long model will wait to detect whether a speaker has finished speaking or pauses for a significant period of time. When set to a value, the streaming endpoint immediately finalizes the transcription for the processed time range and returns the transcript with a speech_final parameter set to true. Can also be set to false to disable endpointing 7779 - */ 7780 - endpointing?: string; 7781 - /** 7782 - * Indicates that speech has started. You'll begin receiving Speech Started messages upon speech starting. Note: Supported only for webosockets. 7783 - */ 7784 - vad_events?: boolean; 7785 - /** 7786 - * Indicates how long model will wait to send an UtteranceEnd message after a word has been transcribed. Use with interim_results. Note: Supported only for webosockets. 7787 - */ 7788 - utterance_end_ms?: boolean; 7789 - } 7790 - interface Ai_Cf_Deepgram_Nova_3_Output { 7791 - results?: { 7792 - channels?: { 7793 - alternatives?: { 7794 - confidence?: number; 7795 - transcript?: string; 7796 - words?: { 7797 - confidence?: number; 7798 - end?: number; 7799 - start?: number; 7800 - word?: string; 7801 - }[]; 7802 - }[]; 7803 - }[]; 7804 - summary?: { 7805 - result?: string; 7806 - short?: string; 7807 - }; 7808 - sentiments?: { 7809 - segments?: { 7810 - text?: string; 7811 - start_word?: number; 7812 - end_word?: number; 7813 - sentiment?: string; 7814 - sentiment_score?: number; 7815 - }[]; 7816 - average?: { 7817 - sentiment?: string; 7818 - sentiment_score?: number; 7819 - }; 7820 - }; 7821 - }; 7822 - } 7823 - declare abstract class Base_Ai_Cf_Deepgram_Nova_3 { 7824 - inputs: Ai_Cf_Deepgram_Nova_3_Input; 7825 - postProcessedOutputs: Ai_Cf_Deepgram_Nova_3_Output; 7826 - } 7827 - interface Ai_Cf_Qwen_Qwen3_Embedding_0_6B_Input { 7828 - queries?: string | string[]; 7829 - /** 7830 - * Optional instruction for the task 7831 - */ 7832 - instruction?: string; 7833 - documents?: string | string[]; 7834 - text?: string | string[]; 7835 - } 7836 - interface Ai_Cf_Qwen_Qwen3_Embedding_0_6B_Output { 7837 - data?: number[][]; 7838 - shape?: number[]; 7839 - } 7840 - declare abstract class Base_Ai_Cf_Qwen_Qwen3_Embedding_0_6B { 7841 - inputs: Ai_Cf_Qwen_Qwen3_Embedding_0_6B_Input; 7842 - postProcessedOutputs: Ai_Cf_Qwen_Qwen3_Embedding_0_6B_Output; 7843 - } 7844 - type Ai_Cf_Pipecat_Ai_Smart_Turn_V2_Input = 7845 - | { 7846 - /** 7847 - * readable stream with audio data and content-type specified for that data 7848 - */ 7849 - audio: { 7850 - body: object; 7851 - contentType: string; 7852 - }; 7853 - /** 7854 - * type of data PCM data that's sent to the inference server as raw array 7855 - */ 7856 - dtype?: 'uint8' | 'float32' | 'float64'; 7857 - } 7858 - | { 7859 - /** 7860 - * base64 encoded audio data 7861 - */ 7862 - audio: string; 7863 - /** 7864 - * type of data PCM data that's sent to the inference server as raw array 7865 - */ 7866 - dtype?: 'uint8' | 'float32' | 'float64'; 7867 - }; 7868 - interface Ai_Cf_Pipecat_Ai_Smart_Turn_V2_Output { 7869 - /** 7870 - * if true, end-of-turn was detected 7871 - */ 7872 - is_complete?: boolean; 7873 - /** 7874 - * probability of the end-of-turn detection 7875 - */ 7876 - probability?: number; 7877 - } 7878 - declare abstract class Base_Ai_Cf_Pipecat_Ai_Smart_Turn_V2 { 7879 - inputs: Ai_Cf_Pipecat_Ai_Smart_Turn_V2_Input; 7880 - postProcessedOutputs: Ai_Cf_Pipecat_Ai_Smart_Turn_V2_Output; 7881 - } 7882 - declare abstract class Base_Ai_Cf_Openai_Gpt_Oss_120B { 7883 - inputs: ResponsesInput; 7884 - postProcessedOutputs: ResponsesOutput; 7885 - } 7886 - declare abstract class Base_Ai_Cf_Openai_Gpt_Oss_20B { 7887 - inputs: ResponsesInput; 7888 - postProcessedOutputs: ResponsesOutput; 7889 - } 7890 - interface Ai_Cf_Leonardo_Phoenix_1_0_Input { 7891 - /** 7892 - * A text description of the image you want to generate. 7893 - */ 7894 - prompt: string; 7895 - /** 7896 - * Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt 7897 - */ 7898 - guidance?: number; 7899 - /** 7900 - * Random seed for reproducibility of the image generation 7901 - */ 7902 - seed?: number; 7903 - /** 7904 - * The height of the generated image in pixels 7905 - */ 7906 - height?: number; 7907 - /** 7908 - * The width of the generated image in pixels 7909 - */ 7910 - width?: number; 7911 - /** 7912 - * The number of diffusion steps; higher values can improve quality but take longer 7913 - */ 7914 - num_steps?: number; 7915 - /** 7916 - * Specify what to exclude from the generated images 7917 - */ 7918 - negative_prompt?: string; 7919 - } 7920 - /** 7921 - * The generated image in JPEG format 7922 - */ 7923 - type Ai_Cf_Leonardo_Phoenix_1_0_Output = string; 7924 - declare abstract class Base_Ai_Cf_Leonardo_Phoenix_1_0 { 7925 - inputs: Ai_Cf_Leonardo_Phoenix_1_0_Input; 7926 - postProcessedOutputs: Ai_Cf_Leonardo_Phoenix_1_0_Output; 7927 - } 7928 - interface Ai_Cf_Leonardo_Lucid_Origin_Input { 7929 - /** 7930 - * A text description of the image you want to generate. 7931 - */ 7932 - prompt: string; 7933 - /** 7934 - * Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt 7935 - */ 7936 - guidance?: number; 7937 - /** 7938 - * Random seed for reproducibility of the image generation 7939 - */ 7940 - seed?: number; 7941 - /** 7942 - * The height of the generated image in pixels 7943 - */ 7944 - height?: number; 7945 - /** 7946 - * The width of the generated image in pixels 7947 - */ 7948 - width?: number; 7949 - /** 7950 - * The number of diffusion steps; higher values can improve quality but take longer 7951 - */ 7952 - num_steps?: number; 7953 - /** 7954 - * The number of diffusion steps; higher values can improve quality but take longer 7955 - */ 7956 - steps?: number; 7957 - } 7958 - interface Ai_Cf_Leonardo_Lucid_Origin_Output { 7959 - /** 7960 - * The generated image in Base64 format. 7961 - */ 7962 - image?: string; 7963 - } 7964 - declare abstract class Base_Ai_Cf_Leonardo_Lucid_Origin { 7965 - inputs: Ai_Cf_Leonardo_Lucid_Origin_Input; 7966 - postProcessedOutputs: Ai_Cf_Leonardo_Lucid_Origin_Output; 7967 - } 7968 - interface Ai_Cf_Deepgram_Aura_1_Input { 7969 - /** 7970 - * Speaker used to produce the audio. 7971 - */ 7972 - speaker?: 7973 - | 'angus' 7974 - | 'asteria' 7975 - | 'arcas' 7976 - | 'orion' 7977 - | 'orpheus' 7978 - | 'athena' 7979 - | 'luna' 7980 - | 'zeus' 7981 - | 'perseus' 7982 - | 'helios' 7983 - | 'hera' 7984 - | 'stella'; 7985 - /** 7986 - * Encoding of the output audio. 7987 - */ 7988 - encoding?: 'linear16' | 'flac' | 'mulaw' | 'alaw' | 'mp3' | 'opus' | 'aac'; 7989 - /** 7990 - * Container specifies the file format wrapper for the output audio. The available options depend on the encoding type.. 7991 - */ 7992 - container?: 'none' | 'wav' | 'ogg'; 7993 - /** 7994 - * The text content to be converted to speech 7995 - */ 7996 - text: string; 7997 - /** 7998 - * Sample Rate specifies the sample rate for the output audio. Based on the encoding, different sample rates are supported. For some encodings, the sample rate is not configurable 7999 - */ 8000 - sample_rate?: number; 8001 - /** 8002 - * The bitrate of the audio in bits per second. Choose from predefined ranges or specific values based on the encoding type. 8003 - */ 8004 - bit_rate?: number; 8005 - } 8006 - /** 8007 - * The generated audio in MP3 format 8008 - */ 8009 - type Ai_Cf_Deepgram_Aura_1_Output = string; 8010 - declare abstract class Base_Ai_Cf_Deepgram_Aura_1 { 8011 - inputs: Ai_Cf_Deepgram_Aura_1_Input; 8012 - postProcessedOutputs: Ai_Cf_Deepgram_Aura_1_Output; 8013 - } 8014 - interface Ai_Cf_Ai4Bharat_Indictrans2_En_Indic_1B_Input { 8015 - /** 8016 - * Input text to translate. Can be a single string or a list of strings. 8017 - */ 8018 - text: string | string[]; 8019 - /** 8020 - * Target language to translate to 8021 - */ 8022 - target_language: 8023 - | 'asm_Beng' 8024 - | 'awa_Deva' 8025 - | 'ben_Beng' 8026 - | 'bho_Deva' 8027 - | 'brx_Deva' 8028 - | 'doi_Deva' 8029 - | 'eng_Latn' 8030 - | 'gom_Deva' 8031 - | 'gon_Deva' 8032 - | 'guj_Gujr' 8033 - | 'hin_Deva' 8034 - | 'hne_Deva' 8035 - | 'kan_Knda' 8036 - | 'kas_Arab' 8037 - | 'kas_Deva' 8038 - | 'kha_Latn' 8039 - | 'lus_Latn' 8040 - | 'mag_Deva' 8041 - | 'mai_Deva' 8042 - | 'mal_Mlym' 8043 - | 'mar_Deva' 8044 - | 'mni_Beng' 8045 - | 'mni_Mtei' 8046 - | 'npi_Deva' 8047 - | 'ory_Orya' 8048 - | 'pan_Guru' 8049 - | 'san_Deva' 8050 - | 'sat_Olck' 8051 - | 'snd_Arab' 8052 - | 'snd_Deva' 8053 - | 'tam_Taml' 8054 - | 'tel_Telu' 8055 - | 'urd_Arab' 8056 - | 'unr_Deva'; 8057 - } 8058 - interface Ai_Cf_Ai4Bharat_Indictrans2_En_Indic_1B_Output { 8059 - /** 8060 - * Translated texts 8061 - */ 8062 - translations: string[]; 8063 - } 8064 - declare abstract class Base_Ai_Cf_Ai4Bharat_Indictrans2_En_Indic_1B { 8065 - inputs: Ai_Cf_Ai4Bharat_Indictrans2_En_Indic_1B_Input; 8066 - postProcessedOutputs: Ai_Cf_Ai4Bharat_Indictrans2_En_Indic_1B_Output; 8067 - } 8068 - type Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Input = 8069 - | Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Prompt 8070 - | Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Messages 8071 - | Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Async_Batch; 8072 - interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Prompt { 8073 - /** 8074 - * The input text prompt for the model to generate a response. 8075 - */ 8076 - prompt: string; 8077 - /** 8078 - * Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. 8079 - */ 8080 - lora?: string; 8081 - response_format?: Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_JSON_Mode; 8082 - /** 8083 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 8084 - */ 8085 - raw?: boolean; 8086 - /** 8087 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 8088 - */ 8089 - stream?: boolean; 8090 - /** 8091 - * The maximum number of tokens to generate in the response. 8092 - */ 8093 - max_tokens?: number; 8094 - /** 8095 - * Controls the randomness of the output; higher values produce more random results. 8096 - */ 8097 - temperature?: number; 8098 - /** 8099 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 8100 - */ 8101 - top_p?: number; 8102 - /** 8103 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 8104 - */ 8105 - top_k?: number; 8106 - /** 8107 - * Random seed for reproducibility of the generation. 8108 - */ 8109 - seed?: number; 8110 - /** 8111 - * Penalty for repeated tokens; higher values discourage repetition. 8112 - */ 8113 - repetition_penalty?: number; 8114 - /** 8115 - * Decreases the likelihood of the model repeating the same lines verbatim. 8116 - */ 8117 - frequency_penalty?: number; 8118 - /** 8119 - * Increases the likelihood of the model introducing new topics. 8120 - */ 8121 - presence_penalty?: number; 8122 - } 8123 - interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_JSON_Mode { 8124 - type?: 'json_object' | 'json_schema'; 8125 - json_schema?: unknown; 8126 - } 8127 - interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Messages { 8128 - /** 8129 - * An array of message objects representing the conversation history. 8130 - */ 8131 - messages: { 8132 - /** 8133 - * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). 8134 - */ 8135 - role: string; 8136 - /** 8137 - * The content of the message as a string. 8138 - */ 8139 - content: string; 8140 - }[]; 8141 - functions?: { 8142 - name: string; 8143 - code: string; 8144 - }[]; 8145 - /** 8146 - * A list of tools available for the assistant to use. 8147 - */ 8148 - tools?: ( 8149 - | { 8150 - /** 8151 - * The name of the tool. More descriptive the better. 8152 - */ 8153 - name: string; 8154 - /** 8155 - * A brief description of what the tool does. 8156 - */ 8157 - description: string; 8158 - /** 8159 - * Schema defining the parameters accepted by the tool. 8160 - */ 8161 - parameters: { 8162 - /** 8163 - * The type of the parameters object (usually 'object'). 8164 - */ 8165 - type: string; 8166 - /** 8167 - * List of required parameter names. 8168 - */ 8169 - required?: string[]; 8170 - /** 8171 - * Definitions of each parameter. 8172 - */ 8173 - properties: { 8174 - [k: string]: { 8175 - /** 8176 - * The data type of the parameter. 8177 - */ 8178 - type: string; 8179 - /** 8180 - * A description of the expected parameter. 8181 - */ 8182 - description: string; 8183 - }; 8184 - }; 8185 - }; 8186 - } 8187 - | { 8188 - /** 8189 - * Specifies the type of tool (e.g., 'function'). 8190 - */ 8191 - type: string; 8192 - /** 8193 - * Details of the function tool. 8194 - */ 8195 - function: { 8196 - /** 8197 - * The name of the function. 8198 - */ 8199 - name: string; 8200 - /** 8201 - * A brief description of what the function does. 8202 - */ 8203 - description: string; 8204 - /** 8205 - * Schema defining the parameters accepted by the function. 8206 - */ 8207 - parameters: { 8208 - /** 8209 - * The type of the parameters object (usually 'object'). 8210 - */ 8211 - type: string; 8212 - /** 8213 - * List of required parameter names. 8214 - */ 8215 - required?: string[]; 8216 - /** 8217 - * Definitions of each parameter. 8218 - */ 8219 - properties: { 8220 - [k: string]: { 8221 - /** 8222 - * The data type of the parameter. 8223 - */ 8224 - type: string; 8225 - /** 8226 - * A description of the expected parameter. 8227 - */ 8228 - description: string; 8229 - }; 8230 - }; 8231 - }; 8232 - }; 8233 - } 8234 - )[]; 8235 - response_format?: Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_JSON_Mode_1; 8236 - /** 8237 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 8238 - */ 8239 - raw?: boolean; 8240 - /** 8241 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 8242 - */ 8243 - stream?: boolean; 8244 - /** 8245 - * The maximum number of tokens to generate in the response. 8246 - */ 8247 - max_tokens?: number; 8248 - /** 8249 - * Controls the randomness of the output; higher values produce more random results. 8250 - */ 8251 - temperature?: number; 8252 - /** 8253 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 8254 - */ 8255 - top_p?: number; 8256 - /** 8257 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 8258 - */ 8259 - top_k?: number; 8260 - /** 8261 - * Random seed for reproducibility of the generation. 8262 - */ 8263 - seed?: number; 8264 - /** 8265 - * Penalty for repeated tokens; higher values discourage repetition. 8266 - */ 8267 - repetition_penalty?: number; 8268 - /** 8269 - * Decreases the likelihood of the model repeating the same lines verbatim. 8270 - */ 8271 - frequency_penalty?: number; 8272 - /** 8273 - * Increases the likelihood of the model introducing new topics. 8274 - */ 8275 - presence_penalty?: number; 8276 - } 8277 - interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_JSON_Mode_1 { 8278 - type?: 'json_object' | 'json_schema'; 8279 - json_schema?: unknown; 8280 - } 8281 - interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Async_Batch { 8282 - requests: ( 8283 - | Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Prompt_1 8284 - | Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Messages_1 8285 - )[]; 8286 - } 8287 - interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Prompt_1 { 8288 - /** 8289 - * The input text prompt for the model to generate a response. 8290 - */ 8291 - prompt: string; 8292 - /** 8293 - * Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model. 8294 - */ 8295 - lora?: string; 8296 - response_format?: Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_JSON_Mode_2; 8297 - /** 8298 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 8299 - */ 8300 - raw?: boolean; 8301 - /** 8302 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 8303 - */ 8304 - stream?: boolean; 8305 - /** 8306 - * The maximum number of tokens to generate in the response. 8307 - */ 8308 - max_tokens?: number; 8309 - /** 8310 - * Controls the randomness of the output; higher values produce more random results. 8311 - */ 8312 - temperature?: number; 8313 - /** 8314 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 8315 - */ 8316 - top_p?: number; 8317 - /** 8318 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 8319 - */ 8320 - top_k?: number; 8321 - /** 8322 - * Random seed for reproducibility of the generation. 8323 - */ 8324 - seed?: number; 8325 - /** 8326 - * Penalty for repeated tokens; higher values discourage repetition. 8327 - */ 8328 - repetition_penalty?: number; 8329 - /** 8330 - * Decreases the likelihood of the model repeating the same lines verbatim. 8331 - */ 8332 - frequency_penalty?: number; 8333 - /** 8334 - * Increases the likelihood of the model introducing new topics. 8335 - */ 8336 - presence_penalty?: number; 8337 - } 8338 - interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_JSON_Mode_2 { 8339 - type?: 'json_object' | 'json_schema'; 8340 - json_schema?: unknown; 8341 - } 8342 - interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Messages_1 { 8343 - /** 8344 - * An array of message objects representing the conversation history. 8345 - */ 8346 - messages: { 8347 - /** 8348 - * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool'). 8349 - */ 8350 - role: string; 8351 - /** 8352 - * The content of the message as a string. 8353 - */ 8354 - content: string; 8355 - }[]; 8356 - functions?: { 8357 - name: string; 8358 - code: string; 8359 - }[]; 8360 - /** 8361 - * A list of tools available for the assistant to use. 8362 - */ 8363 - tools?: ( 8364 - | { 8365 - /** 8366 - * The name of the tool. More descriptive the better. 8367 - */ 8368 - name: string; 8369 - /** 8370 - * A brief description of what the tool does. 8371 - */ 8372 - description: string; 8373 - /** 8374 - * Schema defining the parameters accepted by the tool. 8375 - */ 8376 - parameters: { 8377 - /** 8378 - * The type of the parameters object (usually 'object'). 8379 - */ 8380 - type: string; 8381 - /** 8382 - * List of required parameter names. 8383 - */ 8384 - required?: string[]; 8385 - /** 8386 - * Definitions of each parameter. 8387 - */ 8388 - properties: { 8389 - [k: string]: { 8390 - /** 8391 - * The data type of the parameter. 8392 - */ 8393 - type: string; 8394 - /** 8395 - * A description of the expected parameter. 8396 - */ 8397 - description: string; 8398 - }; 8399 - }; 8400 - }; 8401 - } 8402 - | { 8403 - /** 8404 - * Specifies the type of tool (e.g., 'function'). 8405 - */ 8406 - type: string; 8407 - /** 8408 - * Details of the function tool. 8409 - */ 8410 - function: { 8411 - /** 8412 - * The name of the function. 8413 - */ 8414 - name: string; 8415 - /** 8416 - * A brief description of what the function does. 8417 - */ 8418 - description: string; 8419 - /** 8420 - * Schema defining the parameters accepted by the function. 8421 - */ 8422 - parameters: { 8423 - /** 8424 - * The type of the parameters object (usually 'object'). 8425 - */ 8426 - type: string; 8427 - /** 8428 - * List of required parameter names. 8429 - */ 8430 - required?: string[]; 8431 - /** 8432 - * Definitions of each parameter. 8433 - */ 8434 - properties: { 8435 - [k: string]: { 8436 - /** 8437 - * The data type of the parameter. 8438 - */ 8439 - type: string; 8440 - /** 8441 - * A description of the expected parameter. 8442 - */ 8443 - description: string; 8444 - }; 8445 - }; 8446 - }; 8447 - }; 8448 - } 8449 - )[]; 8450 - response_format?: Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_JSON_Mode_3; 8451 - /** 8452 - * If true, a chat template is not applied and you must adhere to the specific model's expected formatting. 8453 - */ 8454 - raw?: boolean; 8455 - /** 8456 - * If true, the response will be streamed back incrementally using SSE, Server Sent Events. 8457 - */ 8458 - stream?: boolean; 8459 - /** 8460 - * The maximum number of tokens to generate in the response. 8461 - */ 8462 - max_tokens?: number; 8463 - /** 8464 - * Controls the randomness of the output; higher values produce more random results. 8465 - */ 8466 - temperature?: number; 8467 - /** 8468 - * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses. 8469 - */ 8470 - top_p?: number; 8471 - /** 8472 - * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises. 8473 - */ 8474 - top_k?: number; 8475 - /** 8476 - * Random seed for reproducibility of the generation. 8477 - */ 8478 - seed?: number; 8479 - /** 8480 - * Penalty for repeated tokens; higher values discourage repetition. 8481 - */ 8482 - repetition_penalty?: number; 8483 - /** 8484 - * Decreases the likelihood of the model repeating the same lines verbatim. 8485 - */ 8486 - frequency_penalty?: number; 8487 - /** 8488 - * Increases the likelihood of the model introducing new topics. 8489 - */ 8490 - presence_penalty?: number; 8491 - } 8492 - interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_JSON_Mode_3 { 8493 - type?: 'json_object' | 'json_schema'; 8494 - json_schema?: unknown; 8495 - } 8496 - type Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Output = 8497 - | Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Chat_Completion_Response 8498 - | Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Text_Completion_Response 8499 - | string 8500 - | Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_AsyncResponse; 8501 - interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Chat_Completion_Response { 8502 - /** 8503 - * Unique identifier for the completion 8504 - */ 8505 - id?: string; 8506 - /** 8507 - * Object type identifier 8508 - */ 8509 - object?: 'chat.completion'; 8510 - /** 8511 - * Unix timestamp of when the completion was created 8512 - */ 8513 - created?: number; 8514 - /** 8515 - * Model used for the completion 8516 - */ 8517 - model?: string; 8518 - /** 8519 - * List of completion choices 8520 - */ 8521 - choices?: { 8522 - /** 8523 - * Index of the choice in the list 8524 - */ 8525 - index?: number; 8526 - /** 8527 - * The message generated by the model 8528 - */ 8529 - message?: { 8530 - /** 8531 - * Role of the message author 8532 - */ 8533 - role: string; 8534 - /** 8535 - * The content of the message 8536 - */ 8537 - content: string; 8538 - /** 8539 - * Internal reasoning content (if available) 8540 - */ 8541 - reasoning_content?: string; 8542 - /** 8543 - * Tool calls made by the assistant 8544 - */ 8545 - tool_calls?: { 8546 - /** 8547 - * Unique identifier for the tool call 8548 - */ 8549 - id: string; 8550 - /** 8551 - * Type of tool call 8552 - */ 8553 - type: 'function'; 8554 - function: { 8555 - /** 8556 - * Name of the function to call 8557 - */ 8558 - name: string; 8559 - /** 8560 - * JSON string of arguments for the function 8561 - */ 8562 - arguments: string; 8563 - }; 8564 - }[]; 8565 - }; 8566 - /** 8567 - * Reason why the model stopped generating 8568 - */ 8569 - finish_reason?: string; 8570 - /** 8571 - * Stop reason (may be null) 8572 - */ 8573 - stop_reason?: string | null; 8574 - /** 8575 - * Log probabilities (if requested) 8576 - */ 8577 - logprobs?: {} | null; 8578 - }[]; 8579 - /** 8580 - * Usage statistics for the inference request 8581 - */ 8582 - usage?: { 8583 - /** 8584 - * Total number of tokens in input 8585 - */ 8586 - prompt_tokens?: number; 8587 - /** 8588 - * Total number of tokens in output 8589 - */ 8590 - completion_tokens?: number; 8591 - /** 8592 - * Total number of input and output tokens 8593 - */ 8594 - total_tokens?: number; 8595 - }; 8596 - /** 8597 - * Log probabilities for the prompt (if requested) 8598 - */ 8599 - prompt_logprobs?: {} | null; 8600 - } 8601 - interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Text_Completion_Response { 8602 - /** 8603 - * Unique identifier for the completion 8604 - */ 8605 - id?: string; 8606 - /** 8607 - * Object type identifier 8608 - */ 8609 - object?: 'text_completion'; 8610 - /** 8611 - * Unix timestamp of when the completion was created 8612 - */ 8613 - created?: number; 8614 - /** 8615 - * Model used for the completion 8616 - */ 8617 - model?: string; 8618 - /** 8619 - * List of completion choices 8620 - */ 8621 - choices?: { 8622 - /** 8623 - * Index of the choice in the list 8624 - */ 8625 - index: number; 8626 - /** 8627 - * The generated text completion 8628 - */ 8629 - text: string; 8630 - /** 8631 - * Reason why the model stopped generating 8632 - */ 8633 - finish_reason: string; 8634 - /** 8635 - * Stop reason (may be null) 8636 - */ 8637 - stop_reason?: string | null; 8638 - /** 8639 - * Log probabilities (if requested) 8640 - */ 8641 - logprobs?: {} | null; 8642 - /** 8643 - * Log probabilities for the prompt (if requested) 8644 - */ 8645 - prompt_logprobs?: {} | null; 8646 - }[]; 8647 - /** 8648 - * Usage statistics for the inference request 8649 - */ 8650 - usage?: { 8651 - /** 8652 - * Total number of tokens in input 8653 - */ 8654 - prompt_tokens?: number; 8655 - /** 8656 - * Total number of tokens in output 8657 - */ 8658 - completion_tokens?: number; 8659 - /** 8660 - * Total number of input and output tokens 8661 - */ 8662 - total_tokens?: number; 8663 - }; 8664 - } 8665 - interface Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_AsyncResponse { 8666 - /** 8667 - * The async request id that can be used to obtain the results. 8668 - */ 8669 - request_id?: string; 8670 - } 8671 - declare abstract class Base_Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It { 8672 - inputs: Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Input; 8673 - postProcessedOutputs: Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It_Output; 8674 - } 8675 - interface Ai_Cf_Pfnet_Plamo_Embedding_1B_Input { 8676 - /** 8677 - * Input text to embed. Can be a single string or a list of strings. 8678 - */ 8679 - text: string | string[]; 8680 - } 8681 - interface Ai_Cf_Pfnet_Plamo_Embedding_1B_Output { 8682 - /** 8683 - * Embedding vectors, where each vector is a list of floats. 8684 - */ 8685 - data: number[][]; 8686 - /** 8687 - * Shape of the embedding data as [number_of_embeddings, embedding_dimension]. 8688 - * 8689 - * @minItems 2 8690 - * @maxItems 2 8691 - */ 8692 - shape: [number, number]; 8693 - } 8694 - declare abstract class Base_Ai_Cf_Pfnet_Plamo_Embedding_1B { 8695 - inputs: Ai_Cf_Pfnet_Plamo_Embedding_1B_Input; 8696 - postProcessedOutputs: Ai_Cf_Pfnet_Plamo_Embedding_1B_Output; 8697 - } 8698 - interface Ai_Cf_Deepgram_Flux_Input { 8699 - /** 8700 - * Encoding of the audio stream. Currently only supports raw signed little-endian 16-bit PCM. 8701 - */ 8702 - encoding: 'linear16'; 8703 - /** 8704 - * Sample rate of the audio stream in Hz. 8705 - */ 8706 - sample_rate: string; 8707 - /** 8708 - * End-of-turn confidence required to fire an eager end-of-turn event. When set, enables EagerEndOfTurn and TurnResumed events. Valid Values 0.3 - 0.9. 8709 - */ 8710 - eager_eot_threshold?: string; 8711 - /** 8712 - * End-of-turn confidence required to finish a turn. Valid Values 0.5 - 0.9. 8713 - */ 8714 - eot_threshold?: string; 8715 - /** 8716 - * A turn will be finished when this much time has passed after speech, regardless of EOT confidence. 8717 - */ 8718 - eot_timeout_ms?: string; 8719 - /** 8720 - * Keyterm prompting can improve recognition of specialized terminology. Pass multiple keyterm query parameters to boost multiple keyterms. 8721 - */ 8722 - keyterm?: string; 8723 - /** 8724 - * Opts out requests from the Deepgram Model Improvement Program. Refer to Deepgram Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip 8725 - */ 8726 - mip_opt_out?: 'true' | 'false'; 8727 - /** 8728 - * Label your requests for the purpose of identification during usage reporting 8729 - */ 8730 - tag?: string; 8731 - } 8732 - /** 8733 - * Output will be returned as websocket messages. 8734 - */ 8735 - interface Ai_Cf_Deepgram_Flux_Output { 8736 - /** 8737 - * The unique identifier of the request (uuid) 8738 - */ 8739 - request_id?: string; 8740 - /** 8741 - * Starts at 0 and increments for each message the server sends to the client. 8742 - */ 8743 - sequence_id?: number; 8744 - /** 8745 - * The type of event being reported. 8746 - */ 8747 - event?: 'Update' | 'StartOfTurn' | 'EagerEndOfTurn' | 'TurnResumed' | 'EndOfTurn'; 8748 - /** 8749 - * The index of the current turn 8750 - */ 8751 - turn_index?: number; 8752 - /** 8753 - * Start time in seconds of the audio range that was transcribed 8754 - */ 8755 - audio_window_start?: number; 8756 - /** 8757 - * End time in seconds of the audio range that was transcribed 8758 - */ 8759 - audio_window_end?: number; 8760 - /** 8761 - * Text that was said over the course of the current turn 8762 - */ 8763 - transcript?: string; 8764 - /** 8765 - * The words in the transcript 8766 - */ 8767 - words?: { 8768 - /** 8769 - * The individual punctuated, properly-cased word from the transcript 8770 - */ 8771 - word: string; 8772 - /** 8773 - * Confidence that this word was transcribed correctly 8774 - */ 8775 - confidence: number; 8776 - }[]; 8777 - /** 8778 - * Confidence that no more speech is coming in this turn 8779 - */ 8780 - end_of_turn_confidence?: number; 8781 - } 8782 - declare abstract class Base_Ai_Cf_Deepgram_Flux { 8783 - inputs: Ai_Cf_Deepgram_Flux_Input; 8784 - postProcessedOutputs: Ai_Cf_Deepgram_Flux_Output; 8785 - } 8786 - interface Ai_Cf_Deepgram_Aura_2_En_Input { 8787 - /** 8788 - * Speaker used to produce the audio. 8789 - */ 8790 - speaker?: 8791 - | 'amalthea' 8792 - | 'andromeda' 8793 - | 'apollo' 8794 - | 'arcas' 8795 - | 'aries' 8796 - | 'asteria' 8797 - | 'athena' 8798 - | 'atlas' 8799 - | 'aurora' 8800 - | 'callista' 8801 - | 'cora' 8802 - | 'cordelia' 8803 - | 'delia' 8804 - | 'draco' 8805 - | 'electra' 8806 - | 'harmonia' 8807 - | 'helena' 8808 - | 'hera' 8809 - | 'hermes' 8810 - | 'hyperion' 8811 - | 'iris' 8812 - | 'janus' 8813 - | 'juno' 8814 - | 'jupiter' 8815 - | 'luna' 8816 - | 'mars' 8817 - | 'minerva' 8818 - | 'neptune' 8819 - | 'odysseus' 8820 - | 'ophelia' 8821 - | 'orion' 8822 - | 'orpheus' 8823 - | 'pandora' 8824 - | 'phoebe' 8825 - | 'pluto' 8826 - | 'saturn' 8827 - | 'thalia' 8828 - | 'theia' 8829 - | 'vesta' 8830 - | 'zeus'; 8831 - /** 8832 - * Encoding of the output audio. 8833 - */ 8834 - encoding?: 'linear16' | 'flac' | 'mulaw' | 'alaw' | 'mp3' | 'opus' | 'aac'; 8835 - /** 8836 - * Container specifies the file format wrapper for the output audio. The available options depend on the encoding type.. 8837 - */ 8838 - container?: 'none' | 'wav' | 'ogg'; 8839 - /** 8840 - * The text content to be converted to speech 8841 - */ 8842 - text: string; 8843 - /** 8844 - * Sample Rate specifies the sample rate for the output audio. Based on the encoding, different sample rates are supported. For some encodings, the sample rate is not configurable 8845 - */ 8846 - sample_rate?: number; 8847 - /** 8848 - * The bitrate of the audio in bits per second. Choose from predefined ranges or specific values based on the encoding type. 8849 - */ 8850 - bit_rate?: number; 8851 - } 8852 - /** 8853 - * The generated audio in MP3 format 8854 - */ 8855 - type Ai_Cf_Deepgram_Aura_2_En_Output = string; 8856 - declare abstract class Base_Ai_Cf_Deepgram_Aura_2_En { 8857 - inputs: Ai_Cf_Deepgram_Aura_2_En_Input; 8858 - postProcessedOutputs: Ai_Cf_Deepgram_Aura_2_En_Output; 8859 - } 8860 - interface Ai_Cf_Deepgram_Aura_2_Es_Input { 8861 - /** 8862 - * Speaker used to produce the audio. 8863 - */ 8864 - speaker?: 8865 - | 'sirio' 8866 - | 'nestor' 8867 - | 'carina' 8868 - | 'celeste' 8869 - | 'alvaro' 8870 - | 'diana' 8871 - | 'aquila' 8872 - | 'selena' 8873 - | 'estrella' 8874 - | 'javier'; 8875 - /** 8876 - * Encoding of the output audio. 8877 - */ 8878 - encoding?: 'linear16' | 'flac' | 'mulaw' | 'alaw' | 'mp3' | 'opus' | 'aac'; 8879 - /** 8880 - * Container specifies the file format wrapper for the output audio. The available options depend on the encoding type.. 8881 - */ 8882 - container?: 'none' | 'wav' | 'ogg'; 8883 - /** 8884 - * The text content to be converted to speech 8885 - */ 8886 - text: string; 8887 - /** 8888 - * Sample Rate specifies the sample rate for the output audio. Based on the encoding, different sample rates are supported. For some encodings, the sample rate is not configurable 8889 - */ 8890 - sample_rate?: number; 8891 - /** 8892 - * The bitrate of the audio in bits per second. Choose from predefined ranges or specific values based on the encoding type. 8893 - */ 8894 - bit_rate?: number; 8895 - } 8896 - /** 8897 - * The generated audio in MP3 format 8898 - */ 8899 - type Ai_Cf_Deepgram_Aura_2_Es_Output = string; 8900 - declare abstract class Base_Ai_Cf_Deepgram_Aura_2_Es { 8901 - inputs: Ai_Cf_Deepgram_Aura_2_Es_Input; 8902 - postProcessedOutputs: Ai_Cf_Deepgram_Aura_2_Es_Output; 8903 - } 8904 - interface AiModels { 8905 - '@cf/huggingface/distilbert-sst-2-int8': BaseAiTextClassification; 8906 - '@cf/stabilityai/stable-diffusion-xl-base-1.0': BaseAiTextToImage; 8907 - '@cf/runwayml/stable-diffusion-v1-5-inpainting': BaseAiTextToImage; 8908 - '@cf/runwayml/stable-diffusion-v1-5-img2img': BaseAiTextToImage; 8909 - '@cf/lykon/dreamshaper-8-lcm': BaseAiTextToImage; 8910 - '@cf/bytedance/stable-diffusion-xl-lightning': BaseAiTextToImage; 8911 - '@cf/myshell-ai/melotts': BaseAiTextToSpeech; 8912 - '@cf/google/embeddinggemma-300m': BaseAiTextEmbeddings; 8913 - '@cf/microsoft/resnet-50': BaseAiImageClassification; 8914 - '@cf/meta/llama-2-7b-chat-int8': BaseAiTextGeneration; 8915 - '@cf/mistral/mistral-7b-instruct-v0.1': BaseAiTextGeneration; 8916 - '@cf/meta/llama-2-7b-chat-fp16': BaseAiTextGeneration; 8917 - '@hf/thebloke/llama-2-13b-chat-awq': BaseAiTextGeneration; 8918 - '@hf/thebloke/mistral-7b-instruct-v0.1-awq': BaseAiTextGeneration; 8919 - '@hf/thebloke/zephyr-7b-beta-awq': BaseAiTextGeneration; 8920 - '@hf/thebloke/openhermes-2.5-mistral-7b-awq': BaseAiTextGeneration; 8921 - '@hf/thebloke/neural-chat-7b-v3-1-awq': BaseAiTextGeneration; 8922 - '@hf/thebloke/llamaguard-7b-awq': BaseAiTextGeneration; 8923 - '@hf/thebloke/deepseek-coder-6.7b-base-awq': BaseAiTextGeneration; 8924 - '@hf/thebloke/deepseek-coder-6.7b-instruct-awq': BaseAiTextGeneration; 8925 - '@cf/deepseek-ai/deepseek-math-7b-instruct': BaseAiTextGeneration; 8926 - '@cf/defog/sqlcoder-7b-2': BaseAiTextGeneration; 8927 - '@cf/openchat/openchat-3.5-0106': BaseAiTextGeneration; 8928 - '@cf/tiiuae/falcon-7b-instruct': BaseAiTextGeneration; 8929 - '@cf/thebloke/discolm-german-7b-v1-awq': BaseAiTextGeneration; 8930 - '@cf/qwen/qwen1.5-0.5b-chat': BaseAiTextGeneration; 8931 - '@cf/qwen/qwen1.5-7b-chat-awq': BaseAiTextGeneration; 8932 - '@cf/qwen/qwen1.5-14b-chat-awq': BaseAiTextGeneration; 8933 - '@cf/tinyllama/tinyllama-1.1b-chat-v1.0': BaseAiTextGeneration; 8934 - '@cf/microsoft/phi-2': BaseAiTextGeneration; 8935 - '@cf/qwen/qwen1.5-1.8b-chat': BaseAiTextGeneration; 8936 - '@cf/mistral/mistral-7b-instruct-v0.2-lora': BaseAiTextGeneration; 8937 - '@hf/nousresearch/hermes-2-pro-mistral-7b': BaseAiTextGeneration; 8938 - '@hf/nexusflow/starling-lm-7b-beta': BaseAiTextGeneration; 8939 - '@hf/google/gemma-7b-it': BaseAiTextGeneration; 8940 - '@cf/meta-llama/llama-2-7b-chat-hf-lora': BaseAiTextGeneration; 8941 - '@cf/google/gemma-2b-it-lora': BaseAiTextGeneration; 8942 - '@cf/google/gemma-7b-it-lora': BaseAiTextGeneration; 8943 - '@hf/mistral/mistral-7b-instruct-v0.2': BaseAiTextGeneration; 8944 - '@cf/meta/llama-3-8b-instruct': BaseAiTextGeneration; 8945 - '@cf/fblgit/una-cybertron-7b-v2-bf16': BaseAiTextGeneration; 8946 - '@cf/meta/llama-3-8b-instruct-awq': BaseAiTextGeneration; 8947 - '@cf/meta/llama-3.1-8b-instruct-fp8': BaseAiTextGeneration; 8948 - '@cf/meta/llama-3.1-8b-instruct-awq': BaseAiTextGeneration; 8949 - '@cf/meta/llama-3.2-3b-instruct': BaseAiTextGeneration; 8950 - '@cf/meta/llama-3.2-1b-instruct': BaseAiTextGeneration; 8951 - '@cf/deepseek-ai/deepseek-r1-distill-qwen-32b': BaseAiTextGeneration; 8952 - '@cf/ibm-granite/granite-4.0-h-micro': BaseAiTextGeneration; 8953 - '@cf/facebook/bart-large-cnn': BaseAiSummarization; 8954 - '@cf/llava-hf/llava-1.5-7b-hf': BaseAiImageToText; 8955 - '@cf/baai/bge-base-en-v1.5': Base_Ai_Cf_Baai_Bge_Base_En_V1_5; 8956 - '@cf/openai/whisper': Base_Ai_Cf_Openai_Whisper; 8957 - '@cf/meta/m2m100-1.2b': Base_Ai_Cf_Meta_M2M100_1_2B; 8958 - '@cf/baai/bge-small-en-v1.5': Base_Ai_Cf_Baai_Bge_Small_En_V1_5; 8959 - '@cf/baai/bge-large-en-v1.5': Base_Ai_Cf_Baai_Bge_Large_En_V1_5; 8960 - '@cf/unum/uform-gen2-qwen-500m': Base_Ai_Cf_Unum_Uform_Gen2_Qwen_500M; 8961 - '@cf/openai/whisper-tiny-en': Base_Ai_Cf_Openai_Whisper_Tiny_En; 8962 - '@cf/openai/whisper-large-v3-turbo': Base_Ai_Cf_Openai_Whisper_Large_V3_Turbo; 8963 - '@cf/baai/bge-m3': Base_Ai_Cf_Baai_Bge_M3; 8964 - '@cf/black-forest-labs/flux-1-schnell': Base_Ai_Cf_Black_Forest_Labs_Flux_1_Schnell; 8965 - '@cf/meta/llama-3.2-11b-vision-instruct': Base_Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct; 8966 - '@cf/meta/llama-3.3-70b-instruct-fp8-fast': Base_Ai_Cf_Meta_Llama_3_3_70B_Instruct_Fp8_Fast; 8967 - '@cf/meta/llama-guard-3-8b': Base_Ai_Cf_Meta_Llama_Guard_3_8B; 8968 - '@cf/baai/bge-reranker-base': Base_Ai_Cf_Baai_Bge_Reranker_Base; 8969 - '@cf/qwen/qwen2.5-coder-32b-instruct': Base_Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct; 8970 - '@cf/qwen/qwq-32b': Base_Ai_Cf_Qwen_Qwq_32B; 8971 - '@cf/mistralai/mistral-small-3.1-24b-instruct': Base_Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruct; 8972 - '@cf/google/gemma-3-12b-it': Base_Ai_Cf_Google_Gemma_3_12B_It; 8973 - '@cf/meta/llama-4-scout-17b-16e-instruct': Base_Ai_Cf_Meta_Llama_4_Scout_17B_16E_Instruct; 8974 - '@cf/qwen/qwen3-30b-a3b-fp8': Base_Ai_Cf_Qwen_Qwen3_30B_A3B_Fp8; 8975 - '@cf/deepgram/nova-3': Base_Ai_Cf_Deepgram_Nova_3; 8976 - '@cf/qwen/qwen3-embedding-0.6b': Base_Ai_Cf_Qwen_Qwen3_Embedding_0_6B; 8977 - '@cf/pipecat-ai/smart-turn-v2': Base_Ai_Cf_Pipecat_Ai_Smart_Turn_V2; 8978 - '@cf/openai/gpt-oss-120b': Base_Ai_Cf_Openai_Gpt_Oss_120B; 8979 - '@cf/openai/gpt-oss-20b': Base_Ai_Cf_Openai_Gpt_Oss_20B; 8980 - '@cf/leonardo/phoenix-1.0': Base_Ai_Cf_Leonardo_Phoenix_1_0; 8981 - '@cf/leonardo/lucid-origin': Base_Ai_Cf_Leonardo_Lucid_Origin; 8982 - '@cf/deepgram/aura-1': Base_Ai_Cf_Deepgram_Aura_1; 8983 - '@cf/ai4bharat/indictrans2-en-indic-1B': Base_Ai_Cf_Ai4Bharat_Indictrans2_En_Indic_1B; 8984 - '@cf/aisingapore/gemma-sea-lion-v4-27b-it': Base_Ai_Cf_Aisingapore_Gemma_Sea_Lion_V4_27B_It; 8985 - '@cf/pfnet/plamo-embedding-1b': Base_Ai_Cf_Pfnet_Plamo_Embedding_1B; 8986 - '@cf/deepgram/flux': Base_Ai_Cf_Deepgram_Flux; 8987 - '@cf/deepgram/aura-2-en': Base_Ai_Cf_Deepgram_Aura_2_En; 8988 - '@cf/deepgram/aura-2-es': Base_Ai_Cf_Deepgram_Aura_2_Es; 8989 - } 8990 - type AiOptions = { 8991 - /** 8992 - * Send requests as an asynchronous batch job, only works for supported models 8993 - * https://developers.cloudflare.com/workers-ai/features/batch-api 8994 - */ 8995 - queueRequest?: boolean; 8996 - /** 8997 - * Establish websocket connections, only works for supported models 8998 - */ 8999 - websocket?: boolean; 9000 - /** 9001 - * Tag your requests to group and view them in Cloudflare dashboard. 9002 - * 9003 - * Rules: 9004 - * Tags must only contain letters, numbers, and the symbols: : - . / @ 9005 - * Each tag can have maximum 50 characters. 9006 - * Maximum 5 tags are allowed each request. 9007 - * Duplicate tags will removed. 9008 - */ 9009 - tags?: string[]; 9010 - gateway?: GatewayOptions; 9011 - returnRawResponse?: boolean; 9012 - prefix?: string; 9013 - extraHeaders?: object; 9014 - }; 9015 - type AiModelsSearchParams = { 9016 - author?: string; 9017 - hide_experimental?: boolean; 9018 - page?: number; 9019 - per_page?: number; 9020 - search?: string; 9021 - source?: number; 9022 - task?: string; 9023 - }; 9024 - type AiModelsSearchObject = { 9025 - id: string; 9026 - source: number; 9027 - name: string; 9028 - description: string; 9029 - task: { 9030 - id: string; 9031 - name: string; 9032 - description: string; 9033 - }; 9034 - tags: string[]; 9035 - properties: { 9036 - property_id: string; 9037 - value: string; 9038 - }[]; 9039 - }; 9040 - interface InferenceUpstreamError extends Error {} 9041 - interface AiInternalError extends Error {} 9042 - type AiModelListType = Record<string, any>; 9043 - declare abstract class Ai<AiModelList extends AiModelListType = AiModels> { 9044 - aiGatewayLogId: string | null; 9045 - gateway(gatewayId: string): AiGateway; 9046 - autorag(autoragId: string): AutoRAG; 9047 - run< 9048 - Name extends keyof AiModelList, 9049 - Options extends AiOptions, 9050 - InputOptions extends AiModelList[Name]['inputs'], 9051 - >( 9052 - model: Name, 9053 - inputs: InputOptions, 9054 - options?: Options, 9055 - ): Promise< 9056 - Options extends 9057 - | { 9058 - returnRawResponse: true; 9059 - } 9060 - | { 9061 - websocket: true; 9062 - } 9063 - ? Response 9064 - : InputOptions extends { 9065 - stream: true; 9066 - } 9067 - ? ReadableStream 9068 - : AiModelList[Name]['postProcessedOutputs'] 9069 - >; 9070 - models(params?: AiModelsSearchParams): Promise<AiModelsSearchObject[]>; 9071 - toMarkdown(): ToMarkdownService; 9072 - toMarkdown(files: MarkdownDocument[], options?: ConversionRequestOptions): Promise<ConversionResponse[]>; 9073 - toMarkdown(files: MarkdownDocument, options?: ConversionRequestOptions): Promise<ConversionResponse>; 9074 - } 9075 - type GatewayRetries = { 9076 - maxAttempts?: 1 | 2 | 3 | 4 | 5; 9077 - retryDelayMs?: number; 9078 - backoff?: 'constant' | 'linear' | 'exponential'; 9079 - }; 9080 - type GatewayOptions = { 9081 - id: string; 9082 - cacheKey?: string; 9083 - cacheTtl?: number; 9084 - skipCache?: boolean; 9085 - metadata?: Record<string, number | string | boolean | null | bigint>; 9086 - collectLog?: boolean; 9087 - eventId?: string; 9088 - requestTimeoutMs?: number; 9089 - retries?: GatewayRetries; 9090 - }; 9091 - type UniversalGatewayOptions = Exclude<GatewayOptions, 'id'> & { 9092 - /** 9093 - ** @deprecated 9094 - */ 9095 - id?: string; 9096 - }; 9097 - type AiGatewayPatchLog = { 9098 - score?: number | null; 9099 - feedback?: -1 | 1 | null; 9100 - metadata?: Record<string, number | string | boolean | null | bigint> | null; 9101 - }; 9102 - type AiGatewayLog = { 9103 - id: string; 9104 - provider: string; 9105 - model: string; 9106 - model_type?: string; 9107 - path: string; 9108 - duration: number; 9109 - request_type?: string; 9110 - request_content_type?: string; 9111 - status_code: number; 9112 - response_content_type?: string; 9113 - success: boolean; 9114 - cached: boolean; 9115 - tokens_in?: number; 9116 - tokens_out?: number; 9117 - metadata?: Record<string, number | string | boolean | null | bigint>; 9118 - step?: number; 9119 - cost?: number; 9120 - custom_cost?: boolean; 9121 - request_size: number; 9122 - request_head?: string; 9123 - request_head_complete: boolean; 9124 - response_size: number; 9125 - response_head?: string; 9126 - response_head_complete: boolean; 9127 - created_at: Date; 9128 - }; 9129 - type AIGatewayProviders = 9130 - | 'workers-ai' 9131 - | 'anthropic' 9132 - | 'aws-bedrock' 9133 - | 'azure-openai' 9134 - | 'google-vertex-ai' 9135 - | 'huggingface' 9136 - | 'openai' 9137 - | 'perplexity-ai' 9138 - | 'replicate' 9139 - | 'groq' 9140 - | 'cohere' 9141 - | 'google-ai-studio' 9142 - | 'mistral' 9143 - | 'grok' 9144 - | 'openrouter' 9145 - | 'deepseek' 9146 - | 'cerebras' 9147 - | 'cartesia' 9148 - | 'elevenlabs' 9149 - | 'adobe-firefly'; 9150 - type AIGatewayHeaders = { 9151 - 'cf-aig-metadata': Record<string, number | string | boolean | null | bigint> | string; 9152 - 'cf-aig-custom-cost': 9153 - | { 9154 - per_token_in?: number; 9155 - per_token_out?: number; 9156 - } 9157 - | { 9158 - total_cost?: number; 9159 - } 9160 - | string; 9161 - 'cf-aig-cache-ttl': number | string; 9162 - 'cf-aig-skip-cache': boolean | string; 9163 - 'cf-aig-cache-key': string; 9164 - 'cf-aig-event-id': string; 9165 - 'cf-aig-request-timeout': number | string; 9166 - 'cf-aig-max-attempts': number | string; 9167 - 'cf-aig-retry-delay': number | string; 9168 - 'cf-aig-backoff': string; 9169 - 'cf-aig-collect-log': boolean | string; 9170 - Authorization: string; 9171 - 'Content-Type': string; 9172 - [key: string]: string | number | boolean | object; 9173 - }; 9174 - type AIGatewayUniversalRequest = { 9175 - provider: AIGatewayProviders | string; // eslint-disable-line 9176 - endpoint: string; 9177 - headers: Partial<AIGatewayHeaders>; 9178 - query: unknown; 9179 - }; 9180 - interface AiGatewayInternalError extends Error {} 9181 - interface AiGatewayLogNotFound extends Error {} 9182 - declare abstract class AiGateway { 9183 - patchLog(logId: string, data: AiGatewayPatchLog): Promise<void>; 9184 - getLog(logId: string): Promise<AiGatewayLog>; 9185 - run( 9186 - data: AIGatewayUniversalRequest | AIGatewayUniversalRequest[], 9187 - options?: { 9188 - gateway?: UniversalGatewayOptions; 9189 - extraHeaders?: object; 9190 - }, 9191 - ): Promise<Response>; 9192 - getUrl(provider?: AIGatewayProviders | string): Promise<string>; // eslint-disable-line 9193 - } 9194 - interface AutoRAGInternalError extends Error {} 9195 - interface AutoRAGNotFoundError extends Error {} 9196 - interface AutoRAGUnauthorizedError extends Error {} 9197 - interface AutoRAGNameNotSetError extends Error {} 9198 - type ComparisonFilter = { 9199 - key: string; 9200 - type: 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte'; 9201 - value: string | number | boolean; 9202 - }; 9203 - type CompoundFilter = { 9204 - type: 'and' | 'or'; 9205 - filters: ComparisonFilter[]; 9206 - }; 9207 - type AutoRagSearchRequest = { 9208 - query: string; 9209 - filters?: CompoundFilter | ComparisonFilter; 9210 - max_num_results?: number; 9211 - ranking_options?: { 9212 - ranker?: string; 9213 - score_threshold?: number; 9214 - }; 9215 - reranking?: { 9216 - enabled?: boolean; 9217 - model?: string; 9218 - }; 9219 - rewrite_query?: boolean; 9220 - }; 9221 - type AutoRagAiSearchRequest = AutoRagSearchRequest & { 9222 - stream?: boolean; 9223 - system_prompt?: string; 9224 - }; 9225 - type AutoRagAiSearchRequestStreaming = Omit<AutoRagAiSearchRequest, 'stream'> & { 9226 - stream: true; 9227 - }; 9228 - type AutoRagSearchResponse = { 9229 - object: 'vector_store.search_results.page'; 9230 - search_query: string; 9231 - data: { 9232 - file_id: string; 9233 - filename: string; 9234 - score: number; 9235 - attributes: Record<string, string | number | boolean | null>; 9236 - content: { 9237 - type: 'text'; 9238 - text: string; 9239 - }[]; 9240 - }[]; 9241 - has_more: boolean; 9242 - next_page: string | null; 9243 - }; 9244 - type AutoRagListResponse = { 9245 - id: string; 9246 - enable: boolean; 9247 - type: string; 9248 - source: string; 9249 - vectorize_name: string; 9250 - paused: boolean; 9251 - status: string; 9252 - }[]; 9253 - type AutoRagAiSearchResponse = AutoRagSearchResponse & { 9254 - response: string; 9255 - }; 9256 - declare abstract class AutoRAG { 9257 - list(): Promise<AutoRagListResponse>; 9258 - search(params: AutoRagSearchRequest): Promise<AutoRagSearchResponse>; 9259 - aiSearch(params: AutoRagAiSearchRequestStreaming): Promise<Response>; 9260 - aiSearch(params: AutoRagAiSearchRequest): Promise<AutoRagAiSearchResponse>; 9261 - aiSearch(params: AutoRagAiSearchRequest): Promise<AutoRagAiSearchResponse | Response>; 9262 - } 9263 - interface BasicImageTransformations { 9264 - /** 9265 - * Maximum width in image pixels. The value must be an integer. 9266 - */ 9267 - width?: number; 9268 - /** 9269 - * Maximum height in image pixels. The value must be an integer. 9270 - */ 9271 - height?: number; 9272 - /** 9273 - * Resizing mode as a string. It affects interpretation of width and height 9274 - * options: 9275 - * - scale-down: Similar to contain, but the image is never enlarged. If 9276 - * the image is larger than given width or height, it will be resized. 9277 - * Otherwise its original size will be kept. 9278 - * - contain: Resizes to maximum size that fits within the given width and 9279 - * height. If only a single dimension is given (e.g. only width), the 9280 - * image will be shrunk or enlarged to exactly match that dimension. 9281 - * Aspect ratio is always preserved. 9282 - * - cover: Resizes (shrinks or enlarges) to fill the entire area of width 9283 - * and height. If the image has an aspect ratio different from the ratio 9284 - * of width and height, it will be cropped to fit. 9285 - * - crop: The image will be shrunk and cropped to fit within the area 9286 - * specified by width and height. The image will not be enlarged. For images 9287 - * smaller than the given dimensions it's the same as scale-down. For 9288 - * images larger than the given dimensions, it's the same as cover. 9289 - * See also trim. 9290 - * - pad: Resizes to the maximum size that fits within the given width and 9291 - * height, and then fills the remaining area with a background color 9292 - * (white by default). Use of this mode is not recommended, as the same 9293 - * effect can be more efficiently achieved with the contain mode and the 9294 - * CSS object-fit: contain property. 9295 - * - squeeze: Stretches and deforms to the width and height given, even if it 9296 - * breaks aspect ratio 9297 - */ 9298 - fit?: 'scale-down' | 'contain' | 'cover' | 'crop' | 'pad' | 'squeeze'; 9299 - /** 9300 - * Image segmentation using artificial intelligence models. Sets pixels not 9301 - * within selected segment area to transparent e.g "foreground" sets every 9302 - * background pixel as transparent. 9303 - */ 9304 - segment?: 'foreground'; 9305 - /** 9306 - * When cropping with fit: "cover", this defines the side or point that should 9307 - * be left uncropped. The value is either a string 9308 - * "left", "right", "top", "bottom", "auto", or "center" (the default), 9309 - * or an object {x, y} containing focal point coordinates in the original 9310 - * image expressed as fractions ranging from 0.0 (top or left) to 1.0 9311 - * (bottom or right), 0.5 being the center. {fit: "cover", gravity: "top"} will 9312 - * crop bottom or left and right sides as necessary, but won’t crop anything 9313 - * from the top. {fit: "cover", gravity: {x:0.5, y:0.2}} will crop each side to 9314 - * preserve as much as possible around a point at 20% of the height of the 9315 - * source image. 9316 - */ 9317 - gravity?: 9318 - | 'face' 9319 - | 'left' 9320 - | 'right' 9321 - | 'top' 9322 - | 'bottom' 9323 - | 'center' 9324 - | 'auto' 9325 - | 'entropy' 9326 - | BasicImageTransformationsGravityCoordinates; 9327 - /** 9328 - * Background color to add underneath the image. Applies only to images with 9329 - * transparency (such as PNG). Accepts any CSS color (#RRGGBB, rgba(…), 9330 - * hsl(…), etc.) 9331 - */ 9332 - background?: string; 9333 - /** 9334 - * Number of degrees (90, 180, 270) to rotate the image by. width and height 9335 - * options refer to axes after rotation. 9336 - */ 9337 - rotate?: 0 | 90 | 180 | 270 | 360; 9338 - } 9339 - interface BasicImageTransformationsGravityCoordinates { 9340 - x?: number; 9341 - y?: number; 9342 - mode?: 'remainder' | 'box-center'; 9343 - } 9344 - /** 9345 - * In addition to the properties you can set in the RequestInit dict 9346 - * that you pass as an argument to the Request constructor, you can 9347 - * set certain properties of a `cf` object to control how Cloudflare 9348 - * features are applied to that new Request. 9349 - * 9350 - * Note: Currently, these properties cannot be tested in the 9351 - * playground. 9352 - */ 9353 - interface RequestInitCfProperties extends Record<string, unknown> { 9354 - cacheEverything?: boolean; 9355 - /** 9356 - * A request's cache key is what determines if two requests are 9357 - * "the same" for caching purposes. If a request has the same cache key 9358 - * as some previous request, then we can serve the same cached response for 9359 - * both. (e.g. 'some-key') 9360 - * 9361 - * Only available for Enterprise customers. 9362 - */ 9363 - cacheKey?: string; 9364 - /** 9365 - * This allows you to append additional Cache-Tag response headers 9366 - * to the origin response without modifications to the origin server. 9367 - * This will allow for greater control over the Purge by Cache Tag feature 9368 - * utilizing changes only in the Workers process. 9369 - * 9370 - * Only available for Enterprise customers. 9371 - */ 9372 - cacheTags?: string[]; 9373 - /** 9374 - * Force response to be cached for a given number of seconds. (e.g. 300) 9375 - */ 9376 - cacheTtl?: number; 9377 - /** 9378 - * Force response to be cached for a given number of seconds based on the Origin status code. 9379 - * (e.g. { '200-299': 86400, '404': 1, '500-599': 0 }) 9380 - */ 9381 - cacheTtlByStatus?: Record<string, number>; 9382 - scrapeShield?: boolean; 9383 - apps?: boolean; 9384 - image?: RequestInitCfPropertiesImage; 9385 - minify?: RequestInitCfPropertiesImageMinify; 9386 - mirage?: boolean; 9387 - polish?: 'lossy' | 'lossless' | 'off'; 9388 - r2?: RequestInitCfPropertiesR2; 9389 - /** 9390 - * Redirects the request to an alternate origin server. You can use this, 9391 - * for example, to implement load balancing across several origins. 9392 - * (e.g.us-east.example.com) 9393 - * 9394 - * Note - For security reasons, the hostname set in resolveOverride must 9395 - * be proxied on the same Cloudflare zone of the incoming request. 9396 - * Otherwise, the setting is ignored. CNAME hosts are allowed, so to 9397 - * resolve to a host under a different domain or a DNS only domain first 9398 - * declare a CNAME record within your own zone’s DNS mapping to the 9399 - * external hostname, set proxy on Cloudflare, then set resolveOverride 9400 - * to point to that CNAME record. 9401 - */ 9402 - resolveOverride?: string; 9403 - } 9404 - interface RequestInitCfPropertiesImageDraw extends BasicImageTransformations { 9405 - /** 9406 - * Absolute URL of the image file to use for the drawing. It can be any of 9407 - * the supported file formats. For drawing of watermarks or non-rectangular 9408 - * overlays we recommend using PNG or WebP images. 9409 - */ 9410 - url: string; 9411 - /** 9412 - * Floating-point number between 0 (transparent) and 1 (opaque). 9413 - * For example, opacity: 0.5 makes overlay semitransparent. 9414 - */ 9415 - opacity?: number; 9416 - /** 9417 - * - If set to true, the overlay image will be tiled to cover the entire 9418 - * area. This is useful for stock-photo-like watermarks. 9419 - * - If set to "x", the overlay image will be tiled horizontally only 9420 - * (form a line). 9421 - * - If set to "y", the overlay image will be tiled vertically only 9422 - * (form a line). 9423 - */ 9424 - repeat?: true | 'x' | 'y'; 9425 - /** 9426 - * Position of the overlay image relative to a given edge. Each property is 9427 - * an offset in pixels. 0 aligns exactly to the edge. For example, left: 10 9428 - * positions left side of the overlay 10 pixels from the left edge of the 9429 - * image it's drawn over. bottom: 0 aligns bottom of the overlay with bottom 9430 - * of the background image. 9431 - * 9432 - * Setting both left & right, or both top & bottom is an error. 9433 - * 9434 - * If no position is specified, the image will be centered. 9435 - */ 9436 - top?: number; 9437 - left?: number; 9438 - bottom?: number; 9439 - right?: number; 9440 - } 9441 - interface RequestInitCfPropertiesImage extends BasicImageTransformations { 9442 - /** 9443 - * Device Pixel Ratio. Default 1. Multiplier for width/height that makes it 9444 - * easier to specify higher-DPI sizes in <img srcset>. 9445 - */ 9446 - dpr?: number; 9447 - /** 9448 - * Allows you to trim your image. Takes dpr into account and is performed before 9449 - * resizing or rotation. 9450 - * 9451 - * It can be used as: 9452 - * - left, top, right, bottom - it will specify the number of pixels to cut 9453 - * off each side 9454 - * - width, height - the width/height you'd like to end up with - can be used 9455 - * in combination with the properties above 9456 - * - border - this will automatically trim the surroundings of an image based on 9457 - * it's color. It consists of three properties: 9458 - * - color: rgb or hex representation of the color you wish to trim (todo: verify the rgba bit) 9459 - * - tolerance: difference from color to treat as color 9460 - * - keep: the number of pixels of border to keep 9461 - */ 9462 - trim?: 9463 - | 'border' 9464 - | { 9465 - top?: number; 9466 - bottom?: number; 9467 - left?: number; 9468 - right?: number; 9469 - width?: number; 9470 - height?: number; 9471 - border?: 9472 - | boolean 9473 - | { 9474 - color?: string; 9475 - tolerance?: number; 9476 - keep?: number; 9477 - }; 9478 - }; 9479 - /** 9480 - * Quality setting from 1-100 (useful values are in 60-90 range). Lower values 9481 - * make images look worse, but load faster. The default is 85. It applies only 9482 - * to JPEG and WebP images. It doesn’t have any effect on PNG. 9483 - */ 9484 - quality?: number | 'low' | 'medium-low' | 'medium-high' | 'high'; 9485 - /** 9486 - * Output format to generate. It can be: 9487 - * - avif: generate images in AVIF format. 9488 - * - webp: generate images in Google WebP format. Set quality to 100 to get 9489 - * the WebP-lossless format. 9490 - * - json: instead of generating an image, outputs information about the 9491 - * image, in JSON format. The JSON object will contain image size 9492 - * (before and after resizing), source image’s MIME type, file size, etc. 9493 - * - jpeg: generate images in JPEG format. 9494 - * - png: generate images in PNG format. 9495 - */ 9496 - format?: 'avif' | 'webp' | 'json' | 'jpeg' | 'png' | 'baseline-jpeg' | 'png-force' | 'svg'; 9497 - /** 9498 - * Whether to preserve animation frames from input files. Default is true. 9499 - * Setting it to false reduces animations to still images. This setting is 9500 - * recommended when enlarging images or processing arbitrary user content, 9501 - * because large GIF animations can weigh tens or even hundreds of megabytes. 9502 - * It is also useful to set anim:false when using format:"json" to get the 9503 - * response quicker without the number of frames. 9504 - */ 9505 - anim?: boolean; 9506 - /** 9507 - * What EXIF data should be preserved in the output image. Note that EXIF 9508 - * rotation and embedded color profiles are always applied ("baked in" into 9509 - * the image), and aren't affected by this option. Note that if the Polish 9510 - * feature is enabled, all metadata may have been removed already and this 9511 - * option may have no effect. 9512 - * - keep: Preserve most of EXIF metadata, including GPS location if there's 9513 - * any. 9514 - * - copyright: Only keep the copyright tag, and discard everything else. 9515 - * This is the default behavior for JPEG files. 9516 - * - none: Discard all invisible EXIF metadata. Currently WebP and PNG 9517 - * output formats always discard metadata. 9518 - */ 9519 - metadata?: 'keep' | 'copyright' | 'none'; 9520 - /** 9521 - * Strength of sharpening filter to apply to the image. Floating-point 9522 - * number between 0 (no sharpening, default) and 10 (maximum). 1.0 is a 9523 - * recommended value for downscaled images. 9524 - */ 9525 - sharpen?: number; 9526 - /** 9527 - * Radius of a blur filter (approximate gaussian). Maximum supported radius 9528 - * is 250. 9529 - */ 9530 - blur?: number; 9531 - /** 9532 - * Overlays are drawn in the order they appear in the array (last array 9533 - * entry is the topmost layer). 9534 - */ 9535 - draw?: RequestInitCfPropertiesImageDraw[]; 9536 - /** 9537 - * Fetching image from authenticated origin. Setting this property will 9538 - * pass authentication headers (Authorization, Cookie, etc.) through to 9539 - * the origin. 9540 - */ 9541 - 'origin-auth'?: 'share-publicly'; 9542 - /** 9543 - * Adds a border around the image. The border is added after resizing. Border 9544 - * width takes dpr into account, and can be specified either using a single 9545 - * width property, or individually for each side. 9546 - */ 9547 - border?: 9548 - | { 9549 - color: string; 9550 - width: number; 9551 - } 9552 - | { 9553 - color: string; 9554 - top: number; 9555 - right: number; 9556 - bottom: number; 9557 - left: number; 9558 - }; 9559 - /** 9560 - * Increase brightness by a factor. A value of 1.0 equals no change, a value 9561 - * of 0.5 equals half brightness, and a value of 2.0 equals twice as bright. 9562 - * 0 is ignored. 9563 - */ 9564 - brightness?: number; 9565 - /** 9566 - * Increase contrast by a factor. A value of 1.0 equals no change, a value of 9567 - * 0.5 equals low contrast, and a value of 2.0 equals high contrast. 0 is 9568 - * ignored. 9569 - */ 9570 - contrast?: number; 9571 - /** 9572 - * Increase exposure by a factor. A value of 1.0 equals no change, a value of 9573 - * 0.5 darkens the image, and a value of 2.0 lightens the image. 0 is ignored. 9574 - */ 9575 - gamma?: number; 9576 - /** 9577 - * Increase contrast by a factor. A value of 1.0 equals no change, a value of 9578 - * 0.5 equals low contrast, and a value of 2.0 equals high contrast. 0 is 9579 - * ignored. 9580 - */ 9581 - saturation?: number; 9582 - /** 9583 - * Flips the images horizontally, vertically, or both. Flipping is applied before 9584 - * rotation, so if you apply flip=h,rotate=90 then the image will be flipped 9585 - * horizontally, then rotated by 90 degrees. 9586 - */ 9587 - flip?: 'h' | 'v' | 'hv'; 9588 - /** 9589 - * Slightly reduces latency on a cache miss by selecting a 9590 - * quickest-to-compress file format, at a cost of increased file size and 9591 - * lower image quality. It will usually override the format option and choose 9592 - * JPEG over WebP or AVIF. We do not recommend using this option, except in 9593 - * unusual circumstances like resizing uncacheable dynamically-generated 9594 - * images. 9595 - */ 9596 - compression?: 'fast'; 9597 - } 9598 - interface RequestInitCfPropertiesImageMinify { 9599 - javascript?: boolean; 9600 - css?: boolean; 9601 - html?: boolean; 9602 - } 9603 - interface RequestInitCfPropertiesR2 { 9604 - /** 9605 - * Colo id of bucket that an object is stored in 9606 - */ 9607 - bucketColoId?: number; 9608 - } 9609 - /** 9610 - * Request metadata provided by Cloudflare's edge. 9611 - */ 9612 - type IncomingRequestCfProperties<HostMetadata = unknown> = IncomingRequestCfPropertiesBase & 9613 - IncomingRequestCfPropertiesBotManagementEnterprise & 9614 - IncomingRequestCfPropertiesCloudflareForSaaSEnterprise<HostMetadata> & 9615 - IncomingRequestCfPropertiesGeographicInformation & 9616 - IncomingRequestCfPropertiesCloudflareAccessOrApiShield; 9617 - interface IncomingRequestCfPropertiesBase extends Record<string, unknown> { 9618 - /** 9619 - * [ASN](https://www.iana.org/assignments/as-numbers/as-numbers.xhtml) of the incoming request. 9620 - * 9621 - * @example 395747 9622 - */ 9623 - asn?: number; 9624 - /** 9625 - * The organization which owns the ASN of the incoming request. 9626 - * 9627 - * @example "Google Cloud" 9628 - */ 9629 - asOrganization?: string; 9630 - /** 9631 - * The original value of the `Accept-Encoding` header if Cloudflare modified it. 9632 - * 9633 - * @example "gzip, deflate, br" 9634 - */ 9635 - clientAcceptEncoding?: string; 9636 - /** 9637 - * The number of milliseconds it took for the request to reach your worker. 9638 - * 9639 - * @example 22 9640 - */ 9641 - clientTcpRtt?: number; 9642 - /** 9643 - * The three-letter [IATA](https://en.wikipedia.org/wiki/IATA_airport_code) 9644 - * airport code of the data center that the request hit. 9645 - * 9646 - * @example "DFW" 9647 - */ 9648 - colo: string; 9649 - /** 9650 - * Represents the upstream's response to a 9651 - * [TCP `keepalive` message](https://tldp.org/HOWTO/TCP-Keepalive-HOWTO/overview.html) 9652 - * from cloudflare. 9653 - * 9654 - * For workers with no upstream, this will always be `1`. 9655 - * 9656 - * @example 3 9657 - */ 9658 - edgeRequestKeepAliveStatus: IncomingRequestCfPropertiesEdgeRequestKeepAliveStatus; 9659 - /** 9660 - * The HTTP Protocol the request used. 9661 - * 9662 - * @example "HTTP/2" 9663 - */ 9664 - httpProtocol: string; 9665 - /** 9666 - * The browser-requested prioritization information in the request object. 9667 - * 9668 - * If no information was set, defaults to the empty string `""` 9669 - * 9670 - * @example "weight=192;exclusive=0;group=3;group-weight=127" 9671 - * @default "" 9672 - */ 9673 - requestPriority: string; 9674 - /** 9675 - * The TLS version of the connection to Cloudflare. 9676 - * In requests served over plaintext (without TLS), this property is the empty string `""`. 9677 - * 9678 - * @example "TLSv1.3" 9679 - */ 9680 - tlsVersion: string; 9681 - /** 9682 - * The cipher for the connection to Cloudflare. 9683 - * In requests served over plaintext (without TLS), this property is the empty string `""`. 9684 - * 9685 - * @example "AEAD-AES128-GCM-SHA256" 9686 - */ 9687 - tlsCipher: string; 9688 - /** 9689 - * Metadata containing the [`HELLO`](https://www.rfc-editor.org/rfc/rfc5246#section-7.4.1.2) and [`FINISHED`](https://www.rfc-editor.org/rfc/rfc5246#section-7.4.9) messages from this request's TLS handshake. 9690 - * 9691 - * If the incoming request was served over plaintext (without TLS) this field is undefined. 9692 - */ 9693 - tlsExportedAuthenticator?: IncomingRequestCfPropertiesExportedAuthenticatorMetadata; 9694 - } 9695 - interface IncomingRequestCfPropertiesBotManagementBase { 9696 - /** 9697 - * Cloudflare’s [level of certainty](https://developers.cloudflare.com/bots/concepts/bot-score/) that a request comes from a bot, 9698 - * represented as an integer percentage between `1` (almost certainly a bot) and `99` (almost certainly human). 9699 - * 9700 - * @example 54 9701 - */ 9702 - score: number; 9703 - /** 9704 - * A boolean value that is true if the request comes from a good bot, like Google or Bing. 9705 - * Most customers choose to allow this traffic. For more details, see [Traffic from known bots](https://developers.cloudflare.com/firewall/known-issues-and-faq/#how-does-firewall-rules-handle-traffic-from-known-bots). 9706 - */ 9707 - verifiedBot: boolean; 9708 - /** 9709 - * A boolean value that is true if the request originates from a 9710 - * Cloudflare-verified proxy service. 9711 - */ 9712 - corporateProxy: boolean; 9713 - /** 9714 - * A boolean value that's true if the request matches [file extensions](https://developers.cloudflare.com/bots/reference/static-resources/) for many types of static resources. 9715 - */ 9716 - staticResource: boolean; 9717 - /** 9718 - * List of IDs that correlate to the Bot Management heuristic detections made on a request (you can have multiple heuristic detections on the same request). 9719 - */ 9720 - detectionIds: number[]; 9721 - } 9722 - interface IncomingRequestCfPropertiesBotManagement { 9723 - /** 9724 - * Results of Cloudflare's Bot Management analysis 9725 - */ 9726 - botManagement: IncomingRequestCfPropertiesBotManagementBase; 9727 - /** 9728 - * Duplicate of `botManagement.score`. 9729 - * 9730 - * @deprecated 9731 - */ 9732 - clientTrustScore: number; 9733 - } 9734 - interface IncomingRequestCfPropertiesBotManagementEnterprise extends IncomingRequestCfPropertiesBotManagement { 9735 - /** 9736 - * Results of Cloudflare's Bot Management analysis 9737 - */ 9738 - botManagement: IncomingRequestCfPropertiesBotManagementBase & { 9739 - /** 9740 - * A [JA3 Fingerprint](https://developers.cloudflare.com/bots/concepts/ja3-fingerprint/) to help profile specific SSL/TLS clients 9741 - * across different destination IPs, Ports, and X509 certificates. 9742 - */ 9743 - ja3Hash: string; 9744 - }; 9745 - } 9746 - interface IncomingRequestCfPropertiesCloudflareForSaaSEnterprise<HostMetadata> { 9747 - /** 9748 - * Custom metadata set per-host in [Cloudflare for SaaS](https://developers.cloudflare.com/cloudflare-for-platforms/cloudflare-for-saas/). 9749 - * 9750 - * This field is only present if you have Cloudflare for SaaS enabled on your account 9751 - * and you have followed the [required steps to enable it]((https://developers.cloudflare.com/cloudflare-for-platforms/cloudflare-for-saas/domain-support/custom-metadata/)). 9752 - */ 9753 - hostMetadata?: HostMetadata; 9754 - } 9755 - interface IncomingRequestCfPropertiesCloudflareAccessOrApiShield { 9756 - /** 9757 - * Information about the client certificate presented to Cloudflare. 9758 - * 9759 - * This is populated when the incoming request is served over TLS using 9760 - * either Cloudflare Access or API Shield (mTLS) 9761 - * and the presented SSL certificate has a valid 9762 - * [Certificate Serial Number](https://ldapwiki.com/wiki/Certificate%20Serial%20Number) 9763 - * (i.e., not `null` or `""`). 9764 - * 9765 - * Otherwise, a set of placeholder values are used. 9766 - * 9767 - * The property `certPresented` will be set to `"1"` when 9768 - * the object is populated (i.e. the above conditions were met). 9769 - */ 9770 - tlsClientAuth: 9771 - | IncomingRequestCfPropertiesTLSClientAuth 9772 - | IncomingRequestCfPropertiesTLSClientAuthPlaceholder; 9773 - } 9774 - /** 9775 - * Metadata about the request's TLS handshake 9776 - */ 9777 - interface IncomingRequestCfPropertiesExportedAuthenticatorMetadata { 9778 - /** 9779 - * The client's [`HELLO` message](https://www.rfc-editor.org/rfc/rfc5246#section-7.4.1.2), encoded in hexadecimal 9780 - * 9781 - * @example "44372ba35fa1270921d318f34c12f155dc87b682cf36a790cfaa3ba8737a1b5d" 9782 - */ 9783 - clientHandshake: string; 9784 - /** 9785 - * The server's [`HELLO` message](https://www.rfc-editor.org/rfc/rfc5246#section-7.4.1.2), encoded in hexadecimal 9786 - * 9787 - * @example "44372ba35fa1270921d318f34c12f155dc87b682cf36a790cfaa3ba8737a1b5d" 9788 - */ 9789 - serverHandshake: string; 9790 - /** 9791 - * The client's [`FINISHED` message](https://www.rfc-editor.org/rfc/rfc5246#section-7.4.9), encoded in hexadecimal 9792 - * 9793 - * @example "084ee802fe1348f688220e2a6040a05b2199a761f33cf753abb1b006792d3f8b" 9794 - */ 9795 - clientFinished: string; 9796 - /** 9797 - * The server's [`FINISHED` message](https://www.rfc-editor.org/rfc/rfc5246#section-7.4.9), encoded in hexadecimal 9798 - * 9799 - * @example "084ee802fe1348f688220e2a6040a05b2199a761f33cf753abb1b006792d3f8b" 9800 - */ 9801 - serverFinished: string; 9802 - } 9803 - /** 9804 - * Geographic data about the request's origin. 9805 - */ 9806 - interface IncomingRequestCfPropertiesGeographicInformation { 9807 - /** 9808 - * The [ISO 3166-1 Alpha 2](https://www.iso.org/iso-3166-country-codes.html) country code the request originated from. 9809 - * 9810 - * If your worker is [configured to accept TOR connections](https://support.cloudflare.com/hc/en-us/articles/203306930-Understanding-Cloudflare-Tor-support-and-Onion-Routing), this may also be `"T1"`, indicating a request that originated over TOR. 9811 - * 9812 - * If Cloudflare is unable to determine where the request originated this property is omitted. 9813 - * 9814 - * The country code `"T1"` is used for requests originating on TOR. 9815 - * 9816 - * @example "GB" 9817 - */ 9818 - country?: Iso3166Alpha2Code | 'T1'; 9819 - /** 9820 - * If present, this property indicates that the request originated in the EU 9821 - * 9822 - * @example "1" 9823 - */ 9824 - isEUCountry?: '1'; 9825 - /** 9826 - * A two-letter code indicating the continent the request originated from. 9827 - * 9828 - * @example "AN" 9829 - */ 9830 - continent?: ContinentCode; 9831 - /** 9832 - * The city the request originated from 9833 - * 9834 - * @example "Austin" 9835 - */ 9836 - city?: string; 9837 - /** 9838 - * Postal code of the incoming request 9839 - * 9840 - * @example "78701" 9841 - */ 9842 - postalCode?: string; 9843 - /** 9844 - * Latitude of the incoming request 9845 - * 9846 - * @example "30.27130" 9847 - */ 9848 - latitude?: string; 9849 - /** 9850 - * Longitude of the incoming request 9851 - * 9852 - * @example "-97.74260" 9853 - */ 9854 - longitude?: string; 9855 - /** 9856 - * Timezone of the incoming request 9857 - * 9858 - * @example "America/Chicago" 9859 - */ 9860 - timezone?: string; 9861 - /** 9862 - * If known, the ISO 3166-2 name for the first level region associated with 9863 - * the IP address of the incoming request 9864 - * 9865 - * @example "Texas" 9866 - */ 9867 - region?: string; 9868 - /** 9869 - * If known, the ISO 3166-2 code for the first-level region associated with 9870 - * the IP address of the incoming request 9871 - * 9872 - * @example "TX" 9873 - */ 9874 - regionCode?: string; 9875 - /** 9876 - * Metro code (DMA) of the incoming request 9877 - * 9878 - * @example "635" 9879 - */ 9880 - metroCode?: string; 9881 - } 9882 - /** Data about the incoming request's TLS certificate */ 9883 - interface IncomingRequestCfPropertiesTLSClientAuth { 9884 - /** Always `"1"`, indicating that the certificate was presented */ 9885 - certPresented: '1'; 9886 - /** 9887 - * Result of certificate verification. 9888 - * 9889 - * @example "FAILED:self signed certificate" 9890 - */ 9891 - certVerified: Exclude<CertVerificationStatus, 'NONE'>; 9892 - /** The presented certificate's revokation status. 9893 - * 9894 - * - A value of `"1"` indicates the certificate has been revoked 9895 - * - A value of `"0"` indicates the certificate has not been revoked 9896 - */ 9897 - certRevoked: '1' | '0'; 9898 - /** 9899 - * The certificate issuer's [distinguished name](https://knowledge.digicert.com/generalinformation/INFO1745.html) 9900 - * 9901 - * @example "CN=cloudflareaccess.com, C=US, ST=Texas, L=Austin, O=Cloudflare" 9902 - */ 9903 - certIssuerDN: string; 9904 - /** 9905 - * The certificate subject's [distinguished name](https://knowledge.digicert.com/generalinformation/INFO1745.html) 9906 - * 9907 - * @example "CN=*.cloudflareaccess.com, C=US, ST=Texas, L=Austin, O=Cloudflare" 9908 - */ 9909 - certSubjectDN: string; 9910 - /** 9911 - * The certificate issuer's [distinguished name](https://knowledge.digicert.com/generalinformation/INFO1745.html) ([RFC 2253](https://www.rfc-editor.org/rfc/rfc2253.html) formatted) 9912 - * 9913 - * @example "CN=cloudflareaccess.com, C=US, ST=Texas, L=Austin, O=Cloudflare" 9914 - */ 9915 - certIssuerDNRFC2253: string; 9916 - /** 9917 - * The certificate subject's [distinguished name](https://knowledge.digicert.com/generalinformation/INFO1745.html) ([RFC 2253](https://www.rfc-editor.org/rfc/rfc2253.html) formatted) 9918 - * 9919 - * @example "CN=*.cloudflareaccess.com, C=US, ST=Texas, L=Austin, O=Cloudflare" 9920 - */ 9921 - certSubjectDNRFC2253: string; 9922 - /** The certificate issuer's distinguished name (legacy policies) */ 9923 - certIssuerDNLegacy: string; 9924 - /** The certificate subject's distinguished name (legacy policies) */ 9925 - certSubjectDNLegacy: string; 9926 - /** 9927 - * The certificate's serial number 9928 - * 9929 - * @example "00936EACBE07F201DF" 9930 - */ 9931 - certSerial: string; 9932 - /** 9933 - * The certificate issuer's serial number 9934 - * 9935 - * @example "2489002934BDFEA34" 9936 - */ 9937 - certIssuerSerial: string; 9938 - /** 9939 - * The certificate's Subject Key Identifier 9940 - * 9941 - * @example "BB:AF:7E:02:3D:FA:A6:F1:3C:84:8E:AD:EE:38:98:EC:D9:32:32:D4" 9942 - */ 9943 - certSKI: string; 9944 - /** 9945 - * The certificate issuer's Subject Key Identifier 9946 - * 9947 - * @example "BB:AF:7E:02:3D:FA:A6:F1:3C:84:8E:AD:EE:38:98:EC:D9:32:32:D4" 9948 - */ 9949 - certIssuerSKI: string; 9950 - /** 9951 - * The certificate's SHA-1 fingerprint 9952 - * 9953 - * @example "6b9109f323999e52259cda7373ff0b4d26bd232e" 9954 - */ 9955 - certFingerprintSHA1: string; 9956 - /** 9957 - * The certificate's SHA-256 fingerprint 9958 - * 9959 - * @example "acf77cf37b4156a2708e34c4eb755f9b5dbbe5ebb55adfec8f11493438d19e6ad3f157f81fa3b98278453d5652b0c1fd1d71e5695ae4d709803a4d3f39de9dea" 9960 - */ 9961 - certFingerprintSHA256: string; 9962 - /** 9963 - * The effective starting date of the certificate 9964 - * 9965 - * @example "Dec 22 19:39:00 2018 GMT" 9966 - */ 9967 - certNotBefore: string; 9968 - /** 9969 - * The effective expiration date of the certificate 9970 - * 9971 - * @example "Dec 22 19:39:00 2018 GMT" 9972 - */ 9973 - certNotAfter: string; 9974 - } 9975 - /** Placeholder values for TLS Client Authorization */ 9976 - interface IncomingRequestCfPropertiesTLSClientAuthPlaceholder { 9977 - certPresented: '0'; 9978 - certVerified: 'NONE'; 9979 - certRevoked: '0'; 9980 - certIssuerDN: ''; 9981 - certSubjectDN: ''; 9982 - certIssuerDNRFC2253: ''; 9983 - certSubjectDNRFC2253: ''; 9984 - certIssuerDNLegacy: ''; 9985 - certSubjectDNLegacy: ''; 9986 - certSerial: ''; 9987 - certIssuerSerial: ''; 9988 - certSKI: ''; 9989 - certIssuerSKI: ''; 9990 - certFingerprintSHA1: ''; 9991 - certFingerprintSHA256: ''; 9992 - certNotBefore: ''; 9993 - certNotAfter: ''; 9994 - } 9995 - /** Possible outcomes of TLS verification */ 9996 - declare type CertVerificationStatus = 9997 - /** Authentication succeeded */ 9998 - | 'SUCCESS' 9999 - /** No certificate was presented */ 10000 - | 'NONE' 10001 - /** Failed because the certificate was self-signed */ 10002 - | 'FAILED:self signed certificate' 10003 - /** Failed because the certificate failed a trust chain check */ 10004 - | 'FAILED:unable to verify the first certificate' 10005 - /** Failed because the certificate not yet valid */ 10006 - | 'FAILED:certificate is not yet valid' 10007 - /** Failed because the certificate is expired */ 10008 - | 'FAILED:certificate has expired' 10009 - /** Failed for another unspecified reason */ 10010 - | 'FAILED'; 10011 - /** 10012 - * An upstream endpoint's response to a TCP `keepalive` message from Cloudflare. 10013 - */ 10014 - declare type IncomingRequestCfPropertiesEdgeRequestKeepAliveStatus = 10015 - | 0 /** Unknown */ 10016 - | 1 /** no keepalives (not found) */ 10017 - | 2 /** no connection re-use, opening keepalive connection failed */ 10018 - | 3 /** no connection re-use, keepalive accepted and saved */ 10019 - | 4 /** connection re-use, refused by the origin server (`TCP FIN`) */ 10020 - | 5; /** connection re-use, accepted by the origin server */ 10021 - /** ISO 3166-1 Alpha-2 codes */ 10022 - declare type Iso3166Alpha2Code = 10023 - | 'AD' 10024 - | 'AE' 10025 - | 'AF' 10026 - | 'AG' 10027 - | 'AI' 10028 - | 'AL' 10029 - | 'AM' 10030 - | 'AO' 10031 - | 'AQ' 10032 - | 'AR' 10033 - | 'AS' 10034 - | 'AT' 10035 - | 'AU' 10036 - | 'AW' 10037 - | 'AX' 10038 - | 'AZ' 10039 - | 'BA' 10040 - | 'BB' 10041 - | 'BD' 10042 - | 'BE' 10043 - | 'BF' 10044 - | 'BG' 10045 - | 'BH' 10046 - | 'BI' 10047 - | 'BJ' 10048 - | 'BL' 10049 - | 'BM' 10050 - | 'BN' 10051 - | 'BO' 10052 - | 'BQ' 10053 - | 'BR' 10054 - | 'BS' 10055 - | 'BT' 10056 - | 'BV' 10057 - | 'BW' 10058 - | 'BY' 10059 - | 'BZ' 10060 - | 'CA' 10061 - | 'CC' 10062 - | 'CD' 10063 - | 'CF' 10064 - | 'CG' 10065 - | 'CH' 10066 - | 'CI' 10067 - | 'CK' 10068 - | 'CL' 10069 - | 'CM' 10070 - | 'CN' 10071 - | 'CO' 10072 - | 'CR' 10073 - | 'CU' 10074 - | 'CV' 10075 - | 'CW' 10076 - | 'CX' 10077 - | 'CY' 10078 - | 'CZ' 10079 - | 'DE' 10080 - | 'DJ' 10081 - | 'DK' 10082 - | 'DM' 10083 - | 'DO' 10084 - | 'DZ' 10085 - | 'EC' 10086 - | 'EE' 10087 - | 'EG' 10088 - | 'EH' 10089 - | 'ER' 10090 - | 'ES' 10091 - | 'ET' 10092 - | 'FI' 10093 - | 'FJ' 10094 - | 'FK' 10095 - | 'FM' 10096 - | 'FO' 10097 - | 'FR' 10098 - | 'GA' 10099 - | 'GB' 10100 - | 'GD' 10101 - | 'GE' 10102 - | 'GF' 10103 - | 'GG' 10104 - | 'GH' 10105 - | 'GI' 10106 - | 'GL' 10107 - | 'GM' 10108 - | 'GN' 10109 - | 'GP' 10110 - | 'GQ' 10111 - | 'GR' 10112 - | 'GS' 10113 - | 'GT' 10114 - | 'GU' 10115 - | 'GW' 10116 - | 'GY' 10117 - | 'HK' 10118 - | 'HM' 10119 - | 'HN' 10120 - | 'HR' 10121 - | 'HT' 10122 - | 'HU' 10123 - | 'ID' 10124 - | 'IE' 10125 - | 'IL' 10126 - | 'IM' 10127 - | 'IN' 10128 - | 'IO' 10129 - | 'IQ' 10130 - | 'IR' 10131 - | 'IS' 10132 - | 'IT' 10133 - | 'JE' 10134 - | 'JM' 10135 - | 'JO' 10136 - | 'JP' 10137 - | 'KE' 10138 - | 'KG' 10139 - | 'KH' 10140 - | 'KI' 10141 - | 'KM' 10142 - | 'KN' 10143 - | 'KP' 10144 - | 'KR' 10145 - | 'KW' 10146 - | 'KY' 10147 - | 'KZ' 10148 - | 'LA' 10149 - | 'LB' 10150 - | 'LC' 10151 - | 'LI' 10152 - | 'LK' 10153 - | 'LR' 10154 - | 'LS' 10155 - | 'LT' 10156 - | 'LU' 10157 - | 'LV' 10158 - | 'LY' 10159 - | 'MA' 10160 - | 'MC' 10161 - | 'MD' 10162 - | 'ME' 10163 - | 'MF' 10164 - | 'MG' 10165 - | 'MH' 10166 - | 'MK' 10167 - | 'ML' 10168 - | 'MM' 10169 - | 'MN' 10170 - | 'MO' 10171 - | 'MP' 10172 - | 'MQ' 10173 - | 'MR' 10174 - | 'MS' 10175 - | 'MT' 10176 - | 'MU' 10177 - | 'MV' 10178 - | 'MW' 10179 - | 'MX' 10180 - | 'MY' 10181 - | 'MZ' 10182 - | 'NA' 10183 - | 'NC' 10184 - | 'NE' 10185 - | 'NF' 10186 - | 'NG' 10187 - | 'NI' 10188 - | 'NL' 10189 - | 'NO' 10190 - | 'NP' 10191 - | 'NR' 10192 - | 'NU' 10193 - | 'NZ' 10194 - | 'OM' 10195 - | 'PA' 10196 - | 'PE' 10197 - | 'PF' 10198 - | 'PG' 10199 - | 'PH' 10200 - | 'PK' 10201 - | 'PL' 10202 - | 'PM' 10203 - | 'PN' 10204 - | 'PR' 10205 - | 'PS' 10206 - | 'PT' 10207 - | 'PW' 10208 - | 'PY' 10209 - | 'QA' 10210 - | 'RE' 10211 - | 'RO' 10212 - | 'RS' 10213 - | 'RU' 10214 - | 'RW' 10215 - | 'SA' 10216 - | 'SB' 10217 - | 'SC' 10218 - | 'SD' 10219 - | 'SE' 10220 - | 'SG' 10221 - | 'SH' 10222 - | 'SI' 10223 - | 'SJ' 10224 - | 'SK' 10225 - | 'SL' 10226 - | 'SM' 10227 - | 'SN' 10228 - | 'SO' 10229 - | 'SR' 10230 - | 'SS' 10231 - | 'ST' 10232 - | 'SV' 10233 - | 'SX' 10234 - | 'SY' 10235 - | 'SZ' 10236 - | 'TC' 10237 - | 'TD' 10238 - | 'TF' 10239 - | 'TG' 10240 - | 'TH' 10241 - | 'TJ' 10242 - | 'TK' 10243 - | 'TL' 10244 - | 'TM' 10245 - | 'TN' 10246 - | 'TO' 10247 - | 'TR' 10248 - | 'TT' 10249 - | 'TV' 10250 - | 'TW' 10251 - | 'TZ' 10252 - | 'UA' 10253 - | 'UG' 10254 - | 'UM' 10255 - | 'US' 10256 - | 'UY' 10257 - | 'UZ' 10258 - | 'VA' 10259 - | 'VC' 10260 - | 'VE' 10261 - | 'VG' 10262 - | 'VI' 10263 - | 'VN' 10264 - | 'VU' 10265 - | 'WF' 10266 - | 'WS' 10267 - | 'YE' 10268 - | 'YT' 10269 - | 'ZA' 10270 - | 'ZM' 10271 - | 'ZW'; 10272 - /** The 2-letter continent codes Cloudflare uses */ 10273 - declare type ContinentCode = 'AF' | 'AN' | 'AS' | 'EU' | 'NA' | 'OC' | 'SA'; 10274 - type CfProperties<HostMetadata = unknown> = 10275 - | IncomingRequestCfProperties<HostMetadata> 10276 - | RequestInitCfProperties; 10277 - interface D1Meta { 10278 - duration: number; 10279 - size_after: number; 10280 - rows_read: number; 10281 - rows_written: number; 10282 - last_row_id: number; 10283 - changed_db: boolean; 10284 - changes: number; 10285 - /** 10286 - * The region of the database instance that executed the query. 10287 - */ 10288 - served_by_region?: string; 10289 - /** 10290 - * True if-and-only-if the database instance that executed the query was the primary. 10291 - */ 10292 - served_by_primary?: boolean; 10293 - timings?: { 10294 - /** 10295 - * The duration of the SQL query execution by the database instance. It doesn't include any network time. 10296 - */ 10297 - sql_duration_ms: number; 10298 - }; 10299 - /** 10300 - * Number of total attempts to execute the query, due to automatic retries. 10301 - * Note: All other fields in the response like `timings` only apply to the last attempt. 10302 - */ 10303 - total_attempts?: number; 10304 - } 10305 - interface D1Response { 10306 - success: true; 10307 - meta: D1Meta & Record<string, unknown>; 10308 - error?: never; 10309 - } 10310 - type D1Result<T = unknown> = D1Response & { 10311 - results: T[]; 10312 - }; 10313 - interface D1ExecResult { 10314 - count: number; 10315 - duration: number; 10316 - } 10317 - type D1SessionConstraint = 10318 - // Indicates that the first query should go to the primary, and the rest queries 10319 - // using the same D1DatabaseSession will go to any replica that is consistent with 10320 - // the bookmark maintained by the session (returned by the first query). 10321 - | 'first-primary' 10322 - // Indicates that the first query can go anywhere (primary or replica), and the rest queries 10323 - // using the same D1DatabaseSession will go to any replica that is consistent with 10324 - // the bookmark maintained by the session (returned by the first query). 10325 - | 'first-unconstrained'; 10326 - type D1SessionBookmark = string; 10327 - declare abstract class D1Database { 10328 - prepare(query: string): D1PreparedStatement; 10329 - batch<T = unknown>(statements: D1PreparedStatement[]): Promise<D1Result<T>[]>; 10330 - exec(query: string): Promise<D1ExecResult>; 10331 - /** 10332 - * Creates a new D1 Session anchored at the given constraint or the bookmark. 10333 - * All queries executed using the created session will have sequential consistency, 10334 - * meaning that all writes done through the session will be visible in subsequent reads. 10335 - * 10336 - * @param constraintOrBookmark Either the session constraint or the explicit bookmark to anchor the created session. 10337 - */ 10338 - withSession(constraintOrBookmark?: D1SessionBookmark | D1SessionConstraint): D1DatabaseSession; 10339 - /** 10340 - * @deprecated dump() will be removed soon, only applies to deprecated alpha v1 databases. 10341 - */ 10342 - dump(): Promise<ArrayBuffer>; 10343 - } 10344 - declare abstract class D1DatabaseSession { 10345 - prepare(query: string): D1PreparedStatement; 10346 - batch<T = unknown>(statements: D1PreparedStatement[]): Promise<D1Result<T>[]>; 10347 - /** 10348 - * @returns The latest session bookmark across all executed queries on the session. 10349 - * If no query has been executed yet, `null` is returned. 10350 - */ 10351 - getBookmark(): D1SessionBookmark | null; 10352 - } 10353 - declare abstract class D1PreparedStatement { 10354 - bind(...values: unknown[]): D1PreparedStatement; 10355 - first<T = unknown>(colName: string): Promise<T | null>; 10356 - first<T = Record<string, unknown>>(): Promise<T | null>; 10357 - run<T = Record<string, unknown>>(): Promise<D1Result<T>>; 10358 - all<T = Record<string, unknown>>(): Promise<D1Result<T>>; 10359 - raw<T = unknown[]>(options: { columnNames: true }): Promise<[string[], ...T[]]>; 10360 - raw<T = unknown[]>(options?: { columnNames?: false }): Promise<T[]>; 10361 - } 10362 - // `Disposable` was added to TypeScript's standard lib types in version 5.2. 10363 - // To support older TypeScript versions, define an empty `Disposable` interface. 10364 - // Users won't be able to use `using`/`Symbol.dispose` without upgrading to 5.2, 10365 - // but this will ensure type checking on older versions still passes. 10366 - // TypeScript's interface merging will ensure our empty interface is effectively 10367 - // ignored when `Disposable` is included in the standard lib. 10368 - interface Disposable {} 10369 - /** 10370 - * An email message that can be sent from a Worker. 10371 - */ 10372 - interface EmailMessage { 10373 - /** 10374 - * Envelope From attribute of the email message. 10375 - */ 10376 - readonly from: string; 10377 - /** 10378 - * Envelope To attribute of the email message. 10379 - */ 10380 - readonly to: string; 10381 - } 10382 - /** 10383 - * An email message that is sent to a consumer Worker and can be rejected/forwarded. 10384 - */ 10385 - interface ForwardableEmailMessage extends EmailMessage { 10386 - /** 10387 - * Stream of the email message content. 10388 - */ 10389 - readonly raw: ReadableStream<Uint8Array>; 10390 - /** 10391 - * An [Headers object](https://developer.mozilla.org/en-US/docs/Web/API/Headers). 10392 - */ 10393 - readonly headers: Headers; 10394 - /** 10395 - * Size of the email message content. 10396 - */ 10397 - readonly rawSize: number; 10398 - /** 10399 - * Reject this email message by returning a permanent SMTP error back to the connecting client including the given reason. 10400 - * @param reason The reject reason. 10401 - * @returns void 10402 - */ 10403 - setReject(reason: string): void; 10404 - /** 10405 - * Forward this email message to a verified destination address of the account. 10406 - * @param rcptTo Verified destination address. 10407 - * @param headers A [Headers object](https://developer.mozilla.org/en-US/docs/Web/API/Headers). 10408 - * @returns A promise that resolves when the email message is forwarded. 10409 - */ 10410 - forward(rcptTo: string, headers?: Headers): Promise<void>; 10411 - /** 10412 - * Reply to the sender of this email message with a new EmailMessage object. 10413 - * @param message The reply message. 10414 - * @returns A promise that resolves when the email message is replied. 10415 - */ 10416 - reply(message: EmailMessage): Promise<void>; 10417 - } 10418 - /** 10419 - * A binding that allows a Worker to send email messages. 10420 - */ 10421 - interface SendEmail { 10422 - send(message: EmailMessage): Promise<void>; 10423 - } 10424 - declare abstract class EmailEvent extends ExtendableEvent { 10425 - readonly message: ForwardableEmailMessage; 10426 - } 10427 - declare type EmailExportedHandler<Env = unknown> = ( 10428 - message: ForwardableEmailMessage, 10429 - env: Env, 10430 - ctx: ExecutionContext, 10431 - ) => void | Promise<void>; 10432 - declare module 'cloudflare:email' { 10433 - let _EmailMessage: { 10434 - prototype: EmailMessage; 10435 - new (from: string, to: string, raw: ReadableStream | string): EmailMessage; 10436 - }; 10437 - export { _EmailMessage as EmailMessage }; 10438 - } 10439 - /** 10440 - * Hello World binding to serve as an explanatory example. DO NOT USE 10441 - */ 10442 - interface HelloWorldBinding { 10443 - /** 10444 - * Retrieve the current stored value 10445 - */ 10446 - get(): Promise<{ 10447 - value: string; 10448 - ms?: number; 10449 - }>; 10450 - /** 10451 - * Set a new stored value 10452 - */ 10453 - set(value: string): Promise<void>; 10454 - } 10455 - interface Hyperdrive { 10456 - /** 10457 - * Connect directly to Hyperdrive as if it's your database, returning a TCP socket. 10458 - * 10459 - * Calling this method returns an identical socket to if you call 10460 - * `connect("host:port")` using the `host` and `port` fields from this object. 10461 - * Pick whichever approach works better with your preferred DB client library. 10462 - * 10463 - * Note that this socket is not yet authenticated -- it's expected that your 10464 - * code (or preferably, the client library of your choice) will authenticate 10465 - * using the information in this class's readonly fields. 10466 - */ 10467 - connect(): Socket; 10468 - /** 10469 - * A valid DB connection string that can be passed straight into the typical 10470 - * client library/driver/ORM. This will typically be the easiest way to use 10471 - * Hyperdrive. 10472 - */ 10473 - readonly connectionString: string; 10474 - /* 10475 - * A randomly generated hostname that is only valid within the context of the 10476 - * currently running Worker which, when passed into `connect()` function from 10477 - * the "cloudflare:sockets" module, will connect to the Hyperdrive instance 10478 - * for your database. 10479 - */ 10480 - readonly host: string; 10481 - /* 10482 - * The port that must be paired the the host field when connecting. 10483 - */ 10484 - readonly port: number; 10485 - /* 10486 - * The username to use when authenticating to your database via Hyperdrive. 10487 - * Unlike the host and password, this will be the same every time 10488 - */ 10489 - readonly user: string; 10490 - /* 10491 - * The randomly generated password to use when authenticating to your 10492 - * database via Hyperdrive. Like the host field, this password is only valid 10493 - * within the context of the currently running Worker instance from which 10494 - * it's read. 10495 - */ 10496 - readonly password: string; 10497 - /* 10498 - * The name of the database to connect to. 10499 - */ 10500 - readonly database: string; 10501 - } 10502 - // Copyright (c) 2024 Cloudflare, Inc. 10503 - // Licensed under the Apache 2.0 license found in the LICENSE file or at: 10504 - // https://opensource.org/licenses/Apache-2.0 10505 - type ImageInfoResponse = 10506 - | { 10507 - format: 'image/svg+xml'; 10508 - } 10509 - | { 10510 - format: string; 10511 - fileSize: number; 10512 - width: number; 10513 - height: number; 10514 - }; 10515 - type ImageTransform = { 10516 - width?: number; 10517 - height?: number; 10518 - background?: string; 10519 - blur?: number; 10520 - border?: 10521 - | { 10522 - color?: string; 10523 - width?: number; 10524 - } 10525 - | { 10526 - top?: number; 10527 - bottom?: number; 10528 - left?: number; 10529 - right?: number; 10530 - }; 10531 - brightness?: number; 10532 - contrast?: number; 10533 - fit?: 'scale-down' | 'contain' | 'pad' | 'squeeze' | 'cover' | 'crop'; 10534 - flip?: 'h' | 'v' | 'hv'; 10535 - gamma?: number; 10536 - segment?: 'foreground'; 10537 - gravity?: 10538 - | 'face' 10539 - | 'left' 10540 - | 'right' 10541 - | 'top' 10542 - | 'bottom' 10543 - | 'center' 10544 - | 'auto' 10545 - | 'entropy' 10546 - | { 10547 - x?: number; 10548 - y?: number; 10549 - mode: 'remainder' | 'box-center'; 10550 - }; 10551 - rotate?: 0 | 90 | 180 | 270; 10552 - saturation?: number; 10553 - sharpen?: number; 10554 - trim?: 10555 - | 'border' 10556 - | { 10557 - top?: number; 10558 - bottom?: number; 10559 - left?: number; 10560 - right?: number; 10561 - width?: number; 10562 - height?: number; 10563 - border?: 10564 - | boolean 10565 - | { 10566 - color?: string; 10567 - tolerance?: number; 10568 - keep?: number; 10569 - }; 10570 - }; 10571 - }; 10572 - type ImageDrawOptions = { 10573 - opacity?: number; 10574 - repeat?: boolean | string; 10575 - top?: number; 10576 - left?: number; 10577 - bottom?: number; 10578 - right?: number; 10579 - }; 10580 - type ImageInputOptions = { 10581 - encoding?: 'base64'; 10582 - }; 10583 - type ImageOutputOptions = { 10584 - format: 'image/jpeg' | 'image/png' | 'image/gif' | 'image/webp' | 'image/avif' | 'rgb' | 'rgba'; 10585 - quality?: number; 10586 - background?: string; 10587 - anim?: boolean; 10588 - }; 10589 - interface ImagesBinding { 10590 - /** 10591 - * Get image metadata (type, width and height) 10592 - * @throws {@link ImagesError} with code 9412 if input is not an image 10593 - * @param stream The image bytes 10594 - */ 10595 - info(stream: ReadableStream<Uint8Array>, options?: ImageInputOptions): Promise<ImageInfoResponse>; 10596 - /** 10597 - * Begin applying a series of transformations to an image 10598 - * @param stream The image bytes 10599 - * @returns A transform handle 10600 - */ 10601 - input(stream: ReadableStream<Uint8Array>, options?: ImageInputOptions): ImageTransformer; 10602 - } 10603 - interface ImageTransformer { 10604 - /** 10605 - * Apply transform next, returning a transform handle. 10606 - * You can then apply more transformations, draw, or retrieve the output. 10607 - * @param transform 10608 - */ 10609 - transform(transform: ImageTransform): ImageTransformer; 10610 - /** 10611 - * Draw an image on this transformer, returning a transform handle. 10612 - * You can then apply more transformations, draw, or retrieve the output. 10613 - * @param image The image (or transformer that will give the image) to draw 10614 - * @param options The options configuring how to draw the image 10615 - */ 10616 - draw(image: ReadableStream<Uint8Array> | ImageTransformer, options?: ImageDrawOptions): ImageTransformer; 10617 - /** 10618 - * Retrieve the image that results from applying the transforms to the 10619 - * provided input 10620 - * @param options Options that apply to the output e.g. output format 10621 - */ 10622 - output(options: ImageOutputOptions): Promise<ImageTransformationResult>; 10623 - } 10624 - type ImageTransformationOutputOptions = { 10625 - encoding?: 'base64'; 10626 - }; 10627 - interface ImageTransformationResult { 10628 - /** 10629 - * The image as a response, ready to store in cache or return to users 10630 - */ 10631 - response(): Response; 10632 - /** 10633 - * The content type of the returned image 10634 - */ 10635 - contentType(): string; 10636 - /** 10637 - * The bytes of the response 10638 - */ 10639 - image(options?: ImageTransformationOutputOptions): ReadableStream<Uint8Array>; 10640 - } 10641 - interface ImagesError extends Error { 10642 - readonly code: number; 10643 - readonly message: string; 10644 - readonly stack?: string; 10645 - } 10646 - /** 10647 - * Media binding for transforming media streams. 10648 - * Provides the entry point for media transformation operations. 10649 - */ 10650 - interface MediaBinding { 10651 - /** 10652 - * Creates a media transformer from an input stream. 10653 - * @param media - The input media bytes 10654 - * @returns A MediaTransformer instance for applying transformations 10655 - */ 10656 - input(media: ReadableStream<Uint8Array>): MediaTransformer; 10657 - } 10658 - /** 10659 - * Media transformer for applying transformation operations to media content. 10660 - * Handles sizing, fitting, and other input transformation parameters. 10661 - */ 10662 - interface MediaTransformer { 10663 - /** 10664 - * Applies transformation options to the media content. 10665 - * @param transform - Configuration for how the media should be transformed 10666 - * @returns A generator for producing the transformed media output 10667 - */ 10668 - transform(transform: MediaTransformationInputOptions): MediaTransformationGenerator; 10669 - } 10670 - /** 10671 - * Generator for producing media transformation results. 10672 - * Configures the output format and parameters for the transformed media. 10673 - */ 10674 - interface MediaTransformationGenerator { 10675 - /** 10676 - * Generates the final media output with specified options. 10677 - * @param output - Configuration for the output format and parameters 10678 - * @returns The final transformation result containing the transformed media 10679 - */ 10680 - output(output: MediaTransformationOutputOptions): MediaTransformationResult; 10681 - } 10682 - /** 10683 - * Result of a media transformation operation. 10684 - * Provides multiple ways to access the transformed media content. 10685 - */ 10686 - interface MediaTransformationResult { 10687 - /** 10688 - * Returns the transformed media as a readable stream of bytes. 10689 - * @returns A stream containing the transformed media data 10690 - */ 10691 - media(): ReadableStream<Uint8Array>; 10692 - /** 10693 - * Returns the transformed media as an HTTP response object. 10694 - * @returns The transformed media as a Response, ready to store in cache or return to users 10695 - */ 10696 - response(): Response; 10697 - /** 10698 - * Returns the MIME type of the transformed media. 10699 - * @returns The content type string (e.g., 'image/jpeg', 'video/mp4') 10700 - */ 10701 - contentType(): string; 10702 - } 10703 - /** 10704 - * Configuration options for transforming media input. 10705 - * Controls how the media should be resized and fitted. 10706 - */ 10707 - type MediaTransformationInputOptions = { 10708 - /** How the media should be resized to fit the specified dimensions */ 10709 - fit?: 'contain' | 'cover' | 'scale-down'; 10710 - /** Target width in pixels */ 10711 - width?: number; 10712 - /** Target height in pixels */ 10713 - height?: number; 10714 - }; 10715 - /** 10716 - * Configuration options for Media Transformations output. 10717 - * Controls the format, timing, and type of the generated output. 10718 - */ 10719 - type MediaTransformationOutputOptions = { 10720 - /** 10721 - * Output mode determining the type of media to generate 10722 - */ 10723 - mode?: 'video' | 'spritesheet' | 'frame' | 'audio'; 10724 - /** Whether to include audio in the output */ 10725 - audio?: boolean; 10726 - /** 10727 - * Starting timestamp for frame extraction or start time for clips. (e.g. '2s'). 10728 - */ 10729 - time?: string; 10730 - /** 10731 - * Duration for video clips, audio extraction, and spritesheet generation (e.g. '5s'). 10732 - */ 10733 - duration?: string; 10734 - /** 10735 - * Number of frames in the spritesheet. 10736 - */ 10737 - imageCount?: number; 10738 - /** 10739 - * Output format for the generated media. 10740 - */ 10741 - format?: 'jpg' | 'png' | 'm4a'; 10742 - }; 10743 - /** 10744 - * Error object for media transformation operations. 10745 - * Extends the standard Error interface with additional media-specific information. 10746 - */ 10747 - interface MediaError extends Error { 10748 - readonly code: number; 10749 - readonly message: string; 10750 - readonly stack?: string; 10751 - } 10752 - declare module 'cloudflare:node' { 10753 - interface NodeStyleServer { 10754 - listen(...args: unknown[]): this; 10755 - address(): { 10756 - port?: number | null | undefined; 10757 - }; 10758 - } 10759 - export function httpServerHandler(port: number): ExportedHandler; 10760 - export function httpServerHandler(options: { port: number }): ExportedHandler; 10761 - export function httpServerHandler(server: NodeStyleServer): ExportedHandler; 10762 - } 10763 - type Params<P extends string = any> = Record<P, string | string[]>; 10764 - type EventContext<Env, P extends string, Data> = { 10765 - request: Request<unknown, IncomingRequestCfProperties<unknown>>; 10766 - functionPath: string; 10767 - waitUntil: (promise: Promise<any>) => void; 10768 - passThroughOnException: () => void; 10769 - next: (input?: Request | string, init?: RequestInit) => Promise<Response>; 10770 - env: Env & { 10771 - ASSETS: { 10772 - fetch: typeof fetch; 10773 - }; 10774 - }; 10775 - params: Params<P>; 10776 - data: Data; 10777 - }; 10778 - type PagesFunction< 10779 - Env = unknown, 10780 - Params extends string = any, 10781 - Data extends Record<string, unknown> = Record<string, unknown>, 10782 - > = (context: EventContext<Env, Params, Data>) => Response | Promise<Response>; 10783 - type EventPluginContext<Env, P extends string, Data, PluginArgs> = { 10784 - request: Request<unknown, IncomingRequestCfProperties<unknown>>; 10785 - functionPath: string; 10786 - waitUntil: (promise: Promise<any>) => void; 10787 - passThroughOnException: () => void; 10788 - next: (input?: Request | string, init?: RequestInit) => Promise<Response>; 10789 - env: Env & { 10790 - ASSETS: { 10791 - fetch: typeof fetch; 10792 - }; 10793 - }; 10794 - params: Params<P>; 10795 - data: Data; 10796 - pluginArgs: PluginArgs; 10797 - }; 10798 - type PagesPluginFunction< 10799 - Env = unknown, 10800 - Params extends string = any, 10801 - Data extends Record<string, unknown> = Record<string, unknown>, 10802 - PluginArgs = unknown, 10803 - > = (context: EventPluginContext<Env, Params, Data, PluginArgs>) => Response | Promise<Response>; 10804 - declare module 'assets:*' { 10805 - export const onRequest: PagesFunction; 10806 - } 10807 - // Copyright (c) 2022-2023 Cloudflare, Inc. 10808 - // Licensed under the Apache 2.0 license found in the LICENSE file or at: 10809 - // https://opensource.org/licenses/Apache-2.0 10810 - declare module 'cloudflare:pipelines' { 10811 - export abstract class PipelineTransformationEntrypoint< 10812 - Env = unknown, 10813 - I extends PipelineRecord = PipelineRecord, 10814 - O extends PipelineRecord = PipelineRecord, 10815 - > { 10816 - protected env: Env; 10817 - protected ctx: ExecutionContext; 10818 - constructor(ctx: ExecutionContext, env: Env); 10819 - /** 10820 - * run receives an array of PipelineRecord which can be 10821 - * transformed and returned to the pipeline 10822 - * @param records Incoming records from the pipeline to be transformed 10823 - * @param metadata Information about the specific pipeline calling the transformation entrypoint 10824 - * @returns A promise containing the transformed PipelineRecord array 10825 - */ 10826 - public run(records: I[], metadata: PipelineBatchMetadata): Promise<O[]>; 10827 - } 10828 - export type PipelineRecord = Record<string, unknown>; 10829 - export type PipelineBatchMetadata = { 10830 - pipelineId: string; 10831 - pipelineName: string; 10832 - }; 10833 - export interface Pipeline<T extends PipelineRecord = PipelineRecord> { 10834 - /** 10835 - * The Pipeline interface represents the type of a binding to a Pipeline 10836 - * 10837 - * @param records The records to send to the pipeline 10838 - */ 10839 - send(records: T[]): Promise<void>; 10840 - } 10841 - } 10842 - // PubSubMessage represents an incoming PubSub message. 10843 - // The message includes metadata about the broker, the client, and the payload 10844 - // itself. 10845 - // https://developers.cloudflare.com/pub-sub/ 10846 - interface PubSubMessage { 10847 - // Message ID 10848 - readonly mid: number; 10849 - // MQTT broker FQDN in the form mqtts://BROKER.NAMESPACE.cloudflarepubsub.com:PORT 10850 - readonly broker: string; 10851 - // The MQTT topic the message was sent on. 10852 - readonly topic: string; 10853 - // The client ID of the client that published this message. 10854 - readonly clientId: string; 10855 - // The unique identifier (JWT ID) used by the client to authenticate, if token 10856 - // auth was used. 10857 - readonly jti?: string; 10858 - // A Unix timestamp (seconds from Jan 1, 1970), set when the Pub/Sub Broker 10859 - // received the message from the client. 10860 - readonly receivedAt: number; 10861 - // An (optional) string with the MIME type of the payload, if set by the 10862 - // client. 10863 - readonly contentType: string; 10864 - // Set to 1 when the payload is a UTF-8 string 10865 - // https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901063 10866 - readonly payloadFormatIndicator: number; 10867 - // Pub/Sub (MQTT) payloads can be UTF-8 strings, or byte arrays. 10868 - // You can use payloadFormatIndicator to inspect this before decoding. 10869 - payload: string | Uint8Array; 10870 - } 10871 - // JsonWebKey extended by kid parameter 10872 - interface JsonWebKeyWithKid extends JsonWebKey { 10873 - // Key Identifier of the JWK 10874 - readonly kid: string; 10875 - } 10876 - interface RateLimitOptions { 10877 - key: string; 10878 - } 10879 - interface RateLimitOutcome { 10880 - success: boolean; 10881 - } 10882 - interface RateLimit { 10883 - /** 10884 - * Rate limit a request based on the provided options. 10885 - * @see https://developers.cloudflare.com/workers/runtime-apis/bindings/rate-limit/ 10886 - * @returns A promise that resolves with the outcome of the rate limit. 10887 - */ 10888 - limit(options: RateLimitOptions): Promise<RateLimitOutcome>; 10889 - } 10890 - // Namespace for RPC utility types. Unfortunately, we can't use a `module` here as these types need 10891 - // to referenced by `Fetcher`. This is included in the "importable" version of the types which 10892 - // strips all `module` blocks. 10893 - declare namespace Rpc { 10894 - // Branded types for identifying `WorkerEntrypoint`/`DurableObject`/`Target`s. 10895 - // TypeScript uses *structural* typing meaning anything with the same shape as type `T` is a `T`. 10896 - // For the classes exported by `cloudflare:workers` we want *nominal* typing (i.e. we only want to 10897 - // accept `WorkerEntrypoint` from `cloudflare:workers`, not any other class with the same shape) 10898 - export const __RPC_STUB_BRAND: '__RPC_STUB_BRAND'; 10899 - export const __RPC_TARGET_BRAND: '__RPC_TARGET_BRAND'; 10900 - export const __WORKER_ENTRYPOINT_BRAND: '__WORKER_ENTRYPOINT_BRAND'; 10901 - export const __DURABLE_OBJECT_BRAND: '__DURABLE_OBJECT_BRAND'; 10902 - export const __WORKFLOW_ENTRYPOINT_BRAND: '__WORKFLOW_ENTRYPOINT_BRAND'; 10903 - export interface RpcTargetBranded { 10904 - [__RPC_TARGET_BRAND]: never; 10905 - } 10906 - export interface WorkerEntrypointBranded { 10907 - [__WORKER_ENTRYPOINT_BRAND]: never; 10908 - } 10909 - export interface DurableObjectBranded { 10910 - [__DURABLE_OBJECT_BRAND]: never; 10911 - } 10912 - export interface WorkflowEntrypointBranded { 10913 - [__WORKFLOW_ENTRYPOINT_BRAND]: never; 10914 - } 10915 - export type EntrypointBranded = WorkerEntrypointBranded | DurableObjectBranded | WorkflowEntrypointBranded; 10916 - // Types that can be used through `Stub`s 10917 - export type Stubable = RpcTargetBranded | ((...args: any[]) => any); 10918 - // Types that can be passed over RPC 10919 - // The reason for using a generic type here is to build a serializable subset of structured 10920 - // cloneable composite types. This allows types defined with the "interface" keyword to pass the 10921 - // serializable check as well. Otherwise, only types defined with the "type" keyword would pass. 10922 - type Serializable<T> = 10923 - // Structured cloneables 10924 - | BaseType 10925 - // Structured cloneable composites 10926 - | Map< 10927 - T extends Map<infer U, unknown> ? Serializable<U> : never, 10928 - T extends Map<unknown, infer U> ? Serializable<U> : never 10929 - > 10930 - | Set<T extends Set<infer U> ? Serializable<U> : never> 10931 - | ReadonlyArray<T extends ReadonlyArray<infer U> ? Serializable<U> : never> 10932 - | { 10933 - [K in keyof T]: K extends number | string ? Serializable<T[K]> : never; 10934 - } 10935 - // Special types 10936 - | Stub<Stubable> 10937 - // Serialized as stubs, see `Stubify` 10938 - | Stubable; 10939 - // Base type for all RPC stubs, including common memory management methods. 10940 - // `T` is used as a marker type for unwrapping `Stub`s later. 10941 - interface StubBase<T extends Stubable> extends Disposable { 10942 - [__RPC_STUB_BRAND]: T; 10943 - dup(): this; 10944 - } 10945 - export type Stub<T extends Stubable> = Provider<T> & StubBase<T>; 10946 - // This represents all the types that can be sent as-is over an RPC boundary 10947 - type BaseType = 10948 - | void 10949 - | undefined 10950 - | null 10951 - | boolean 10952 - | number 10953 - | bigint 10954 - | string 10955 - | TypedArray 10956 - | ArrayBuffer 10957 - | DataView 10958 - | Date 10959 - | Error 10960 - | RegExp 10961 - | ReadableStream<Uint8Array> 10962 - | WritableStream<Uint8Array> 10963 - | Request 10964 - | Response 10965 - | Headers; 10966 - // Recursively rewrite all `Stubable` types with `Stub`s 10967 - // prettier-ignore 10968 - type Stubify<T> = T extends Stubable ? Stub<T> : T extends Map<infer K, infer V> ? Map<Stubify<K>, Stubify<V>> : T extends Set<infer V> ? Set<Stubify<V>> : T extends Array<infer V> ? Array<Stubify<V>> : T extends ReadonlyArray<infer V> ? ReadonlyArray<Stubify<V>> : T extends BaseType ? T : T extends { 10969 - [key: string | number]: any; 10970 - } ? { 10971 - [K in keyof T]: Stubify<T[K]>; 10972 - } : T; 10973 - // Recursively rewrite all `Stub<T>`s with the corresponding `T`s. 10974 - // Note we use `StubBase` instead of `Stub` here to avoid circular dependencies: 10975 - // `Stub` depends on `Provider`, which depends on `Unstubify`, which would depend on `Stub`. 10976 - // prettier-ignore 10977 - type Unstubify<T> = T extends StubBase<infer V> ? V : T extends Map<infer K, infer V> ? Map<Unstubify<K>, Unstubify<V>> : T extends Set<infer V> ? Set<Unstubify<V>> : T extends Array<infer V> ? Array<Unstubify<V>> : T extends ReadonlyArray<infer V> ? ReadonlyArray<Unstubify<V>> : T extends BaseType ? T : T extends { 10978 - [key: string | number]: unknown; 10979 - } ? { 10980 - [K in keyof T]: Unstubify<T[K]>; 10981 - } : T; 10982 - type UnstubifyAll<A extends any[]> = { 10983 - [I in keyof A]: Unstubify<A[I]>; 10984 - }; 10985 - // Utility type for adding `Provider`/`Disposable`s to `object` types only. 10986 - // Note `unknown & T` is equivalent to `T`. 10987 - type MaybeProvider<T> = T extends object ? Provider<T> : unknown; 10988 - type MaybeDisposable<T> = T extends object ? Disposable : unknown; 10989 - // Type for method return or property on an RPC interface. 10990 - // - Stubable types are replaced by stubs. 10991 - // - Serializable types are passed by value, with stubable types replaced by stubs 10992 - // and a top-level `Disposer`. 10993 - // Everything else can't be passed over PRC. 10994 - // Technically, we use custom thenables here, but they quack like `Promise`s. 10995 - // Intersecting with `(Maybe)Provider` allows pipelining. 10996 - // prettier-ignore 10997 - type Result<R> = R extends Stubable ? Promise<Stub<R>> & Provider<R> : R extends Serializable<R> ? Promise<Stubify<R> & MaybeDisposable<R>> & MaybeProvider<R> : never; 10998 - // Type for method or property on an RPC interface. 10999 - // For methods, unwrap `Stub`s in parameters, and rewrite returns to be `Result`s. 11000 - // Unwrapping `Stub`s allows calling with `Stubable` arguments. 11001 - // For properties, rewrite types to be `Result`s. 11002 - // In each case, unwrap `Promise`s. 11003 - type MethodOrProperty<V> = V extends (...args: infer P) => infer R 11004 - ? (...args: UnstubifyAll<P>) => Result<Awaited<R>> 11005 - : Result<Awaited<V>>; 11006 - // Type for the callable part of an `Provider` if `T` is callable. 11007 - // This is intersected with methods/properties. 11008 - type MaybeCallableProvider<T> = T extends (...args: any[]) => any ? MethodOrProperty<T> : unknown; 11009 - // Base type for all other types providing RPC-like interfaces. 11010 - // Rewrites all methods/properties to be `MethodOrProperty`s, while preserving callable types. 11011 - // `Reserved` names (e.g. stub method names like `dup()`) and symbols can't be accessed over RPC. 11012 - export type Provider<T extends object, Reserved extends string = never> = MaybeCallableProvider<T> & 11013 - Pick< 11014 - { 11015 - [K in keyof T]: MethodOrProperty<T[K]>; 11016 - }, 11017 - Exclude<keyof T, Reserved | symbol | keyof StubBase<never>> 11018 - >; 11019 - } 11020 - declare namespace Cloudflare { 11021 - // Type of `env`. 11022 - // 11023 - // The specific project can extend `Env` by redeclaring it in project-specific files. Typescript 11024 - // will merge all declarations. 11025 - // 11026 - // You can use `wrangler types` to generate the `Env` type automatically. 11027 - interface Env {} 11028 - // Project-specific parameters used to inform types. 11029 - // 11030 - // This interface is, again, intended to be declared in project-specific files, and then that 11031 - // declaration will be merged with this one. 11032 - // 11033 - // A project should have a declaration like this: 11034 - // 11035 - // interface GlobalProps { 11036 - // // Declares the main module's exports. Used to populate Cloudflare.Exports aka the type 11037 - // // of `ctx.exports`. 11038 - // mainModule: typeof import("my-main-module"); 11039 - // 11040 - // // Declares which of the main module's exports are configured with durable storage, and 11041 - // // thus should behave as Durable Object namsepace bindings. 11042 - // durableNamespaces: "MyDurableObject" | "AnotherDurableObject"; 11043 - // } 11044 - // 11045 - // You can use `wrangler types` to generate `GlobalProps` automatically. 11046 - interface GlobalProps {} 11047 - // Evaluates to the type of a property in GlobalProps, defaulting to `Default` if it is not 11048 - // present. 11049 - type GlobalProp<K extends string, Default> = K extends keyof GlobalProps ? GlobalProps[K] : Default; 11050 - // The type of the program's main module exports, if known. Requires `GlobalProps` to declare the 11051 - // `mainModule` property. 11052 - type MainModule = GlobalProp<'mainModule', {}>; 11053 - // The type of ctx.exports, which contains loopback bindings for all top-level exports. 11054 - type Exports = { 11055 - [K in keyof MainModule]: LoopbackForExport<MainModule[K]> & 11056 - // If the export is listed in `durableNamespaces`, then it is also a 11057 - // DurableObjectNamespace. 11058 - (K extends GlobalProp<'durableNamespaces', never> 11059 - ? MainModule[K] extends new (...args: any[]) => infer DoInstance 11060 - ? DoInstance extends Rpc.DurableObjectBranded 11061 - ? DurableObjectNamespace<DoInstance> 11062 - : DurableObjectNamespace<undefined> 11063 - : DurableObjectNamespace<undefined> 11064 - : {}); 11065 - }; 11066 - } 11067 - declare namespace CloudflareWorkersModule { 11068 - export type RpcStub<T extends Rpc.Stubable> = Rpc.Stub<T>; 11069 - export const RpcStub: { 11070 - new <T extends Rpc.Stubable>(value: T): Rpc.Stub<T>; 11071 - }; 11072 - export abstract class RpcTarget implements Rpc.RpcTargetBranded { 11073 - [Rpc.__RPC_TARGET_BRAND]: never; 11074 - } 11075 - // `protected` fields don't appear in `keyof`s, so can't be accessed over RPC 11076 - export abstract class WorkerEntrypoint<Env = Cloudflare.Env, Props = {}> 11077 - implements Rpc.WorkerEntrypointBranded 11078 - { 11079 - [Rpc.__WORKER_ENTRYPOINT_BRAND]: never; 11080 - protected ctx: ExecutionContext<Props>; 11081 - protected env: Env; 11082 - constructor(ctx: ExecutionContext, env: Env); 11083 - email?(message: ForwardableEmailMessage): void | Promise<void>; 11084 - fetch?(request: Request): Response | Promise<Response>; 11085 - queue?(batch: MessageBatch<unknown>): void | Promise<void>; 11086 - scheduled?(controller: ScheduledController): void | Promise<void>; 11087 - tail?(events: TraceItem[]): void | Promise<void>; 11088 - tailStream?( 11089 - event: TailStream.TailEvent<TailStream.Onset>, 11090 - ): TailStream.TailEventHandlerType | Promise<TailStream.TailEventHandlerType>; 11091 - test?(controller: TestController): void | Promise<void>; 11092 - trace?(traces: TraceItem[]): void | Promise<void>; 11093 - } 11094 - export abstract class DurableObject<Env = Cloudflare.Env, Props = {}> implements Rpc.DurableObjectBranded { 11095 - [Rpc.__DURABLE_OBJECT_BRAND]: never; 11096 - protected ctx: DurableObjectState<Props>; 11097 - protected env: Env; 11098 - constructor(ctx: DurableObjectState, env: Env); 11099 - alarm?(alarmInfo?: AlarmInvocationInfo): void | Promise<void>; 11100 - fetch?(request: Request): Response | Promise<Response>; 11101 - webSocketMessage?(ws: WebSocket, message: string | ArrayBuffer): void | Promise<void>; 11102 - webSocketClose?(ws: WebSocket, code: number, reason: string, wasClean: boolean): void | Promise<void>; 11103 - webSocketError?(ws: WebSocket, error: unknown): void | Promise<void>; 11104 - } 11105 - export type WorkflowDurationLabel = 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year'; 11106 - export type WorkflowSleepDuration = `${number} ${WorkflowDurationLabel}${'s' | ''}` | number; 11107 - export type WorkflowDelayDuration = WorkflowSleepDuration; 11108 - export type WorkflowTimeoutDuration = WorkflowSleepDuration; 11109 - export type WorkflowRetentionDuration = WorkflowSleepDuration; 11110 - export type WorkflowBackoff = 'constant' | 'linear' | 'exponential'; 11111 - export type WorkflowStepConfig = { 11112 - retries?: { 11113 - limit: number; 11114 - delay: WorkflowDelayDuration | number; 11115 - backoff?: WorkflowBackoff; 11116 - }; 11117 - timeout?: WorkflowTimeoutDuration | number; 11118 - }; 11119 - export type WorkflowEvent<T> = { 11120 - payload: Readonly<T>; 11121 - timestamp: Date; 11122 - instanceId: string; 11123 - }; 11124 - export type WorkflowStepEvent<T> = { 11125 - payload: Readonly<T>; 11126 - timestamp: Date; 11127 - type: string; 11128 - }; 11129 - export abstract class WorkflowStep { 11130 - do<T extends Rpc.Serializable<T>>(name: string, callback: () => Promise<T>): Promise<T>; 11131 - do<T extends Rpc.Serializable<T>>( 11132 - name: string, 11133 - config: WorkflowStepConfig, 11134 - callback: () => Promise<T>, 11135 - ): Promise<T>; 11136 - sleep: (name: string, duration: WorkflowSleepDuration) => Promise<void>; 11137 - sleepUntil: (name: string, timestamp: Date | number) => Promise<void>; 11138 - waitForEvent<T extends Rpc.Serializable<T>>( 11139 - name: string, 11140 - options: { 11141 - type: string; 11142 - timeout?: WorkflowTimeoutDuration | number; 11143 - }, 11144 - ): Promise<WorkflowStepEvent<T>>; 11145 - } 11146 - export abstract class WorkflowEntrypoint<Env = unknown, T extends Rpc.Serializable<T> | unknown = unknown> 11147 - implements Rpc.WorkflowEntrypointBranded 11148 - { 11149 - [Rpc.__WORKFLOW_ENTRYPOINT_BRAND]: never; 11150 - protected ctx: ExecutionContext; 11151 - protected env: Env; 11152 - constructor(ctx: ExecutionContext, env: Env); 11153 - run(event: Readonly<WorkflowEvent<T>>, step: WorkflowStep): Promise<unknown>; 11154 - } 11155 - export function waitUntil(promise: Promise<unknown>): void; 11156 - export function withEnv(newEnv: unknown, fn: () => unknown): unknown; 11157 - export function withExports(newExports: unknown, fn: () => unknown): unknown; 11158 - export function withEnvAndExports(newEnv: unknown, newExports: unknown, fn: () => unknown): unknown; 11159 - export const env: Cloudflare.Env; 11160 - export const exports: Cloudflare.Exports; 11161 - } 11162 - declare module 'cloudflare:workers' { 11163 - export = CloudflareWorkersModule; 11164 - } 11165 - interface SecretsStoreSecret { 11166 - /** 11167 - * Get a secret from the Secrets Store, returning a string of the secret value 11168 - * if it exists, or throws an error if it does not exist 11169 - */ 11170 - get(): Promise<string>; 11171 - } 11172 - declare module 'cloudflare:sockets' { 11173 - function _connect(address: string | SocketAddress, options?: SocketOptions): Socket; 11174 - export { _connect as connect }; 11175 - } 11176 - type MarkdownDocument = { 11177 - name: string; 11178 - blob: Blob; 11179 - }; 11180 - type ConversionResponse = 11181 - | { 11182 - name: string; 11183 - mimeType: string; 11184 - format: 'markdown'; 11185 - tokens: number; 11186 - data: string; 11187 - } 11188 - | { 11189 - name: string; 11190 - mimeType: string; 11191 - format: 'error'; 11192 - error: string; 11193 - }; 11194 - type ImageConversionOptions = { 11195 - descriptionLanguage?: 'en' | 'es' | 'fr' | 'it' | 'pt' | 'de'; 11196 - }; 11197 - type EmbeddedImageConversionOptions = ImageConversionOptions & { 11198 - convert?: boolean; 11199 - maxConvertedImages?: number; 11200 - }; 11201 - type ConversionOptions = { 11202 - html?: { 11203 - images?: EmbeddedImageConversionOptions & { 11204 - convertOGImage?: boolean; 11205 - }; 11206 - }; 11207 - docx?: { 11208 - images?: EmbeddedImageConversionOptions; 11209 - }; 11210 - image?: ImageConversionOptions; 11211 - pdf?: { 11212 - images?: EmbeddedImageConversionOptions; 11213 - metadata?: boolean; 11214 - }; 11215 - }; 11216 - type ConversionRequestOptions = { 11217 - gateway?: GatewayOptions; 11218 - extraHeaders?: object; 11219 - conversionOptions?: ConversionOptions; 11220 - }; 11221 - type SupportedFileFormat = { 11222 - mimeType: string; 11223 - extension: string; 11224 - }; 11225 - declare abstract class ToMarkdownService { 11226 - transform(files: MarkdownDocument[], options?: ConversionRequestOptions): Promise<ConversionResponse[]>; 11227 - transform(files: MarkdownDocument, options?: ConversionRequestOptions): Promise<ConversionResponse>; 11228 - supported(): Promise<SupportedFileFormat[]>; 11229 - } 11230 - declare namespace TailStream { 11231 - interface Header { 11232 - readonly name: string; 11233 - readonly value: string; 11234 - } 11235 - interface FetchEventInfo { 11236 - readonly type: 'fetch'; 11237 - readonly method: string; 11238 - readonly url: string; 11239 - readonly cfJson?: object; 11240 - readonly headers: Header[]; 11241 - } 11242 - interface JsRpcEventInfo { 11243 - readonly type: 'jsrpc'; 11244 - } 11245 - interface ScheduledEventInfo { 11246 - readonly type: 'scheduled'; 11247 - readonly scheduledTime: Date; 11248 - readonly cron: string; 11249 - } 11250 - interface AlarmEventInfo { 11251 - readonly type: 'alarm'; 11252 - readonly scheduledTime: Date; 11253 - } 11254 - interface QueueEventInfo { 11255 - readonly type: 'queue'; 11256 - readonly queueName: string; 11257 - readonly batchSize: number; 11258 - } 11259 - interface EmailEventInfo { 11260 - readonly type: 'email'; 11261 - readonly mailFrom: string; 11262 - readonly rcptTo: string; 11263 - readonly rawSize: number; 11264 - } 11265 - interface TraceEventInfo { 11266 - readonly type: 'trace'; 11267 - readonly traces: (string | null)[]; 11268 - } 11269 - interface HibernatableWebSocketEventInfoMessage { 11270 - readonly type: 'message'; 11271 - } 11272 - interface HibernatableWebSocketEventInfoError { 11273 - readonly type: 'error'; 11274 - } 11275 - interface HibernatableWebSocketEventInfoClose { 11276 - readonly type: 'close'; 11277 - readonly code: number; 11278 - readonly wasClean: boolean; 11279 - } 11280 - interface HibernatableWebSocketEventInfo { 11281 - readonly type: 'hibernatableWebSocket'; 11282 - readonly info: 11283 - | HibernatableWebSocketEventInfoClose 11284 - | HibernatableWebSocketEventInfoError 11285 - | HibernatableWebSocketEventInfoMessage; 11286 - } 11287 - interface CustomEventInfo { 11288 - readonly type: 'custom'; 11289 - } 11290 - interface FetchResponseInfo { 11291 - readonly type: 'fetch'; 11292 - readonly statusCode: number; 11293 - } 11294 - type EventOutcome = 11295 - | 'ok' 11296 - | 'canceled' 11297 - | 'exception' 11298 - | 'unknown' 11299 - | 'killSwitch' 11300 - | 'daemonDown' 11301 - | 'exceededCpu' 11302 - | 'exceededMemory' 11303 - | 'loadShed' 11304 - | 'responseStreamDisconnected' 11305 - | 'scriptNotFound'; 11306 - interface ScriptVersion { 11307 - readonly id: string; 11308 - readonly tag?: string; 11309 - readonly message?: string; 11310 - } 11311 - interface Onset { 11312 - readonly type: 'onset'; 11313 - readonly attributes: Attribute[]; 11314 - // id for the span being opened by this Onset event. 11315 - readonly spanId: string; 11316 - readonly dispatchNamespace?: string; 11317 - readonly entrypoint?: string; 11318 - readonly executionModel: string; 11319 - readonly scriptName?: string; 11320 - readonly scriptTags?: string[]; 11321 - readonly scriptVersion?: ScriptVersion; 11322 - readonly info: 11323 - | FetchEventInfo 11324 - | JsRpcEventInfo 11325 - | ScheduledEventInfo 11326 - | AlarmEventInfo 11327 - | QueueEventInfo 11328 - | EmailEventInfo 11329 - | TraceEventInfo 11330 - | HibernatableWebSocketEventInfo 11331 - | CustomEventInfo; 11332 - } 11333 - interface Outcome { 11334 - readonly type: 'outcome'; 11335 - readonly outcome: EventOutcome; 11336 - readonly cpuTime: number; 11337 - readonly wallTime: number; 11338 - } 11339 - interface SpanOpen { 11340 - readonly type: 'spanOpen'; 11341 - readonly name: string; 11342 - // id for the span being opened by this SpanOpen event. 11343 - readonly spanId: string; 11344 - readonly info?: FetchEventInfo | JsRpcEventInfo | Attributes; 11345 - } 11346 - interface SpanClose { 11347 - readonly type: 'spanClose'; 11348 - readonly outcome: EventOutcome; 11349 - } 11350 - interface DiagnosticChannelEvent { 11351 - readonly type: 'diagnosticChannel'; 11352 - readonly channel: string; 11353 - readonly message: any; 11354 - } 11355 - interface Exception { 11356 - readonly type: 'exception'; 11357 - readonly name: string; 11358 - readonly message: string; 11359 - readonly stack?: string; 11360 - } 11361 - interface Log { 11362 - readonly type: 'log'; 11363 - readonly level: 'debug' | 'error' | 'info' | 'log' | 'warn'; 11364 - readonly message: object; 11365 - } 11366 - // This marks the worker handler return information. 11367 - // This is separate from Outcome because the worker invocation can live for a long time after 11368 - // returning. For example - Websockets that return an http upgrade response but then continue 11369 - // streaming information or SSE http connections. 11370 - interface Return { 11371 - readonly type: 'return'; 11372 - readonly info?: FetchResponseInfo; 11373 - } 11374 - interface Attribute { 11375 - readonly name: string; 11376 - readonly value: string | string[] | boolean | boolean[] | number | number[] | bigint | bigint[]; 11377 - } 11378 - interface Attributes { 11379 - readonly type: 'attributes'; 11380 - readonly info: Attribute[]; 11381 - } 11382 - type EventType = 11383 - | Onset 11384 - | Outcome 11385 - | SpanOpen 11386 - | SpanClose 11387 - | DiagnosticChannelEvent 11388 - | Exception 11389 - | Log 11390 - | Return 11391 - | Attributes; 11392 - // Context in which this trace event lives. 11393 - interface SpanContext { 11394 - // Single id for the entire top-level invocation 11395 - // This should be a new traceId for the first worker stage invoked in the eyeball request and then 11396 - // same-account service-bindings should reuse the same traceId but cross-account service-bindings 11397 - // should use a new traceId. 11398 - readonly traceId: string; 11399 - // spanId in which this event is handled 11400 - // for Onset and SpanOpen events this would be the parent span id 11401 - // for Outcome and SpanClose these this would be the span id of the opening Onset and SpanOpen events 11402 - // For Hibernate and Mark this would be the span under which they were emitted. 11403 - // spanId is not set ONLY if: 11404 - // 1. This is an Onset event 11405 - // 2. We are not inheriting any SpanContext. (e.g. this is a cross-account service binding or a new top-level invocation) 11406 - readonly spanId?: string; 11407 - } 11408 - interface TailEvent<Event extends EventType> { 11409 - // invocation id of the currently invoked worker stage. 11410 - // invocation id will always be unique to every Onset event and will be the same until the Outcome event. 11411 - readonly invocationId: string; 11412 - // Inherited spanContext for this event. 11413 - readonly spanContext: SpanContext; 11414 - readonly timestamp: Date; 11415 - readonly sequence: number; 11416 - readonly event: Event; 11417 - } 11418 - type TailEventHandler<Event extends EventType = EventType> = ( 11419 - event: TailEvent<Event>, 11420 - ) => void | Promise<void>; 11421 - type TailEventHandlerObject = { 11422 - outcome?: TailEventHandler<Outcome>; 11423 - spanOpen?: TailEventHandler<SpanOpen>; 11424 - spanClose?: TailEventHandler<SpanClose>; 11425 - diagnosticChannel?: TailEventHandler<DiagnosticChannelEvent>; 11426 - exception?: TailEventHandler<Exception>; 11427 - log?: TailEventHandler<Log>; 11428 - return?: TailEventHandler<Return>; 11429 - attributes?: TailEventHandler<Attributes>; 11430 - }; 11431 - type TailEventHandlerType = TailEventHandler | TailEventHandlerObject; 11432 - } 11433 - // Copyright (c) 2022-2023 Cloudflare, Inc. 11434 - // Licensed under the Apache 2.0 license found in the LICENSE file or at: 11435 - // https://opensource.org/licenses/Apache-2.0 11436 - /** 11437 - * Data types supported for holding vector metadata. 11438 - */ 11439 - type VectorizeVectorMetadataValue = string | number | boolean | string[]; 11440 - /** 11441 - * Additional information to associate with a vector. 11442 - */ 11443 - type VectorizeVectorMetadata = VectorizeVectorMetadataValue | Record<string, VectorizeVectorMetadataValue>; 11444 - type VectorFloatArray = Float32Array | Float64Array; 11445 - interface VectorizeError { 11446 - code?: number; 11447 - error: string; 11448 - } 11449 - /** 11450 - * Comparison logic/operation to use for metadata filtering. 11451 - * 11452 - * This list is expected to grow as support for more operations are released. 11453 - */ 11454 - type VectorizeVectorMetadataFilterOp = '$eq' | '$ne' | '$lt' | '$lte' | '$gt' | '$gte'; 11455 - type VectorizeVectorMetadataFilterCollectionOp = '$in' | '$nin'; 11456 - /** 11457 - * Filter criteria for vector metadata used to limit the retrieved query result set. 11458 - */ 11459 - type VectorizeVectorMetadataFilter = { 11460 - [field: string]: 11461 - | Exclude<VectorizeVectorMetadataValue, string[]> 11462 - | null 11463 - | { 11464 - [Op in VectorizeVectorMetadataFilterOp]?: Exclude<VectorizeVectorMetadataValue, string[]> | null; 11465 - } 11466 - | { 11467 - [Op in VectorizeVectorMetadataFilterCollectionOp]?: Exclude<VectorizeVectorMetadataValue, string[]>[]; 11468 - }; 11469 - }; 11470 - /** 11471 - * Supported distance metrics for an index. 11472 - * Distance metrics determine how other "similar" vectors are determined. 11473 - */ 11474 - type VectorizeDistanceMetric = 'euclidean' | 'cosine' | 'dot-product'; 11475 - /** 11476 - * Metadata return levels for a Vectorize query. 11477 - * 11478 - * Default to "none". 11479 - * 11480 - * @property all Full metadata for the vector return set, including all fields (including those un-indexed) without truncation. This is a more expensive retrieval, as it requires additional fetching & reading of un-indexed data. 11481 - * @property indexed Return all metadata fields configured for indexing in the vector return set. This level of retrieval is "free" in that no additional overhead is incurred returning this data. However, note that indexed metadata is subject to truncation (especially for larger strings). 11482 - * @property none No indexed metadata will be returned. 11483 - */ 11484 - type VectorizeMetadataRetrievalLevel = 'all' | 'indexed' | 'none'; 11485 - interface VectorizeQueryOptions { 11486 - topK?: number; 11487 - namespace?: string; 11488 - returnValues?: boolean; 11489 - returnMetadata?: boolean | VectorizeMetadataRetrievalLevel; 11490 - filter?: VectorizeVectorMetadataFilter; 11491 - } 11492 - /** 11493 - * Information about the configuration of an index. 11494 - */ 11495 - type VectorizeIndexConfig = 11496 - | { 11497 - dimensions: number; 11498 - metric: VectorizeDistanceMetric; 11499 - } 11500 - | { 11501 - preset: string; // keep this generic, as we'll be adding more presets in the future and this is only in a read capacity 11502 - }; 11503 - /** 11504 - * Metadata about an existing index. 11505 - * 11506 - * This type is exclusively for the Vectorize **beta** and will be deprecated once Vectorize RC is released. 11507 - * See {@link VectorizeIndexInfo} for its post-beta equivalent. 11508 - */ 11509 - interface VectorizeIndexDetails { 11510 - /** The unique ID of the index */ 11511 - readonly id: string; 11512 - /** The name of the index. */ 11513 - name: string; 11514 - /** (optional) A human readable description for the index. */ 11515 - description?: string; 11516 - /** The index configuration, including the dimension size and distance metric. */ 11517 - config: VectorizeIndexConfig; 11518 - /** The number of records containing vectors within the index. */ 11519 - vectorsCount: number; 11520 - } 11521 - /** 11522 - * Metadata about an existing index. 11523 - */ 11524 - interface VectorizeIndexInfo { 11525 - /** The number of records containing vectors within the index. */ 11526 - vectorCount: number; 11527 - /** Number of dimensions the index has been configured for. */ 11528 - dimensions: number; 11529 - /** ISO 8601 datetime of the last processed mutation on in the index. All changes before this mutation will be reflected in the index state. */ 11530 - processedUpToDatetime: number; 11531 - /** UUIDv4 of the last mutation processed by the index. All changes before this mutation will be reflected in the index state. */ 11532 - processedUpToMutation: number; 11533 - } 11534 - /** 11535 - * Represents a single vector value set along with its associated metadata. 11536 - */ 11537 - interface VectorizeVector { 11538 - /** The ID for the vector. This can be user-defined, and must be unique. It should uniquely identify the object, and is best set based on the ID of what the vector represents. */ 11539 - id: string; 11540 - /** The vector values */ 11541 - values: VectorFloatArray | number[]; 11542 - /** The namespace this vector belongs to. */ 11543 - namespace?: string; 11544 - /** Metadata associated with the vector. Includes the values of other fields and potentially additional details. */ 11545 - metadata?: Record<string, VectorizeVectorMetadata>; 11546 - } 11547 - /** 11548 - * Represents a matched vector for a query along with its score and (if specified) the matching vector information. 11549 - */ 11550 - type VectorizeMatch = Pick<Partial<VectorizeVector>, 'values'> & 11551 - Omit<VectorizeVector, 'values'> & { 11552 - /** The score or rank for similarity, when returned as a result */ 11553 - score: number; 11554 - }; 11555 - /** 11556 - * A set of matching {@link VectorizeMatch} for a particular query. 11557 - */ 11558 - interface VectorizeMatches { 11559 - matches: VectorizeMatch[]; 11560 - count: number; 11561 - } 11562 - /** 11563 - * Results of an operation that performed a mutation on a set of vectors. 11564 - * Here, `ids` is a list of vectors that were successfully processed. 11565 - * 11566 - * This type is exclusively for the Vectorize **beta** and will be deprecated once Vectorize RC is released. 11567 - * See {@link VectorizeAsyncMutation} for its post-beta equivalent. 11568 - */ 11569 - interface VectorizeVectorMutation { 11570 - /* List of ids of vectors that were successfully processed. */ 11571 - ids: string[]; 11572 - /* Total count of the number of processed vectors. */ 11573 - count: number; 11574 - } 11575 - /** 11576 - * Result type indicating a mutation on the Vectorize Index. 11577 - * Actual mutations are processed async where the `mutationId` is the unique identifier for the operation. 11578 - */ 11579 - interface VectorizeAsyncMutation { 11580 - /** The unique identifier for the async mutation operation containing the changeset. */ 11581 - mutationId: string; 11582 - } 11583 - /** 11584 - * A Vectorize Vector Search Index for querying vectors/embeddings. 11585 - * 11586 - * This type is exclusively for the Vectorize **beta** and will be deprecated once Vectorize RC is released. 11587 - * See {@link Vectorize} for its new implementation. 11588 - */ 11589 - declare abstract class VectorizeIndex { 11590 - /** 11591 - * Get information about the currently bound index. 11592 - * @returns A promise that resolves with information about the current index. 11593 - */ 11594 - public describe(): Promise<VectorizeIndexDetails>; 11595 - /** 11596 - * Use the provided vector to perform a similarity search across the index. 11597 - * @param vector Input vector that will be used to drive the similarity search. 11598 - * @param options Configuration options to massage the returned data. 11599 - * @returns A promise that resolves with matched and scored vectors. 11600 - */ 11601 - public query( 11602 - vector: VectorFloatArray | number[], 11603 - options?: VectorizeQueryOptions, 11604 - ): Promise<VectorizeMatches>; 11605 - /** 11606 - * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown. 11607 - * @param vectors List of vectors that will be inserted. 11608 - * @returns A promise that resolves with the ids & count of records that were successfully processed. 11609 - */ 11610 - public insert(vectors: VectorizeVector[]): Promise<VectorizeVectorMutation>; 11611 - /** 11612 - * Upsert a list of vectors into the index dataset. If a provided id exists, it will be replaced with the new values. 11613 - * @param vectors List of vectors that will be upserted. 11614 - * @returns A promise that resolves with the ids & count of records that were successfully processed. 11615 - */ 11616 - public upsert(vectors: VectorizeVector[]): Promise<VectorizeVectorMutation>; 11617 - /** 11618 - * Delete a list of vectors with a matching id. 11619 - * @param ids List of vector ids that should be deleted. 11620 - * @returns A promise that resolves with the ids & count of records that were successfully processed (and thus deleted). 11621 - */ 11622 - public deleteByIds(ids: string[]): Promise<VectorizeVectorMutation>; 11623 - /** 11624 - * Get a list of vectors with a matching id. 11625 - * @param ids List of vector ids that should be returned. 11626 - * @returns A promise that resolves with the raw unscored vectors matching the id set. 11627 - */ 11628 - public getByIds(ids: string[]): Promise<VectorizeVector[]>; 11629 - } 11630 - /** 11631 - * A Vectorize Vector Search Index for querying vectors/embeddings. 11632 - * 11633 - * Mutations in this version are async, returning a mutation id. 11634 - */ 11635 - declare abstract class Vectorize { 11636 - /** 11637 - * Get information about the currently bound index. 11638 - * @returns A promise that resolves with information about the current index. 11639 - */ 11640 - public describe(): Promise<VectorizeIndexInfo>; 11641 - /** 11642 - * Use the provided vector to perform a similarity search across the index. 11643 - * @param vector Input vector that will be used to drive the similarity search. 11644 - * @param options Configuration options to massage the returned data. 11645 - * @returns A promise that resolves with matched and scored vectors. 11646 - */ 11647 - public query( 11648 - vector: VectorFloatArray | number[], 11649 - options?: VectorizeQueryOptions, 11650 - ): Promise<VectorizeMatches>; 11651 - /** 11652 - * Use the provided vector-id to perform a similarity search across the index. 11653 - * @param vectorId Id for a vector in the index against which the index should be queried. 11654 - * @param options Configuration options to massage the returned data. 11655 - * @returns A promise that resolves with matched and scored vectors. 11656 - */ 11657 - public queryById(vectorId: string, options?: VectorizeQueryOptions): Promise<VectorizeMatches>; 11658 - /** 11659 - * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown. 11660 - * @param vectors List of vectors that will be inserted. 11661 - * @returns A promise that resolves with a unique identifier of a mutation containing the insert changeset. 11662 - */ 11663 - public insert(vectors: VectorizeVector[]): Promise<VectorizeAsyncMutation>; 11664 - /** 11665 - * Upsert a list of vectors into the index dataset. If a provided id exists, it will be replaced with the new values. 11666 - * @param vectors List of vectors that will be upserted. 11667 - * @returns A promise that resolves with a unique identifier of a mutation containing the upsert changeset. 11668 - */ 11669 - public upsert(vectors: VectorizeVector[]): Promise<VectorizeAsyncMutation>; 11670 - /** 11671 - * Delete a list of vectors with a matching id. 11672 - * @param ids List of vector ids that should be deleted. 11673 - * @returns A promise that resolves with a unique identifier of a mutation containing the delete changeset. 11674 - */ 11675 - public deleteByIds(ids: string[]): Promise<VectorizeAsyncMutation>; 11676 - /** 11677 - * Get a list of vectors with a matching id. 11678 - * @param ids List of vector ids that should be returned. 11679 - * @returns A promise that resolves with the raw unscored vectors matching the id set. 11680 - */ 11681 - public getByIds(ids: string[]): Promise<VectorizeVector[]>; 11682 - } 11683 - /** 11684 - * The interface for "version_metadata" binding 11685 - * providing metadata about the Worker Version using this binding. 11686 - */ 11687 - type WorkerVersionMetadata = { 11688 - /** The ID of the Worker Version using this binding */ 11689 - id: string; 11690 - /** The tag of the Worker Version using this binding */ 11691 - tag: string; 11692 - /** The timestamp of when the Worker Version was uploaded */ 11693 - timestamp: string; 11694 - }; 11695 - interface DynamicDispatchLimits { 11696 - /** 11697 - * Limit CPU time in milliseconds. 11698 - */ 11699 - cpuMs?: number; 11700 - /** 11701 - * Limit number of subrequests. 11702 - */ 11703 - subRequests?: number; 11704 - } 11705 - interface DynamicDispatchOptions { 11706 - /** 11707 - * Limit resources of invoked Worker script. 11708 - */ 11709 - limits?: DynamicDispatchLimits; 11710 - /** 11711 - * Arguments for outbound Worker script, if configured. 11712 - */ 11713 - outbound?: { 11714 - [key: string]: any; 11715 - }; 11716 - } 11717 - interface DispatchNamespace { 11718 - /** 11719 - * @param name Name of the Worker script. 11720 - * @param args Arguments to Worker script. 11721 - * @param options Options for Dynamic Dispatch invocation. 11722 - * @returns A Fetcher object that allows you to send requests to the Worker script. 11723 - * @throws If the Worker script does not exist in this dispatch namespace, an error will be thrown. 11724 - */ 11725 - get( 11726 - name: string, 11727 - args?: { 11728 - [key: string]: any; 11729 - }, 11730 - options?: DynamicDispatchOptions, 11731 - ): Fetcher; 11732 - } 11733 - declare module 'cloudflare:workflows' { 11734 - /** 11735 - * NonRetryableError allows for a user to throw a fatal error 11736 - * that makes a Workflow instance fail immediately without triggering a retry 11737 - */ 11738 - export class NonRetryableError extends Error { 11739 - public constructor(message: string, name?: string); 11740 - } 11741 - } 11742 - declare abstract class Workflow<PARAMS = unknown> { 11743 - /** 11744 - * Get a handle to an existing instance of the Workflow. 11745 - * @param id Id for the instance of this Workflow 11746 - * @returns A promise that resolves with a handle for the Instance 11747 - */ 11748 - public get(id: string): Promise<WorkflowInstance>; 11749 - /** 11750 - * Create a new instance and return a handle to it. If a provided id exists, an error will be thrown. 11751 - * @param options Options when creating an instance including id and params 11752 - * @returns A promise that resolves with a handle for the Instance 11753 - */ 11754 - public create(options?: WorkflowInstanceCreateOptions<PARAMS>): Promise<WorkflowInstance>; 11755 - /** 11756 - * Create a batch of instances and return handle for all of them. If a provided id exists, an error will be thrown. 11757 - * `createBatch` is limited at 100 instances at a time or when the RPC limit for the batch (1MiB) is reached. 11758 - * @param batch List of Options when creating an instance including name and params 11759 - * @returns A promise that resolves with a list of handles for the created instances. 11760 - */ 11761 - public createBatch(batch: WorkflowInstanceCreateOptions<PARAMS>[]): Promise<WorkflowInstance[]>; 11762 - } 11763 - type WorkflowDurationLabel = 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year'; 11764 - type WorkflowSleepDuration = `${number} ${WorkflowDurationLabel}${'s' | ''}` | number; 11765 - type WorkflowRetentionDuration = WorkflowSleepDuration; 11766 - interface WorkflowInstanceCreateOptions<PARAMS = unknown> { 11767 - /** 11768 - * An id for your Workflow instance. Must be unique within the Workflow. 11769 - */ 11770 - id?: string; 11771 - /** 11772 - * The event payload the Workflow instance is triggered with 11773 - */ 11774 - params?: PARAMS; 11775 - /** 11776 - * The retention policy for Workflow instance. 11777 - * Defaults to the maximum retention period available for the owner's account. 11778 - */ 11779 - retention?: { 11780 - successRetention?: WorkflowRetentionDuration; 11781 - errorRetention?: WorkflowRetentionDuration; 11782 - }; 11783 - } 11784 - type InstanceStatus = { 11785 - status: 11786 - | 'queued' // means that instance is waiting to be started (see concurrency limits) 11787 - | 'running' 11788 - | 'paused' 11789 - | 'errored' 11790 - | 'terminated' // user terminated the instance while it was running 11791 - | 'complete' 11792 - | 'waiting' // instance is hibernating and waiting for sleep or event to finish 11793 - | 'waitingForPause' // instance is finishing the current work to pause 11794 - | 'unknown'; 11795 - error?: { 11796 - name: string; 11797 - message: string; 11798 - }; 11799 - output?: unknown; 11800 - }; 11801 - interface WorkflowError { 11802 - code?: number; 11803 - message: string; 11804 - } 11805 - declare abstract class WorkflowInstance { 11806 - public id: string; 11807 - /** 11808 - * Pause the instance. 11809 - */ 11810 - public pause(): Promise<void>; 11811 - /** 11812 - * Resume the instance. If it is already running, an error will be thrown. 11813 - */ 11814 - public resume(): Promise<void>; 11815 - /** 11816 - * Terminate the instance. If it is errored, terminated or complete, an error will be thrown. 11817 - */ 11818 - public terminate(): Promise<void>; 11819 - /** 11820 - * Restart the instance. 11821 - */ 11822 - public restart(): Promise<void>; 11823 - /** 11824 - * Returns the current status of the instance. 11825 - */ 11826 - public status(): Promise<InstanceStatus>; 11827 - /** 11828 - * Send an event to this instance. 11829 - */ 11830 - public sendEvent({ type, payload }: { type: string; payload: unknown }): Promise<void>; 11831 - }
-18
packages/oauth/cab-example/wrangler.jsonc
··· 1 - { 2 - "$schema": "node_modules/wrangler/config-schema.json", 3 - "name": "cab-example", 4 - "compatibility_date": "2025-09-27", 5 - "main": "server/index.ts", 6 - "assets": { 7 - "not_found_handling": "single-page-application", 8 - // route XRPC and metadata endpoints to the Worker 9 - "run_worker_first": ["/xrpc/*", "/oauth-client-metadata.json", "/jwks.json"], 10 - }, 11 - "observability": { 12 - "enabled": true, 13 - }, 14 - "vars": { 15 - // set via `wrangler secret put` or .dev.vars for local dev 16 - // "PRIVATE_KEY_JWK": "..." 17 - }, 18 - }
-127
packages/oauth/cab/README.md
··· 1 - # @atcute/oauth-cab 2 - 3 - Client Assertion Backend (CAB) for AT Protocol OAuth browser clients. 4 - 5 - ```sh 6 - npm install @atcute/oauth-cab 7 - ``` 8 - 9 - CAB enables browser-based OAuth clients to become confidential clients by having a backend service 10 - that issues DPoP-bound client assertions. 11 - 12 - ## usage 13 - 14 - ### server-side (CAB backend) 15 - 16 - > [!WARNING] 17 - > the CAB endpoint should only accept requests from your client's origin. if you have CORS 18 - > middleware set up, you should exclude `/xrpc/dev.atcute.oauth.getClientAssertion` from it. 19 - 20 - #### with XRPC router 21 - 22 - ```ts 23 - import { 24 - buildClientMetadata, 25 - generateClientAssertionKey, 26 - Keyset, 27 - registerCab, 28 - } from '@atcute/oauth-cab/server'; 29 - import { XRPCRouter, cors } from '@atcute/xrpc-server'; 30 - 31 - const keyset = new Keyset([await generateClientAssertionKey('my-key')]); 32 - 33 - const metadata = buildClientMetadata( 34 - { 35 - client_id: 'https://example.com/oauth-client-metadata.json', 36 - redirect_uris: ['https://example.com/oauth/callback'], 37 - scope: 'atproto transition:generic', 38 - client_name: 'my app', 39 - jwks_uri: 'https://example.com/jwks.json', 40 - }, 41 - keyset, 42 - ); 43 - 44 - const router = new XRPCRouter({ 45 - // if using CORS middleware, exclude CAB endpoint (it should be same-origin) 46 - middlewares: [cors({ exclude: ['dev.atcute.oauth.getClientAssertion'] })], 47 - }); 48 - 49 - await registerCab(router, { 50 - client_id: metadata.client_id, 51 - keyset, 52 - // dpopSecret: false, 53 - // dpopSecret: 'hex-secret' 54 - }); 55 - 56 - export default { 57 - async fetch(request: Request): Promise<Response> { 58 - const url = new URL(request.url); 59 - 60 - if (url.pathname === '/oauth-client-metadata.json') { 61 - return Response.json(metadata); 62 - } 63 - if (url.pathname === '/jwks.json') { 64 - return Response.json(keyset.publicJwks); 65 - } 66 - 67 - return router.fetch(request); 68 - }, 69 - }; 70 - ``` 71 - 72 - #### standalone handler 73 - 74 - ```ts 75 - import { 76 - buildClientMetadata, 77 - createCabHandler, 78 - generateClientAssertionKey, 79 - Keyset, 80 - } from '@atcute/oauth-cab/server'; 81 - 82 - // create keyset 83 - const keyset = new Keyset([await generateClientAssertionKey('my-key')]); 84 - 85 - // build client metadata 86 - const metadata = buildClientMetadata( 87 - { 88 - client_id: 'https://example.com/oauth-client-metadata.json', 89 - redirect_uris: ['https://example.com/oauth/callback'], 90 - scope: 'atproto transition:generic', 91 - client_name: 'my app', 92 - jwks_uri: 'https://example.com/jwks.json', 93 - }, 94 - keyset, 95 - ); 96 - 97 - // create handler (returns undefined for non-matching paths) 98 - const handler = await createCabHandler({ 99 - client_id: metadata.client_id, 100 - keyset, 101 - // dpopSecret: false, 102 - // dpopSecret: 'hex-secret', 103 - }); 104 - 105 - // use with Hono 106 - app.get('/oauth-client-metadata.json', (c) => c.json(metadata)); 107 - app.get('/jwks.json', (c) => c.json(keyset.publicJwks)); 108 - app.all('*', async (c, next) => { 109 - const res = await handler(c.req.raw); 110 - if (res === undefined) { 111 - return next(); 112 - } 113 - return res; 114 - }); 115 - ``` 116 - 117 - ### client-side (browser) 118 - 119 - ```ts 120 - import { createCabFetcher } from '@atcute/oauth-cab/client'; 121 - import { configureOAuth } from '@atcute/oauth-browser-client'; 122 - 123 - configureOAuth({ 124 - // ... other options 125 - fetchClientAssertion: createCabFetcher(), // defaults to location.origin 126 - }); 127 - ```
-10
packages/oauth/cab/lex.config.js
··· 1 - import { defineLexiconConfig } from '@atcute/lex-cli'; 2 - 3 - export default defineLexiconConfig({ 4 - files: ['lexicons-src/**/*.ts'], 5 - outdir: 'lib/lexicons/', 6 - export: { 7 - outdir: 'lexicons/', 8 - clean: true, 9 - }, 10 - });
-30
packages/oauth/cab/lexicons-src/dev/atcute/oauth/get-client-assertion.ts
··· 1 - import { document, object, procedure, required, string } from '@atcute/lexicon-doc/builder'; 2 - 3 - export default document({ 4 - id: 'dev.atcute.oauth.getClientAssertion', 5 - defs: { 6 - main: procedure({ 7 - description: 'get a DPoP-bound client assertion for OAuth token requests', 8 - input: { 9 - encoding: 'application/json', 10 - schema: object({ 11 - properties: { 12 - aud: required(string({ description: 'authorization server issuer' })), 13 - }, 14 - }), 15 - }, 16 - output: { 17 - encoding: 'application/json', 18 - schema: object({ 19 - properties: { 20 - client_assertion: required(string({ description: 'signed JWT assertion' })), 21 - }, 22 - }), 23 - }, 24 - errors: [ 25 - { name: 'InvalidDpopProof', description: 'DPoP proof is missing or invalid' }, 26 - { name: 'UseDpopNonce', description: 'retry with the provided DPoP-Nonce' }, 27 - ], 28 - }), 29 - }, 30 - });
-46
packages/oauth/cab/lexicons/dev/atcute/oauth/getClientAssertion.json
··· 1 - { 2 - "defs": { 3 - "main": { 4 - "description": "get a DPoP-bound client assertion for OAuth token requests", 5 - "errors": [ 6 - { 7 - "name": "InvalidDpopProof", 8 - "description": "DPoP proof is missing or invalid" 9 - }, 10 - { 11 - "name": "UseDpopNonce", 12 - "description": "retry with the provided DPoP-Nonce" 13 - } 14 - ], 15 - "input": { 16 - "encoding": "application/json", 17 - "schema": { 18 - "properties": { 19 - "aud": { 20 - "type": "string", 21 - "description": "authorization server issuer" 22 - } 23 - }, 24 - "required": ["aud"], 25 - "type": "object" 26 - } 27 - }, 28 - "output": { 29 - "encoding": "application/json", 30 - "schema": { 31 - "properties": { 32 - "client_assertion": { 33 - "type": "string", 34 - "description": "signed JWT assertion" 35 - } 36 - }, 37 - "required": ["client_assertion"], 38 - "type": "object" 39 - } 40 - }, 41 - "type": "procedure" 42 - } 43 - }, 44 - "id": "dev.atcute.oauth.getClientAssertion", 45 - "lexicon": 1 46 - }
-73
packages/oauth/cab/lib/client/index.ts
··· 1 - import { Client, simpleFetchHandler } from '@atcute/client'; 2 - import type { ClientAssertionFetcher } from '@atcute/oauth-browser-client'; 3 - 4 - import type {} from '../lexicons/index.js'; 5 - 6 - /** 7 - * options for creating a CAB fetcher 8 - */ 9 - export interface CreateCabFetcherOptions { 10 - /** URL of CAB backend (defaults to location.origin) */ 11 - service?: string | URL; 12 - /** optional custom fetch implementation */ 13 - fetch?: typeof globalThis.fetch; 14 - } 15 - 16 - /** 17 - * creates a client assertion fetcher that communicates with a CAB backend. 18 - * 19 - * the fetcher handles DPoP proof creation and nonce retry automatically. 20 - * 21 - * @param options fetcher configuration 22 - * @returns client assertion fetcher for use with oauth-browser-client 23 - */ 24 - export const createCabFetcher = (options: CreateCabFetcherOptions = {}): ClientAssertionFetcher => { 25 - const serviceUrl = new URL(options.service ?? location.origin); 26 - 27 - const client = new Client({ 28 - handler: simpleFetchHandler({ 29 - service: serviceUrl, 30 - fetch: options.fetch, 31 - }), 32 - }); 33 - 34 - return async ({ aud, createDpopProof }) => { 35 - // build the endpoint URL for DPoP proof (htu is origin + pathname only) 36 - const htu = serviceUrl.origin + '/xrpc/dev.atcute.oauth.getClientAssertion'; 37 - 38 - // create initial DPoP proof without nonce 39 - let dpopProof = await createDpopProof(htu); 40 - 41 - // make the request 42 - let response = await client.post('dev.atcute.oauth.getClientAssertion', { 43 - input: { aud }, 44 - headers: { DPoP: dpopProof }, 45 - }); 46 - 47 - // check for nonce requirement (UseDpopNonce error) 48 - if (!response.ok && response.data.error === 'UseDpopNonce') { 49 - const dpopNonce = response.headers.get('DPoP-Nonce'); 50 - if (dpopNonce) { 51 - // retry with nonce 52 - dpopProof = await createDpopProof(htu, dpopNonce); 53 - 54 - response = await client.post('dev.atcute.oauth.getClientAssertion', { 55 - input: { aud }, 56 - headers: { DPoP: dpopProof }, 57 - }); 58 - } 59 - } 60 - 61 - if (!response.ok) { 62 - const message = response.data.message ?? response.data.error ?? 'CAB request failed'; 63 - throw new Error(message); 64 - } 65 - 66 - const { client_assertion } = response.data; 67 - 68 - return { 69 - client_assertion_type: 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer', 70 - client_assertion, 71 - }; 72 - }; 73 - };
-1
packages/oauth/cab/lib/index.ts
··· 1 - export * from './lexicons/index.js';
-1
packages/oauth/cab/lib/lexicons/index.ts
··· 1 - export * as DevAtcuteOauthGetClientAssertion from './types/dev/atcute/oauth/getClientAssertion.js';
-41
packages/oauth/cab/lib/lexicons/types/dev/atcute/oauth/getClientAssertion.ts
··· 1 - import type {} from '@atcute/lexicons'; 2 - import type {} from '@atcute/lexicons/ambient'; 3 - import * as v from '@atcute/lexicons/validations'; 4 - 5 - const _mainSchema = /*#__PURE__*/ v.procedure('dev.atcute.oauth.getClientAssertion', { 6 - params: null, 7 - input: { 8 - type: 'lex', 9 - schema: /*#__PURE__*/ v.object({ 10 - /** 11 - * authorization server issuer 12 - */ 13 - aud: /*#__PURE__*/ v.string(), 14 - }), 15 - }, 16 - output: { 17 - type: 'lex', 18 - schema: /*#__PURE__*/ v.object({ 19 - /** 20 - * signed JWT assertion 21 - */ 22 - client_assertion: /*#__PURE__*/ v.string(), 23 - }), 24 - }, 25 - }); 26 - 27 - type main$schematype = typeof _mainSchema; 28 - 29 - export interface mainSchema extends main$schematype {} 30 - 31 - export const mainSchema = _mainSchema as mainSchema; 32 - 33 - export interface $params {} 34 - export interface $input extends v.InferXRPCBodyInput<mainSchema['input']> {} 35 - export interface $output extends v.InferXRPCBodyInput<mainSchema['output']> {} 36 - 37 - declare module '@atcute/lexicons/ambient' { 38 - interface XRPCProcedures { 39 - 'dev.atcute.oauth.getClientAssertion': mainSchema; 40 - } 41 - }
-162
packages/oauth/cab/lib/server/dpop-nonce.ts
··· 1 - import { toBase64Url } from '@atcute/multibase'; 2 - import { randomBytes } from '@atcute/uint8array'; 3 - 4 - /** max age for DPoP nonces (3 minutes) */ 5 - const DPOP_NONCE_MAX_AGE = 3 * 60 * 1000; 6 - 7 - /** rotation interval (1 minute) */ 8 - const ROTATION_INTERVAL = DPOP_NONCE_MAX_AGE / 3; 9 - 10 - /** secret byte length */ 11 - const SECRET_BYTE_LENGTH = 32; 12 - 13 - export type DpopSecret = string | Uint8Array<ArrayBuffer>; 14 - 15 - /** 16 - * HMAC-based DPoP nonce manager. 17 - * 18 - * generates deterministic nonces based on time and a secret, allowing 19 - * validation without storing individual nonces. maintains a window of 20 - * 3 valid nonces (prev, now, next) for clock skew tolerance. 21 - */ 22 - export class DpopNonce { 23 - readonly #key: CryptoKey; 24 - readonly #rotationInterval: number; 25 - 26 - #counter: number; 27 - #prev: string; 28 - #now: string; 29 - #next: string; 30 - 31 - private constructor(key: CryptoKey, counter: number, prev: string, now: string, next: string) { 32 - this.#key = key; 33 - this.#rotationInterval = ROTATION_INTERVAL; 34 - this.#counter = counter; 35 - this.#prev = prev; 36 - this.#now = now; 37 - this.#next = next; 38 - } 39 - 40 - /** 41 - * creates a new DpopNonce instance. 42 - * 43 - * @param secret optional secret for nonce generation. if not provided, a 44 - * random secret will be generated. use a shared secret for multi-instance 45 - * deployments. 46 - * @returns promise resolving to the DpopNonce instance 47 - */ 48 - static async create(secret?: DpopSecret): Promise<DpopNonce> { 49 - const secretBytes = parseSecret(secret); 50 - const key = await crypto.subtle.importKey('raw', secretBytes, { name: 'HMAC', hash: 'SHA-256' }, false, [ 51 - 'sign', 52 - ]); 53 - 54 - const counter = getCurrentCounter(ROTATION_INTERVAL); 55 - 56 - // pre-compute initial nonces 57 - const [prev, now, next] = await Promise.all([ 58 - computeNonce(key, counter - 1), 59 - computeNonce(key, counter), 60 - computeNonce(key, counter + 1), 61 - ]); 62 - 63 - return new DpopNonce(key, counter, prev, now, next); 64 - } 65 - 66 - /** 67 - * returns the next nonce to include in the DPoP-Nonce response header. 68 - */ 69 - async next(): Promise<string> { 70 - await this.#rotate(); 71 - return this.#next; 72 - } 73 - 74 - /** 75 - * validates a nonce from a DPoP proof. 76 - * 77 - * @param nonce the nonce to validate 78 - * @returns true if the nonce matches prev, now, or next 79 - */ 80 - async check(nonce: string): Promise<boolean> { 81 - await this.#rotate(); 82 - 83 - return nonce === this.#prev || nonce === this.#now || nonce === this.#next; 84 - } 85 - 86 - async #rotate(): Promise<void> { 87 - const counter = getCurrentCounter(this.#rotationInterval); 88 - const diff = counter - this.#counter; 89 - 90 - if (diff === 0) { 91 - return; 92 - } 93 - 94 - if (diff === 1) { 95 - // optimize: shift window by one 96 - this.#prev = this.#now; 97 - this.#now = this.#next; 98 - this.#next = await this.#compute(counter + 1); 99 - } else if (diff === 2) { 100 - // optimize: reuse #next as #prev 101 - this.#prev = this.#next; 102 - this.#now = await this.#compute(counter); 103 - this.#next = await this.#compute(counter + 1); 104 - } else { 105 - // all nonces outdated, recompute all 106 - [this.#prev, this.#now, this.#next] = await Promise.all([ 107 - this.#compute(counter - 1), 108 - this.#compute(counter), 109 - this.#compute(counter + 1), 110 - ]); 111 - } 112 - 113 - this.#counter = counter; 114 - } 115 - 116 - async #compute(counter: number): Promise<string> { 117 - return computeNonce(this.#key, counter); 118 - } 119 - } 120 - 121 - function getCurrentCounter(interval: number): number { 122 - return (Date.now() / interval) | 0; 123 - } 124 - 125 - function parseSecret(secret: DpopSecret | undefined): Uint8Array<ArrayBuffer> { 126 - if (secret === undefined) { 127 - return randomBytes(SECRET_BYTE_LENGTH); 128 - } 129 - 130 - if (secret instanceof Uint8Array) { 131 - if (secret.length !== SECRET_BYTE_LENGTH) { 132 - throw new TypeError(`secret must be exactly ${SECRET_BYTE_LENGTH} bytes`); 133 - } 134 - 135 - return secret; 136 - } 137 - 138 - if (typeof secret === 'string') { 139 - if (secret.length !== SECRET_BYTE_LENGTH * 2 || !/^[0-9a-f]+$/i.test(secret)) { 140 - throw new TypeError(`secret must be a ${SECRET_BYTE_LENGTH * 2} character hex string`); 141 - } 142 - const bytes = new Uint8Array(SECRET_BYTE_LENGTH); 143 - for (let i = 0; i < SECRET_BYTE_LENGTH; i++) { 144 - bytes[i] = parseInt(secret.slice(i * 2, i * 2 + 2), 16); 145 - } 146 - 147 - return bytes; 148 - } 149 - 150 - throw new TypeError('secret must be a Uint8Array or hex string'); 151 - } 152 - 153 - async function computeNonce(key: CryptoKey, counter: number): Promise<string> { 154 - const data = new ArrayBuffer(8); 155 - const view = new DataView(data); 156 - // write counter as 64-bit big-endian (only lower 32 bits used for practical purposes) 157 - view.setUint32(0, 0, false); 158 - view.setUint32(4, counter >>> 0, false); 159 - 160 - const signature = await crypto.subtle.sign('HMAC', key, data); 161 - return toBase64Url(new Uint8Array(signature)); 162 - }
-118
packages/oauth/cab/lib/server/handler.ts
··· 1 - import { createClientAssertion, DpopVerifyError, verifyDpopProof } from '@atcute/oauth-crypto'; 2 - import type { Keyset } from '@atcute/oauth-keyset'; 3 - import { 4 - createXrpcHandler, 5 - InvalidRequestError, 6 - json, 7 - type ProcedureConfig, 8 - type XRPCRouter, 9 - } from '@atcute/xrpc-server'; 10 - 11 - import { DevAtcuteOauthGetClientAssertion } from '../lexicons/index.js'; 12 - 13 - import { DpopNonce, type DpopSecret } from './dpop-nonce.js'; 14 - 15 - /** 16 - * options for creating a CAB handler 17 - */ 18 - export interface CabOptions { 19 - /** OAuth client ID */ 20 - client_id: string; 21 - /** client's private keyset */ 22 - keyset: Keyset; 23 - /** 24 - * DPoP nonce secret for replay protection. 25 - * - `undefined`: generate random secret (single instance) 26 - * - `string | Uint8Array`: shared secret (multi-instance) 27 - * - `false`: disable nonce requirement 28 - */ 29 - dpopSecret?: DpopSecret | false; 30 - /** optional algorithms supported by the server (for key selection) */ 31 - serverAlgs?: readonly string[]; 32 - } 33 - 34 - const createCabProcedure = async ( 35 - options: CabOptions, 36 - ): Promise<ProcedureConfig<DevAtcuteOauthGetClientAssertion.mainSchema>> => { 37 - const { client_id, keyset, dpopSecret, serverAlgs } = options; 38 - 39 - const dpopNonce = dpopSecret === false ? undefined : await DpopNonce.create(dpopSecret); 40 - 41 - return { 42 - async handler({ request, input: { aud } }) { 43 - const url = new URL(request.url); 44 - const htu = url.origin + url.pathname; 45 - 46 - // get fresh nonce for response headers 47 - const nextNonce = dpopNonce ? await dpopNonce.next() : undefined; 48 - const headers: HeadersInit | undefined = nextNonce ? { 'dpop-nonce': nextNonce } : undefined; 49 - 50 - // verify DPoP proof (includes nonce validation if configured) 51 - let jkt: string; 52 - try { 53 - const result = await verifyDpopProof(request.headers.get('dpop'), { 54 - method: 'POST', 55 - url: htu, 56 - nonce: dpopNonce, 57 - }); 58 - jkt = result.jkt; 59 - } catch (err) { 60 - if (err instanceof DpopVerifyError) { 61 - const error = err.code === 'nonce_required' ? 'UseDpopNonce' : 'InvalidDpopProof'; 62 - throw new InvalidRequestError({ error, headers }); 63 - } 64 - throw err; 65 - } 66 - 67 - // create client assertion 68 - const { key } = keyset.findForSigning(serverAlgs); 69 - const assertion = await createClientAssertion({ 70 - client_id, 71 - aud: aud, 72 - jkt, 73 - key, 74 - }); 75 - 76 - return json({ client_assertion: assertion }, { headers }); 77 - }, 78 - }; 79 - }; 80 - 81 - /** 82 - * registers the CAB procedure to an existing XRPC router. 83 - * 84 - * @param router XRPC router to register to 85 - * @param options handler configuration 86 - */ 87 - export const registerCab = async (router: XRPCRouter, options: CabOptions): Promise<void> => { 88 - const config = await createCabProcedure(options); 89 - router.addProcedure(DevAtcuteOauthGetClientAssertion.mainSchema, config); 90 - }; 91 - 92 - const CAB_PATH = `/xrpc/${DevAtcuteOauthGetClientAssertion.mainSchema.nsid}`; 93 - 94 - /** 95 - * creates a standalone CAB handler. 96 - * 97 - * returns `undefined` for non-matching requests, allowing use as middleware. 98 - * 99 - * @param options handler configuration 100 - * @returns fetch handler that returns `Response` or `undefined` if path doesn't match 101 - */ 102 - export const createCabHandler = async ( 103 - options: CabOptions, 104 - ): Promise<(request: Request) => Promise<Response> | undefined> => { 105 - const handler = createXrpcHandler({ 106 - lxm: DevAtcuteOauthGetClientAssertion.mainSchema, 107 - ...(await createCabProcedure(options)), 108 - }); 109 - 110 - return (request: Request): Promise<Response> | undefined => { 111 - const url = new URL(request.url); 112 - if (url.pathname !== CAB_PATH) { 113 - return undefined; 114 - } 115 - 116 - return handler(request); 117 - }; 118 - };
-25
packages/oauth/cab/lib/server/index.ts
··· 1 - export { Keyset, type KeySearchOptions } from '@atcute/oauth-keyset'; 2 - 3 - export { 4 - exportPkcs8PrivateKey, 5 - generateClientAssertionKey, 6 - importClientAssertionPkcs8, 7 - type ClientAssertionPrivateJwk, 8 - } from '@atcute/oauth-crypto'; 9 - 10 - export { 11 - buildClientMetadata, 12 - CLIENT_ASSERTION_TYPE_JWT_BEARER, 13 - FALLBACK_ALG, 14 - scope, 15 - type AtprotoAuthorizationServerMetadata, 16 - type AtprotoProtectedResourceMetadata, 17 - type ConfidentialClientMetadata, 18 - type OAuthAuthorizationServerMetadata, 19 - type OAuthClientMetadata, 20 - type OAuthProtectedResourceMetadata, 21 - type OAuthResponseMode, 22 - } from '@atcute/oauth-types'; 23 - 24 - export type { DpopSecret } from './dpop-nonce.js'; 25 - export { createCabHandler, registerCab, type CabOptions } from './handler.js';
-58
packages/oauth/cab/package.json
··· 1 - { 2 - "name": "@atcute/oauth-cab", 3 - "version": "0.1.0", 4 - "description": "Client Assertion Backend (CAB) for AT Protocol OAuth browser clients", 5 - "license": "0BSD", 6 - "repository": { 7 - "url": "https://github.com/mary-ext/atcute", 8 - "directory": "packages/oauth/cab" 9 - }, 10 - "files": [ 11 - "dist/", 12 - "lib/", 13 - "!lib/**/*.bench.ts", 14 - "!lib/**/*.test.ts" 15 - ], 16 - "type": "module", 17 - "sideEffects": false, 18 - "exports": { 19 - ".": "./dist/index.js", 20 - "./client": "./dist/client/index.js", 21 - "./server": "./dist/server/index.js" 22 - }, 23 - "publishConfig": { 24 - "access": "public" 25 - }, 26 - "scripts": { 27 - "build": "tsgo -b", 28 - "generate": "rm -r ./lib/lexicons/; lex-cli generate", 29 - "export": "lex-cli export", 30 - "test": "vitest", 31 - "prepublish": "rm -rf dist; pnpm run build" 32 - }, 33 - "dependencies": { 34 - "@atcute/client": "workspace:^", 35 - "@atcute/lexicons": "workspace:^", 36 - "@atcute/multibase": "workspace:^", 37 - "@atcute/oauth-crypto": "workspace:^", 38 - "@atcute/oauth-keyset": "workspace:^", 39 - "@atcute/oauth-types": "workspace:^", 40 - "@atcute/uint8array": "workspace:^", 41 - "@atcute/xrpc-server": "workspace:^" 42 - }, 43 - "devDependencies": { 44 - "@atcute/lex-cli": "workspace:^", 45 - "@atcute/lexicon-doc": "workspace:^", 46 - "@atcute/oauth-browser-client": "workspace:^", 47 - "@atcute/oauth-cab": "file:", 48 - "vitest": "^4.0.16" 49 - }, 50 - "peerDependencies": { 51 - "@atcute/oauth-browser-client": "^2.0.3" 52 - }, 53 - "peerDependenciesMeta": { 54 - "@atcute/oauth-browser-client": { 55 - "optional": true 56 - } 57 - } 58 - }
-4
packages/oauth/cab/tsconfig.json
··· 1 - { 2 - "files": [], 3 - "references": [{ "path": "./tsconfig.lib.json" }, { "path": "./tsconfig.lexicons.json" }] 4 - }
-19
packages/oauth/cab/tsconfig.lexicons.json
··· 1 - { 2 - "compilerOptions": { 3 - "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.lexicons.tsbuildinfo", 4 - "target": "ESNext", 5 - "module": "NodeNext", 6 - "moduleResolution": "NodeNext", 7 - "allowImportingTsExtensions": true, 8 - "verbatimModuleSyntax": true, 9 - "moduleDetection": "force", 10 - "isolatedModules": true, 11 - "skipLibCheck": true, 12 - "noEmit": true, 13 - "strict": true, 14 - "noUnusedLocals": true, 15 - "noUnusedParameters": true, 16 - "noFallthroughCasesInSwitch": true 17 - }, 18 - "include": ["lexicons-src"] 19 - }
-26
packages/oauth/cab/tsconfig.lib.json
··· 1 - { 2 - "compilerOptions": { 3 - "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.lib.tsbuildinfo", 4 - "rootDir": "lib/", 5 - "outDir": "dist/", 6 - "esModuleInterop": true, 7 - "skipLibCheck": true, 8 - "target": "ESNext", 9 - "allowJs": true, 10 - "resolveJsonModule": true, 11 - "moduleDetection": "force", 12 - "isolatedModules": true, 13 - "verbatimModuleSyntax": true, 14 - "strict": true, 15 - "noImplicitOverride": true, 16 - "noUnusedLocals": true, 17 - "noUnusedParameters": true, 18 - "noFallthroughCasesInSwitch": true, 19 - "module": "NodeNext", 20 - "sourceMap": true, 21 - "declaration": true, 22 - "declarationMap": true 23 - }, 24 - "include": ["lib/"], 25 - "exclude": ["lib/**/*.test.ts", "lib/**/*.bench.ts"] 26 - }