@kensio/yulin 1.21.23 → 1.21.24

package/dist/service/wafv2/managed/sim-waf-bot-declaration.d.ts

@@ -0,0 +1,35 @@
+/**
+ * The bot a test says sent a request, as Bot Control would identify it.
+ */
+export interface SimWafBotDeclaration {
+    /**
+     * The category, spelled as the `bot:category:` label spells it, such as
+     * `search_engine` or `http_library`.
+     */
+    readonly category: string;
+    /** The bot's name, as the `bot:name:` label spells it, such as `googlebot`. */
+    readonly name?: string | undefined;
+    /** The bot's publisher, as the `bot:organization:` label spells it. */
+    readonly organization?: string | undefined;
+    /**
+     * Whether Bot Control could verify the bot. A verified bot is labelled and
+     * left alone, and an unverified one matches its category's rule.
+     */
+    readonly verified?: boolean | undefined;
+}
+/**
+ * What one declared bot adds to a request: the rules that match it, and the
+ * labels the group adds whether or not a rule matches.
+ */
+export interface SimWafBotDeclared {
+    readonly matches: readonly string[];
+    readonly groupLabels: ReadonlyMap<string, readonly string[]>;
+}
+/**
+ * Read a declared bot into the rule it matches and the labels it carries.
+ *
+ * A verified bot matches no rule, `CategoryAI` aside, which AWS applies to
+ * verified bots too. Either way the group labels the bot's category, its name
+ * and publisher where the declaration gives them, and whether it was verified.
+ */
+export declare function simWafBotDeclared(bot: SimWafBotDeclaration): SimWafBotDeclared;

package/dist/service/wafv2/managed/sim-waf-bot-declaration.js

@@ -0,0 +1,42 @@
+import { SimWafDeclarationError } from "../error/sim-wafv2.error.js";
+import { simWafBotCategories, simWafBotCategoryMatchingVerified, simWafBotControlRuleSet, } from "./group/sim-waf-bot-control.js";
+/**
+ * Read a declared bot into the rule it matches and the labels it carries.
+ *
+ * A verified bot matches no rule, `CategoryAI` aside, which AWS applies to
+ * verified bots too. Either way the group labels the bot's category, its name
+ * and publisher where the declaration gives them, and whether it was verified.
+ */
+export function simWafBotDeclared(bot) {
+    const rule = requiredCategoryRule(bot.category);
+    const verified = bot.verified === true;
+    const matches = !verified || bot.category === simWafBotCategoryMatchingVerified;
+    return {
+        matches: matches ? [rule] : [],
+        groupLabels: new Map([
+            [
+                simWafBotControlRuleSet.name,
+                [
+                    `bot:category:${bot.category}`,
+                    ...optionalLabel("bot:name", bot.name),
+                    ...optionalLabel("bot:organization", bot.organization),
+                    verified ? "bot:verified" : "bot:unverified",
+                ],
+            ],
+        ]),
+    };
+}
+/**
+ * The rule for one category, refusing a category Bot Control does not name.
+ */
+function requiredCategoryRule(category) {
+    const rule = simWafBotCategories.get(category);
+    if (rule === undefined) {
+        throw new SimWafDeclarationError(`Bot Control names no bot category ${category}. The categories are ` +
+            `${simWafBotCategories.keys().toArray().join(", ")}.`);
+    }
+    return rule;
+}
+function optionalLabel(prefix, value) {
+    return value === undefined ? [] : [`${prefix}:${value}`];
+}

package/dist/service/wafv2/managed/sim-waf-managed-declaration.d.ts

@@ -0,0 +1,35 @@
+import { type SimWafBotDeclaration } from "./sim-waf-bot-declaration.js";
+/**
+ * The managed rules a test says claim a request.
+ */
+export interface SimWafManagedMatchDeclaration {
+    /** The rules that claim the request, by the name AWS gives them. */
+    readonly matches?: readonly string[] | undefined;
+    /**
+     * The bot that sent the request, for Bot Control to match and label as it
+     * would have identified it.
+     */
+    readonly bot?: SimWafBotDeclaration | undefined;
+}
+/**
+ * What a test declared about the requests to one URI path.
+ */
+export interface SimWafDeclared {
+    readonly matches: ReadonlySet<string>;
+    readonly groupLabels: ReadonlyMap<string, readonly string[]>;
+}
+/**
+ * What a request nothing was declared for carries.
+ */
+export declare const simWafNothingDeclared: SimWafDeclared;
+/**
+ * Read a declaration into the rules that match and the labels groups add.
+ *
+ * `ruleNamed` checks a rule name the declaration gives, and answers with the
+ * name the rule goes by.
+ */
+export declare function simWafReadDeclaration(declaration: SimWafManagedMatchDeclaration, ruleNamed: (name: string) => string): SimWafDeclared;
+/**
+ * The labels one group adds to a request whatever its rules decide.
+ */
+export declare function simWafDeclaredGroupLabels(declared: SimWafDeclared, groupName: string): readonly string[];

package/dist/service/wafv2/managed/sim-waf-managed-declaration.js

@@ -0,0 +1,30 @@
+import { simWafBotDeclared, } from "./sim-waf-bot-declaration.js";
+/**
+ * What a request nothing was declared for carries.
+ */
+export const simWafNothingDeclared = {
+    matches: new Set(),
+    groupLabels: new Map(),
+};
+/**
+ * Read a declaration into the rules that match and the labels groups add.
+ *
+ * `ruleNamed` checks a rule name the declaration gives, and answers with the
+ * name the rule goes by.
+ */
+export function simWafReadDeclaration(declaration, ruleNamed) {
+    const bot = declaration.bot === undefined
+        ? simWafNothingDeclared
+        : simWafBotDeclared(declaration.bot);
+    const named = (declaration.matches ?? []).map((name) => ruleNamed(name));
+    return {
+        matches: new Set([...named, ...bot.matches]),
+        groupLabels: bot.groupLabels,
+    };
+}
+/**
+ * The labels one group adds to a request whatever its rules decide.
+ */
+export function simWafDeclaredGroupLabels(declared, groupName) {
+    return declared.groupLabels.get(groupName) ?? [];
+}

package/dist/service/wafv2/managed/sim-waf-managed-group-configs.d.ts

@@ -0,0 +1,11 @@
+import type { SimWafManagedRuleGroupDefinition } from "./sim-waf-managed-rule.type.js";
+/**
+ * Stop compiling a rule whose group configuration this simulation does not
+ * evaluate, so the web ACL holds it unevaluated.
+ *
+ * Bot Control at `COMMON` is evaluated, with or without the configuration
+ * that names the level. `TARGETED` is held, since its rules read tokens,
+ * browser signals and traffic across requests. Every other configuration sets
+ * up the account takeover and account creation groups, which are held too.
+ */
+export declare function refuseUnsimulatedSimWafGroupConfigs(configs: readonly unknown[] | undefined, group: SimWafManagedRuleGroupDefinition, ruleName: string): void;

package/dist/service/wafv2/managed/sim-waf-managed-group-configs.js

@@ -0,0 +1,42 @@
+import { refuseSimWafRuleInput } from "../statement/sim-waf-rule-refusals.js";
+import { simWafBotControlRuleSet } from "./group/sim-waf-bot-control.js";
+/**
+ * Stop compiling a rule whose group configuration this simulation does not
+ * evaluate, so the web ACL holds it unevaluated.
+ *
+ * Bot Control at `COMMON` is evaluated, with or without the configuration
+ * that names the level. `TARGETED` is held, since its rules read tokens,
+ * browser signals and traffic across requests. Every other configuration sets
+ * up the account takeover and account creation groups, which are held too.
+ */
+export function refuseUnsimulatedSimWafGroupConfigs(configs, group, ruleName) {
+    const written = configs ?? [];
+    for (const config of written) {
+        const level = botControlLevel(config);
+        if (group !== simWafBotControlRuleSet || level === undefined) {
+            refuseSimWafRuleInput(ruleName, "the rule group member ManagedRuleGroupConfigs", "it configures the account takeover and account creation groups, " +
+                "and Bot Control's level, and an entry holding nothing but Bot " +
+                "Control at COMMON is the one configuration simulated");
+        }
+        if (level !== "COMMON") {
+            refuseSimWafRuleInput(ruleName, `Bot Control at the ${level} inspection level`, "the targeted rules read tokens, browser signals and traffic across " +
+                "requests, and COMMON is the level simulated");
+        }
+    }
+}
+/**
+ * The level one entry runs Bot Control at, when the entry is Bot Control's
+ * configuration and nothing else.
+ *
+ * Anything else answers with no level, so a malformed entry or one carrying
+ * another member beside Bot Control's is held rather than read as `COMMON`.
+ */
+function botControlLevel(config) {
+    const isBotControlAlone = typeof config === "object" &&
+        config !== null &&
+        Object.keys(config).join(",") === "AWSManagedRulesBotControlRuleSet";
+    return isBotControlAlone
+        ? config.AWSManagedRulesBotControlRuleSet
+            ?.InspectionLevel
+        : undefined;
+}

package/dist/service/wafv2/managed/sim-waf-managed-group-input.d.ts

@@ -1,12 +1,13 @@
 import type { SimWafManagedRuleGroupStatementInput, SimWafOverrideActionInput } from "./sim-waf-managed-group.type.js";
 import type { SimWafManagedRuleGroupDefinition } from "./sim-waf-managed-rule.type.js";
 /**
- * Find the simulated group a statement names, refusing any other.
+ * Find the simulated group a statement names, stopping the rule's compilation
+ * at any other so the web ACL holds it unevaluated.
  *
- * The refusal names the groups that are simulated, because the ones that are
+ * The reason names the groups that are simulated, because the ones that are
  * not are left out for reasons a reader cannot guess from the name: a group
- * that decides by caller address sees one client for the whole simulation, and
- * a group whose detection AWS does not describe cannot be reproduced at all.
+ * that decides by behaviour across requests has one request to look at, and a
+ * group whose detection AWS does not describe cannot be reproduced at all.
  */
 export declare function requiredSimWafManagedRuleGroup(statement: SimWafManagedRuleGroupStatementInput, ruleName: string): SimWafManagedRuleGroupDefinition;
 /**

package/dist/service/wafv2/managed/sim-waf-managed-group-input.js

@@ -1,5 +1,6 @@
 import { invalidSimWafRule, refuseSimWafRuleInput, } from "../statement/sim-waf-rule-refusals.js";
 import { findSimWafManagedRuleGroup, simWafManagedRuleGroupNames, } from "./sim-waf-managed-rule-groups.js";
+import { refuseUnsimulatedSimWafGroupConfigs } from "./sim-waf-managed-group-configs.js";
 /**
  * The rule group statement members real WAFv2 takes and this simulation does
  * not.
@@ -15,19 +16,15 @@ const refusedMembers = new Map([
         "AWS replaced it with RuleActionOverrides, which says which action a " +
             "named rule takes rather than only that it takes none",
     ],
-    [
-        "ManagedRuleGroupConfigs",
-        "it configures the Bot Control, account takeover and account creation " +
-            "groups, and none of those is simulated",
-    ],
 ]);
 /**
- * Find the simulated group a statement names, refusing any other.
+ * Find the simulated group a statement names, stopping the rule's compilation
+ * at any other so the web ACL holds it unevaluated.
  *
- * The refusal names the groups that are simulated, because the ones that are
+ * The reason names the groups that are simulated, because the ones that are
  * not are left out for reasons a reader cannot guess from the name: a group
- * that decides by caller address sees one client for the whole simulation, and
- * a group whose detection AWS does not describe cannot be reproduced at all.
+ * that decides by behaviour across requests has one request to look at, and a
+ * group whose detection AWS does not describe cannot be reproduced at all.
  */
 export function requiredSimWafManagedRuleGroup(statement, ruleName) {
     for (const [member, value] of Object.entries(statement)) {
@@ -42,6 +39,7 @@ export function requiredSimWafManagedRuleGroup(statement, ruleName) {
         const simulated = simWafManagedRuleGroupNames().join(", ");
         refuseSimWafRuleInput(ruleName, `the managed rule group ${named}`, `the simulated groups are ${simulated}`);
     }
+    refuseUnsimulatedSimWafGroupConfigs(statement.ManagedRuleGroupConfigs, group, ruleName);
     return group;
 }
 /**

package/dist/service/wafv2/managed/sim-waf-managed-group-statement.js

@@ -1,6 +1,7 @@
 import { compileSimWafStatement } from "../statement/sim-waf-statement.js";
-import { SimWafAction } from "../web-acl/sim-waf-action.js";
 import { requiredSimWafManagedRuleGroup, simWafGroupCountsEverything, } from "./sim-waf-managed-group-input.js";
+import { simWafDeclaredGroupLabels } from "./sim-waf-managed-declaration.js";
+import { simWafAddGroupLabels, simWafManagedRuleActions, } from "./sim-waf-managed-rule-actions.js";
 import { simWafManagedRuleOverrides } from "./sim-waf-managed-rule-overrides.js";
 import { simWafManagedRequestParts } from "./sim-waf-managed-request.js";
 /**
@@ -20,8 +21,11 @@ import { simWafManagedRequestParts } from "./sim-waf-managed-request.js";
 export function compileSimWafManagedRuleGroup(properties) {
     const { statement, ruleName, scope } = properties;
     const group = requiredSimWafManagedRuleGroup(statement, ruleName);
-    const overrides = simWafManagedRuleOverrides(statement, group, ruleName, scope.customResponseBodies);
-    const counting = simWafGroupCountsEverything(properties.overrideAction, ruleName);
+    const actions = simWafManagedRuleActions({
+        ruleName,
+        overrides: simWafManagedRuleOverrides(statement, group, ruleName, scope.customResponseBodies),
+        counting: simWafGroupCountsEverything(properties.overrideAction, ruleName),
+    });
     const scopeDown = statement.ScopeDownStatement === undefined
         ? undefined
         : compileSimWafStatement(statement.ScopeDownStatement, {
@@ -29,10 +33,6 @@ export function compileSimWafManagedRuleGroup(properties) {
             clock: scope.clock,
             ruleName,
         });
-    // Every rule in the three simulated groups blocks by default, and a group
-    // that is counting counts whatever the rule that matched was set to.
-    const blocking = SimWafAction.read({ Block: {} }, ruleName, {});
-    const counted = SimWafAction.read({ Count: {} }, ruleName, {});
     const { managedRules } = scope;
     return (request) => {
         // A scope-down statement decides whether the group sees the request at
@@ -41,21 +41,23 @@ export function compileSimWafManagedRuleGroup(properties) {
             return undefined;
         }
         const parts = simWafManagedRequestParts(request);
-        const declared = managedRules.declaredMatches(request);
+        const declared = managedRules.declared(request);
         let matched = false;
+        simWafAddGroupLabels(request, group, simWafDeclaredGroupLabels(declared, group.name));
         for (const rule of group.rules) {
-            if (!declared.has(rule.name) && rule.detects?.(parts) !== true) {
+            if (!declared.matches.has(rule.name) && rule.detects?.(parts) !== true) {
                 continue;
             }
-            request.labels.add(`${group.labelNamespace}:${rule.label}`);
-            const action = counting
-                ? counted
-                : (overrides.get(rule.name) ?? blocking);
+            simWafAddGroupLabels(request, group, [
+                rule.label,
+                ...(rule.labels ?? []),
+            ]);
+            const action = actions.of(rule);
             if (action.isTerminating) {
                 return action;
             }
             matched = true;
         }
-        return matched ? counted : undefined;
+        return matched ? actions.counted : undefined;
     };
 }

package/dist/service/wafv2/managed/sim-waf-managed-group.type.d.ts

@@ -3,8 +3,8 @@ import type { SimWafActionInput } from "../web-acl/sim-waf-action.type.js";
 /**
  * Minimal structural WAFv2 ManagedRuleGroupStatement.
  *
- * The members Yulin refuses are declared here rather than left out, so a
- * statement that names one is refused by name.
+ * The members Yulin does not simulate are declared here rather than left out,
+ * so a rule whose statement names one is held and reported by name.
  *
  * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wafv2/Interface/ManagedRuleGroupStatement/
  */

package/dist/service/wafv2/managed/sim-waf-managed-rule-actions.d.ts

@@ -0,0 +1,30 @@
+import type { SimWafInspectedRequest } from "../evaluate/sim-waf-inspected-request.js";
+import { SimWafAction } from "../web-acl/sim-waf-action.js";
+import type { SimWafManagedRuleDefinition, SimWafManagedRuleGroupDefinition } from "./sim-waf-managed-rule.type.js";
+interface SimWafManagedRuleActionsProperties {
+    readonly ruleName: string;
+    readonly overrides: ReadonlyMap<string, SimWafAction>;
+    readonly counting: boolean;
+}
+/**
+ * What each rule of one managed rule group does to a request it claims.
+ */
+export interface SimWafManagedRuleActions {
+    /** The action one rule of the group takes. */
+    of(rule: SimWafManagedRuleDefinition): SimWafAction;
+    /** The action a group answers with when its rules only counted. */
+    readonly counted: SimWafAction;
+}
+/**
+ * Settle what the rules of a group do, where the rule naming it is compiled.
+ *
+ * A rule takes its own default (`Block`, or `Count` for the few AWS ships
+ * counting), an action override replaces that, and a group counting as a
+ * whole counts whatever its rules were set to.
+ */
+export declare function simWafManagedRuleActions(properties: SimWafManagedRuleActionsProperties): SimWafManagedRuleActions;
+/**
+ * Add labels to a request within a group's namespace.
+ */
+export declare function simWafAddGroupLabels(request: SimWafInspectedRequest, group: SimWafManagedRuleGroupDefinition, labels: readonly string[]): void;
+export {};

package/dist/service/wafv2/managed/sim-waf-managed-rule-actions.js

@@ -0,0 +1,26 @@
+import { SimWafAction } from "../web-acl/sim-waf-action.js";
+/**
+ * Settle what the rules of a group do, where the rule naming it is compiled.
+ *
+ * A rule takes its own default (`Block`, or `Count` for the few AWS ships
+ * counting), an action override replaces that, and a group counting as a
+ * whole counts whatever its rules were set to.
+ */
+export function simWafManagedRuleActions(properties) {
+    const { ruleName, overrides, counting } = properties;
+    const blocking = SimWafAction.read({ Block: {} }, ruleName, {});
+    const counted = SimWafAction.read({ Count: {} }, ruleName, {});
+    const ownAction = (rule) => rule.counts === true ? counted : blocking;
+    return {
+        of: (rule) => counting ? counted : (overrides.get(rule.name) ?? ownAction(rule)),
+        counted,
+    };
+}
+/**
+ * Add labels to a request within a group's namespace.
+ */
+export function simWafAddGroupLabels(request, group, labels) {
+    for (const label of labels) {
+        request.labels.add(`${group.labelNamespace}:${label}`);
+    }
+}

package/dist/service/wafv2/managed/sim-waf-managed-rule-groups.d.ts

@@ -2,8 +2,9 @@ import type { SimWafManagedRuleDefinition, SimWafManagedRuleGroupDefinition } fr
 /**
  * The vendor the simulated managed rule groups belong to.
  *
- * A group from any other vendor is refused, marketplace groups included: a
- * subscription buys rules nobody outside the vendor has ever seen.
+ * A rule naming a group from any other vendor is held unevaluated,
+ * marketplace groups included: a subscription buys rules nobody outside the
+ * vendor has ever seen.
  */
 export declare const simWafManagedVendorName = "AWS";
 /**
@@ -18,7 +19,8 @@ export interface SimWafManagedRuleEntry {
  */
 export declare function findSimWafManagedRuleGroup(vendorName: string | undefined, name: string | undefined): SimWafManagedRuleGroupDefinition | undefined;
 /**
- * The groups that are simulated, named as a refusal names them.
+ * The groups that are simulated, named as an unsimulated group's reason names
+ * them.
  */
 export declare function simWafManagedRuleGroupNames(): readonly string[];
 /**

package/dist/service/wafv2/managed/sim-waf-managed-rule-groups.js

@@ -1,17 +1,23 @@
 import { simWafAdminProtectionRuleSet } from "./group/sim-waf-admin-protection.js";
+import { simWafBotControlRuleSet } from "./group/sim-waf-bot-control.js";
 import { simWafCommonRuleSet } from "./group/sim-waf-common-rule-set.js";
+import { simWafAnonymousIpList, simWafIpReputationList, } from "./group/sim-waf-ip-reputation.js";
 import { simWafKnownBadInputsRuleSet } from "./group/sim-waf-known-bad-inputs.js";
 /**
  * The vendor the simulated managed rule groups belong to.
  *
- * A group from any other vendor is refused, marketplace groups included: a
- * subscription buys rules nobody outside the vendor has ever seen.
+ * A rule naming a group from any other vendor is held unevaluated,
+ * marketplace groups included: a subscription buys rules nobody outside the
+ * vendor has ever seen.
  */
 export const simWafManagedVendorName = "AWS";
 const groups = [
     simWafCommonRuleSet,
     simWafKnownBadInputsRuleSet,
     simWafAdminProtectionRuleSet,
+    simWafIpReputationList,
+    simWafAnonymousIpList,
+    simWafBotControlRuleSet,
 ];
 const byName = new Map(groups.map((group) => [group.name, group]));
 const rulesByName = new Map(groups.flatMap((group) => group.rules.map((rule) => [rule.name, { group, rule }])));
@@ -24,7 +30,8 @@ export function findSimWafManagedRuleGroup(vendorName, name) {
         : undefined;
 }
 /**
- * The groups that are simulated, named as a refusal names them.
+ * The groups that are simulated, named as an unsimulated group's reason names
+ * them.
  */
 export function simWafManagedRuleGroupNames() {
     return groups.map((group) => group.name);

package/dist/service/wafv2/managed/sim-waf-managed-rule.type.d.ts

@@ -23,14 +23,23 @@ export type SimWafManagedDetector = (parts: SimWafManagedRequestParts) => boolea
 /**
  * One rule of an AWS managed rule group.
  *
- * Every rule in the three simulated groups blocks by default, so the action is
- * not carried here. A rule with no detector is a declared-only rule.
+ * A rule blocks by default unless it says it counts. A rule with no detector
+ * is a declared-only rule.
  */
 export interface SimWafManagedRuleDefinition {
     /** The rule name, as AWS names it and as an override names it. */
     readonly name: string;
     /** The label this rule adds, within its group's namespace. */
     readonly label: string;
+    /**
+     * The labels the rule adds beside its own, within its group's namespace.
+     *
+     * A Bot Control rule labels the bot category or the signal it found as well
+     * as itself.
+     */
+    readonly labels?: readonly string[] | undefined;
+    /** Whether the rule counts by default where most rules block. */
+    readonly counts?: boolean | undefined;
     readonly tier: SimWafManagedRuleTier;
     readonly detects?: SimWafManagedDetector | undefined;
 }

package/dist/service/wafv2/managed/sim-waf-managed-rules.d.ts

@@ -1,13 +1,8 @@
 import type { SimWafInspectedRequest } from "../evaluate/sim-waf-inspected-request.js";
 import { type SimWafManagedRuleReport } from "./sim-waf-managed-rule-report.js";
 import type { SimWafManagedRuleTier } from "./sim-waf-managed-rule.type.js";
-/**
- * The managed rules a test says claim a request.
- */
-export interface SimWafManagedMatchDeclaration {
-    /** The rules that claim the request, by the name AWS gives them. */
-    readonly matches: readonly string[];
-}
+import { type SimWafDeclared, type SimWafManagedMatchDeclaration } from "./sim-waf-managed-declaration.js";
+export type { SimWafDeclared, SimWafManagedMatchDeclaration, } from "./sim-waf-managed-declaration.js";
 /**
  * The managed rule matches this simulated WAFv2 answers with, and what it
  * covers of each rule.
@@ -24,6 +19,15 @@ export interface SimWafManagedMatchDeclaration {
  * });
  * ```
  *
+ * Bot Control is declared by the bot rather than the rule, since a verified
+ * bot is labelled and matches no rule:
+ *
+ * ```typescript
+ * simAws.wafV2().managedRules().onRequest("/search", {
+ *   bot: { category: "search_engine", name: "googlebot", verified: true },
+ * });
+ * ```
+ *
  * A declared match is a match, and everything after it is what the group would
  * have done anyway: the rule adds its label, an action override applies to it,
  * and the group blocks by that rule.
@@ -39,9 +43,10 @@ export declare class SimWafManagedRules {
      */
     onRequest(uriPath: string, declaration: SimWafManagedMatchDeclaration): void;
     /**
-     * The rules declared to claim one request.
+     * What a test declared about one request: the rules that claim it, and the
+     * labels a group adds to it whatever its rules decide.
      */
-    declaredMatches(request: SimWafInspectedRequest): ReadonlySet<string>;
+    declared(request: SimWafInspectedRequest): SimWafDeclared;
     /**
      * What this simulation covers of one managed rule.
      */

package/dist/service/wafv2/managed/sim-waf-managed-rules.js

@@ -1,7 +1,7 @@
 import { SimWafDeclarationError } from "../error/sim-wafv2.error.js";
 import { findSimWafManagedRule, } from "./sim-waf-managed-rule-groups.js";
 import { simWafManagedRuleReports, } from "./sim-waf-managed-rule-report.js";
-const noMatches = new Set();
+import { simWafNothingDeclared, simWafReadDeclaration, } from "./sim-waf-managed-declaration.js";
 /**
  * The managed rule matches this simulated WAFv2 answers with, and what it
  * covers of each rule.
@@ -18,6 +18,15 @@ const noMatches = new Set();
  * });
  * ```
  *
+ * Bot Control is declared by the bot rather than the rule, since a verified
+ * bot is labelled and matches no rule:
+ *
+ * ```typescript
+ * simAws.wafV2().managedRules().onRequest("/search", {
+ *   bot: { category: "search_engine", name: "googlebot", verified: true },
+ * });
+ * ```
+ *
  * A declared match is a match, and everything after it is what the group would
  * have done anyway: the rule adds its label, an action override applies to it,
  * and the group blocks by that rule.
@@ -36,13 +45,14 @@ export class SimWafManagedRules {
             throw new SimWafDeclarationError("A declared managed rule match needs the URI path of the request it " +
                 "is declared for");
         }
-        this.#byUriPath.set(uriPath, new Set(declaration.matches.map((name) => this.requiredRule(name).rule.name)));
+        this.#byUriPath.set(uriPath, simWafReadDeclaration(declaration, (name) => this.requiredRule(name).rule.name));
     }
     /**
-     * The rules declared to claim one request.
+     * What a test declared about one request: the rules that claim it, and the
+     * labels a group adds to it whatever its rules decide.
      */
-    declaredMatches(request) {
-        return this.#byUriPath.get(request.uriPath) ?? noMatches;
+    declared(request) {
+        return this.#byUriPath.get(request.uriPath) ?? simWafNothingDeclared;
     }
     /**
      * What this simulation covers of one managed rule.

package/dist/service/wafv2/resource/sim-waf-resource.d.ts

@@ -1,6 +1,7 @@
 import type { SimAwsAccountRegionScope } from "../../aws/sim-aws-account-region-scope.js";
 import { type SimWafResourceKind } from "../sim-wafv2-arn.js";
 import type { SimWafScope } from "../scope/sim-waf-scope.js";
+import { type SimWafUnsimulatedPart } from "./sim-waf-unsimulated-part.js";
 /**
  * What every WAFv2 resource reports about itself in a listing.
  */
@@ -16,6 +17,7 @@ export interface SimWafResourceProperties {
     readonly scope: SimWafScope;
     readonly accountRegionScope: SimAwsAccountRegionScope;
     readonly description?: string | undefined;
+    readonly tags?: readonly unknown[] | undefined;
 }
 /**
  * What a web ACL, an IP set and a regex pattern set have in common.
@@ -32,11 +34,19 @@ export declare abstract class SimWafResource {
     readonly scope: SimWafScope;
     readonly id: string;
     readonly arn: string;
+    /** The tags the resource was created with, held as they were written. */
+    readonly tags: readonly unknown[];
     protected constructor(kind: SimWafResourceKind, properties: SimWafResourceProperties);
     /**
      * What the resource was created or last updated with as its description.
      */
     get description(): string | undefined;
+    /**
+     * What this resource was written with and the simulation does not act on.
+     *
+     * A web ACL adds the rules and members it holds without evaluating.
+     */
+    get unsimulated(): readonly SimWafUnsimulatedPart[];
     /**
      * The token the next write to this resource has to present.
      */

package/dist/service/wafv2/resource/sim-waf-resource.js

@@ -1,6 +1,7 @@
 import { randomUUID } from "node:crypto";
 import { SimWafOptimisticLockException } from "../error/sim-wafv2.error.js";
 import { simWafArn } from "../sim-wafv2-arn.js";
+import { simWafTagsParts, } from "./sim-waf-unsimulated-part.js";
 /**
  * What a web ACL, an IP set and a regex pattern set have in common.
  *
@@ -15,12 +16,15 @@ export class SimWafResource {
     scope;
     id = randomUUID();
     arn;
+    /** The tags the resource was created with, held as they were written. */
+    tags;
     #description;
     #lockToken = randomUUID();
     constructor(kind, properties) {
         this.name = properties.name;
         this.scope = properties.scope;
         this.#description = properties.description;
+        this.tags = properties.tags ?? [];
         this.arn = simWafArn({
             accountRegionScope: properties.accountRegionScope,
             scope: properties.scope,
@@ -35,6 +39,14 @@ export class SimWafResource {
     get description() {
         return this.#description;
     }
+    /**
+     * What this resource was written with and the simulation does not act on.
+     *
+     * A web ACL adds the rules and members it holds without evaluating.
+     */
+    get unsimulated() {
+        return simWafTagsParts(this.tags);
+    }
     /**
      * The token the next write to this resource has to present.
      */