@google-psat/analysis-utils 0.9.0-1

package/dist-types/procedures/analyzeCookiesUrlsInBatchesAndFetchResources.d.ts

@@ -0,0 +1,29 @@
+/**
+ * External dependencies.
+ */
+import { CookieData, CookieDatabase, LibraryData, LibraryMatchers } from '@google-psat/common';
+export declare const analyzeCookiesUrlsInBatchesAndFetchResources: (urls: string[], Libraries: LibraryMatchers[], isHeadless: boolean, delayTime: number, cookieDictionary: CookieDatabase, batchSize?: number, spinnies?: {
+    add: (id: string, { text, indent }: {
+        text: string;
+        indent: number;
+    }) => void;
+    succeed: (id: string, { text, indent }: {
+        text: string;
+        indent: number;
+    }) => void;
+}, shouldSkipAcceptBanner?: boolean) => Promise<{
+    url: string;
+    cookieData: {
+        [frameUrl: string]: {
+            frameCookies: {
+                [key: string]: CookieData;
+            };
+        };
+    };
+    resources: {
+        origin: string | null;
+        content: string;
+        type?: string;
+    }[];
+    domQueryMatches: LibraryData;
+}[]>;

package/dist-types/procedures/analyzeTechnologiesUrlsInBatches.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Internal dependencies.
+ */
+import { TechnologyDetailList } from '../types';
+export declare const analyzeTechnologiesUrlsInBatches: (urls: Array<string>, batchSize?: number, spinnies?: {
+    add: (id: string, { text, indent }: {
+        text: string;
+        indent: number;
+    }) => void;
+    succeed: (id: string, { text, indent }: {
+        text: string;
+        indent: number;
+    }) => void;
+}) => Promise<TechnologyDetailList[]>;

package/dist-types/procedures/index.d.ts

@@ -0,0 +1,3 @@
+export { analyzeCookiesUrlsAndFetchResources } from './analyzeCookiesUrlsAndFetchResources';
+export { analyzeCookiesUrlsInBatchesAndFetchResources } from './analyzeCookiesUrlsInBatchesAndFetchResources';
+export { analyzeTechnologiesUrlsInBatches } from './analyzeTechnologiesUrlsInBatches';

package/dist-types/types.d.ts

@@ -0,0 +1,80 @@
+/**
+ * External dependencies.
+ */
+import { Protocol } from 'puppeteer';
+import { type Cookie as SimpleCookie } from 'simple-cookie';
+export interface Cookie extends Protocol.Network.Cookie {
+    partitionKey?: string;
+}
+export type ResponseReceivedExtraInfo = Protocol.Network.ResponseReceivedExtraInfoEvent;
+export type ResponseReceived = Protocol.Network.ResponseReceivedEvent;
+export type Cookies = Array<Cookie>;
+export type CookiesObjects = {
+    [key: string]: Cookie;
+};
+export type ParsedCookie = SimpleCookie;
+export interface TechnologyDetail {
+    name: string;
+    categories: string[];
+}
+export type TechnologyDetailList = Array<TechnologyDetail>;
+export interface CookieLogDetails extends Omit<Cookie, 'sameSite' | 'size' | 'session' | 'priority' | 'sameParty' | 'sourceScheme' | 'sourcePort'> {
+    name: string;
+    domain: string;
+    platform: string;
+    category: string;
+    description: string;
+    isFirstParty: 'Yes' | 'No';
+    sameSite: string;
+    partitionKey?: string;
+    pageUrl: string;
+    requestUrls: {
+        [key: string]: string;
+    };
+    frameUrls: {
+        [key: string]: string;
+    };
+    isBlocked?: boolean;
+    blockedReasons: Array<string>;
+}
+export type BlockedCookie = {
+    blockedReasons: Array<string>;
+    cookieLine: string;
+    cookie?: Cookie;
+};
+export type BlockedCookies = Array<BlockedCookie>;
+export type RequestDetail = {
+    requestID: string;
+    frameID: string;
+    type: string;
+    url: string;
+    frameURL: string;
+    allCookies: Cookies;
+    blockedCookies: BlockedCookies;
+    acceptedCookies: Cookies;
+};
+export type RequestDetails = {
+    [requestID: string]: RequestDetail;
+};
+export interface TechnologiesDetails {
+    name: string;
+    description: string;
+    confidence: number;
+    website: string;
+    categories: {
+        name: string;
+    }[];
+}
+export interface TechnologiesDetailsSitemap extends TechnologiesDetails {
+    frequency: number;
+}
+export type CookieLogDetailList = Array<CookieLogDetails>;
+export type UniqueCookiesLogDetail = {
+    [key: string]: CookieLogDetails;
+};
+export interface Job {
+    data: any;
+    status: string;
+    response: any;
+    message: string;
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@google-psat/analysis-utils",
+  "version": "0.9.0-1",
+  "description": "A package for CLI analysis",
+  "main": "dist/index.js",
+  "types": "dist-types/index.d.ts",
+  "source": "src/index.ts",
+  "author": {
+    "name": "Google"
+  },
+  "customExports": {
+    ".": {
+      "default": "./src/index.ts"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc-watch",
+    "build:remove": "rimraf dist dist-types tsconfig.tsbuildinfo",
+    "publish:local": "npm publish --registry=http://localhost:4873",
+    "publish:remote": "npm publish --access=public --registry=https://registry.npmjs.org",
+    "unpublish:local": "npm unpublish --registry=http://localhost:4873 --force",
+    "unpublish:remote": "npm unpublish --registry=https://registry.npmjs.org --force"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/GoogleChromeLabs/ps-analysis-tool",
+    "directory": "packages/analysis-utils"
+  },
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/GoogleChromeLabs/ps-analysis-tool/issues"
+  },
+  "homepage": "https://github.com/GoogleChromeLabs/ps-analysis-tool",
+  "dependencies": {
+    "@google-psat/common": "*",
+    "puppeteer": "^22.10.0",
+    "simple-cookie": "^1.0.15",
+    "tldts": "^6.0.14",
+    "wappalyzer": "^6.10.66"
+  },
+  "devDependencies": {
+    "tsc-watch": "^6.0.4",
+    "typescript": "^5.0.4"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "rootDir": "src",
+    "target": "es6",
+    "lib": ["es2021"],
+    "module": "commonjs",
+    "outDir": "dist",
+    "declarationDir": "dist-types",
+    "composite": true,
+    "strict": true,
+    "sourceMap": true,
+    "esModuleInterop": true,
+    "moduleResolution": "node"
+  },
+  "exclude": ["**/tests/**/*.ts", "dist/**", "dist-types/**"]
+}