UNPKG

@push.rocks/smartrequest

Version:

A module for modern HTTP/HTTPS requests with support for form data, file uploads, JSON, binary data, streams, and more.

276 lines 15.9 kB
import { CoreRequest, CoreResponse } from '../core_node/index.js'; import * as plugins from '../core_node/plugins.js'; import { PaginationStrategy } from './types/pagination.js'; import { createPaginatedResponse } from './features/pagination.js'; /** * Modern fluent client for making HTTP requests */ export class SmartRequestClient { constructor() { this._options = {}; this._retries = 0; this._queryParams = {}; } /** * Create a new SmartRequestClient instance */ static create() { return new SmartRequestClient(); } /** * Set the URL for the request */ url(url) { this._url = url; return this; } /** * Set the HTTP method */ method(method) { this._options.method = method; return this; } /** * Set JSON body for the request */ json(data) { if (!this._options.headers) { this._options.headers = {}; } this._options.headers['Content-Type'] = 'application/json'; this._options.requestBody = data; return this; } /** * Set form data for the request */ formData(data) { const form = new plugins.formData(); for (const item of data) { if (Buffer.isBuffer(item.value)) { form.append(item.name, item.value, { filename: item.filename || 'file', contentType: item.contentType || 'application/octet-stream' }); } else { form.append(item.name, item.value); } } if (!this._options.headers) { this._options.headers = {}; } this._options.headers = { ...this._options.headers, ...form.getHeaders() }; this._options.requestBody = form; return this; } /** * Set request timeout in milliseconds */ timeout(ms) { this._options.timeout = ms; this._options.hardDataCuttingTimeout = ms; return this; } /** * Set number of retry attempts */ retry(count) { this._retries = count; return this; } /** * Set HTTP headers */ headers(headers) { if (!this._options.headers) { this._options.headers = {}; } this._options.headers = { ...this._options.headers, ...headers }; return this; } /** * Set a single HTTP header */ header(name, value) { if (!this._options.headers) { this._options.headers = {}; } this._options.headers[name] = value; return this; } /** * Set query parameters */ query(params) { this._queryParams = { ...this._queryParams, ...params }; return this; } /** * Set the Accept header to indicate what content type is expected */ accept(type) { // Map response types to Accept header values const acceptHeaders = { 'json': 'application/json', 'text': 'text/plain', 'binary': 'application/octet-stream', 'stream': '*/*' }; return this.header('Accept', acceptHeaders[type]); } /** * Configure pagination for requests */ pagination(config) { this._paginationConfig = config; return this; } /** * Configure offset-based pagination (page & limit) */ withOffsetPagination(config = {}) { this._paginationConfig = { strategy: PaginationStrategy.OFFSET, pageParam: config.pageParam || 'page', limitParam: config.limitParam || 'limit', startPage: config.startPage || 1, pageSize: config.pageSize || 20, totalPath: config.totalPath || 'total' }; // Add initial pagination parameters this.query({ [this._paginationConfig.pageParam]: String(this._paginationConfig.startPage), [this._paginationConfig.limitParam]: String(this._paginationConfig.pageSize) }); return this; } /** * Configure cursor-based pagination */ withCursorPagination(config = {}) { this._paginationConfig = { strategy: PaginationStrategy.CURSOR, cursorParam: config.cursorParam || 'cursor', cursorPath: config.cursorPath || 'nextCursor', hasMorePath: config.hasMorePath || 'hasMore' }; return this; } /** * Configure Link header-based pagination */ withLinkPagination() { this._paginationConfig = { strategy: PaginationStrategy.LINK_HEADER }; return this; } /** * Configure custom pagination */ withCustomPagination(config) { this._paginationConfig = { strategy: PaginationStrategy.CUSTOM, hasNextPage: config.hasNextPage, getNextPageParams: config.getNextPageParams }; return this; } /** * Make a GET request */ async get() { return this.execute('GET'); } /** * Make a POST request */ async post() { return this.execute('POST'); } /** * Make a PUT request */ async put() { return this.execute('PUT'); } /** * Make a DELETE request */ async delete() { return this.execute('DELETE'); } /** * Make a PATCH request */ async patch() { return this.execute('PATCH'); } /** * Get paginated response */ async getPaginated() { if (!this._paginationConfig) { throw new Error('Pagination not configured. Call one of the pagination methods first.'); } // Default to GET if no method specified if (!this._options.method) { this._options.method = 'GET'; } const response = await this.execute(); return await createPaginatedResponse(response, this._paginationConfig, this._queryParams, (nextPageParams) => { // Create a new client with the same configuration but updated query params const nextClient = new SmartRequestClient(); Object.assign(nextClient, this); nextClient._queryParams = nextPageParams; return nextClient.getPaginated(); }); } /** * Get all pages at once (use with caution for large datasets) */ async getAllPages() { const firstPage = await this.getPaginated(); return firstPage.getAllPages(); } /** * Execute the HTTP request */ async execute(method) { if (method) { this._options.method = method; } this._options.queryParams = this._queryParams; // Handle retry logic let lastError; for (let attempt = 0; attempt <= this._retries; attempt++) { try { const response = await CoreRequest.create(this._url, this._options); return response; } catch (error) { lastError = error; // If this is the last attempt, throw the error if (attempt === this._retries) { throw lastError; } // Otherwise, wait before retrying await new Promise(resolve => setTimeout(resolve, 1000)); } } // This should never be reached due to the throw in the loop above throw lastError; } } //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"smartrequestclient.js","sourceRoot":"","sources":["../../ts/modern/smartrequestclient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,YAAY,EAA4B,MAAM,uBAAuB,CAAC;AAC5F,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AAGnD,OAAO,EAEL,kBAAkB,EAKnB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,uBAAuB,EAAE,MAAM,0BAA0B,CAAC;AAEnE;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAA/B;QAEU,aAAQ,GAAwB,EAAE,CAAC;QACnC,aAAQ,GAAW,CAAC,CAAC;QACrB,iBAAY,GAA2B,EAAE,CAAC;IAmTpD,CAAC;IAhTC;;OAEG;IACH,MAAM,CAAC,MAAM;QACX,OAAO,IAAI,kBAAkB,EAAK,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,GAAW;QACb,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,MAAkB;QACvB,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,IAAS;QACZ,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YAC3B,IAAI,CAAC,QAAQ,CAAC,OAAO,GAAG,EAAE,CAAC;QAC7B,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAC3D,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,IAAiB;QACxB,MAAM,IAAI,GAAG,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QAEpC,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;YACxB,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE;oBACjC,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,MAAM;oBACjC,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,0BAA0B;iBAC5D,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YACrC,CAAC;QACH,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YAC3B,IAAI,CAAC,QAAQ,CAAC,OAAO,GAAG,EAAE,CAAC;QAC7B,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,OAAO,GAAG;YACtB,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO;YACxB,GAAG,IAAI,CAAC,UAAU,EAAE;SACrB,CAAC;QAEF,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,EAAU;QAChB,IAAI,CAAC,QAAQ,CAAC,OAAO,GAAG,EAAE,CAAC;QAC3B,IAAI,CAAC,QAAQ,CAAC,sBAAsB,GAAG,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,OAA+B;QACrC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YAC3B,IAAI,CAAC,QAAQ,CAAC,OAAO,GAAG,EAAE,CAAC;QAC7B,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,OAAO,GAAG;YACtB,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO;YACxB,GAAG,OAAO;SACX,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAY,EAAE,KAAa;QAChC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YAC3B,IAAI,CAAC,QAAQ,CAAC,OAAO,GAAG,EAAE,CAAC;QAC7B,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAA8B;QAClC,IAAI,CAAC,YAAY,GAAG;YAClB,GAAG,IAAI,CAAC,YAAY;YACpB,GAAG,MAAM;SACV,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAkB;QACvB,6CAA6C;QAC7C,MAAM,aAAa,GAAiC;YAClD,MAAM,EAAE,kBAAkB;YAC1B,MAAM,EAAE,YAAY;YACpB,QAAQ,EAAE,0BAA0B;YACpC,QAAQ,EAAE,KAAK;SAChB,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,MAAyB;QAClC,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,oBAAoB,CAAC,SAAmD,EAAE;QACxE,IAAI,CAAC,iBAAiB,GAAG;YACvB,QAAQ,EAAE,kBAAkB,CAAC,MAAM;YACnC,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,MAAM;YACrC,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,OAAO;YACxC,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,CAAC;YAChC,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,EAAE;YAC/B,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,OAAO;SACvC,CAAC;QAEF,oCAAoC;QACpC,IAAI,CAAC,KAAK,CAAC;YACT,CAAC,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC;YAC5E,CAAC,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC;SAC7E,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,oBAAoB,CAAC,SAAmD,EAAE;QACxE,IAAI,CAAC,iBAAiB,GAAG;YACvB,QAAQ,EAAE,kBAAkB,CAAC,MAAM;YACnC,WAAW,EAAE,MAAM,CAAC,WAAW,IAAI,QAAQ;YAC3C,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,YAAY;YAC7C,WAAW,EAAE,MAAM,CAAC,WAAW,IAAI,SAAS;SAC7C,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,kBAAkB;QAChB,IAAI,CAAC,iBAAiB,GAAG;YACvB,QAAQ,EAAE,kBAAkB,CAAC,WAAW;SACzC,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,oBAAoB,CAAC,MAAgD;QACnE,IAAI,CAAC,iBAAiB,GAAG;YACvB,QAAQ,EAAE,kBAAkB,CAAC,MAAM;YACnC,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;SAC5C,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG;QACP,OAAO,IAAI,CAAC,OAAO,CAAI,KAAK,CAAC,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,OAAO,IAAI,CAAC,OAAO,CAAI,MAAM,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG;QACP,OAAO,IAAI,CAAC,OAAO,CAAI,KAAK,CAAC,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM;QACV,OAAO,IAAI,CAAC,OAAO,CAAI,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,OAAO,IAAI,CAAC,OAAO,CAAI,OAAO,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY;QAChB,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAC;QAC1F,CAAC;QAED,wCAAwC;QACxC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC1B,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,KAAK,CAAC;QAC/B,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QAEtC,OAAO,MAAM,uBAAuB,CAClC,QAAQ,EACR,IAAI,CAAC,iBAAiB,EACtB,IAAI,CAAC,YAAY,EACjB,CAAC,cAAc,EAAE,EAAE;YACjB,2EAA2E;YAC3E,MAAM,UAAU,GAAG,IAAI,kBAAkB,EAAY,CAAC;YACtD,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YAChC,UAAU,CAAC,YAAY,GAAG,cAAc,CAAC;YAEzC,OAAO,UAAU,CAAC,YAAY,EAAY,CAAC;QAC7C,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW;QACf,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,YAAY,EAAY,CAAC;QACtD,OAAO,SAAS,CAAC,WAAW,EAAE,CAAC;IACjC,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,OAAO,CAAQ,MAAmB;QAC9C,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC;QAChC,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC;QAE9C,qBAAqB;QACrB,IAAI,SAAgB,CAAC;QAErB,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,CAAC;YAC1D,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACpE,OAAO,QAA2B,CAAC;YACrC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,SAAS,GAAG,KAAc,CAAC;gBAE3B,+CAA+C;gBAC/C,IAAI,OAAO,KAAK,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAC9B,MAAM,SAAS,CAAC;gBAClB,CAAC;gBAED,kCAAkC;gBAClC,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC;QAED,kEAAkE;QAClE,MAAM,SAAS,CAAC;IAClB,CAAC;CACF"}