tor-browser

The Tor Browser
git clone https://git.dasho.dev/tor-browser.git
Log | Files | Refs | README | LICENSE

turtledove.idl (12459B)

      1 // GENERATED CONTENT - DO NOT EDIT
      2 // Content was automatically extracted by Reffy into webref
      3 // (https://github.com/w3c/webref)
      4 // Source: Protected Audience (formerly FLEDGE) (https://wicg.github.io/turtledove/)
      5 
      6 [SecureContext]
      7 partial interface Navigator {
      8  Promise<undefined> joinAdInterestGroup(AuctionAdInterestGroup group);
      9 };
     10 
     11 dictionary AuctionAd {
     12  required USVString renderURL;
     13  USVString sizeGroup;
     14  any metadata;
     15 
     16  USVString buyerReportingId;
     17  USVString buyerAndSellerReportingId;
     18  sequence<USVString> selectableBuyerAndSellerReportingIds;
     19  sequence<USVString> allowedReportingOrigins;
     20  DOMString adRenderId;
     21  USVString creativeScanningMetadata;
     22 };
     23 
     24 dictionary AuctionAdInterestGroupSize {
     25  required USVString width;
     26  required USVString height;
     27 };
     28 
     29 dictionary GenerateBidInterestGroup {
     30  required USVString owner;
     31  required USVString name;
     32 
     33  boolean enableBiddingSignalsPrioritization = false;
     34  record<DOMString, double> priorityVector;
     35 
     36  record<USVString, sequence<DOMString>> sellerCapabilities;
     37  DOMString executionMode = "compatibility";
     38  USVString biddingLogicURL;
     39  USVString biddingWasmHelperURL;
     40  USVString updateURL;
     41  USVString trustedBiddingSignalsURL;
     42  sequence<USVString> trustedBiddingSignalsKeys;
     43  DOMString trustedBiddingSignalsSlotSizeMode = "none";
     44  long maxTrustedBiddingSignalsURLLength;
     45  USVString trustedBiddingSignalsCoordinator;
     46  any userBiddingSignals;
     47  sequence<AuctionAd> ads;
     48  sequence<AuctionAd> adComponents;
     49  record<DOMString, AuctionAdInterestGroupSize> adSizes;
     50  record<DOMString, sequence<DOMString>> sizeGroups;
     51 };
     52 
     53 dictionary ProtectedAudiencePrivateAggregationConfig {
     54  USVString aggregationCoordinatorOrigin;
     55 };
     56 
     57 dictionary AuctionAdInterestGroup : GenerateBidInterestGroup {
     58  double priority = 0.0;
     59  record<DOMString, double> prioritySignalsOverrides;
     60  required double lifetimeMs;
     61  DOMString additionalBidKey;
     62  ProtectedAudiencePrivateAggregationConfig privateAggregationConfig;
     63 };
     64 
     65 [SecureContext]
     66 partial interface Navigator {
     67  Promise<undefined> leaveAdInterestGroup(optional AuctionAdInterestGroupKey group = {});
     68 };
     69 
     70 dictionary AuctionAdInterestGroupKey {
     71  required USVString owner;
     72  required USVString name;
     73 };
     74 
     75 [SecureContext]
     76 partial interface Navigator {
     77  Promise<undefined> clearOriginJoinedAdInterestGroups(
     78      USVString owner, optional sequence<USVString> interestGroupsToKeep = []);
     79 };
     80 
     81 [SecureContext]
     82 partial interface Navigator {
     83  Promise<(USVString or FencedFrameConfig)?> runAdAuction(AuctionAdConfig config);
     84  readonly attribute boolean deprecatedRunAdAuctionEnforcesKAnonymity;
     85 };
     86 
     87 dictionary AuctionReportBuyersConfig {
     88  required bigint bucket;
     89  required double scale;
     90 };
     91 
     92 dictionary AuctionReportBuyerDebugModeConfig {
     93  boolean enabled = false;
     94 
     95  // Must only be provided if `enabled` is true.
     96  bigint? debugKey;
     97 };
     98 
     99 dictionary AuctionRealTimeReportingConfig {
    100  required DOMString type;
    101 };
    102 
    103 dictionary AuctionAdConfig {
    104  required USVString seller;
    105  required USVString decisionLogicURL;
    106 
    107  USVString trustedScoringSignalsURL;
    108  long maxTrustedScoringSignalsURLLength;
    109  USVString trustedScoringSignalsCoordinator;
    110  boolean sendCreativeScanningMetadata;
    111  sequence<USVString> interestGroupBuyers;
    112  Promise<any> auctionSignals;
    113  Promise<any> sellerSignals;
    114  Promise<DOMString?> directFromSellerSignalsHeaderAdSlot;
    115  Promise<record<USVString, USVString>?> deprecatedRenderURLReplacements;
    116  unsigned long long sellerTimeout;
    117  unsigned short sellerExperimentGroupId;
    118  Promise<record<USVString, any>?> perBuyerSignals;
    119  Promise<record<USVString, unsigned long long>?> perBuyerTimeouts;
    120  Promise<record<USVString, unsigned long long>?> perBuyerCumulativeTimeouts;
    121  unsigned long long reportingTimeout;
    122  USVString sellerCurrency;
    123  Promise<record<USVString, USVString>?> perBuyerCurrencies;
    124  record<USVString, unsigned short> perBuyerMultiBidLimits;
    125  record<USVString, unsigned short> perBuyerGroupLimits;
    126  record<USVString, unsigned short> perBuyerExperimentGroupIds;
    127  record<USVString, record<USVString, double>> perBuyerPrioritySignals;
    128 
    129  sequence<bigint> auctionReportBuyerKeys;
    130  record<DOMString, AuctionReportBuyersConfig> auctionReportBuyers;
    131  AuctionReportBuyerDebugModeConfig auctionReportBuyerDebugModeConfig;
    132  sequence<DOMString> requiredSellerCapabilities;
    133  ProtectedAudiencePrivateAggregationConfig privateAggregationConfig;
    134 
    135  record<DOMString, DOMString> requestedSize;
    136  sequence<record<DOMString, DOMString>> allSlotsRequestedSizes;
    137  Promise<undefined> additionalBids;
    138  DOMString auctionNonce;
    139  AuctionRealTimeReportingConfig sellerRealTimeReportingConfig;
    140  record<USVString, AuctionRealTimeReportingConfig> perBuyerRealTimeReportingConfig;
    141  sequence<AuctionAdConfig> componentAuctions = [];
    142  AbortSignal? signal;
    143  Promise<boolean> resolveToConfig;
    144 
    145  Promise<Uint8Array> serverResponse;
    146  USVString requestId;
    147 };
    148 
    149 [SecureContext]
    150 partial interface Navigator {
    151  boolean canLoadAdAuctionFencedFrame();
    152 };
    153 
    154 [SecureContext]
    155 partial interface Navigator {
    156  Promise<AdAuctionData> getInterestGroupAdAuctionData(optional AdAuctionDataConfig config = {});
    157 };
    158 
    159 dictionary AdAuctionPerSellerData {
    160  required USVString seller;
    161  Uint8Array request;
    162  DOMString error;
    163 };
    164 
    165 dictionary AdAuctionData {
    166  required USVString requestId;
    167  Uint8Array request;
    168  sequence<AdAuctionPerSellerData> requests;
    169 };
    170 
    171 dictionary AdAuctionOneSeller {
    172  required USVString seller;
    173  USVString coordinatorOrigin;
    174 };
    175 
    176 dictionary AdAuctionDataConfig {
    177  USVString seller;
    178  USVString coordinatorOrigin;
    179  sequence<AdAuctionOneSeller> sellers;
    180 
    181  unsigned long requestSize;
    182  record<USVString, AdAuctionDataBuyerConfig> perBuyerConfig;
    183 };
    184 
    185 dictionary AdAuctionDataBuyerConfig {
    186  unsigned long targetSize;
    187 };
    188 
    189 dictionary StorageInterestGroup : AuctionAdInterestGroup {
    190  unsigned long long joinCount;
    191  unsigned long long bidCount;
    192  sequence<PreviousWin> prevWinsMs;
    193  USVString joiningOrigin;
    194  long long timeSinceGroupJoinedMs;
    195  long long lifetimeRemainingMs;
    196  long long timeSinceLastUpdateMs;
    197  long long timeUntilNextUpdateMs;
    198  unsigned long long estimatedSize;
    199 };
    200 
    201 [SecureContext]
    202 partial interface Navigator {
    203  Promise<DOMString> createAuctionNonce();
    204 };
    205 
    206 [Exposed=InterestGroupScriptRunnerGlobalScope]
    207 interface InterestGroupScriptRunnerGlobalScope {
    208  readonly attribute PrivateAggregation? privateAggregation;
    209  readonly attribute ProtectedAudienceUtilities protectedAudience;
    210 };
    211 
    212 dictionary PASignalValue {
    213  required DOMString baseValue;
    214  double scale;
    215  (bigint or long) offset;
    216 };
    217 
    218 dictionary PAExtendedHistogramContribution {
    219  required (PASignalValue or bigint) bucket;
    220  required (PASignalValue or long) value;
    221  bigint filteringId = 0;
    222 };
    223 
    224 [Exposed=InterestGroupScriptRunnerGlobalScope]
    225 interface ProtectedAudienceUtilities {
    226  Uint8Array encodeUtf8(USVString input);
    227  USVString decodeUtf8(Uint8Array bytes);
    228 };
    229 
    230 [Exposed=InterestGroupBiddingAndScoringScriptRunnerGlobalScope]
    231 interface ForDebuggingOnly {
    232  undefined reportAdAuctionWin(USVString url);
    233  undefined reportAdAuctionLoss(USVString url);
    234 };
    235 
    236 [Exposed=InterestGroupBiddingAndScoringScriptRunnerGlobalScope]
    237 interface RealTimeReporting {
    238  undefined contributeToHistogram(RealTimeContribution contribution);
    239 };
    240 
    241 dictionary RealTimeContribution {
    242  required long bucket;
    243  required double priorityWeight;
    244  long latencyThreshold;
    245 };
    246 
    247 [Exposed=InterestGroupBiddingAndScoringScriptRunnerGlobalScope,
    248 Global=InterestGroupBiddingAndScoringScriptRunnerGlobalScope]
    249 interface InterestGroupBiddingAndScoringScriptRunnerGlobalScope : InterestGroupScriptRunnerGlobalScope {
    250  readonly attribute ForDebuggingOnly forDebuggingOnly;
    251  readonly attribute RealTimeReporting realTimeReporting;
    252 };
    253 
    254 [Exposed=InterestGroupBiddingScriptRunnerGlobalScope,
    255 Global=(InterestGroupScriptRunnerGlobalScope,
    256         InterestGroupBiddingScriptRunnerGlobalScope)]
    257 interface InterestGroupBiddingScriptRunnerGlobalScope
    258        : InterestGroupBiddingAndScoringScriptRunnerGlobalScope {
    259  boolean setBid(optional (GenerateBidOutput or sequence<GenerateBidOutput>) oneOrManyBids = []);
    260  undefined setPriority(double priority);
    261  undefined setPrioritySignalsOverride(DOMString key, optional double? priority);
    262 };
    263 
    264 dictionary AdRender {
    265  required DOMString url;
    266  DOMString width;
    267  DOMString height;
    268 };
    269 
    270 dictionary GenerateBidOutput {
    271  double bid = -1;
    272  DOMString bidCurrency;
    273  (DOMString or AdRender) render;
    274  any ad;
    275  USVString selectedBuyerAndSellerReportingId;
    276  sequence<(DOMString or AdRender)> adComponents;
    277  double adCost;
    278  unrestricted double modelingSignals;
    279  boolean allowComponentAuction = false;
    280  unsigned long targetNumAdComponents;
    281  unsigned long numMandatoryAdComponents = 0;
    282 };
    283 
    284 [Exposed=InterestGroupScoringScriptRunnerGlobalScope,
    285 Global=(InterestGroupScriptRunnerGlobalScope,
    286         InterestGroupScoringScriptRunnerGlobalScope)]
    287 interface InterestGroupScoringScriptRunnerGlobalScope
    288        : InterestGroupBiddingAndScoringScriptRunnerGlobalScope {
    289 };
    290 
    291 [Exposed=InterestGroupReportingScriptRunnerGlobalScope,
    292 Global=(InterestGroupScriptRunnerGlobalScope,
    293         InterestGroupReportingScriptRunnerGlobalScope)]
    294 interface InterestGroupReportingScriptRunnerGlobalScope
    295        : InterestGroupScriptRunnerGlobalScope {
    296  undefined sendReportTo(DOMString url);
    297  undefined registerAdBeacon(record<DOMString, USVString> map);
    298  undefined registerAdMacro(DOMString name, USVString value);
    299 };
    300 
    301 [SecureContext]
    302 partial interface Navigator {
    303  undefined updateAdInterestGroups();
    304 };
    305 
    306 [SecureContext]
    307 partial interface Navigator {
    308  [SameObject] readonly attribute ProtectedAudience protectedAudience;
    309 };
    310 
    311 [SecureContext, Exposed=Window]
    312 interface ProtectedAudience {
    313  any queryFeatureSupport(DOMString feature);
    314 };
    315 
    316 partial dictionary RequestInit {
    317  boolean adAuctionHeaders;
    318 };
    319 
    320 partial interface HTMLIFrameElement {
    321  [CEReactions] attribute boolean adAuctionHeaders;
    322 };
    323 
    324 typedef (long long or AuctionAd) PreviousWinElement;
    325 typedef sequence<PreviousWinElement> PreviousWin;
    326 
    327 dictionary BiddingBrowserSignals {
    328  required DOMString topWindowHostname;
    329  required USVString seller;
    330  required long joinCount;
    331  required long bidCount;
    332  required long recency;
    333  required long adComponentsLimit;
    334  required unsigned short multiBidLimit;
    335 
    336  record<DOMString, DOMString> requestedSize;
    337  USVString topLevelSeller;
    338  sequence<PreviousWin> prevWinsMs;
    339  object wasmHelper;
    340  unsigned long dataVersion;
    341  unsigned long crossOriginDataVersion;
    342  boolean forDebuggingOnlyInCooldownOrLockout = false;
    343 };
    344 
    345 dictionary ScoringBrowserSignals {
    346  required DOMString topWindowHostname;
    347  required USVString interestGroupOwner;
    348  required USVString renderURL;
    349  required unsigned long biddingDurationMsec;
    350  required DOMString bidCurrency;
    351 
    352  record<DOMString, DOMString> renderSize;
    353  unsigned long dataVersion;
    354  unsigned long crossOriginDataVersion;
    355  sequence<USVString> adComponents;
    356  boolean forDebuggingOnlyInCooldownOrLockout = false;
    357  USVString creativeScanningMetadata;
    358  sequence<USVString?> adComponentsCreativeScanningMetadata;
    359 };
    360 
    361 dictionary ReportingBrowserSignals {
    362  required DOMString topWindowHostname;
    363  required USVString interestGroupOwner;
    364  required USVString renderURL;
    365  required double bid;
    366  required double highestScoringOtherBid;
    367 
    368  DOMString bidCurrency;
    369  DOMString highestScoringOtherBidCurrency;
    370  USVString topLevelSeller;
    371  USVString componentSeller;
    372 
    373  USVString buyerAndSellerReportingId;
    374  USVString selectedBuyerAndSellerReportingId;
    375 };
    376 
    377 dictionary ReportResultBrowserSignals : ReportingBrowserSignals {
    378  required double desirability;
    379 
    380  DOMString topLevelSellerSignals;
    381  double modifiedBid;
    382  unsigned long dataVersion;
    383 };
    384 
    385 dictionary ReportWinBrowserSignals : ReportingBrowserSignals {
    386  double adCost;
    387  USVString seller;
    388  boolean madeHighestScoringOtherBid;
    389  DOMString interestGroupName;
    390  DOMString buyerReportingId;
    391  unsigned short modelingSignals;
    392  unsigned long dataVersion;
    393  KAnonStatus kAnonStatus;
    394 };
    395 
    396 enum KAnonStatus { "passedAndEnforced", "passedNotEnforced", "belowThreshold", "notCalculated" };
    397 
    398 dictionary DirectFromSellerSignalsForBuyer {
    399  any auctionSignals = null;
    400  any perBuyerSignals = null;
    401 };
    402 
    403 dictionary DirectFromSellerSignalsForSeller {
    404  any auctionSignals = null;
    405  any sellerSignals = null;
    406 };
    407 
    408 dictionary ScoreAdOutput {
    409  required double desirability;
    410  double bid;
    411  DOMString bidCurrency;
    412  double incomingBidInSellerCurrency;
    413  boolean allowComponentAuction = false;
    414 };