@alwaysmeticulous/api
Advanced tools
Comparing version 2.152.0 to 2.153.0
@@ -12,5 +12,5 @@ export { Organization } from "./organization.types"; | ||
export { ScreenshotAssertionsOptions, ScreenshotAssertionsEnabledOptions, ScreenshottingEnabledOptions, StoryboardOptions, ScreenshotDiffOptions, ElementToIgnore, CSSSelectorToIgnore, } from "./sdk-bundle-api/sdk-to-bundle/screenshotting-options"; | ||
export { NetworkStubbingMode, StubAllRequests, StubNonSSRRequests, NoStubbing, CustomStubbing, RequestFilter, } from "./sdk-bundle-api/sdk-to-bundle/network-stubbing"; | ||
export { NetworkStubbingMode, StubAllRequests, StubNonSSRRequests, NoStubbing, CustomStubbing, RequestFilter, CustomTransformation, } from "./sdk-bundle-api/sdk-to-bundle/network-stubbing"; | ||
export { ConsoleMessageWithStackTracePointer, VirtualTimeChange, MeticulousConsoleMessage, ApplicationConsoleMessage, ConsoleMessageCoreData, ConsoleMessageType, ConsoleMessageLocation, } from "./sdk-bundle-api/bundle-to-sdk/console-message"; | ||
export { InjectableRequestHeader, StaticHeaderValue, DynamicHeaderValue, AllRequests, AppUrlRequestsOnly, CustomRequests, } from "./sdk-bundle-api/sdk-to-bundle/header-injection"; | ||
export { ConsoleErrorDivergenceIndicator, Divergence, DivergenceConsoleError, DivergenceIndicator, InitialNavigationDivergenceIndicator, NetworkActivityDivergenceIndicator, ScreenshotDivergenceIdentifier, UrlChangeEventDivergenceIndicator, UserEventDivergenceIndicator, } from "./sdk-bundle-api/bundle-to-sdk/replay-divergence"; |
export type NetworkStubbingMode = StubAllRequests | StubNonSSRRequests | CustomStubbing; | ||
interface NetworkStubbingBase { | ||
/** | ||
* When looking for a request to use as a stub, these transformations will be applied to the request before any other transformations. | ||
* They will be applied in the order they are defined. | ||
*/ | ||
customRequestTransformations?: CustomTransformation[]; | ||
} | ||
/** | ||
* The default mode. Stubs all requests, apart from ones for _next/static/ files. | ||
*/ | ||
export interface StubAllRequests { | ||
export interface StubAllRequests extends NetworkStubbingBase { | ||
type: "stub-all-requests"; | ||
@@ -13,6 +20,6 @@ } | ||
*/ | ||
export interface StubNonSSRRequests { | ||
export interface StubNonSSRRequests extends NetworkStubbingBase { | ||
type: "stub-non-ssr-requests"; | ||
} | ||
export interface CustomStubbing { | ||
export interface CustomStubbing extends NetworkStubbingBase { | ||
type: "custom-stubbing"; | ||
@@ -40,1 +47,26 @@ requestsToNotStub: RequestFilter[]; | ||
} | ||
type TransformableRequestData = Pick<Request, "body" | "method" | "url">; | ||
interface CustomTransformationBase { | ||
/** | ||
* The regex to match against the request component. | ||
*/ | ||
matchRegex: string; | ||
/** | ||
* The replacement for any matches with matchRegex. | ||
* This can reference groups in the matchRegex, for example: | ||
* - matchRegex = `id_(\w*)=[^&]*`, replacement = `id_$1=<redacted>` | ||
* - matchRegex= `id_(?<param_name>\w*)=[^&]*`, replacement = `id_$<param_name>=<redacted>` | ||
*/ | ||
replacement: string; | ||
requestComponent: keyof TransformableRequestData; | ||
} | ||
type TransformableUrlFields = keyof Pick<URL, "hash" | "host" | "hostname" | "href" | "password" | "pathname" | "port" | "protocol" | "search" | "username">; | ||
interface CustomUrlTransformation extends CustomTransformationBase { | ||
requestComponent: keyof Pick<TransformableRequestData, "url">; | ||
urlComponent: TransformableUrlFields; | ||
} | ||
interface CustomRequestTransformation extends CustomTransformationBase { | ||
requestComponent: keyof Omit<TransformableRequestData, "url">; | ||
} | ||
export type CustomTransformation = CustomRequestTransformation | CustomUrlTransformation; | ||
export {}; |
{ | ||
"name": "@alwaysmeticulous/api", | ||
"version": "2.152.0", | ||
"version": "2.153.0", | ||
"description": "Meticulous API types", | ||
@@ -38,3 +38,3 @@ "license": "ISC", | ||
}, | ||
"gitHead": "95717c6bee4830ff0c977ba642d6253753952481" | ||
"gitHead": "97b550636b6c7bef9e68801cb8798e58f0089251" | ||
} |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
38848
838