@8ms/helpers 2.3.4 → 2.3.6

package/axios/get.js

@@ -1,24 +0,0 @@
-import axios from "axios";
-import { ApiResponseClass } from "../api";
-/**
- * Make a GET request.
- */
-export const get = async (url, config = {}) => {
-    const response = await axios.get(url, config)
-        .then(async (response) => {
-        // Is API response
-        if (undefined !== response.data.body && undefined !== response.data.error && undefined !== response.data.state) {
-            return new ApiResponseClass(response.data);
-        }
-        // General success - some APIs report 201
-        else if (response.status >= 200 && response.status <= 299) {
-            return (new ApiResponseClass()).setToSuccess(response.data);
-        }
-        // Error
-        return (new ApiResponseClass()).setToError(response.data, response.statusText);
-    })
-        .catch(error => {
-        return (new ApiResponseClass()).setToError(null, error.message);
-    });
-    return response;
-};

package/axios/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./deleteRequest";
-export * from "./get";
-export * from "./post";

package/axios/index.js

@@ -1,3 +0,0 @@
-export * from "./deleteRequest";
-export * from "./get";
-export * from "./post";

package/axios/post.d.ts

@@ -1,5 +0,0 @@
-import { ApiResponseClass } from "../api";
-/**
- * Make a POST request.
- */
-export declare const post: (url: string, data?: {}, config?: {}) => Promise<ApiResponseClass>;

package/axios/post.js

@@ -1,25 +0,0 @@
-import axios from "axios";
-import { ApiResponseClass } from "../api";
-/**
- * Make a POST request.
- */
-export const post = async (url, data = {}, config = {}) => {
-    const response = await axios.post(url, data, config)
-        .then(async (response) => {
-        // Is API response
-        if (undefined !== response.data.body && undefined !== response.data.error && undefined !== response.data.state) {
-            return new ApiResponseClass(response.data);
-        }
-        // General success - some APIs report 201
-        else if (response.status >= 200 && response.status <= 299) {
-            return (new ApiResponseClass()).setToSuccess(response.data);
-        }
-        // Error
-        return (new ApiResponseClass()).setToError(response.data, response.statusText);
-    })
-        .catch(error => {
-        // Error
-        return (new ApiResponseClass()).setToError(null, error.message);
-    });
-    return response;
-};

package/boolean/boolean.d.ts

@@ -1,4 +0,0 @@
-/**
- * Convert an input from a variety of forms into boolean.
- */
-export declare const getBoolean: (input: any, defaultValue?: boolean) => boolean;

package/boolean/boolean.js

@@ -1,16 +0,0 @@
-import isBoolean from "lodash/isBoolean";
-/**
- * Convert an input from a variety of forms into boolean.
- */
-export const getBoolean = (input, defaultValue = false) => {
-    if (isBoolean(input)) {
-        return input;
-    }
-    else if ("string" === typeof input) {
-        return "true" === input || "1" === input || "yes" === input || "y" === input;
-    }
-    else if ("number" === typeof input) {
-        return 1 === input;
-    }
-    return defaultValue;
-};

package/boolean/index.d.ts

@@ -1 +0,0 @@
-export * from "./boolean";

package/boolean/index.js

@@ -1 +0,0 @@
-export * from "./boolean";

package/brightData/serpApi/server/brightDataSerpApi.d.ts

@@ -1,10 +0,0 @@
-export declare const brightDataSerpApiType: {
-    readonly GOOGLE_FLIGHTS: "GOOGLE_FLIGHTS";
-    readonly GOOGLE_HOTELS: "GOOGLE_HOTELS";
-    readonly GOOGLE_LENS: "GOOGLE_LENS";
-    readonly GOOGLE_MAPS: "GOOGLE_MAPS";
-    readonly GOOGLE_REVIEWS: "GOOGLE_REVIEWS";
-    readonly GOOGLE_SEARCH: "GOOGLE_SEARCH";
-    readonly GOOGLE_TRENDS: "GOOGLE_TRENDS";
-};
-export type BrightDataSerpApiType = typeof brightDataSerpApiType[keyof typeof brightDataSerpApiType];

package/brightData/serpApi/server/brightDataSerpApi.js

@@ -1,9 +0,0 @@
-export const brightDataSerpApiType = {
-    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",
-};

package/brightData/serpApi/server/buildGoogleSerpUrl.d.ts

@@ -1,32 +0,0 @@
-type BuildGoogleSerpUrl = {
-    country?: string;
-    device?: "mobile" | "android" | "androidTablet" | "iphone" | "ipad";
-    language?: string;
-    geoLocation?: string;
-    hotel?: {
-        dates?: string;
-        occupancy?: number;
-    };
-    pagination?: {
-        offset?: number;
-        perPage?: number;
-    };
-    searchType?: "images" | "jobs" | "news" | "shopping" | "video";
-    query: string;
-    googleDomain: string;
-    output?: "html" | "json";
-    returnType: "url" | "json";
-};
-/**
- * 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
- */
-export declare const buildGoogleSerpUrl: (props: BuildGoogleSerpUrl) => string | {
-    query: {
-        q: string;
-    };
-};
-export {};

package/brightData/serpApi/server/buildGoogleSerpUrl.js

@@ -1,112 +0,0 @@
-/**
- * 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
- */
-export 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();
-};

package/brightData/serpApi/server/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
- */
-export declare const buildGoogleTrendsUrl: (props: BuildGoogleTrendsUrl) => string | {
-    query: {
-        q: string;
-    };
-};
-export {};

package/brightData/serpApi/server/buildGoogleTrendsUrl.js

@@ -1,57 +0,0 @@
-/**
- * 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
- */
-export 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();
-};

package/brightData/serpApi/server/getAsyncRequestId.d.ts

@@ -1,8 +0,0 @@
-import { Auth } from "../../server";
-import { BrightDataSerpApiType } from "../server";
-/**
- * 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
- */
-export declare const getAsyncRequestId: (auth: Auth, data: {}, type: BrightDataSerpApiType) => Promise<string>;

package/brightData/serpApi/server/getAsyncRequestId.js

@@ -1,32 +0,0 @@
-import { post } from "../../../axios";
-import { getCustomerId, getZone } from "../../server";
-import { brightDataSerpApiType } from "../server";
-/**
- * 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
- */
-export const getAsyncRequestId = async (auth, data = {}, type) => {
-    let url = "";
-    let response = "";
-    // Prevent auth requests getting blocked
-    process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = "0";
-    const customerId = getCustomerId(auth);
-    const zone = getZone(auth);
-    switch (type) {
-        case brightDataSerpApiType.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 post(url, data, {
-        headers: {
-            Authorization: `Bearer ${auth.apiKey}`
-        },
-    });
-    if (requestResponse.isSuccess()) {
-        response = requestResponse.getBodyDefaultTo(["response_id"], "");
-    }
-    return response;
-};

package/brightData/serpApi/server/getAsyncResults.d.ts

@@ -1,7 +0,0 @@
-import { Auth } from "../../server";
-import { ApiResponseClass } from "../../../api";
-/**
- * Using the request ID from getAsyncRequestId fetch to see if the data is available.
- * https://docs.brightdata.com/scraping-automation/serp-api/asynchronous-requests
- */
-export declare const getAsyncResults: (auth: Auth, requestId: string) => Promise<ApiResponseClass<any, any>>;

package/brightData/serpApi/server/getAsyncResults.js

@@ -1,31 +0,0 @@
-import { get } from "../../../axios";
-import { getCustomerId, getZone } from "../../server";
-import { ApiResponseClass } from "../../../api";
-/**
- * Using the request ID from getAsyncRequestId fetch to see if the data is available.
- * https://docs.brightdata.com/scraping-automation/serp-api/asynchronous-requests
- */
-export const getAsyncResults = async (auth, requestId) => {
-    let response = (new ApiResponseClass());
-    // Prevent auth requests getting blocked
-    process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = "0";
-    const customerId = getCustomerId(auth);
-    const zone = getZone(auth);
-    const requestResponse = await get(`https://api.brightdata.com/serp/get_result?customer=${customerId}&zone=${zone}&response_id=${requestId}`, {
-        headers: {
-            Authorization: `Bearer ${auth.apiKey}`
-        },
-    });
-    if (requestResponse.isSuccess()) {
-        if ("Request is pending" === requestResponse.getBody()) {
-            response.setToPending();
-        }
-        else {
-            response.setToSuccess(requestResponse.getBody());
-        }
-    }
-    else {
-        response.setToError(null, "Error in request");
-    }
-    return response;
-};

package/brightData/serpApi/server/getRealtime.d.ts

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

package/brightData/serpApi/server/getRealtime.js

@@ -1,26 +0,0 @@
-import { get } from "../../../axios";
-/**
- * Make a request to the SERP API using the Bright Data proxy
- */
-export const getRealtime = async (auth, url) => {
-    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 get(url, {
-        proxy: {
-            protocol: "http",
-            host: auth.host,
-            port: auth.port,
-            auth: {
-                username: auth.username,
-                password: auth.password,
-            }
-        },
-    });
-    if (apiResponse.isSuccess()) {
-        response = apiResponse.getBody();
-    }
-    return response;
-};

package/brightData/serpApi/server/index.d.ts

@@ -1,6 +0,0 @@
-export * from "./brightDataSerpApi";
-export * from "./buildGoogleSerpUrl";
-export * from "./buildGoogleTrendsUrl";
-export * from "./getAsyncResults";
-export * from "./getAsyncRequestId";
-export * from "./getRealtime";

package/brightData/serpApi/server/index.js

@@ -1,6 +0,0 @@
-export * from "./brightDataSerpApi";
-export * from "./buildGoogleSerpUrl";
-export * from "./buildGoogleTrendsUrl";
-export * from "./getAsyncResults";
-export * from "./getAsyncRequestId";
-export * from "./getRealtime";

package/brightData/server/brightData.d.ts

@@ -1,15 +0,0 @@
-export type Auth = {
-    apiKey: string;
-    host: string;
-    port: string;
-    username: string;
-    password: string;
-};
-/**
- * Return the Zone based on the username.
- */
-export declare const getZone: (auth: Auth) => string;
-/**
- * Return the customer Id based on the username.
- */
-export declare const getCustomerId: (auth: Auth, prefix?: string) => string;

package/brightData/server/brightData.js

@@ -1,15 +0,0 @@
-/**
- * Return the Zone based on the username.
- */
-export const getZone = (auth) => {
-    const segments = auth.username.split("-");
-    return segments[segments.length - 1];
-};
-/**
- * Return the customer Id based on the username.
- */
-export const getCustomerId = (auth, prefix) => {
-    const segments = auth.username.split("-")[2];
-    const customerId = segments[2].replace("hl_", "");
-    return (prefix || "") + customerId;
-};

package/brightData/server/index.d.ts

@@ -1 +0,0 @@
-export * from "./brightData";

package/brightData/server/index.js

@@ -1 +0,0 @@
-export * from "./brightData";

package/brightData/webScraperIde/server/getBatch.d.ts

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

package/brightData/webScraperIde/server/getBatch.js

@@ -1,24 +0,0 @@
-import { post } from "../../../axios";
-/**
- * Depends on the Scraper setup!
- *
- * Make the request to trigger the scraper and let it do its job.
- */
-export const getBatch = async (auth, scraperId, data = {}, isDev = false) => {
-    let response = false;
-    const requestUrl = new URL("https://api.brightdata.com/dca/trigger");
-    requestUrl.searchParams.append("collector", scraperId);
-    requestUrl.searchParams.append("queue_next", "1");
-    if (isDev) {
-        requestUrl.searchParams.append("version", "dev");
-    }
-    const requestResponse = await post(requestUrl.toString(), data, {
-        headers: {
-            Authorization: `Bearer ${auth.apiKey}`
-        },
-    });
-    if (requestResponse.isSuccess()) {
-        response = true;
-    }
-    return response;
-};

package/brightData/webScraperIde/server/getRealtime.d.ts

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

package/brightData/webScraperIde/server/getRealtime.js

@@ -1,45 +0,0 @@
-import { get, post } from "../../../axios";
-import { apiState } from "../../../api";
-import { sleep } from "../../../util";
-/**
- * Depends on the Scraper setup!
- *
- * Make the request and pool the response until the data is available.
- */
-export const getRealtime = async (auth, scraperId, data = {}) => {
-    let response = {};
-    const requestUrl = `https://api.brightdata.com/dca/trigger_immediate?collector=${scraperId}`;
-    const requestResponse = await post(requestUrl, data, {
-        headers: {
-            Authorization: `Bearer ${auth.apiKey}`
-        },
-    });
-    if (requestResponse.isSuccess()) {
-        const responseId = requestResponse.getBodyDefaultTo(["response_id"], "");
-        if ("" !== responseId) {
-            let state = apiState.PENDING;
-            while (apiState.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 get(resultUrl, {
-                    headers: {
-                        Authorization: `Bearer ${auth.apiKey}`
-                    },
-                });
-                if (resultResponse.isSuccess()) {
-                    if (undefined !== resultResponse.body.pending &&
-                        true === resultResponse.body.pending) {
-                        state = apiState.PENDING;
-                    }
-                    else {
-                        state = apiState.SUCCESS;
-                        response = resultResponse.getBody();
-                    }
-                }
-                await sleep(1);
-            }
-        }
-    }
-    return response;
-};

package/brightData/webScraperIde/server/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./getBatch";
-export * from "./getRealtime";

package/brightData/webScraperIde/server/index.js

@@ -1,2 +0,0 @@
-export * from "./getBatch";
-export * from "./getRealtime";

package/cache/server/cache.d.ts

@@ -1,7 +0,0 @@
-export type CacheEntry = {
-    data: any;
-    expires: number;
-    insertedAt: number;
-};
-export declare const getCache: (key: string) => any;
-export declare const setCache: (key: string, data: any, expires?: number, force?: boolean) => any;