@google-psat/common 0.14.1 → 1.2.1

package/dist-types/protectedAudience.types.d.ts

@@ -14,9 +14,10 @@ export interface singleAuctionEvent {
     componentSellerOrigin?: string;
     time: number;
     auctionConfig?: object;
+    url?: string;
     interestGroupConfig?: Protocol.Storage.InterestGroupAccessedEvent;
     parentAuctionId?: Protocol.Storage.InterestGroupAuctionId;
-    eventType: 'interestGroupAuctionEventOccurred' | 'interestGroupAuctionNetworkRequestCompleted' | 'interestGroupAuctionNetworkRequestCreated' | 'interestGroupAccessed';
+    eventType: 'interestGroupAuctionEventOccurred' | 'interestGroupAuctionNetworkRequestCompleted' | 'interestGroupAuctionNetworkRequestCreated' | 'interestGroupAccessed' | 'BidAvailable';
 }
 export interface auctionData {
     [uniqueAuctionId: Protocol.Storage.InterestGroupAuctionId]: {
@@ -45,6 +46,14 @@ export type NoBidsType = {
         mediaContainerSize?: number[][];
     };
 };
+export type PrebidNoBidsType = {
+    [adUnitCode: string]: {
+        bidder: string[];
+        uniqueAuctionId: string;
+        adUnitCode?: string;
+        mediaContainerSize?: number[][];
+    };
+};
 export type AdsAndBiddersTypeData = {
     adUnitCode: string;
     bidders: string[];
@@ -52,6 +61,7 @@ export type AdsAndBiddersTypeData = {
     winningBid: number;
     bidCurrency: string;
     winningBidder: string;
+    winningMediaContainerSize?: number[][];
 };
 export type AdsAndBiddersType = {
     [adUnitCode: string]: AdsAndBiddersTypeData;
@@ -61,3 +71,24 @@ export type ReceivedBids = singleAuctionEvent & {
     mediaContainerSize?: number[][];
     adType?: string;
 };
+export interface PrebidDebugModuleConfig {
+    enabled?: boolean;
+    intercept: PrebidDebugModuleConfigRule[];
+}
+export interface PrebidDebugModuleConfigRule {
+    when: {
+        [key: string]: string | number;
+    };
+    then: {
+        [key: string]: string | number;
+    };
+}
+export type AuctionEventsType = {
+    [adunit: string]: {
+        [time: string]: {
+            [sellerURL: string]: {
+                [auctionHostURL: string]: singleAuctionEvent[];
+            };
+        };
+    };
+};

package/dist-types/prtToken.types.d.ts

@@ -0,0 +1,33 @@
+export interface ProbablisticRevealToken {
+    version: number;
+    u: Uint8Array<any>;
+    e: Uint8Array<any>;
+    epochId: Uint8Array<any>;
+    prtHeader: string;
+    epochIdBase64: string;
+}
+interface DecryptedToken {
+    plainText: Uint8Array<any>;
+    hmacSecret: Uint8Array<ArrayBuffer>;
+}
+interface PlaintTextToken {
+    uint8Signal: Uint8Array<any>;
+    ordinal: Uint8Array<any>;
+    version: number;
+    hmacValid: boolean;
+}
+export interface PRTMetadata {
+    origin: string;
+    isInMDL: boolean;
+    decryptionKeyAvailable: boolean;
+    prtHeader: string;
+    nonZeroUint8Signal: boolean;
+    owner: string;
+}
+export type UniquePlainTextToken = PlaintTextToken & {
+    prtHeader?: string;
+};
+export type UniqueDecryptedToken = DecryptedToken & {
+    prtHeader?: string;
+};
+export {};

package/dist-types/utils/auctions/bidderCreator.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Internal dependencies
+ */
+import { PrebidAuctionEventType } from '../../prebid.types';
+import { BidRequestedEvent, BidResponse, BidTimeoutEvent, NoBid } from '../../prebidGlobal.types';
+import { Bidder, BidderType } from './types';
+/**
+ * Forms data for received bids in an auction
+ * @param receivedBids Array of bid responses received in the auction
+ * @param bidderRequest The bidder request event data
+ * @param auctionEndTimestamp Timestamp marking the end of the auction
+ * @returns {Partial<Bidder> | null} Bidder data object or null if no matching bid is found
+ */
+export declare function formReceivedBidData(receivedBids: BidResponse[], bidderRequest: BidRequestedEvent, auctionEndTimestamp: number): {
+    name: string;
+    startTime: number;
+    endTime: number;
+    duration: string;
+    type: BidderType;
+    data: BidRequestedEvent;
+} | null;
+/**
+ * Forms data for bids that received no response
+ * @param noBids Array of bid responses that received no bids
+ * @param bidderRequest The bidder request event data
+ * @param auctionEndTimestamp Timestamp marking the end of the auction
+ * @param events Array of Prebid auction events
+ * @returns {Partial<Bidder> | null} Bidder data object or null if no matching bid is found
+ */
+export declare function formNoBidData(noBids: NoBid[], bidderRequest: BidRequestedEvent, auctionEndTimestamp: number, events: PrebidAuctionEventType[]): Partial<Bidder> | null;
+/**
+ * Forms data for bids that received no response
+ * @param timedOutBids Array of bid responses that received no bids
+ * @param bidderRequest The bidder request event data
+ * @param auctionEndTimestamp Timestamp marking the end of the auction
+ * @param events Array of Prebid auction events
+ * @returns {Partial<Bidder> | null} Bidder data object or null if no matching bid is found
+ */
+export declare function formTimedOutBids(timedOutBids: BidTimeoutEvent[], bidderRequest: BidRequestedEvent, auctionEndTimestamp: number, events: PrebidAuctionEventType[]): Partial<Bidder> | null;

package/dist-types/utils/auctions/findMaximumBidderDuration.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Internal dependencies.
+ */
+import type { Bidder } from './types';
+export declare const findMaximumBidderDuration: (bidders: Bidder[]) => number;

package/dist-types/utils/auctions/formatDuration.d.ts

@@ -0,0 +1 @@
+export declare const formatDuration: (value: string) => string;

package/dist-types/utils/auctions/formatTimestamp.d.ts

@@ -0,0 +1 @@
+export declare const formatTimestamp: (timestamp: number) => string;

package/dist-types/utils/auctions/index.d.ts

@@ -0,0 +1,5 @@
+export * from './findMaximumBidderDuration';
+export * from './formatDuration';
+export * from './formatTimestamp';
+export * from './prepareTimelineData';
+export * from './types';

package/dist-types/utils/auctions/prepareTimelineData.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Internal dependencies.
+ */
+import { PrebidEvents } from '../../prebid.types';
+import { AuctionEventsType } from '../../protectedAudience.types';
+export declare const prepareTimelineData: (auctionEvents: PrebidEvents["auctionEvents"] | AuctionEventsType, isPrebid: boolean) => any;

package/dist-types/utils/auctions/types.d.ts

@@ -0,0 +1,24 @@
+export declare enum BidderType {
+    BID = "bid",
+    NO_BID = "no-bid",
+    WON = "won",
+    TIMED_OUT = "timed-out"
+}
+export interface Bidder {
+    name: string;
+    duration: string;
+    type: BidderType;
+    data?: any;
+    startTime: number;
+    endTime: number;
+    adUnitCode: string;
+    serverResponseTimeMs?: number;
+}
+export interface TimelineData {
+    auctionTimeout: number;
+    auctionId: string;
+    auctionStartTimeFormatted: string;
+    auctionTime: string;
+    bidders: Bidder[];
+    auctionEndDuration: number;
+}

package/dist-types/utils/extractReportData.d.ts

@@ -2,12 +2,8 @@
  * Internal dependencies
  */
 import { CompleteJson, ErroredOutUrlsData } from '../cookies.types';
-import { LibraryData } from '../libraryDetection.types';
 declare const extractReportData: (data: CompleteJson[]) => {
     landingPageCookies: {};
-    consolidatedLibraryMatches: {
-        [url: string]: LibraryData;
-    };
     erroredOutUrlsData: ErroredOutUrlsData[];
 };
 export default extractReportData;

package/dist-types/utils/isValidURL.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Returns if a url is valid or not
+ * @param {string } urlString The url that needs to be checked for validity.
+ * @returns {boolean} validity of the url
+ */
+declare const isValidURL: (urlString: string) => boolean;
+export default isValidURL;

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@google-psat/common",
-  "version": "0.14.1",
+  "version": "1.2.1",
   "description": "A package for common utilities that are being used in multiple packages",
+  "type": "module",
   "main": "dist/index.js",
   "types": "dist-types/index.d.ts",
   "source": "src/index.ts",
@@ -38,8 +39,9 @@
   "dependencies": {
     "@google-psat/i18n": "*",
     "@types/lodash-es": "^4.17.12",
-    "lodash-es": "^4.17.21",
-    "tldts": "^6.0.14"
+    "lodash-es": "^4.17.23",
+    "tldts": "^6.0.14",
+    "use-context-selector": "^1.4.1"
   },
   "devDependencies": {
     "devtools-protocol": "^0.0.1345247"

package/tsconfig.json

@@ -1,9 +1,9 @@
 {
   "compilerOptions": {
     "rootDir": "src",
-    "target": "es6",
-    "lib": ["es2021"],
-    "module": "commonjs",
+    "target": "ESNext",
+    "lib": ["ESNext"],
+    "module": "ESNext",
     "outDir": "dist",
     "declarationDir": "dist-types",
     "composite": true,

package/dist/libraryDetection.types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=libraryDetection.types.js.map

package/dist/libraryDetection.types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"libraryDetection.types.js","sourceRoot":"","sources":["../src/libraryDetection.types.ts"],"names":[],"mappings":""}

package/dist/worker/devToolWorker.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"devToolWorker.js","sourceRoot":"","sources":["../../src/worker/devToolWorker.ts"],"names":[],"mappings":";;AAAA;;;;;;;;;;;;;;GAcG;AACH,IAAI,aAAa,GAAkB,IAAI,CAAC;AAExC;;;GAGG;AACH,MAAM,gBAAgB,GAAG,GAAW,EAAE;IACpC,aAAa,GAAG,aAAa,IAAI,IAAI,MAAM,CAAC,WAAW,CAAC,CAAC;IAEzD,OAAO,aAAa,CAAC;AACvB,CAAC,CAAC;AAEF,kBAAe,gBAAgB,CAAC"}

package/dist/worker/enums.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../src/worker/enums.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;GAcG;AACH,IAAY,6BAEX;AAFD,WAAY,6BAA6B;IACvC,sFAAqD,CAAA;AACvD,CAAC,EAFW,6BAA6B,6CAA7B,6BAA6B,QAExC"}

package/dist/worker/executeTaskInDevToolWorker.js

@@ -1,43 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/*
- * Copyright 2023 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-/**
- * Internal dependencies.
- */
-const devToolWorker_1 = __importDefault(require("./devToolWorker"));
-/**
- * Execute a task using a web worker.
- * This is a highlevel abstraction over webworker.
- * @param {string} task - The predefined task to be executed by the worker.
- * @param {unknown} payload - The payload or data required for the task.
- * @param {Function} onMessage callback.
- */
-const executeTaskInDevToolWorker = (task, payload, onMessage) => {
-    const worker = (0, devToolWorker_1.default)();
-    worker.postMessage({
-        task,
-        payload,
-    });
-    worker.onmessage = (resultEvent) => {
-        onMessage(resultEvent.data);
-    };
-};
-exports.default = executeTaskInDevToolWorker;
-//# sourceMappingURL=executeTaskInDevToolWorker.js.map

package/dist/worker/executeTaskInDevToolWorker.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"executeTaskInDevToolWorker.js","sourceRoot":"","sources":["../../src/worker/executeTaskInDevToolWorker.ts"],"names":[],"mappings":";;;;;AAAA;;;;;;;;;;;;;;GAcG;AACH;;GAEG;AACH,oEAA+C;AAI/C;;;;;;GAMG;AACH,MAAM,0BAA0B,GAAG,CACjC,IAAmC,EACnC,OAAgB,EAChB,SAAgD,EAChD,EAAE;IACF,MAAM,MAAM,GAAG,IAAA,uBAAgB,GAAE,CAAC;IAElC,MAAM,CAAC,WAAW,CAAC;QACjB,IAAI;QACJ,OAAO;KACR,CAAC,CAAC;IAEH,MAAM,CAAC,SAAS,GAAG,CAAC,WAAyB,EAAE,EAAE;QAC/C,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,0BAA0B,CAAC"}

package/dist-types/libraryDetection.types.d.ts

@@ -1,50 +0,0 @@
-export type DetectedSignature = {
-    feature: {
-        type: 'link';
-        text: string;
-        url: string;
-    };
-    subItems: {
-        type: 'subitems';
-        items: {
-            sourceLocation: string;
-            snippet: string;
-        }[];
-    };
-};
-export type LibraryData = {
-    [key: string]: {
-        signatureMatches?: number;
-        moduleMatch?: number;
-        matches?: DetectedSignature[];
-        domQuerymatches?: [string] | null;
-    };
-};
-export type ScriptTagUnderCheck = {
-    origin: string | null;
-    content: string;
-    type?: string;
-};
-export type DetectionFunctions = (arg0: ScriptTagUnderCheck, arg1: DetectedSignature[], arg2: number, arg3: number) => {
-    signatureMatches: number;
-    matches: DetectedSignature[];
-    moduleMatch?: number;
-};
-export type LibraryMatchers = {
-    name?: string;
-    component: React.FC;
-    signatures?: {
-        strongMatches: {
-            signature: string;
-            helpUrl: string;
-        }[];
-        weakMatches: {
-            signature: string;
-            helpUrl: string;
-        }[];
-    };
-    domainsToSkip?: string[];
-    helpUrl: string;
-    detectionFunction?: DetectionFunctions;
-    domQueryFunction?: (externalDocument?: Document | null) => string[];
-};

package/dist-types/worker/devToolWorker.d.ts

@@ -1,6 +0,0 @@
-/**
- * Get the devTool worker instance. If it doesn't exist, it creates a new one.
- * @returns {Worker} The DevTool worker instance.
- */
-declare const getDevToolWorker: () => Worker;
-export default getDevToolWorker;

package/dist-types/worker/enums.d.ts

@@ -1,3 +0,0 @@
-export declare enum LIBRARY_DETECTION_WORKER_TASK {
-    DETECT_SIGNATURE_MATCHING = "DetectSignatureMatching"
-}

package/dist-types/worker/executeTaskInDevToolWorker.d.ts

@@ -1,11 +0,0 @@
-import type { LibraryData } from '../libraryDetection.types';
-import { LIBRARY_DETECTION_WORKER_TASK } from './enums';
-/**
- * Execute a task using a web worker.
- * This is a highlevel abstraction over webworker.
- * @param {string} task - The predefined task to be executed by the worker.
- * @param {unknown} payload - The payload or data required for the task.
- * @param {Function} onMessage callback.
- */
-declare const executeTaskInDevToolWorker: (task: LIBRARY_DETECTION_WORKER_TASK, payload: unknown, onMessage: (dataFromThread: LibraryData) => void) => void;
-export default executeTaskInDevToolWorker;