quickscraper-sdk
Version:
Quick Scraper SDK NodeJS APIs
541 lines (540 loc) • 29.6 kB
JavaScript
"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.QuickScraper = void 0;
var debug_1 = require("debug");
var fs = require("fs-extra");
var got_1 = require("got");
var _ = require("lodash");
var lodash_1 = require("lodash");
var querystring = require("querystring");
var constants_1 = require("./constants");
var error_1 = require("./error");
var debug = debug_1.default('QS:Main:index.ts');
var QuickScraper = /** @class */ (function () {
function QuickScraper(accessToken) {
this.accessToken = '';
this.DEFAULT = {
CLIENT: 'NODEJS_CLIENT_LIB',
HOST: constants_1.APP.BASE_URL,
CLIENT_VERSION: constants_1.APP.VERSION
};
// debug('DEFAULT ', this.DEFAULT);
this.parseUrl = this.DEFAULT.HOST.concat('parse');
this.accountUrl = this.DEFAULT.HOST.concat('account');
if (accessToken) {
this.setAccessToken(accessToken);
}
}
QuickScraper.prototype.setHost = function (host) {
if (host) {
this.parseUrl = host.concat('parse');
this.accountUrl = this.DEFAULT.HOST.concat('account');
}
};
QuickScraper.prototype.setAccessToken = function (accessToken) {
this.accessToken = accessToken;
};
QuickScraper.prototype.getContent = function (url, parseOptions) {
var _a, _b;
if (parseOptions === void 0) { parseOptions = {}; }
return __awaiter(this, void 0, void 0, function () {
var requestUrl, mergedHeaders, gotOptions, response, metadata, responseBody, gotError_1, errorBody, error, message_1, type_1, statusCode_1, message, type, statusCode;
return __generator(this, function (_c) {
switch (_c.label) {
case 0:
debug('parseOptions ', parseOptions);
requestUrl = this.prepareRequestBodyOrUrl(url, parseOptions, 'GET');
debug('requestUrl ', requestUrl);
mergedHeaders = this.prepareHeaders();
gotOptions = {
headers: mergedHeaders
};
_c.label = 1;
case 1:
_c.trys.push([1, 3, , 4]);
return [4 /*yield*/, got_1.default.get(requestUrl, gotOptions)];
case 2:
response = _c.sent();
metadata = {
'quotaMax': (_a = response.headers['x-qs-quota-max']) === null || _a === void 0 ? void 0 : _a.toString(),
'quotaRemaining': (_b = response.headers['x-qs-quota-remaining']) === null || _b === void 0 ? void 0 : _b.toString()
};
responseBody = response.body;
if (!lodash_1.isEmpty(parseOptions.parserSubscriptionId)
&& response.headers['content-type'] &&
response.headers['content-type'].includes('application/json')) {
responseBody = JSON.parse(responseBody);
}
debug('response type', typeof (responseBody));
return [2 /*return*/, {
data: responseBody,
metadata: metadata
}];
case 3:
gotError_1 = _c.sent();
if (gotError_1 &&
gotError_1.response &&
gotError_1.response.body) {
errorBody = gotError_1.response.body;
debug('errorBody ', errorBody);
error = JSON.parse(errorBody);
message_1 = error.message || 'Failed to process request';
type_1 = error.error || 'UNKNOWN';
statusCode_1 = error.statusCode || 530;
debug('error message ', message_1);
debug('error statusCode ', statusCode_1);
debug('error type ', type_1);
throw new error_1.QsError(message_1, type_1, statusCode_1);
}
debug('gotError ', gotError_1);
message = 'Failed to process request';
type = 'UNKNOWN';
statusCode = 530;
throw new error_1.QsError(message, type, statusCode);
case 4: return [2 /*return*/];
}
});
});
};
QuickScraper.prototype.postContent = function (url, parseOptions) {
var _a, _b;
if (parseOptions === void 0) { parseOptions = {}; }
return __awaiter(this, void 0, void 0, function () {
var requestData, mergedHeaders, gotOptions, response, metadata, responseBody, gotError_2, errorBody, error, message_2, type_2, statusCode_2, message, type, statusCode;
return __generator(this, function (_c) {
switch (_c.label) {
case 0:
debug('parseOptions ', parseOptions);
requestData = this.prepareRequestBodyOrUrl(url, parseOptions, 'POST');
debug('requestBody ', requestData);
mergedHeaders = this.prepareHeaders();
gotOptions = {
headers: mergedHeaders,
json: requestData.requestBody
};
_c.label = 1;
case 1:
_c.trys.push([1, 3, , 4]);
return [4 /*yield*/, got_1.default.post(requestData.requestUrl, gotOptions)];
case 2:
response = _c.sent();
metadata = {
'quotaMax': (_a = response.headers['x-qs-quota-max']) === null || _a === void 0 ? void 0 : _a.toString(),
'quotaRemaining': (_b = response.headers['x-qs-quota-remaining']) === null || _b === void 0 ? void 0 : _b.toString()
};
responseBody = response.body;
if (!lodash_1.isEmpty(parseOptions.parserSubscriptionId)
&& response.headers['content-type'] &&
response.headers['content-type'].includes('application/json')) {
responseBody = JSON.parse(responseBody);
}
debug('response type', typeof (responseBody));
return [2 /*return*/, {
data: responseBody,
metadata: metadata
}];
case 3:
gotError_2 = _c.sent();
if (gotError_2 &&
gotError_2.response &&
gotError_2.response.body) {
errorBody = gotError_2.response.body;
debug('errorBody ', errorBody);
error = JSON.parse(errorBody);
message_2 = error.message || 'Failed to process request';
type_2 = error.error || 'UNKNOWN';
statusCode_2 = error.statusCode || 530;
debug('error message ', message_2);
debug('error statusCode ', statusCode_2);
debug('error type ', type_2);
throw new error_1.QsError(message_2, type_2, statusCode_2);
}
debug('gotError ', gotError_2);
message = 'Failed to process request';
type = 'UNKNOWN';
statusCode = 530;
throw new error_1.QsError(message, type, statusCode);
case 4: return [2 /*return*/];
}
});
});
};
QuickScraper.prototype.getHtml = function (url, parseOptions) {
var _a;
if (parseOptions === void 0) { parseOptions = {}; }
return __awaiter(this, void 0, void 0, function () {
var gotError_3, errorBody, error, message_3, type_3, statusCode_3, message, type, statusCode;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
_b.trys.push([0, 4, , 5]);
if (!((parseOptions.customSelectors && ((_a = parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.customSelectors) === null || _a === void 0 ? void 0 : _a.length) > 0) || (parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.formData) || ((parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.dynamicInputs) && (parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.parserSubscriptionId)) || (parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.isKeepHeaders))) return [3 /*break*/, 2];
return [4 /*yield*/, this.postContent(url, parseOptions)];
case 1: return [2 /*return*/, _b.sent()];
case 2: return [4 /*yield*/, this.getContent(url, parseOptions)];
case 3: return [2 /*return*/, _b.sent()];
case 4:
gotError_3 = _b.sent();
if (gotError_3 &&
gotError_3.response &&
gotError_3.response.body) {
errorBody = gotError_3.response.body;
debug('errorBody ', errorBody);
error = JSON.parse(errorBody);
message_3 = error.message || 'Failed to process request';
type_3 = error.error || 'UNKNOWN';
statusCode_3 = error.statusCode || 530;
debug('error message ', message_3);
debug('error statusCode ', statusCode_3);
debug('error type ', type_3);
throw new error_1.QsError(message_3, type_3, statusCode_3);
}
debug('gotError ', gotError_3);
message = 'Failed to process request';
type = 'UNKNOWN';
statusCode = 530;
throw new error_1.QsError(message, type, statusCode);
case 5: return [2 /*return*/];
}
});
});
};
QuickScraper.prototype.writeHtmlToFile = function (url, filePath, parseOptions) {
return __awaiter(this, void 0, void 0, function () {
var isFileExits, message, errorCode, statusCode, response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, fs.pathExists(filePath)];
case 1:
isFileExits = _a.sent();
if (isFileExits === false) {
message = 'File does not exits.';
errorCode = 'FILE_NOT_EXITS';
statusCode = 400;
throw new error_1.QsError(message, errorCode, statusCode);
// throw Error('File does not exits.');
}
return [4 /*yield*/, this.getHtml(url, parseOptions)];
case 2:
response = _a.sent();
if ((parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.format) === 'images' || (parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.format) === 'docx') {
fs.outputFileSync(filePath, Buffer.from(response.data, 'base64'));
return [2 /*return*/, response];
}
fs.outputFileSync(filePath, response.data);
return [2 /*return*/, response];
}
});
});
};
QuickScraper.prototype.writeCSVFile = function (url, filePath, parseOptions) {
return __awaiter(this, void 0, void 0, function () {
var newParseOptions, response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
newParseOptions = Object.assign(parseOptions || {}, {
format: 'tables'
});
return [4 /*yield*/, this.writeHtmlToFile(url, filePath, newParseOptions)];
case 1:
response = _a.sent();
return [2 /*return*/, response];
}
});
});
};
QuickScraper.prototype.getAllImagesInZip = function (url, filePath, parseOptions) {
return __awaiter(this, void 0, void 0, function () {
var newParseOptions, response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
newParseOptions = Object.assign(parseOptions || {}, {
format: 'images'
});
return [4 /*yield*/, this.writeHtmlToFile(url, filePath, newParseOptions)];
case 1:
response = _a.sent();
return [2 /*return*/, response];
}
});
});
};
QuickScraper.prototype.writeDOCXFile = function (url, filePath, parseOptions) {
return __awaiter(this, void 0, void 0, function () {
var newParseOptions, response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
newParseOptions = Object.assign(parseOptions || {}, {
format: 'docx'
});
return [4 /*yield*/, this.writeHtmlToFile(url, filePath, newParseOptions)];
case 1:
response = _a.sent();
return [2 /*return*/, response];
}
});
});
};
QuickScraper.prototype.getJsonUsingParser = function (url, parseOptions) {
return __awaiter(this, void 0, void 0, function () {
var response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.getHtml(url, parseOptions)];
case 1:
response = _a.sent();
return [2 /*return*/, response];
}
});
});
};
QuickScraper.prototype.getCsvUsingParser = function (url, filePath, parseOptions) {
return __awaiter(this, void 0, void 0, function () {
var response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.writeHtmlToFile(url, filePath, parseOptions)];
case 1:
response = _a.sent();
return [2 /*return*/, response];
}
});
});
};
QuickScraper.prototype.getExcelUsingParser = function (url, filePath, parseOptions) {
return __awaiter(this, void 0, void 0, function () {
var response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.writeHtmlToFile(url, filePath, parseOptions)];
case 1:
response = _a.sent();
return [2 /*return*/, response];
}
});
});
};
QuickScraper.prototype.post = function (url, parseOptions) {
if (parseOptions === void 0) { parseOptions = {}; }
return __awaiter(this, void 0, void 0, function () {
var response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.getHtml(url, parseOptions)];
case 1:
response = _a.sent();
return [2 /*return*/, response];
}
});
});
};
QuickScraper.prototype.put = function (url, parseOptions) {
if (parseOptions === void 0) { parseOptions = {}; }
return __awaiter(this, void 0, void 0, function () {
var response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.getHtml(url, parseOptions)];
case 1:
response = _a.sent();
return [2 /*return*/, response];
}
});
});
};
QuickScraper.prototype.account = function () {
return __awaiter(this, void 0, void 0, function () {
var response, gotError_4, errorBody, error, message_4, type_4, statusCode_4, message, type, statusCode;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
return [4 /*yield*/, got_1.default.get(this.accountUrl, {
searchParams: { 'access_token': this.accessToken }
}).json()];
case 1:
response = _a.sent();
return [2 /*return*/, response];
case 2:
gotError_4 = _a.sent();
if (gotError_4 &&
gotError_4.response &&
gotError_4.response.body) {
errorBody = gotError_4.response.body;
debug('errorBody ', errorBody);
error = JSON.parse(errorBody);
message_4 = error.message || 'Failed to process request';
type_4 = error.error || 'UNKNOWN';
statusCode_4 = error.statusCode || 530;
debug('error message ', message_4);
debug('error statusCode ', statusCode_4);
debug('error type ', type_4);
throw new error_1.QsError(message_4, type_4, statusCode_4);
}
debug('gotError ', gotError_4);
message = 'Failed to process request';
type = 'UNKNOWN';
statusCode = 530;
throw new error_1.QsError(message, type, statusCode);
case 3: return [2 /*return*/];
}
});
});
};
// eslint-disable-next-line @typescript-eslint/no-explicit-any
QuickScraper.prototype.prepareRequestBodyOrUrl = function (url, parseOptions, requestType) {
var urlOptions = {
access_token: this.accessToken,
URL: url
};
if (_.isUndefined(parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.render) === false) {
urlOptions.render = parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.render;
}
if (_.isUndefined(parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.session_number) === false) {
urlOptions.session_number = parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.session_number;
}
if (_.isUndefined(parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.country_code) === false) {
urlOptions.country_code = parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.country_code;
}
if (_.isUndefined(parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.premium) === false) {
urlOptions.premium = parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.premium;
}
if (_.isUndefined(parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.isKeepHeaders) === false) {
urlOptions.isKeepHeaders = parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.isKeepHeaders;
}
if (_.isUndefined(parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.customRequestHeaders) === false) {
urlOptions.customRequestHeaders = parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.customRequestHeaders;
}
if (_.isUndefined(parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.format) === false) {
urlOptions.format = parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.format;
}
if (_.isUndefined(parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.device_type) === false) {
urlOptions.device_type = parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.device_type;
}
if (_.isUndefined(parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.parserSubscriptionId) === false) {
urlOptions.parserSubscriptionRequestId = parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.parserSubscriptionId;
}
if (_.isUndefined(parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.webhookRequestId) === false) {
urlOptions.webhookRequestId = parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.webhookRequestId;
}
if (_.isUndefined(parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.isScroll) === false) {
urlOptions.isScroll = parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.isScroll;
}
if (_.isUndefined(parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.scrollTimeout) === false) {
urlOptions.scrollTimeout = parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.scrollTimeout;
}
if (_.isUndefined(parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.isPabbly) === false) {
urlOptions.isPabbly = parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.isPabbly;
}
if (_.isUndefined(parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.isZapier) === false) {
urlOptions.isZapier = parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.isZapier;
}
if (_.isUndefined(parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.customSelectors) === false) {
urlOptions.customSelectors = parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.customSelectors;
}
if (_.isUndefined(parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.keepSelection) === false) {
urlOptions.keepSelection = parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.keepSelection;
}
if (_.isUndefined(parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.formData) === false) {
urlOptions.formData = parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.formData;
}
if (_.isUndefined(parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.isKeepFormDataSelection) === false) {
urlOptions.isKeepFormDataSelection = parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.isKeepFormDataSelection;
}
if (_.isUndefined(parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.dynamicInputs) === false) {
urlOptions.dynamicInputs = parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.dynamicInputs;
}
if (_.isUndefined(parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.parserResponseType) === false) {
urlOptions.parserResponseType = parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.parserResponseType;
}
var requestData = {
requestBody: urlOptions, requestUrl: this.parseUrl
};
if (requestType === 'GET') {
debug('urlOptions ', urlOptions);
var optionString = querystring.stringify(urlOptions);
var requestUrl = this.parseUrl.concat('?', optionString);
return requestUrl;
}
return requestData;
};
QuickScraper.prototype.prepareHeaders = function () {
var headers = {
Client: this.DEFAULT.CLIENT,
'Client-Version': this.DEFAULT.CLIENT_VERSION,
};
return headers;
};
QuickScraper.prototype.executeJsonParser = function (url, parseOptions) {
if (parseOptions === void 0) { parseOptions = {}; }
return __awaiter(this, void 0, void 0, function () {
var response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.getHtml(url, parseOptions)];
case 1:
response = _a.sent();
return [2 /*return*/, response];
}
});
});
};
QuickScraper.prototype.getData = function (url, parseOptions) {
if (parseOptions === void 0) { parseOptions = {}; }
return __awaiter(this, void 0, void 0, function () {
var response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.getHtml(url, parseOptions)];
case 1:
response = _a.sent();
return [2 /*return*/, response];
}
});
});
};
return QuickScraper;
}());
exports.QuickScraper = QuickScraper;
module.exports = QuickScraper;
module.exports.QuickScraper = QuickScraper;
module.exports.default = QuickScraper;