@8ms/helpers 1.38.0 → 2.0.0

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;

package/crypto/getEncrypt.js

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

package/crypto/getRandom.d.ts

@@ -1,8 +0,0 @@
-/**
- * Create a random string and return a number of characters from it.
- * Library: crypto-js
- */
-declare const getRandom: ({ length }: {
-    length: number;
-}) => string;
-export default getRandom;

package/crypto/getRandom.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Create a random string and return a number of characters from it.
- * Library: crypto-js
- */
-const getRandom = ({ length }) => {
-    return Math.random()
-        .toString(36)
-        .substr(0, length);
-};
-exports.default = getRandom;

package/crypto/getSha256.d.ts

@@ -1,8 +0,0 @@
-/**
- * Encrypt a string using sha256
- * Library: crypto-js
- */
-declare const getSha256: ({ input }: {
-    input: any;
-}) => string;
-export default getSha256;

package/crypto/getSha256.js

@@ -1,17 +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 getString_1 = __importDefault(require("../string/getString"));
-/**
- * Encrypt a string using sha256
- * Library: crypto-js
- */
-const getSha256 = ({ input }) => {
-    const { SHA256 } = require('crypto-js');
-    const inputString = (0, getString_1.default)({ input });
-    return SHA256(inputString)
-        .toString();
-};
-exports.default = getSha256;

package/date/format.d.ts

@@ -1,10 +0,0 @@
-import { GetDate } from "./getDate";
-type Format = GetDate & {
-    dateFormat?: string;
-};
-/**
- * Convert a (number | string | Date) into a "yyyy-MM-dd" string or a specified format.
- * As the user would be providing the input we don't want to change the timezone typically.
- */
-declare const format: (props: Format) => string;
-export default format;

package/date/format.js

@@ -1,21 +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 date_fns_1 = require("date-fns");
-const getDate_1 = __importDefault(require("./getDate"));
-/**
- * Convert a (number | string | Date) into a "yyyy-MM-dd" string or a specified format.
- * As the user would be providing the input we don't want to change the timezone typically.
- */
-const format = (props) => {
-    const dateInstance = (0, getDate_1.default)({
-        input: props.input,
-        isUtc: props.isUtc,
-        setMidnight: props?.setMidnight,
-        setTimeZone: props?.setTimeZone,
-    });
-    return (0, date_fns_1.format)(dateInstance, props?.dateFormat || "yyyy-MM-dd");
-};
-exports.default = format;

package/date/getDate.d.ts

@@ -1,14 +0,0 @@
-import { DateType } from "./";
-import { GetMidnight } from "./getMidnight";
-import { GetTimeZoned } from "./getTimeZoned";
-export type GetDate = GetTimeZoned & GetMidnight & {
-    input: DateType;
-    isUtc?: boolean;
-};
-/**
- * Convert a (number | string | Date) into a Date object.
- * As the user would be providing the input we don't want to change the timezone typically.
- * By default assumption is that the input is UTC, however it can be switched to timezoned time.
- */
-declare const getDate: (props: GetDate) => Date;
-export default getDate;

package/date/getDate.js

@@ -1,138 +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 getMidnight_1 = __importDefault(require("./getMidnight"));
-/**
- * Convert a (number | string | Date) into a Date object.
- * As the user would be providing the input we don't want to change the timezone typically.
- * By default assumption is that the input is UTC, however it can be switched to timezoned time.
- */
-const getDate = (props) => {
-    let date;
-    let isUtc = undefined === props?.isUtc ? true : props.isUtc;
-    // Already date instance - no change
-    if (props.input instanceof Date) {
-        date = new Date(props.input.valueOf());
-    }
-    else if ("string" === typeof props.input || "number" === typeof props.input) {
-        // Convert the input into string
-        const dateString = props.input.toString();
-        const regexes = {
-            ymdDash: new RegExp("^[0-9]{4}-[0-9]{2}-[0-9]{2}$"),
-            ymdNumber: new RegExp("^[0-9]{8}$"),
-            ymdHisDash: new RegExp("^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$"),
-            ymdHisNumber: new RegExp("^[0-9]{14}$"),
-        };
-        //	console.log('regexes.ymdHisDash.test(dateString) ',regexes.ymdHisDash.test(dateString));
-        // 20220412
-        if (regexes.ymdNumber.test(dateString)) {
-            const year = Number(dateString.substring(0, 4));
-            const month = Number(dateString.substring(4, 6)) - 1;
-            const day = Number(dateString.substring(6, 8));
-            date = new Date();
-            // Reset the date to the 1st initially at 1am
-            date.setUTCDate(1);
-            date.setUTCHours(1, 0, 0, 0);
-            if (isUtc) {
-                date.setUTCFullYear(year);
-                date.setUTCMonth(month);
-                date.setUTCDate(day);
-                date.setUTCHours(0, 0, 0, 0);
-            }
-            else {
-                date.setFullYear(year);
-                date.setMonth(month);
-                date.setDate(day);
-                date.setHours(0, 0, 0, 0);
-            }
-        }
-        // 2022-04-12
-        else if (regexes.ymdDash.test(dateString)) {
-            const year = Number(dateString.substring(0, 4));
-            const month = Number(dateString.substring(5, 7)) - 1;
-            const day = Number(dateString.substring(8, 10));
-            date = new Date();
-            // Reset the date to the 1st initially at 1am
-            date.setUTCDate(1);
-            date.setUTCHours(1, 0, 0, 0);
-            // Finalise date
-            if (isUtc) {
-                date.setUTCFullYear(year);
-                date.setUTCMonth(month);
-                date.setUTCDate(day);
-                date.setUTCHours(0, 0, 0, 0);
-            }
-            else {
-                date.setFullYear(year);
-                date.setMonth(month);
-                date.setDate(day);
-                date.setHours(0, 0, 0, 0);
-            }
-        }
-        // 2022-04-12 01:01:01
-        else if (regexes.ymdHisDash.test(dateString)) {
-            const year = Number(dateString.substring(0, 4));
-            const month = Number(dateString.substring(5, 7)) - 1;
-            const day = Number(dateString.substring(8, 10));
-            const hours = Number(dateString.substring(11, 13));
-            const minutes = Number(dateString.substring(14, 16));
-            const seconds = Number(dateString.substring(17, 19));
-            date = new Date();
-            // Reset the date to the 1st initially at 1am
-            date.setUTCDate(1);
-            date.setUTCHours(1, 0, 0, 0);
-            // Finalise date
-            if (isUtc) {
-                date.setUTCFullYear(year);
-                date.setUTCMonth(month);
-                date.setUTCDate(day);
-                date.setUTCHours(hours, minutes, seconds);
-            }
-            else {
-                date.setFullYear(year);
-                date.setMonth(month);
-                date.setDate(day);
-                date.setHours(hours, minutes, seconds);
-            }
-        }
-        // 20220412010101
-        else if (regexes.ymdHisNumber.test(dateString)) {
-            const year = Number(dateString.substring(0, 4));
-            const month = Number(dateString.substring(4, 6)) - 1;
-            const day = Number(dateString.substring(6, 8));
-            const hours = Number(dateString.substring(8, 10));
-            const minutes = Number(dateString.substring(10, 12));
-            const seconds = Number(dateString.substring(12, 14));
-            date = new Date();
-            // Reset the date to the 1st initially at 1am
-            date.setUTCDate(1);
-            date.setUTCHours(1, 0, 0, 0);
-            // Finalise date
-            if (isUtc) {
-                date.setUTCFullYear(year);
-                date.setUTCMonth(month);
-                date.setUTCDate(day);
-                date.setUTCHours(hours, minutes, seconds);
-            }
-            else {
-                date.setFullYear(year);
-                date.setMonth(month);
-                date.setDate(day);
-                date.setHours(hours, minutes, seconds);
-            }
-        }
-        // Unsure date format, try anything
-        else {
-            date = new Date(dateString);
-        }
-    }
-    // Reset to midnight
-    date = (0, getMidnight_1.default)({
-        input: date,
-        setMidnight: props?.setMidnight,
-    });
-    return date;
-};
-exports.default = getDate;

package/date/getDatesBetween.d.ts

@@ -1,13 +0,0 @@
-import { DateType } from "./";
-type GetDatesBetween = {
-    end: DateType;
-    start: DateType;
-    isUtc?: boolean;
-};
-/**
- * Similar to date-fns' eachDayOfInterval, however the timezone messes this function up.
- * https://date-fns.org/v2.28.0/docs/eachDayOfInterval
- * https://www.gov.uk/when-do-the-clocks-change
- */
-declare const getDatesBetween: (props: GetDatesBetween) => Date[];
-export default getDatesBetween;