@reclaimprotocol/agent 0.1.17 → 0.1.18

package/src/provider/schema.ts

@@ -15,6 +15,25 @@ export type HttpMethod = HttpParams['method']
  */
 export type ResponseMatch = HttpParams['responseMatches'][number]
 
+/**
+ * A response match as drafted for PUBLISH: the attestor's match plus
+ * `isOptional` — a backend-side matcher flag (both the old devtools backend
+ * and the builder store it; the attestor's own params have no such field, so
+ * `propose_provider` drafts never set it — only an explicit publish input
+ * does). Default false on both backends.
+ */
+export type DraftResponseMatch = ResponseMatch & { isOptional?: boolean }
+
+/** How the verification client supplies cookies/auth when replaying a
+ *  request. Both backends accept the same enum (old devtools on
+ *  `requestData`, builder on `RequestSelection`); default `include`. */
+export type WebCredentials = 'omit' | 'same-origin' | 'include'
+
+/** Old-devtools `urlType` for a requestData entry. The builder backend has
+ *  no such field (templating is implicit in the URL's `{{param}}`
+ *  placeholders), so the builder translator ignores it. */
+export type OldUrlType = 'REGEX' | 'CONSTANT' | 'TEMPLATE'
+
 /**
  * Selector telling the prover which portion of the response to reveal:
  * `xPath`/`jsonPath` narrows the slice, `regex` (with named groups) matches
@@ -67,8 +86,15 @@ export interface ReclaimProvider {
 	method: HttpMethod
 	headers?: Record<string, string>
 	body?: string
-	responseMatches: ResponseMatch[]
+	responseMatches: DraftResponseMatch[]
 	responseRedactions?: ResponseRedaction[]
+	/** How the verification client supplies cookies/auth on replay. Both
+	 *  backends default to `include` when unset. */
+	credentials?: WebCredentials
+	/** Old-devtools-only url type override (`REGEX`/`CONSTANT`/`TEMPLATE`).
+	 *  Auto-derived from `{{param}}` placeholders when unset; ignored by the
+	 *  builder backend. */
+	urlType?: OldUrlType
 	/** Public param refs (templated into URL/body), populated by draft layer. */
 	paramValues?: Record<string, string>
 	/** Redaction mode for the transcript (attestor default: 'key-update'). */

package/src/provider/to-version.ts

@@ -4,10 +4,12 @@ import type {
 	ProviderVersionRef,
 } from '@reclaimprotocol/client/openapi'
 import type {
+	DraftResponseMatch,
 	HttpMethod,
+	OldUrlType,
 	ReclaimProvider,
-	ResponseMatch,
 	ResponseRedaction,
+	WebCredentials,
 } from './schema.ts'
 import { DYNAMIC_GEO, normalizeGeoLocation } from './schema.ts'
 
@@ -24,8 +26,15 @@ export interface DraftRequest {
 	body?: string
 	writeRedactionMode?: ReclaimProvider['writeRedactionMode']
 	additionalClientOptions?: ReclaimProvider['additionalClientOptions']
-	responseMatches?: ResponseMatch[]
+	responseMatches?: DraftResponseMatch[]
 	responseRedactions?: ResponseRedaction[]
+	/** How the verification client supplies cookies/auth on replay. Default
+	 *  `include` (both backends). */
+	credentials?: WebCredentials
+	/** Old-devtools `urlType` override. Ignored by THIS translator (the
+	 *  builder backend has no urlType) — read only by the old-devtools
+	 *  translator (`old/to-register.ts`). */
+	urlType?: OldUrlType
 }
 
 /** A request the page's injection script is allowed to fire, plus the
@@ -60,6 +69,16 @@ export interface CreateVersionOptions {
 	jsUserScripts?: string
 	/** Requests the injection script may fire, as `RequestSelectionTemplate`s. */
 	allowedJsRequests?: AllowedJsRequest[]
+	/** In-app interception options, mapped verbatim to
+	 *  `webSettings.clientOptions.inapp.interceptorOptions`. `interceptorType`
+	 *  is required by the backend whenever the object is present.
+	 *  `isDocumentRequestReplayEnabled` is the INVERSE of old-devtools'
+	 *  `disableRequestReplay` (default false). */
+	interceptorOptions?: {
+		interceptorType: 'HAWKEYE' | 'MSWJS' | 'CDP'
+		isDocumentRequestReplayEnabled?: boolean
+		interceptorSettings?: string
+	}
 }
 
 /**
@@ -139,14 +158,14 @@ export function providerToRequestSelection(
 	const responseMatches = (provider.responseMatches ?? []).map((match) => ({
 		type: match.type,
 		value: match.value,
-		isOptional: false,
+		isOptional: match.isOptional ?? false,
 	}))
 	const responseRedactions = provider.responseRedactions ?? []
 
 	return {
 		url: provider.url,
 		method: provider.method,
-		credentials: 'include',
+		credentials: provider.credentials ?? 'include',
 		...(provider.body ? { requestBodyTemplate: provider.body } : {}),
 		...(provider.writeRedactionMode
 			? { writeRedactionMode: provider.writeRedactionMode }
@@ -177,7 +196,9 @@ export function providerToCreateVersionRequest(
 	initialUrl: string,
 	opts: CreateVersionOptions = {},
 ): CreateProviderVersionRequest {
-	const { notes, version, jsUserScripts, allowedJsRequests } = opts
+	const {
+		notes, version, jsUserScripts, allowedJsRequests, interceptorOptions,
+	} = opts
 	const requiredContext = deriveRequiredContext(providers, {
 		allowedJsRequests,
 		jsUserScripts,
@@ -206,7 +227,21 @@ export function providerToCreateVersionRequest(
 		// apply schema defaults to request bodies.
 		webSettings: {
 			geoLocation: pickGeoLocation(providers),
-			clientOptions: { portal: { useProxy: true } },
+			clientOptions: {
+				portal: { useProxy: true },
+				...(interceptorOptions
+					? {
+						inapp: {
+							interceptorOptions: {
+								// openapi `default: false` — the generated type
+								// requires the key even when the author omits it.
+								isDocumentRequestReplayEnabled: false,
+								...interceptorOptions,
+							},
+						},
+					}
+					: {}),
+			},
 			// Only set when non-empty; an empty string would store a no-op script.
 			...(script ? { jsUserScripts: script } : {}),
 		},