npm - header-generator - Versions diffs - 2.0.0-beta.7 → 2.0.0-dev.0 - Mend

header-generator 2.0.0-beta.7 → 2.0.0-dev.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

package/{LICENSE → LICENSE.md} +2 -2
package/README.md +2 -154
package/index.js +7 -0
package/package.json +45 -64
package/dist/constants.d.ts +0 -21
package/dist/constants.d.ts.map +0 -1
package/dist/constants.js +0 -28
package/dist/constants.js.map +0 -1
package/dist/data_files/browser-helper-file.json +0 -1
package/dist/data_files/header-network-definition.json +0 -1
package/dist/data_files/headers-order.json +0 -92
package/dist/data_files/input-network-definition.json +0 -1
package/dist/header-generator.d.ts +0 -115
package/dist/header-generator.d.ts.map +0 -1
package/dist/header-generator.js +0 -304
package/dist/header-generator.js.map +0 -1
package/dist/index.d.ts +0 -3
package/dist/index.d.ts.map +0 -1
package/dist/index.js +0 -7
package/dist/index.js.map +0 -1
package/dist/index.mjs +0 -6
package/dist/presets.d.ts +0 -49
package/dist/presets.d.ts.map +0 -1
package/dist/presets.js +0 -51
package/dist/presets.js.map +0 -1
package/dist/tsconfig.tsbuildinfo +0 -1
package/dist/utils.d.ts +0 -6
package/dist/utils.d.ts.map +0 -1
package/dist/utils.js +0 -87
package/dist/utils.js.map +0 -1

package/{LICENSE → LICENSE.md} RENAMED Viewed

@@ -178,7 +178,7 @@
    APPENDIX: How to apply the Apache License to your work.
       To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
+      boilerplate notice, with the fields enclosed by brackets "{}"
       replaced with your own identifying information. (Don't include
       the brackets!)  The text should be enclosed in the appropriate
       comment syntax for the file format. We also recommend that a
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2018 Apify Technologies s.r.o.
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md CHANGED Viewed

@@ -1,155 +1,3 @@
-# Header generator
-NodeJs package for generating browser-like headers.
-<!-- toc -->
-- [Installation](#installation)
-- [Usage](#usage)
-- [Presets](#presets)
-- [Result example](#result-example)
-- [API Reference](#api-reference)
-<!-- tocstop -->
-## Installation
-Run the `npm install header-generator` command. No further setup is needed afterwards.
-## Usage
-To use the generator, you need to create an instance of the `HeaderGenerator` class which is exported from this package. Constructor of this class accepts a `HeaderGeneratorOptions` object, which can be used to globally specify what kind of headers you are looking for:
-```js
-const { HeaderGenerator } = require('header-generator');
-let headerGenerator = new HeaderGenerator({
-        browsers: [
-            {name: "firefox", minVersion: 80},
-            {name: "chrome", minVersion: 87},
-            "safari"
-        ],
-        devices: [
-            "desktop"
-        ],
-        operatingSystems: [
-            "windows"
-        ]
-});
-```
-You can then get the headers using the `getHeaders` method, either with no argument, or with another `HeaderGeneratorOptions` object, this time specifying the options only for this call (overwriting the global options when in conflict) and using the global options specified beforehands for the unspecified options:
-```js
-let headers = headersGenerator.getHeaders({
-        operatingSystems: [
-            "linux"
-        ],
-        locales: ["en-US", "en"]
-});
-```
-This method always generates a random realistic set of headers, excluding the request dependant headers, which need to be filled in afterwards. Since the generation is randomized, multiple calls to this method with the same parameters can generate multiple different outputs.
-## Presets
-Presets are setting templates for common use cases. It saves time writing the same configuration over and over.
-```js
-const { HeaderGenerator, PRESETS } = require('header-generator');
-let headerGenerator = new HeaderGenerator(PRESETS.MODERN_WINDOWS_CHROME);
-```
-This preset will fill the configuration for the latest five versions of chrome for windows desktops. Checkout the available presets list [here](https://github.com/apify/header-generator/blob/master/src/presets.ts).
-## Result example
-A result that can be generated for the usage example above:
-```json
-{
-  "sec-ch-ua-mobile": "?0",
-  "user-agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.72 Safari/537.36",
-  "accept-encoding": "gzip, deflate, br",
-  "accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9",
-  "upgrade-insecure-requests": "1",
-  "accept-language": "en-US,en;0.9",
-  "sec-fetch-site": "same-site",
-  "sec-fetch-mode": "navigate",
-  "sec-fetch-user": "?1",
-  "sec-fetch-dest": "document"
-}
-```
-## API Reference
-All public classes, methods and their parameters can be inspected in this API reference.
-<a name="HeaderGenerator"></a>
-### HeaderGenerator
-HeaderGenerator randomly generates realistic browser headers based on specified options.
-* [HeaderGenerator](#HeaderGenerator)
-    * [`new HeaderGenerator(options)`](#new_HeaderGenerator_new)
-    * [`.getHeaders(options, requestDependentHeaders)`](#HeaderGenerator+getHeaders)
-    * [`.orderHeaders(headers, order)`](#HeaderGenerator+orderHeaders)
-* * *
-<a name="new_HeaderGenerator_new"></a>
-#### `new HeaderGenerator(options)`
-| Param | Type | Description |
-| --- | --- | --- |
-| options | [<code>HeaderGeneratorOptions</code>](#HeaderGeneratorOptions) | default header generation options used unless overridden |
-* * *
-<a name="HeaderGenerator+getHeaders"></a>
-#### `headerGenerator.getHeaders(options, requestDependentHeaders)`
-Generates a single set of ordered headers using a combination of the default options specified in the constructor
-and their possible overrides provided here.
-| Param | Type | Description |
-| --- | --- | --- |
-| options | [<code>HeaderGeneratorOptions</code>](#HeaderGeneratorOptions) | specifies options that should be overridden for this one call |
-| requestDependentHeaders | <code>Object</code> | specifies known values of headers dependent on the particular request |
-* * *
-<a name="HeaderGenerator+orderHeaders"></a>
-#### `headerGenerator.orderHeaders(headers, order)`
-Returns a new object that contains ordered headers.
-| Param | Type | Description |
-| --- | --- | --- |
-| headers | <code>object</code> | specifies known values of headers dependent on the particular request |
-| order | <code>Array.&lt;string&gt;</code> | an array of ordered header names, optional (will be deducted from `user-agent`) |
-* * *
-<a name="BrowserSpecification"></a>
-### `BrowserSpecification`
-| Param | Type | Description |
-| --- | --- | --- |
-| name | <code>string</code> | One of `chrome`, `firefox` and `safari`. |
-| minVersion | <code>number</code> | Minimal version of browser used. |
-| maxVersion | <code>number</code> | Maximal version of browser used. |
-| httpVersion | <code>string</code> | Http version to be used to generate headers (the headers differ depending on the version).  Either 1 or 2. If none specified the httpVersion specified in `HeaderGeneratorOptions` is used. |
-* * *
-<a name="HeaderGeneratorOptions"></a>
-### `HeaderGeneratorOptions`
-| Param | Type | Description |
-| --- | --- | --- |
-| browsers | <code>Array.&lt;(BrowserSpecification\|string)&gt;</code> | List of BrowserSpecifications to generate the headers for,  or one of `chrome`, `firefox` and `safari`. |
-| browserListQuery | <code>string</code> | Browser generation query based on the real world data.  For more info see the [query docs](https://github.com/browserslist/browserslist#full-list).  If `browserListQuery` is passed the `browsers` array is ignored. |
-| operatingSystems | <code>Array.&lt;string&gt;</code> | List of operating systems to generate the headers for.  The options are `windows`, `macos`, `linux`, `android` and `ios`. |
-| devices | <code>Array.&lt;string&gt;</code> | List of devices to generate the headers for. Options are `desktop` and `mobile`. |
-| locales | <code>Array.&lt;string&gt;</code> | List of at most 10 languages to include in the  [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language) request header  in the language format accepted by that header, for example `en`, `en-US` or `de`. |
-| httpVersion | <code>string</code> | Http version to be used to generate headers (the headers differ depending on the version).  Can be either 1 or 2. Default value is 2. |
-* * *
+# Fingerprint suite
+This repository contains a set of fingerprinting tools developed by Apify.

package/index.js ADDED Viewed

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PRESETS = void 0;
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./header-generator"), exports);
+exports.PRESETS = tslib_1.__importStar(require("./presets"));
+//# sourceMappingURL=index.js.map

package/package.json CHANGED Viewed

@@ -1,66 +1,47 @@
 {
-  "name": "header-generator",
-  "version": "2.0.0-beta.7",
-  "description": "NodeJs package for generating browser-like headers.",
-  "author": {
-    "name": "Apify",
-    "email": "support@apify.com",
-    "url": "https://apify.com"
-  },
-  "homepage": "https://github.com/apify/header-generator#readme",
-  "license": "Apache-2.0",
-  "engines": {
-    "node": ">=15.10.0"
-  },
-  "files": [
-    "dist"
-  ],
-  "main": "dist/index.js",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.js"
-    }
-  },
-  "dependencies": {
-    "browserslist": "^4.19.1",
-    "generative-bayesian-network": "0.1.0-beta.1",
-    "ow": "^0.23.0",
-    "tslib": "^2.3.1"
-  },
-  "devDependencies": {
-    "@apify/eslint-config-ts": "^0.1.4",
-    "@apify/tsconfig": "^0.1.0",
-    "@types/jest": "^27.0.2",
-    "@typescript-eslint/eslint-plugin": "^4.32.0",
-    "@typescript-eslint/parser": "^4.32.0",
-    "eslint": "^7.0.0",
-    "gen-esm-wrapper": "^1.1.3",
-    "jest": "^27.2.5",
-    "jest-circus": "^27.2.4",
-    "jsdoc-to-markdown": "^7.0.0",
-    "markdown-toc": "^1.2.0",
-    "ts-jest": "^27.0.5",
-    "ts-node": "^10.2.1",
-    "typescript": "^4.4.3"
-  },
-  "scripts": {
-    "build": "rimraf dist && tsc",
-    "postbuild": "gen-esm-wrapper dist/index.js dist/index.mjs",
-    "prepublishOnly": "npm run build",
-    "lint": "eslint src test",
-    "lint:fix": "eslint src test --fix",
-    "test": "jest",
-    "build-docs": "npm run build && npm run build-toc && node docs/build-docs.js",
-    "build-toc": "markdown-toc docs/README.md -i"
-  },
-  "bugs": {
-    "url": "https://github.com/apify/header-generator/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/apify/header-generator.git"
-  }
+    "name": "header-generator",
+    "version": "2.0.0-dev.0",
+    "description": "NodeJs package for generating browser-like headers.",
+    "author": {
+        "name": "Apify",
+        "email": "support@apify.com",
+        "url": "https://apify.com"
+    },
+    "homepage": "https://github.com/apify/header-generator#readme",
+    "license": "Apache-2.0",
+    "engines": {
+        "node": ">=16.0.0"
+    },
+    "files": [
+        "dist"
+    ],
+    "main": "index.js",
+    "module": "index.mjs",
+    "types": "index.d.ts",
+    "exports": {
+        ".": {
+            "import": "./index.mjs",
+            "require": "./index.js"
+        }
+    },
+    "dependencies": {
+        "browserslist": "^4.19.1",
+        "generative-bayesian-network": "^2.0.0",
+        "ow": "^0.28.1"
+    },
+    "scripts": {
+        "build": "npm run clean && npm run compile",
+        "postbuild": "cp -r src/data_files/ ",
+        "clean": "rimraf ./dist",
+        "compile": "tsc -p tsconfig.build.json && gen-esm-wrapper ./index.js ./index.mjs",
+        "copy": "ts-node -T ../../scripts/copy.ts"
+    },
+    "bugs": {
+        "url": "https://github.com/apify/header-generator/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/apify/header-generator.git"
+    },
+    "gitHead": "2dd3d8c9ced1a14cb74ef16ebdd50b349bb5971b"
 }

package/dist/constants.d.ts DELETED Viewed

@@ -1,21 +0,0 @@
-export declare const SUPPORTED_BROWSERS: readonly ["chrome", "firefox", "safari"];
-export declare const SUPPORTED_OPERATING_SYSTEMS: readonly ["windows", "macos", "linux", "android", "ios"];
-export declare const SUPPORTED_DEVICES: readonly ["desktop", "mobile"];
-export declare const SUPPORTED_HTTP_VERSIONS: readonly ["1", "2"];
-export declare const BROWSER_HTTP_NODE_NAME: "*BROWSER_HTTP";
-export declare const OPERATING_SYSTEM_NODE_NAME: "*OPERATING_SYSTEM";
-export declare const DEVICE_NODE_NAME: "*DEVICE";
-export declare const MISSING_VALUE_DATASET_TOKEN: "*MISSING_VALUE*";
-export declare const HTTP1_SEC_FETCH_ATTRIBUTES: {
-    readonly mode: "Sec-Fetch-Mode";
-    readonly dest: "Sec-Fetch-Dest";
-    readonly site: "Sec-Fetch-Site";
-    readonly user: "Sec-Fetch-User";
-};
-export declare const HTTP2_SEC_FETCH_ATTRIBUTES: {
-    readonly mode: "sec-fetch-mode";
-    readonly dest: "sec-fetch-dest";
-    readonly site: "sec-fetch-site";
-    readonly user: "sec-fetch-user";
-};
-//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map DELETED Viewed

@@ -1 +0,0 @@

- {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,kBAAkB,0CAIrB,CAAC;AACX,eAAO,MAAM,2BAA2B,0DAA2D,CAAC;AACpG,eAAO,MAAM,iBAAiB,gCAAiC,CAAC;AAChE,eAAO,MAAM,uBAAuB,qBAAsB,CAAC;AAE3D,eAAO,MAAM,sBAAsB,iBAA2B,CAAC;AAC/D,eAAO,MAAM,0BAA0B,qBAA+B,CAAC;AACvE,eAAO,MAAM,gBAAgB,WAAqB,CAAC;AACnD,eAAO,MAAM,2BAA2B,mBAA6B,CAAC;AAEtE,eAAO,MAAM,0BAA0B;;;;;CAK7B,CAAC;AAEX,eAAO,MAAM,0BAA0B;;;;;CAK7B,CAAC"}

package/dist/constants.js DELETED Viewed

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HTTP2_SEC_FETCH_ATTRIBUTES = exports.HTTP1_SEC_FETCH_ATTRIBUTES = exports.MISSING_VALUE_DATASET_TOKEN = exports.DEVICE_NODE_NAME = exports.OPERATING_SYSTEM_NODE_NAME = exports.BROWSER_HTTP_NODE_NAME = exports.SUPPORTED_HTTP_VERSIONS = exports.SUPPORTED_DEVICES = exports.SUPPORTED_OPERATING_SYSTEMS = exports.SUPPORTED_BROWSERS = void 0;
-exports.SUPPORTED_BROWSERS = [
-    'chrome',
-    'firefox',
-    'safari',
-];
-exports.SUPPORTED_OPERATING_SYSTEMS = ['windows', 'macos', 'linux', 'android', 'ios'];
-exports.SUPPORTED_DEVICES = ['desktop', 'mobile'];
-exports.SUPPORTED_HTTP_VERSIONS = ['1', '2'];
-exports.BROWSER_HTTP_NODE_NAME = '*BROWSER_HTTP';
-exports.OPERATING_SYSTEM_NODE_NAME = '*OPERATING_SYSTEM';
-exports.DEVICE_NODE_NAME = '*DEVICE';
-exports.MISSING_VALUE_DATASET_TOKEN = '*MISSING_VALUE*';
-exports.HTTP1_SEC_FETCH_ATTRIBUTES = {
-    mode: 'Sec-Fetch-Mode',
-    dest: 'Sec-Fetch-Dest',
-    site: 'Sec-Fetch-Site',
-    user: 'Sec-Fetch-User',
-};
-exports.HTTP2_SEC_FETCH_ATTRIBUTES = {
-    mode: 'sec-fetch-mode',
-    dest: 'sec-fetch-dest',
-    site: 'sec-fetch-site',
-    user: 'sec-fetch-user',
-};
-//# sourceMappingURL=constants.js.map

package/dist/constants.js.map DELETED Viewed

@@ -1 +0,0 @@

- {"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,kBAAkB,GAAG;IAC9B,QAAQ;IACR,SAAS;IACT,QAAQ;CACF,CAAC;AACE,QAAA,2BAA2B,GAAG,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,CAAU,CAAC;AACvF,QAAA,iBAAiB,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAU,CAAC;AACnD,QAAA,uBAAuB,GAAG,CAAC,GAAG,EAAE,GAAG,CAAU,CAAC;AAE9C,QAAA,sBAAsB,GAAG,eAAwB,CAAC;AAClD,QAAA,0BAA0B,GAAG,mBAA4B,CAAC;AAC1D,QAAA,gBAAgB,GAAG,SAAkB,CAAC;AACtC,QAAA,2BAA2B,GAAG,iBAA0B,CAAC;AAEzD,QAAA,0BAA0B,GAAG;IACtC,IAAI,EAAE,gBAAgB;IACtB,IAAI,EAAE,gBAAgB;IACtB,IAAI,EAAE,gBAAgB;IACtB,IAAI,EAAE,gBAAgB;CAChB,CAAC;AAEE,QAAA,0BAA0B,GAAG;IACtC,IAAI,EAAE,gBAAgB;IACtB,IAAI,EAAE,gBAAgB;IACtB,IAAI,EAAE,gBAAgB;IACtB,IAAI,EAAE,gBAAgB;CAChB,CAAC"}

package/dist/data_files/browser-helper-file.json DELETED Viewed

@@ -1 +0,0 @@