@8ms/helpers 1.39.0 → 1.40.1

package/brightData/serpApi/buildGoogleSerpUrl.js

@@ -1,115 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Construct the Google SERP url using Bright Data's API:
- * https://brightdata.com/cp/serp_api/api/google/search?id=c_2cef083f
- *
- * For geolocation use value from:
- * https://developers.google.com/google-ads/api/data/geotargets
- */
-const buildGoogleSerpUrl = (props) => {
-    let url = new URL(`https://www.${props.googleDomain}/search`);
-    let params = {
-        query: {
-            q: props.query,
-        }
-    };
-    url.searchParams.append("q", props.query);
-    // Two-letter country code used to define the country of search
-    if (props?.country) {
-        params.query["gl"] = props.country;
-        url.searchParams.append("gl", props.country);
-    }
-    // Define what device type to be represented in user-agent - Default desktop
-    switch (props?.device) {
-        case "mobile":
-            params.query["brd_mobile"] = "1";
-            url.searchParams.append("brd_mobile", "1");
-            break;
-        case "android":
-            params.query["brd_mobile"] = "android";
-            url.searchParams.append("brd_mobile", "android");
-            break;
-        case "androidTablet":
-            params.query["brd_mobile"] = "android_tablet";
-            url.searchParams.append("brd_mobile", "android_tablet");
-            break;
-        case "ipad":
-            params.query["brd_mobile"] = "ipad";
-            url.searchParams.append("brd_mobile", "ipad");
-            break;
-        case "iphone":
-            params.query["brd_mobile"] = "ios";
-            url.searchParams.append("brd_mobile", "ios");
-            break;
-    }
-    // Stands for the encoded location you want to use for your search
-    if (props?.geoLocation) {
-        params.query["uule"] = props.geoLocation;
-        url.searchParams.append("uule", props.geoLocation);
-    }
-    if (props?.hotel) {
-        if (props.hotel?.dates) {
-            params.query["hotel_dates"] = props.hotel.dates.toString();
-            url.searchParams.append("hotel_dates", props.hotel.dates);
-        }
-        if (props.hotel?.occupancy) {
-            params.query["hotel_occupancy"] = props.hotel.occupancy.toString();
-            url.searchParams.append("hotel_occupancy", props.hotel.occupancy.toString());
-        }
-    }
-    // Two-letter language code used to define the page language
-    if (props?.language) {
-        params.query["uule"] = props.language;
-        url.searchParams.append("hl", props.language);
-    }
-    // Define search type. For regular search
-    switch (props?.searchType) {
-        case "images":
-            params.query["tbm"] = "isch";
-            url.searchParams.append("tbm", "isch");
-            break;
-        case "jobs":
-            params.query["ibp"] = "htl;jobs";
-            url.searchParams.append("ibp", "htl;jobs");
-            break;
-        case "news":
-            params.query["tbm"] = "nws";
-            url.searchParams.append("tbm", "nws");
-            break;
-        case "shopping":
-            params.query["tbm"] = "shop";
-            url.searchParams.append("tbm", "shop");
-            break;
-        case "video":
-            params.query["tbm"] = "vid";
-            url.searchParams.append("tbm", "vid");
-            break;
-    }
-    if (props?.pagination) {
-        // Define the result offset
-        if (props.pagination?.offset) {
-            params.query["start"] = props.pagination.offset.toString();
-            url.searchParams.append("start", props.pagination.offset.toString());
-        }
-        // Defines the number of results to return
-        if (props.pagination?.perPage) {
-            params.query["num"] = props.pagination.offset.toString();
-            url.searchParams.append("num", props.pagination.perPage.toString());
-        }
-    }
-    // Specify the output type
-    if ("json" === props.output) {
-        params["brd_json"] = "1";
-        url.searchParams.append("brn_json", "1");
-    }
-    else {
-        params["brd_json"] = "html";
-        url.searchParams.append("brn_json", "html");
-    }
-    if ("json" === props.returnType) {
-        return params;
-    }
-    return url.toString();
-};
-exports.default = buildGoogleSerpUrl;

package/brightData/serpApi/buildGoogleTrendsUrl.d.ts

@@ -1,22 +0,0 @@
-type BuildGoogleTrendsUrl = {
-    country?: string;
-    language?: string;
-    category?: string;
-    date?: string;
-    searchType?: "images" | "news" | "shopping" | "youtube";
-    query: string;
-    returnType: "url" | "json";
-};
-/**
- * Construct the Google Trends url using Bright Data's API:
- * https://brightdata.com/cp/serp_api/api/google/trends?id=c_2cef083f
- *
- * For category use value from:
- * https://trends.google.com/trends/api/explore/pickers/category?lang=en-US&tz=240
- */
-declare const buildGoogleTrendsUrl: (props: BuildGoogleTrendsUrl) => string | {
-    query: {
-        q: string;
-    };
-};
-export default buildGoogleTrendsUrl;

package/brightData/serpApi/buildGoogleTrendsUrl.js

@@ -1,60 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Construct the Google Trends url using Bright Data's API:
- * https://brightdata.com/cp/serp_api/api/google/trends?id=c_2cef083f
- *
- * For category use value from:
- * https://trends.google.com/trends/api/explore/pickers/category?lang=en-US&tz=240
- */
-const buildGoogleTrendsUrl = (props) => {
-    let url = new URL(`http://trends.google.com/trends/explore`);
-    url.searchParams.append("q", props.query);
-    let params = {
-        query: {
-            q: props.query,
-        }
-    };
-    // Location of interest, two-letter country code
-    if (props?.country) {
-        params.query['geo'] = props.country;
-        url.searchParams.append("geo", props.country);
-    }
-    // Preferred language, two-letter language code
-    if (props?.language) {
-        params.query['hl'] = props.language;
-        url.searchParams.append("hl", props.language);
-    }
-    if (props?.category) {
-        params.query['cat'] = props.category;
-        url.searchParams.append("cat", props.category);
-    }
-    if (props?.date) {
-        params.query['date'] = props.date;
-        url.searchParams.append("date", props.date);
-    }
-    // Define search type. For regular search
-    switch (props?.searchType) {
-        case "images":
-            params.query['group'] = "images";
-            url.searchParams.append("gprop", "images");
-            break;
-        case "news":
-            params.query['group'] = "news";
-            url.searchParams.append("gprop", "news");
-            break;
-        case "shopping":
-            params.query['group'] = "froogle";
-            url.searchParams.append("gprop", "froogle");
-            break;
-        case "youtube":
-            params.query['group'] = "youtube";
-            url.searchParams.append("gprop", "youtube");
-            break;
-    }
-    if ("json" === props.returnType) {
-        return params;
-    }
-    return url.toString();
-};
-exports.default = buildGoogleTrendsUrl;

package/brightData/serpApi/getAsyncRequestId.d.ts

@@ -1,14 +0,0 @@
-import { Param } from "../param";
-import { Type } from "./type";
-type GetAsyncRequestId = {
-    auth: Param;
-    data: object;
-    type: Type;
-};
-/**
- * Make an async request to the SERP API using the Bright Data proxy.
- * Returns a request ID used with getAsyncResults
- * https://docs.brightdata.com/scraping-automation/serp-api/asynchronous-requests
- */
-declare const getAsyncRequestId: (props: GetAsyncRequestId) => Promise<string>;
-export default getAsyncRequestId;

package/brightData/serpApi/getAsyncRequestId.js

@@ -1,50 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const post_1 = __importDefault(require("../../axios/post"));
-const getCustomerId_1 = __importDefault(require("../getCustomerId"));
-const getZone_1 = __importDefault(require("../getZone"));
-const type_1 = require("./type");
-/**
- * Make an async request to the SERP API using the Bright Data proxy.
- * Returns a request ID used with getAsyncResults
- * https://docs.brightdata.com/scraping-automation/serp-api/asynchronous-requests
- */
-const getAsyncRequestId = async (props) => {
-    let url = "";
-    let response = "";
-    // Prevent auth requests getting blocked
-    process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = "0";
-    const customerId = (0, getCustomerId_1.default)({
-        auth: props.auth,
-    });
-    const zone = (0, getZone_1.default)({
-        auth: props.auth,
-    });
-    switch (props.type) {
-        case type_1.Type.GOOGLE_TRENDS:
-            url = `https://api.brightdata.com/serp/trends?customer=${customerId}&zone=${zone}`;
-            break;
-        default:
-            url = `https://api.brightdata.com/serp/req?customer=${customerId}&zone=${zone}`;
-    }
-    const requestResponse = await (0, post_1.default)({
-        config: {
-            headers: {
-                Authorization: `Bearer ${props.auth.apiKey}`
-            },
-        },
-        data: props?.data || {},
-        url,
-    });
-    if (requestResponse.isSuccess()) {
-        response = requestResponse.getBodyDefaultTo({
-            defaultValue: "",
-            keys: ["response_id"],
-        });
-    }
-    return response;
-};
-exports.default = getAsyncRequestId;

package/brightData/serpApi/getAsyncResults.d.ts

@@ -1,12 +0,0 @@
-import { Param } from "../param";
-import ApiResponse from "../../api/ApiResponse";
-type GetAsync = {
-    auth: Param;
-    requestId: string;
-};
-/**
- * Using the request ID from getAsyncRequestId fetch to see if the data is available.
- * https://docs.brightdata.com/scraping-automation/serp-api/asynchronous-requests
- */
-declare const getAsyncResults: (props: GetAsync) => Promise<ApiResponse>;
-export default getAsyncResults;

package/brightData/serpApi/getAsyncResults.js

@@ -1,49 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const get_1 = __importDefault(require("../../axios/get"));
-const getCustomerId_1 = __importDefault(require("../getCustomerId"));
-const getZone_1 = __importDefault(require("../getZone"));
-const ApiResponse_1 = __importDefault(require("../../api/ApiResponse"));
-/**
- * Using the request ID from getAsyncRequestId fetch to see if the data is available.
- * https://docs.brightdata.com/scraping-automation/serp-api/asynchronous-requests
- */
-const getAsyncResults = async (props) => {
-    let response = (new ApiResponse_1.default());
-    // Prevent auth requests getting blocked
-    process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = "0";
-    const customerId = (0, getCustomerId_1.default)({
-        auth: props.auth,
-    });
-    const zone = (0, getZone_1.default)({
-        auth: props.auth,
-    });
-    const requestResponse = await (0, get_1.default)({
-        config: {
-            headers: {
-                Authorization: `Bearer ${props.auth.apiKey}`
-            },
-        },
-        url: `https://api.brightdata.com/serp/get_result?customer=${customerId}&zone=${zone}&response_id=${props.requestId}`,
-    });
-    if (requestResponse.isSuccess()) {
-        if ("Request is pending" === requestResponse.getBody()) {
-            response.setToPending();
-        }
-        else {
-            response.setToSuccess({
-                body: requestResponse.getBody(),
-            });
-        }
-    }
-    else {
-        response.setToError({
-            error: "Error in request",
-        });
-    }
-    return response;
-};
-exports.default = getAsyncResults;

package/brightData/serpApi/getRealtime.d.ts

@@ -1,10 +0,0 @@
-import { Param } from "../param";
-type GetRealtime = {
-    auth: Param;
-    url: string;
-};
-/**
- * Make a request to the SERP API using the Bright Data proxy
- */
-declare const getRealtime: (props: GetRealtime) => Promise<{}>;
-export default getRealtime;

package/brightData/serpApi/getRealtime.js

@@ -1,35 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const get_1 = __importDefault(require("../../axios/get"));
-/**
- * Make a request to the SERP API using the Bright Data proxy
- */
-const getRealtime = async (props) => {
-    let response = {};
-    // Prevent auth requests getting blocked
-    process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = "0";
-    // Use fetch with the agent option to make an HTTP request through the proxy
-    // Replace <target_url> with the URL you want to request
-    const apiResponse = await (0, get_1.default)({
-        config: {
-            proxy: {
-                protocol: "http",
-                host: props.auth.host,
-                port: props.auth.port,
-                auth: {
-                    username: props.auth.username,
-                    password: props.auth.password,
-                }
-            },
-        },
-        url: props.url,
-    });
-    if (apiResponse.isSuccess()) {
-        response = apiResponse.getBody();
-    }
-    return response;
-};
-exports.default = getRealtime;

package/brightData/serpApi/type.d.ts

@@ -1,11 +0,0 @@
-export declare enum Type {
-    GOOGLE_FLIGHTS = "GOOGLE_FLIGHTS",
-    GOOGLE_HOTELS = "GOOGLE_HOTELS",
-    GOOGLE_LENS = "GOOGLE_LENS",
-    GOOGLE_MAPS = "GOOGLE_MAPS",
-    GOOGLE_REVIEWS = "GOOGLE_REVIEWS",
-    GOOGLE_SEARCH = "GOOGLE_SEARCH",
-    GOOGLE_TRENDS = "GOOGLE_TRENDS"
-}
-declare const _default: {};
-export default _default;

package/brightData/serpApi/type.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Type = void 0;
-var Type;
-(function (Type) {
-    Type["GOOGLE_FLIGHTS"] = "GOOGLE_FLIGHTS";
-    Type["GOOGLE_HOTELS"] = "GOOGLE_HOTELS";
-    Type["GOOGLE_LENS"] = "GOOGLE_LENS";
-    Type["GOOGLE_MAPS"] = "GOOGLE_MAPS";
-    Type["GOOGLE_REVIEWS"] = "GOOGLE_REVIEWS";
-    Type["GOOGLE_SEARCH"] = "GOOGLE_SEARCH";
-    Type["GOOGLE_TRENDS"] = "GOOGLE_TRENDS";
-})(Type || (exports.Type = Type = {}));
-exports.default = {};

package/brightData/webScraperIde/getBatch.d.ts

@@ -1,14 +0,0 @@
-import { Param } from "../param";
-type GetBatch = {
-    auth: Param;
-    data?: object;
-    scraperId: string;
-    isDev?: boolean;
-};
-/**
- * Depends on the Scraper setup!
- *
- * Make the request to trigger the scraper and let it do its job.
- */
-declare const getBatch: (props: GetBatch) => Promise<boolean>;
-export default getBatch;

package/brightData/webScraperIde/getBatch.js

@@ -1,34 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const post_1 = __importDefault(require("../../axios/post"));
-/**
- * Depends on the Scraper setup!
- *
- * Make the request to trigger the scraper and let it do its job.
- */
-const getBatch = async (props) => {
-    let response = false;
-    const requestUrl = new URL('https://api.brightdata.com/dca/trigger');
-    requestUrl.searchParams.append('collector', props.scraperId);
-    requestUrl.searchParams.append('queue_next', '1');
-    if (props.isDev) {
-        requestUrl.searchParams.append('version', 'dev');
-    }
-    const requestResponse = await (0, post_1.default)({
-        config: {
-            headers: {
-                Authorization: `Bearer ${props.auth.apiKey}`
-            },
-        },
-        data: props?.data || {},
-        url: requestUrl.toString(),
-    });
-    if (requestResponse.isSuccess()) {
-        response = true;
-    }
-    return response;
-};
-exports.default = getBatch;

package/brightData/webScraperIde/getRealtime.d.ts

@@ -1,13 +0,0 @@
-import { Param } from "../param";
-type GetRealtime = {
-    auth: Param;
-    data?: object;
-    scraperId: string;
-};
-/**
- * Depends on the Scraper setup!
- *
- * Make the request and pool the response until the data is available.
- */
-declare const getRealtime: (props: GetRealtime) => Promise<{}>;
-export default getRealtime;

package/brightData/webScraperIde/getRealtime.js

@@ -1,64 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const post_1 = __importDefault(require("../../axios/post"));
-const api_1 = require("../../api");
-const get_1 = __importDefault(require("../../axios/get"));
-const sleep_1 = __importDefault(require("../../util/sleep"));
-/**
- * Depends on the Scraper setup!
- *
- * Make the request and pool the response until the data is available.
- */
-const getRealtime = async (props) => {
-    let response = {};
-    const requestUrl = `https://api.brightdata.com/dca/trigger_immediate?collector=${props.scraperId}`;
-    const requestResponse = await (0, post_1.default)({
-        config: {
-            headers: {
-                Authorization: `Bearer ${props.auth.apiKey}`
-            },
-        },
-        data: props?.data || {},
-        url: requestUrl,
-    });
-    if (requestResponse.isSuccess()) {
-        const responseId = requestResponse.getBodyDefaultTo({
-            defaultValue: "",
-            keys: ["response_id"],
-        });
-        if ("" !== responseId) {
-            let state = api_1.State.PENDING;
-            while (api_1.State.PENDING === state) {
-                const resultUrl = `https://api.brightdata.com/dca/get_result?response_id=${responseId}`;
-                // Use fetch with the agent option to make an HTTP request through the proxy
-                // Replace <target_url> with the URL you want to request
-                const resultResponse = await (0, get_1.default)({
-                    config: {
-                        headers: {
-                            Authorization: `Bearer ${props.auth.apiKey}`
-                        },
-                    },
-                    url: resultUrl,
-                });
-                if (resultResponse.isSuccess()) {
-                    if (undefined !== resultResponse.body.pending &&
-                        true === resultResponse.body.pending) {
-                        state = api_1.State.PENDING;
-                    }
-                    else {
-                        state = api_1.State.SUCCESS;
-                        response = resultResponse.getBody();
-                    }
-                }
-                await (0, sleep_1.default)({
-                    seconds: 1
-                });
-            }
-        }
-    }
-    return response;
-};
-exports.default = getRealtime;

package/class/BaseClass.d.ts

@@ -1,31 +0,0 @@
-declare class BaseClass {
-    /**
-     * Shortcut to set a value to an array and return the instance.
-     */
-    protected _setArray({ input, fields }: {
-        input: any | any[];
-        fields: any | any[];
-    }): this;
-    /**
-     * Shortcut to set a value and return the instance.
-     */
-    protected _setValue({ input, fields }: {
-        input: any;
-        fields: any | any[];
-    }): this;
-    /**
-     * Shortcut to add a value to an existing array.
-     */
-    protected _push({ input, fields }: {
-        input: any | any[];
-        fields: any | any[];
-    }): this;
-    /**
-     * Shortcut to get a value, but default if the fields don't exist.
-     */
-    protected _get({ defaultValue, fields }: {
-        defaultValue: any;
-        fields: any | any[];
-    }): any;
-}
-export default BaseClass;

package/class/BaseClass.js

@@ -1,50 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const isArray_1 = __importDefault(require("lodash/isArray"));
-const set_1 = __importDefault(require("lodash/set"));
-const defaultTo_1 = __importDefault(require("../util/defaultTo"));
-class BaseClass {
-    /**
-     * Shortcut to set a value to an array and return the instance.
-     */
-    _setArray({ input, fields }) {
-        if ((0, isArray_1.default)(input)) {
-            (0, set_1.default)(this, fields, input);
-        }
-        else {
-            (0, set_1.default)(this, fields, [input]);
-        }
-        return this;
-    }
-    /**
-     * Shortcut to set a value and return the instance.
-     */
-    _setValue({ input, fields }) {
-        (0, set_1.default)(this, fields, input);
-        return this;
-    }
-    /**
-     * Shortcut to add a value to an existing array.
-     */
-    _push({ input, fields }) {
-        let temp = this._get({ defaultValue: [], fields });
-        if ((0, isArray_1.default)(input)) {
-            temp = temp.concat(input);
-        }
-        else {
-            temp = temp.push(input);
-        }
-        (0, set_1.default)(this, fields, temp);
-        return this;
-    }
-    /**
-     * Shortcut to get a value, but default if the fields don't exist.
-     */
-    _get({ defaultValue, fields }) {
-        return (0, defaultTo_1.default)({ defaultValue, instance: this, keys: fields });
-    }
-}
-exports.default = BaseClass;

package/crud/index.d.ts

@@ -1,6 +0,0 @@
-export declare enum Action {
-    CREATE = "CREATE",
-    READ = "READ",
-    UPDATE = "UPDATE",
-    DELETE = "DELETE"
-}

package/crud/index.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Action = void 0;
-var Action;
-(function (Action) {
-    Action["CREATE"] = "CREATE";
-    Action["READ"] = "READ";
-    Action["UPDATE"] = "UPDATE";
-    Action["DELETE"] = "DELETE";
-})(Action || (exports.Action = Action = {}));

package/crypto/getDecrypt.d.ts

@@ -1,10 +0,0 @@
-/**
- * Decrypt an encoding string using a salt
- * Library: crypto-js
- */
-declare const getDecrypt: ({ appSalt, input, salt }: {
-    appSalt: string;
-    input: string;
-    salt: string;
-}) => string;
-export default getDecrypt;

package/crypto/getDecrypt.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Decrypt an encoding string using a salt
- * Library: crypto-js
- */
-const getDecrypt = ({ appSalt, input, salt }) => {
-    const { AES, enc } = require('crypto-js');
-    const customSalt = `${appSalt}-${salt}`;
-    return AES.decrypt(input, customSalt)
-        .toString(enc.Utf8);
-};
-exports.default = getDecrypt;

package/crypto/getEncrypt.d.ts

@@ -1,10 +0,0 @@
-/**
- * Encrypt an encoding string using a salt
- * Library: crypto-js
- */
-declare const getEncrypt: ({ appSalt, input, salt }: {
-    appSalt: string;
-    input: string;
-    salt: string;
-}) => string;
-export default getEncrypt;