@8ms/helpers 1.39.0 → 1.40.1

package/dist/brightData/getCustomerId.d.mts

@@ -0,0 +1,13 @@
+import { Param } from "./param.mjs";
+
+//#region src/brightData/getCustomerId.d.ts
+type GetCustomerId = {
+  auth: Param;
+  prefix?: string;
+};
+/**
+ * Return the customer Id based on the username.
+ */
+declare const getCustomerId: (props: GetCustomerId) => string;
+//#endregion
+export { getCustomerId as default };

package/dist/brightData/getCustomerId.mjs

@@ -0,0 +1,10 @@
+//#region src/brightData/getCustomerId.ts
+/**
+* Return the customer Id based on the username.
+*/
+const getCustomerId = (props) => {
+	const customerId = props.auth.username.split("-")[2][2].replace("hl_", "");
+	return (props?.prefix || "") + customerId;
+};
+//#endregion
+export { getCustomerId as default };

package/dist/brightData/getZone.d.mts

@@ -0,0 +1,12 @@
+import { Param } from "./param.mjs";
+
+//#region src/brightData/getZone.d.ts
+type GetZone = {
+  auth: Param;
+};
+/**
+ * Return the Zone based on the username.
+ */
+declare const getZone: (props: GetZone) => string;
+//#endregion
+export { getZone as default };

package/dist/brightData/getZone.mjs

@@ -0,0 +1,10 @@
+//#region src/brightData/getZone.ts
+/**
+* Return the Zone based on the username.
+*/
+const getZone = (props) => {
+	const segments = props.auth.username.split("-");
+	return segments[segments.length - 1];
+};
+//#endregion
+export { getZone as default };

package/dist/brightData/param.d.mts

@@ -0,0 +1,11 @@
+//#region src/brightData/param.d.ts
+type Param = {
+  apiKey: string;
+  host: string;
+  port: string;
+  username: string;
+  password: string;
+};
+declare const _default: {};
+//#endregion
+export { Param, _default as default };

package/dist/brightData/param.mjs

@@ -0,0 +1,4 @@
+//#region src/brightData/param.ts
+var param_default = {};
+//#endregion
+export { param_default as default };

package/dist/brightData/serpApi/buildGoogleSerpUrl.d.mts

@@ -0,0 +1,34 @@
+//#region src/brightData/serpApi/buildGoogleSerpUrl.d.ts
+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
+ */
+declare const buildGoogleSerpUrl: (props: BuildGoogleSerpUrl) => string | {
+  query: {
+    q: string;
+  };
+};
+//#endregion
+export { buildGoogleSerpUrl as default };

package/dist/brightData/serpApi/buildGoogleSerpUrl.mjs

@@ -0,0 +1,100 @@
+//#region src/brightData/serpApi/buildGoogleSerpUrl.ts
+/**
+* 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);
+	if (props?.country) {
+		params.query["gl"] = props.country;
+		url.searchParams.append("gl", props.country);
+	}
+	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;
+	}
+	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());
+		}
+	}
+	if (props?.language) {
+		params.query["uule"] = props.language;
+		url.searchParams.append("hl", props.language);
+	}
+	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) {
+		if (props.pagination?.offset) {
+			params.query["start"] = props.pagination.offset.toString();
+			url.searchParams.append("start", props.pagination.offset.toString());
+		}
+		if (props.pagination?.perPage) {
+			params.query["num"] = props.pagination.offset.toString();
+			url.searchParams.append("num", props.pagination.perPage.toString());
+		}
+	}
+	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();
+};
+//#endregion
+export { buildGoogleSerpUrl as default };

package/dist/brightData/serpApi/buildGoogleTrendsUrl.d.mts

@@ -0,0 +1,24 @@
+//#region src/brightData/serpApi/buildGoogleTrendsUrl.d.ts
+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;
+  };
+};
+//#endregion
+export { buildGoogleTrendsUrl as default };

package/dist/brightData/serpApi/buildGoogleTrendsUrl.mjs

@@ -0,0 +1,51 @@
+//#region src/brightData/serpApi/buildGoogleTrendsUrl.ts
+/**
+* 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 } };
+	if (props?.country) {
+		params.query["geo"] = props.country;
+		url.searchParams.append("geo", props.country);
+	}
+	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);
+	}
+	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();
+};
+//#endregion
+export { buildGoogleTrendsUrl as default };

package/dist/brightData/serpApi/getAsyncRequestId.d.mts

@@ -0,0 +1,17 @@
+import { Param } from "../param.mjs";
+import { Type } from "./type.mjs";
+
+//#region src/brightData/serpApi/getAsyncRequestId.d.ts
+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>;
+//#endregion
+export { getAsyncRequestId as default };

package/dist/brightData/serpApi/getAsyncRequestId.mjs

@@ -0,0 +1,35 @@
+import post from "../../axios/post.mjs";
+import getCustomerId from "../getCustomerId.mjs";
+import getZone from "../getZone.mjs";
+import { Type } from "./type.mjs";
+//#region src/brightData/serpApi/getAsyncRequestId.ts
+/**
+* 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 = "";
+	process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = "0";
+	const customerId = getCustomerId({ auth: props.auth });
+	const zone = getZone({ auth: props.auth });
+	switch (props.type) {
+		case 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 post({
+		config: { headers: { Authorization: `Bearer ${props.auth.apiKey}` } },
+		data: props?.data || {},
+		url
+	});
+	if (requestResponse.isSuccess()) response = requestResponse.getBodyDefaultTo({
+		defaultValue: "",
+		keys: ["response_id"]
+	});
+	return response;
+};
+//#endregion
+export { getAsyncRequestId as default };

package/dist/brightData/serpApi/getAsyncResults.d.mts

@@ -0,0 +1,15 @@
+import ApiResponse from "../../api/ApiResponse.mjs";
+import { Param } from "../param.mjs";
+
+//#region src/brightData/serpApi/getAsyncResults.d.ts
+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>;
+//#endregion
+export { getAsyncResults as default };

package/dist/brightData/serpApi/getAsyncResults.mjs

@@ -0,0 +1,25 @@
+import ApiResponse from "../../api/ApiResponse.mjs";
+import get from "../../axios/get.mjs";
+import getCustomerId from "../getCustomerId.mjs";
+import getZone from "../getZone.mjs";
+//#region src/brightData/serpApi/getAsyncResults.ts
+/**
+* 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();
+	process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = "0";
+	const customerId = getCustomerId({ auth: props.auth });
+	const zone = getZone({ auth: props.auth });
+	const requestResponse = await get({
+		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;
+};
+//#endregion
+export { getAsyncResults as default };

package/dist/brightData/serpApi/getRealtime.d.mts

@@ -0,0 +1,13 @@
+import { Param } from "../param.mjs";
+
+//#region src/brightData/serpApi/getRealtime.d.ts
+type GetRealtime = {
+  auth: Param;
+  url: string;
+};
+/**
+ * Make a request to the SERP API using the Bright Data proxy
+ */
+declare const getRealtime: (props: GetRealtime) => Promise<{}>;
+//#endregion
+export { getRealtime as default };

package/dist/brightData/serpApi/getRealtime.mjs

@@ -0,0 +1,25 @@
+import get from "../../axios/get.mjs";
+//#region src/brightData/serpApi/getRealtime.ts
+/**
+* Make a request to the SERP API using the Bright Data proxy
+*/
+const getRealtime = async (props) => {
+	let response = {};
+	process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = "0";
+	const apiResponse = await get({
+		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;
+};
+//#endregion
+export { getRealtime as default };

package/dist/brightData/serpApi/type.d.mts

@@ -0,0 +1,13 @@
+//#region src/brightData/serpApi/type.d.ts
+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: {};
+//#endregion
+export { Type, _default as default };

package/dist/brightData/serpApi/type.mjs

@@ -0,0 +1,14 @@
+//#region src/brightData/serpApi/type.ts
+let Type = /* @__PURE__ */ 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";
+	return Type;
+}({});
+var type_default = {};
+//#endregion
+export { Type, type_default as default };

package/dist/brightData/webScraperIde/getBatch.d.mts

@@ -0,0 +1,17 @@
+import { Param } from "../param.mjs";
+
+//#region src/brightData/webScraperIde/getBatch.d.ts
+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>;
+//#endregion
+export { getBatch as default };

package/dist/brightData/webScraperIde/getBatch.mjs

@@ -0,0 +1,22 @@
+import post from "../../axios/post.mjs";
+//#region src/brightData/webScraperIde/getBatch.ts
+/**
+* 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");
+	if ((await post({
+		config: { headers: { Authorization: `Bearer ${props.auth.apiKey}` } },
+		data: props?.data || {},
+		url: requestUrl.toString()
+	})).isSuccess()) response = true;
+	return response;
+};
+//#endregion
+export { getBatch as default };

package/dist/brightData/webScraperIde/getRealtime.d.mts

@@ -0,0 +1,16 @@
+import { Param } from "../param.mjs";
+
+//#region src/brightData/webScraperIde/getRealtime.d.ts
+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<{}>;
+//#endregion
+export { getRealtime as default };

package/dist/brightData/webScraperIde/getRealtime.mjs

@@ -0,0 +1,44 @@
+import { State } from "../../api/index.mjs";
+import post from "../../axios/post.mjs";
+import get from "../../axios/get.mjs";
+import sleep from "../../util/sleep.mjs";
+//#region src/brightData/webScraperIde/getRealtime.ts
+/**
+* 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 post({
+		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 = State.PENDING;
+			while (State.PENDING === state) {
+				const resultUrl = `https://api.brightdata.com/dca/get_result?response_id=${responseId}`;
+				const resultResponse = await get({
+					config: { headers: { Authorization: `Bearer ${props.auth.apiKey}` } },
+					url: resultUrl
+				});
+				if (resultResponse.isSuccess()) if (void 0 !== resultResponse.body.pending && true === resultResponse.body.pending) state = State.PENDING;
+				else {
+					state = State.SUCCESS;
+					response = resultResponse.getBody();
+				}
+				await sleep({ seconds: 1 });
+			}
+		}
+	}
+	return response;
+};
+//#endregion
+export { getRealtime as default };

package/dist/chunk-y_GBKt04.mjs

@@ -0,0 +1,5 @@
+import { createRequire } from "node:module";
+//#region \0rolldown/runtime.js
+var __require = /* @__PURE__ */ createRequire(import.meta.url);
+//#endregion
+export { __require as t };

package/dist/class/BaseClass.d.mts

@@ -0,0 +1,45 @@
+//#region src/class/BaseClass.d.ts
+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;
+}
+//#endregion
+export { BaseClass as default };

package/dist/class/BaseClass.mjs

@@ -0,0 +1,46 @@
+import defaultTo from "../util/defaultTo.mjs";
+import isArray from "lodash/isArray.js";
+import set from "lodash/set.js";
+//#region src/class/BaseClass.ts
+var BaseClass = class {
+	/**
+	* Shortcut to set a value to an array and return the instance.
+	*/
+	_setArray({ input, fields }) {
+		if (isArray(input)) set(this, fields, input);
+		else set(this, fields, [input]);
+		return this;
+	}
+	/**
+	* Shortcut to set a value and return the instance.
+	*/
+	_setValue({ input, fields }) {
+		set(this, fields, input);
+		return this;
+	}
+	/**
+	* Shortcut to add a value to an existing array.
+	*/
+	_push({ input, fields }) {
+		let temp = this._get({
+			defaultValue: [],
+			fields
+		});
+		if (isArray(input)) temp = temp.concat(input);
+		else temp = temp.push(input);
+		set(this, fields, temp);
+		return this;
+	}
+	/**
+	* Shortcut to get a value, but default if the fields don't exist.
+	*/
+	_get({ defaultValue, fields }) {
+		return defaultTo({
+			defaultValue,
+			instance: this,
+			keys: fields
+		});
+	}
+};
+//#endregion
+export { BaseClass as default };

package/dist/crud/index.d.mts

@@ -0,0 +1,9 @@
+//#region src/crud/index.d.ts
+declare enum Action {
+  CREATE = "CREATE",
+  READ = "READ",
+  UPDATE = "UPDATE",
+  DELETE = "DELETE"
+}
+//#endregion
+export { Action };