npm - header-generator - Versions diffs - 1.1.3 → 2.0.0-beta.2 - Mend

header-generator 1.1.3 → 2.0.0-beta.2

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 (34) hide show

package/README.md +12 -1
package/dist/constants.d.ts +21 -0
package/dist/constants.d.ts.map +1 -0
package/dist/constants.js +28 -0
package/dist/constants.js.map +1 -0
package/dist/data_files/browser-helper-file.json +1 -0
package/dist/data_files/header-network-definition.json +1 -0
package/{src → dist}/data_files/headers-order.json +0 -0
package/dist/data_files/input-network-definition.json +1 -0
package/dist/header-generator.d.ts +97 -0
package/dist/header-generator.d.ts.map +1 -0
package/dist/header-generator.js +304 -0
package/dist/header-generator.js.map +1 -0
package/dist/index.d.ts +3 -0
package/dist/index.d.ts.map +1 -0
package/dist/index.js +8 -0
package/dist/index.js.map +1 -0
package/dist/index.mjs +5 -0
package/dist/presets.d.ts +49 -0
package/dist/presets.d.ts.map +1 -0
package/dist/presets.js +51 -0
package/dist/presets.js.map +1 -0
package/dist/tsconfig.tsbuildinfo +1 -0
package/dist/utils.d.ts +6 -0
package/dist/utils.d.ts.map +1 -0
package/dist/utils.js +87 -0
package/dist/utils.js.map +1 -0
package/package.json +38 -14
package/src/data_files/browser-helper-file.json +0 -1
package/src/data_files/header-network-definition.json +0 -1
package/src/data_files/input-network-definition.json +0 -1
package/src/header-generator.js +0 -334
package/src/main.js +0 -3
package/src/utils.js +0 -33

package/README.md CHANGED Viewed

@@ -5,6 +5,7 @@ NodeJs package for generating browser-like headers.
 - [Installation](#installation)
 - [Usage](#usage)
+- [Presets](#presets)
 - [Result example](#result-example)
 - [API Reference](#api-reference)
@@ -15,7 +16,7 @@ Run the `npm install header-generator` command. No further setup is needed after
 ## 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');
+const { HeaderGenerator } = require('header-generator');
 let headerGenerator = new HeaderGenerator({
         browsers: [
             {name: "firefox", minVersion: 80},
@@ -40,6 +41,15 @@ let headers = headersGenerator.getHeaders({
 });
 ```
 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 @TODO: LINK.
 ## Result example
 A result that can be generated for the usage example above:
 ```json
@@ -134,6 +144,7 @@ Returns a new object that contains ordered headers.
 | 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`. |

package/dist/constants.d.ts ADDED Viewed

@@ -0,0 +1,21 @@
+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: {
+    mode: string;
+    dest: string;
+    site: string;
+    user: string;
+};
+export declare const HTTP2_SEC_FETCH_ATTRIBUTES: {
+    mode: string;
+    dest: string;
+    site: string;
+    user: string;
+};
+//# sourceMappingURL=constants.d.ts.map

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

@@ -0,0 +1 @@

+ {"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,kBAAkB,CAAC;AACtD,eAAO,MAAM,0BAA0B,sBAAsB,CAAC;AAC9D,eAAO,MAAM,gBAAgB,YAAY,CAAC;AAC1C,eAAO,MAAM,2BAA2B,oBAAoB,CAAC;AAE7D,eAAO,MAAM,0BAA0B;;;;;CAKtC,CAAC;AAEF,eAAO,MAAM,0BAA0B;;;;;CAKtC,CAAC"}

package/dist/constants.js ADDED Viewed

@@ -0,0 +1,28 @@
+"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 ADDED Viewed

@@ -0,0 +1 @@

+ {"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,eAAe,CAAC;AACzC,QAAA,0BAA0B,GAAG,mBAAmB,CAAC;AACjD,QAAA,gBAAgB,GAAG,SAAS,CAAC;AAC7B,QAAA,2BAA2B,GAAG,iBAAiB,CAAC;AAEhD,QAAA,0BAA0B,GAAG;IACtC,IAAI,EAAE,gBAAgB;IACtB,IAAI,EAAE,gBAAgB;IACtB,IAAI,EAAE,gBAAgB;IACtB,IAAI,EAAE,gBAAgB;CACzB,CAAC;AAEW,QAAA,0BAA0B,GAAG;IACtC,IAAI,EAAE,gBAAgB;IACtB,IAAI,EAAE,gBAAgB;IACtB,IAAI,EAAE,gBAAgB;IACtB,IAAI,EAAE,gBAAgB;CACzB,CAAC"}

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

@@ -0,0 +1 @@