@8ms/helpers 2.0.0 → 2.0.1

package/axios/deleteRequest.js

@@ -0,0 +1,33 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteRequest = void 0;
+const axios_1 = __importDefault(require("axios"));
+const api_1 = require("../api");
+/**
+ * Make a DELETE request.
+ * Can't use the function name delete as it's reserved
+ */
+const deleteRequest = async (url, config = {}) => {
+    const response = await axios_1.default.delete(url, config)
+        .then(async (response) => {
+        // Is API response
+        if (undefined !== response.data.body && undefined !== response.data.error && undefined !== response.data.state) {
+            return new api_1.ApiResponseClass(response.data);
+        }
+        // General success - some APIs report 201
+        else if (response.status >= 200 && response.status <= 299) {
+            return (new api_1.ApiResponseClass()).setToSuccess(response.data);
+        }
+        // Error
+        return (new api_1.ApiResponseClass()).setToError(response.data, response.statusText);
+    })
+        .catch(error => {
+        // Error
+        return (new api_1.ApiResponseClass()).setToError(null, error.message);
+    });
+    return response;
+};
+exports.deleteRequest = deleteRequest;

package/axios/get.d.ts

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

package/axios/get.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.get = void 0;
+const axios_1 = __importDefault(require("axios"));
+const api_1 = require("../api");
+/**
+ * Make a GET request.
+ */
+const get = async (url, config = {}) => {
+    const response = await axios_1.default.get(url, config)
+        .then(async (response) => {
+        // Is API response
+        if (undefined !== response.data.body && undefined !== response.data.error && undefined !== response.data.state) {
+            return new api_1.ApiResponseClass(response.data);
+        }
+        // General success - some APIs report 201
+        else if (response.status >= 200 && response.status <= 299) {
+            return (new api_1.ApiResponseClass()).setToSuccess(response.data);
+        }
+        // Error
+        return (new api_1.ApiResponseClass()).setToError(response.data, response.statusText);
+    })
+        .catch(error => {
+        return (new api_1.ApiResponseClass()).setToError(null, error.message);
+    });
+    return response;
+};
+exports.get = get;

package/axios/index.d.ts

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

package/axios/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteRequest = exports.post = exports.get = void 0;
+var get_1 = require("./get");
+Object.defineProperty(exports, "get", { enumerable: true, get: function () { return get_1.get; } });
+var post_1 = require("./post");
+Object.defineProperty(exports, "post", { enumerable: true, get: function () { return post_1.post; } });
+var deleteRequest_1 = require("./deleteRequest");
+Object.defineProperty(exports, "deleteRequest", { enumerable: true, get: function () { return deleteRequest_1.deleteRequest; } });

package/axios/post.d.ts

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

package/axios/post.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.post = void 0;
+const axios_1 = __importDefault(require("axios"));
+const api_1 = require("../api");
+/**
+ * Make a POST request.
+ */
+const post = async (url, data = {}, config = {}) => {
+    const response = await axios_1.default.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 api_1.ApiResponseClass(response.data);
+        }
+        // General success - some APIs report 201
+        else if (response.status >= 200 && response.status <= 299) {
+            return (new api_1.ApiResponseClass()).setToSuccess(response.data);
+        }
+        // Error
+        return (new api_1.ApiResponseClass()).setToError(response.data, response.statusText);
+    })
+        .catch(error => {
+        // Error
+        return (new api_1.ApiResponseClass()).setToError(null, error.message);
+    });
+    return response;
+};
+exports.post = post;

package/boolean/getBoolean.d.ts

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

package/boolean/getBoolean.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBoolean = void 0;
+const isBoolean_1 = __importDefault(require("lodash/isBoolean"));
+/**
+ * Convert an input from a variety of forms into boolean.
+ */
+const getBoolean = (input, defaultValue = false) => {
+    if ((0, isBoolean_1.default)(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;
+};
+exports.getBoolean = getBoolean;

package/boolean/index.d.ts

@@ -0,0 +1 @@
+export { getBoolean } from "./getBoolean";

package/boolean/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBoolean = void 0;
+var getBoolean_1 = require("./getBoolean");
+Object.defineProperty(exports, "getBoolean", { enumerable: true, get: function () { return getBoolean_1.getBoolean; } });

package/brightData/index.d.ts

@@ -0,0 +1,15 @@
+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/index.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCustomerId = exports.getZone = void 0;
+/**
+ * Return the Zone based on the username.
+ */
+const getZone = (auth) => {
+    const segments = auth.username.split("-");
+    return segments[segments.length - 1];
+};
+exports.getZone = getZone;
+/**
+ * Return the customer Id based on the username.
+ */
+const getCustomerId = (auth, prefix) => {
+    const segments = auth.username.split("-")[2];
+    const customerId = segments[2].replace("hl_", "");
+    return (prefix || "") + customerId;
+};
+exports.getCustomerId = getCustomerId;

package/brightData/serpApi/buildGoogleSerpUrl.d.ts

@@ -0,0 +1,32 @@
+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/buildGoogleSerpUrl.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildGoogleSerpUrl = void 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
+ */
+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.buildGoogleSerpUrl = buildGoogleSerpUrl;

package/brightData/serpApi/buildGoogleTrendsUrl.d.ts

@@ -0,0 +1,22 @@
+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/buildGoogleTrendsUrl.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildGoogleTrendsUrl = void 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
+ */
+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.buildGoogleTrendsUrl = buildGoogleTrendsUrl;

package/brightData/serpApi/getAsyncRequestId.d.ts

@@ -0,0 +1,8 @@
+import { Auth } from "../";
+import { BrightDataSerpApiType } from "./";
+/**
+ * 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/getAsyncRequestId.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAsyncRequestId = void 0;
+const axios_1 = require("../../axios");
+const __1 = require("../");
+const _1 = require("./");
+/**
+ * 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 (auth, data = {}, type) => {
+    let url = "";
+    let response = "";
+    // Prevent auth requests getting blocked
+    process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = "0";
+    const customerId = (0, __1.getCustomerId)(auth);
+    const zone = (0, __1.getZone)(auth);
+    switch (type) {
+        case _1.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 (0, axios_1.post)(url, data, {
+        headers: {
+            Authorization: `Bearer ${auth.apiKey}`
+        },
+    });
+    if (requestResponse.isSuccess()) {
+        response = requestResponse.getBodyDefaultTo(["response_id"], "");
+    }
+    return response;
+};
+exports.getAsyncRequestId = getAsyncRequestId;

package/brightData/serpApi/getAsyncResults.d.ts

@@ -0,0 +1,7 @@
+import { Auth } from "../";
+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/getAsyncResults.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAsyncResults = void 0;
+const axios_1 = require("../../axios");
+const __1 = require("../");
+const api_1 = require("../../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
+ */
+const getAsyncResults = async (auth, requestId) => {
+    let response = (new api_1.ApiResponseClass());
+    // Prevent auth requests getting blocked
+    process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = "0";
+    const customerId = (0, __1.getCustomerId)(auth);
+    const zone = (0, __1.getZone)(auth);
+    const requestResponse = await (0, axios_1.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;
+};
+exports.getAsyncResults = getAsyncResults;

package/brightData/serpApi/getRealtime.d.ts

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

package/brightData/serpApi/getRealtime.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRealtime = void 0;
+const axios_1 = require("../../axios");
+/**
+ * Make a request to the SERP API using the Bright Data proxy
+ */
+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 (0, axios_1.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;
+};
+exports.getRealtime = getRealtime;

package/brightData/serpApi/index.d.ts

@@ -0,0 +1,14 @@
+export declare enum 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"
+}
+export { buildGoogleSerpUrl } from "./buildGoogleSerpUrl";
+export { buildGoogleTrendsUrl } from "./buildGoogleTrendsUrl";
+export { getAsyncRequestId } from "./getAsyncRequestId";
+export { getAsyncResults } from "./getAsyncResults";
+export { getRealtime } from "./getRealtime";

package/brightData/serpApi/index.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRealtime = exports.getAsyncResults = exports.getAsyncRequestId = exports.buildGoogleTrendsUrl = exports.buildGoogleSerpUrl = exports.BrightDataSerpApiType = void 0;
+var BrightDataSerpApiType;
+(function (BrightDataSerpApiType) {
+    BrightDataSerpApiType["GOOGLE_FLIGHTS"] = "GOOGLE_FLIGHTS";
+    BrightDataSerpApiType["GOOGLE_HOTELS"] = "GOOGLE_HOTELS";
+    BrightDataSerpApiType["GOOGLE_LENS"] = "GOOGLE_LENS";
+    BrightDataSerpApiType["GOOGLE_MAPS"] = "GOOGLE_MAPS";
+    BrightDataSerpApiType["GOOGLE_REVIEWS"] = "GOOGLE_REVIEWS";
+    BrightDataSerpApiType["GOOGLE_SEARCH"] = "GOOGLE_SEARCH";
+    BrightDataSerpApiType["GOOGLE_TRENDS"] = "GOOGLE_TRENDS";
+})(BrightDataSerpApiType || (exports.BrightDataSerpApiType = BrightDataSerpApiType = {}));
+var buildGoogleSerpUrl_1 = require("./buildGoogleSerpUrl");
+Object.defineProperty(exports, "buildGoogleSerpUrl", { enumerable: true, get: function () { return buildGoogleSerpUrl_1.buildGoogleSerpUrl; } });
+var buildGoogleTrendsUrl_1 = require("./buildGoogleTrendsUrl");
+Object.defineProperty(exports, "buildGoogleTrendsUrl", { enumerable: true, get: function () { return buildGoogleTrendsUrl_1.buildGoogleTrendsUrl; } });
+var getAsyncRequestId_1 = require("./getAsyncRequestId");
+Object.defineProperty(exports, "getAsyncRequestId", { enumerable: true, get: function () { return getAsyncRequestId_1.getAsyncRequestId; } });
+var getAsyncResults_1 = require("./getAsyncResults");
+Object.defineProperty(exports, "getAsyncResults", { enumerable: true, get: function () { return getAsyncResults_1.getAsyncResults; } });
+var getRealtime_1 = require("./getRealtime");
+Object.defineProperty(exports, "getRealtime", { enumerable: true, get: function () { return getRealtime_1.getRealtime; } });

package/brightData/webScraperIde/getBatch.d.ts

@@ -0,0 +1,7 @@
+import { Auth } from "../";
+/**
+ * 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/getBatch.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBatch = void 0;
+const axios_1 = require("../../axios");
+/**
+ * Depends on the Scraper setup!
+ *
+ * Make the request to trigger the scraper and let it do its job.
+ */
+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 (0, axios_1.post)(requestUrl.toString(), data, {
+        headers: {
+            Authorization: `Bearer ${auth.apiKey}`
+        },
+    });
+    if (requestResponse.isSuccess()) {
+        response = true;
+    }
+    return response;
+};
+exports.getBatch = getBatch;

package/brightData/webScraperIde/getRealtime.d.ts

@@ -0,0 +1,7 @@
+import { Auth } from "../";
+/**
+ * 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<{}>;