UNPKG

@vepler/http-client

Version:

A flexible and extensible API service library for making HTTP requests with built-in authentication support for bearer tokens and API keys.

217 lines 11.1 kB
"use strict"; var __assign = (this && this.__assign) || function () { __assign = Object.assign || function(t) { for (var s, i = 1, n = arguments.length; i < n; i++) { s = arguments[i]; for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p]; } return t; }; return __assign.apply(this, arguments); }; var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { if (k2 === undefined) k2 = k; var desc = Object.getOwnPropertyDescriptor(m, k); if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { desc = { enumerable: true, get: function() { return m[k]; } }; } Object.defineProperty(o, k2, desc); }) : (function(o, m, k, k2) { if (k2 === undefined) k2 = k; o[k2] = m[k]; })); var __exportStar = (this && this.__exportStar) || function(m, exports) { for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p); }; 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 (g && (g = 0, op[0] && (_ = 0)), _) 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 }; } }; var __importDefault = (this && this.__importDefault) || function (mod) { return (mod && mod.__esModule) ? mod : { "default": mod }; }; Object.defineProperty(exports, "__esModule", { value: true }); var axios_1 = __importDefault(require("axios")); var request_1 = __importDefault(require("./interceptors/request")); var response_success_1 = __importDefault(require("./interceptors/response-success")); var response_error_1 = __importDefault(require("./interceptors/response-error")); var logger_1 = __importDefault(require("@vepler/logger")); var http_error_1 = require("./errors/http-error"); var ensureProtocol = function (hostname) { return /^https?:\/\//i.test(hostname) ? hostname : "http://".concat(hostname); }; var configureRequest = function (token, apiKey, headers) { var config = { headers: {} }; // Initialize headers if they are undefined config.headers = config.headers || {}; if (token) { config.headers['Authorization'] = "Bearer ".concat(token); } if (apiKey) { config.headers['x-api-key'] = apiKey; } if (headers) { config.headers = __assign(__assign({}, config.headers), headers); } return config; }; /** * Extract data from API response */ var handleResponse = function (response) { return response.data; }; /** * Standardized error handler that passes through HttpError instances * and wraps other errors in a HttpError */ var handleError = function (error) { // If it's already our custom HttpError, just rethrow it if (error instanceof http_error_1.HttpError || (error && error.isHttpError)) { throw error; } // Otherwise, it's an unexpected error type, so wrap it throw new http_error_1.HttpError("Unexpected API error: ".concat(error.message || 'Unknown error')); }; var createAxiosInstance = function (options) { // Initialize the logger logger_1.default.initialize({ level: options.logLevel || 'info' }); var http = axios_1.default.create({ baseURL: ensureProtocol(options.host), timeout: options.timeout || 3000, headers: options.headers, }); // @ts-expect-error - The interceptors are not defined in the AxiosInstance type http.interceptors.request.use(request_1.default); http.interceptors.response.use(response_success_1.default, response_error_1.default); return http; }; var ApiService = { /** * Create a new Axios instance with the provided options. * @param options - Configuration options for the Axios instance. * @returns An object containing the Axios client and CRUD methods. */ create: function (options) { var http = createAxiosInstance(options); return { client: http, /** * Send a GET request to the specified resource with optional query parameters. * @param resource - The resource endpoint. * @param params - The request parameters. * @param queryParams - Additional query parameters and headers. * @returns The response data. */ query: function (resource, params, queryParams) { if (queryParams === void 0) { queryParams = {}; } return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) { return [2 /*return*/, http.get(resource, __assign(__assign({}, configureRequest(queryParams.token, queryParams.apiKey, queryParams.headers)), { params: params })).then(handleResponse).catch(handleError)]; }); }); }, /** * Send a GET request to the specified resource with an optional slug and query parameters. * @param resource - The resource endpoint. * @param slug - The resource identifier. * @param queryParams - Additional query parameters and headers. * @returns The response data. */ get: function (resource, slug, queryParams) { if (slug === void 0) { slug = ''; } if (queryParams === void 0) { queryParams = {}; } return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) { return [2 /*return*/, http.get("".concat(resource, "/").concat(slug), configureRequest(queryParams.token, queryParams.apiKey, queryParams.headers)) .then(handleResponse).catch(handleError)]; }); }); }, /** * Send a POST request to the specified resource with the provided data. * @param resource - The resource endpoint. * @param data - The request payload. * @param queryParams - Additional query parameters and headers. * @returns The response data. */ post: function (resource, data, queryParams) { if (queryParams === void 0) { queryParams = {}; } return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) { return [2 /*return*/, http.post(resource, data, configureRequest(queryParams.token, queryParams.apiKey, queryParams.headers)) .then(handleResponse).catch(handleError)]; }); }); }, /** * Send a PUT request to the specified resource with the provided data. * @param resource - The resource endpoint. * @param data - The request payload. * @param queryParams - Additional query parameters and headers. * @returns The response data. */ put: function (resource, data, queryParams) { if (queryParams === void 0) { queryParams = {}; } return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) { return [2 /*return*/, http.put(resource, data, configureRequest(queryParams.token, queryParams.apiKey, queryParams.headers)) .then(handleResponse).catch(handleError)]; }); }); }, /** * Send a DELETE request to the specified resource with an optional slug and query parameters. * @param resource - The resource endpoint. * @param slug - The resource identifier. * @param queryParams - Additional query parameters and headers. * @returns The response data. */ delete: function (resource, slug, queryParams) { if (slug === void 0) { slug = ''; } if (queryParams === void 0) { queryParams = {}; } return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) { return [2 /*return*/, http.delete("".concat(resource, "/").concat(slug), configureRequest(queryParams.token, queryParams.apiKey, queryParams.headers)) .then(handleResponse).catch(handleError)]; }); }); }, }; }, }; // Export error classes for consumers __exportStar(require("./errors"), exports); exports.default = ApiService; //# sourceMappingURL=index.js.map