@stackone/transport 1.1.3 → 1.3.0

package/dist/index.es.mjs

@@ -1 +1 @@
-import t from"axios";import e from"qs";const r=["get","post","put","delete","patch"];function s(t,e,r,s){if("a"===r&&!s)throw new TypeError("Private accessor was defined without a getter");if("function"==typeof e?t!==e||!s:!e.has(t))throw new TypeError("Cannot read private member from an object whose class did not declare it");return"m"===r?s:"a"===r?s.call(t):s?s.value:e.get(t)}var n,a,o,c,i,h;"function"==typeof SuppressedError&&SuppressedError;const p=()=>t.create({maxBodyLength:1/0});class d{constructor({transportInstance:t=p()}={}){n.add(this),a.set(this,void 0),function(t,e,r,s,n){if("m"===s)throw new TypeError("Private method is not writable");if("a"===s&&!n)throw new TypeError("Private accessor was defined without a setter");if("function"==typeof e?t!==e||!n:!e.has(t))throw new TypeError("Cannot write private member to an object whose class did not declare it");"a"===s?n.call(t,r):n?n.value=r:e.set(t,r)}(this,a,t,"f")}async request({headers:t={},url:e,method:r="get",maxRedirects:i=0,responseType:p,cacheTTL:d,context:l,payload:u,httpsAgent:f}){try{const d=s(this,n,"m",o).call(this,t),l=await s(this,a,"f").request({headers:d,url:e,method:r,maxRedirects:i,responseType:p,data:s(this,n,"m",h).call(this,u,d),httpsAgent:f});return{data:l.data,status:l.status,headers:s(this,n,"m",c).call(this,l.headers),requestUrl:e,responseType:l?.config?.responseType,responseTime:new Date}}catch(t){throw t}}async get({headers:t,url:e,maxRedirects:r,cacheTTL:s,context:n}){return this.request({url:e,method:"get",headers:t,maxRedirects:r,cacheTTL:s,context:n})}async post({headers:t,url:e,maxRedirects:r,cacheTTL:s,context:n,payload:a}){return this.request({url:e,method:"post",headers:t,maxRedirects:r,cacheTTL:s,context:n,payload:a})}}a=new WeakMap,n=new WeakSet,o=function(t){if(!t)return{};const e={};return Object.keys(t).forEach((r=>{e[r.toLowerCase()]=t[r]||""})),e},c=function(t){if(!t)return{};const e={};return Object.keys(t).forEach((r=>{e[r]=t[r]||""})),e},i=function(t){return"application/x-www-form-urlencoded"===t["content-type"]},h=function(t,r){if(t)return s(this,n,"m",i).call(this,r)?e.stringify(t):t};const l=()=>new d;class u{static async getInstance({getHttpClient:t=l}={}){return this.httpClientInstance||(this.httpClientInstance=t()),this.httpClientInstance}static resetInstance(){this.httpClientInstance=null}}u.httpClientInstance=null;export{d as HttpClient,u as HttpClientManager,r as HttpMethods};
+import e from"axios";import t from"qs";const r=["get","post","put","delete","patch"];function a(e,t,r,a){if("a"===r&&!a)throw new TypeError("Private accessor was defined without a getter");if("function"==typeof t?e!==t||!a:!t.has(e))throw new TypeError("Cannot read private member from an object whose class did not declare it");return"m"===r?a:"a"===r?a.call(e):a?a.value:t.get(e)}var n,s,o,c,i,u;"function"==typeof SuppressedError&&SuppressedError;const h=()=>e.create({maxBodyLength:1/0});class d{constructor({transportInstance:e=h()}={}){n.add(this),s.set(this,void 0),function(e,t,r,a,n){if("m"===a)throw new TypeError("Private method is not writable");if("a"===a&&!n)throw new TypeError("Private accessor was defined without a setter");if("function"==typeof t?e!==t||!n:!t.has(e))throw new TypeError("Cannot write private member to an object whose class did not declare it");"a"===a?n.call(e,r):n?n.value=r:t.set(e,r)}(this,s,e,"f")}async request({headers:e={},url:t,method:r="get",queryParams:i,maxRedirects:h=0,responseType:d,cacheTTL:l,context:p,payload:m,httpsAgent:y}){try{const l=new URLSearchParams(i).toString(),p=a(this,n,"m",o).call(this,e),f=await a(this,s,"f").request({headers:p,url:l?`${t}?${l}`:t,method:r,maxRedirects:h,responseType:d,data:a(this,n,"m",u).call(this,m,p),httpsAgent:y});return{data:f.data,status:f.status,headers:a(this,n,"m",c).call(this,f.headers),requestUrl:t,responseType:f?.config?.responseType,responseTime:new Date}}catch(e){throw e}}async get({headers:e,url:t,queryParams:r,maxRedirects:a,cacheTTL:n,context:s}){return this.request({url:t,method:"get",queryParams:r,headers:e,maxRedirects:a,cacheTTL:n,context:s})}async post({headers:e,url:t,maxRedirects:r,cacheTTL:a,context:n,payload:s}){return this.request({url:t,method:"post",headers:e,maxRedirects:r,cacheTTL:a,context:n,payload:s})}}s=new WeakMap,n=new WeakSet,o=function(e){if(!e)return{};const t={};return Object.keys(e).forEach((r=>{t[r.toLowerCase()]=e[r]||""})),t},c=function(e){if(!e)return{};const t={};return Object.keys(e).forEach((r=>{t[r]=e[r]||""})),t},i=function(e){return"application/x-www-form-urlencoded"===e["content-type"]},u=function(e,r){if(e)return a(this,n,"m",i).call(this,r)?t.stringify(e):e};const l=()=>new d;class p{static async getInstance({getHttpClient:e=l}={}){return this.httpClientInstance??=e(),this.httpClientInstance}static resetInstance(){this.httpClientInstance=null}}p.httpClientInstance=null;const m=e=>{switch(e.type){case"basic":return y(e);case"bearer":return f(e);default:throw new Error("Invalid authentication type")}},y=({username:e,password:t,encoding:r="base64"})=>{const a=r;return{authorization:`Basic ${Buffer.from(`${e}:${t}`).toString(a)}`}},f=({token:e,includeBearer:t=!0})=>({authorization:`${t?"Bearer ":""}${e}`}),w=e=>e.reduce(((e,t)=>(Array.isArray(e[t.in][t.name])?e[t.in][t.name]=e[t.in][t.name].concat(t.value):"object"==typeof e[t.in][t.name]&&"object"==typeof t.value?e[t.in][t.name]={...e[t.in][t.name],...t.value}:e[t.in][t.name]="body"===t.in?t.value:String(t.value),e)),{query:{},body:{},headers:{}});class T{async performRequest({httpClient:e,url:t,method:r,headers:a,body:n}){return e?.request({method:r,url:t,headers:a,maxRedirects:0,payload:n})}}class b{static build(e="rest"){if("rest"===e)return new T;throw new Error(`Unknown request client type: ${e}`)}}const g=["query","body","headers"];export{d as HttpClient,p as HttpClientManager,r as HttpMethods,b as RequestClientFactory,g as RequestParameterLocations,m as createAuthorizationHeaders,w as parseRequestParameters};

package/dist/index.js

@@ -1 +1 @@
-"use strict";var t=require("axios"),e=require("qs");function r(t,e,r,s){if("a"===r&&!s)throw new TypeError("Private accessor was defined without a getter");if("function"==typeof e?t!==e||!s:!e.has(t))throw new TypeError("Cannot read private member from an object whose class did not declare it");return"m"===r?s:"a"===r?s.call(t):s?s.value:e.get(t)}var s,a,n,o,c,i;"function"==typeof SuppressedError&&SuppressedError;const h=()=>t.create({maxBodyLength:1/0});class p{constructor({transportInstance:t=h()}={}){s.add(this),a.set(this,void 0),function(t,e,r,s,a){if("m"===s)throw new TypeError("Private method is not writable");if("a"===s&&!a)throw new TypeError("Private accessor was defined without a setter");if("function"==typeof e?t!==e||!a:!e.has(t))throw new TypeError("Cannot write private member to an object whose class did not declare it");"a"===s?a.call(t,r):a?a.value=r:e.set(t,r)}(this,a,t,"f")}async request({headers:t={},url:e,method:c="get",maxRedirects:h=0,responseType:p,cacheTTL:u,context:d,payload:l,httpsAgent:f}){try{const u=r(this,s,"m",n).call(this,t),d=await r(this,a,"f").request({headers:u,url:e,method:c,maxRedirects:h,responseType:p,data:r(this,s,"m",i).call(this,l,u),httpsAgent:f});return{data:d.data,status:d.status,headers:r(this,s,"m",o).call(this,d.headers),requestUrl:e,responseType:d?.config?.responseType,responseTime:new Date}}catch(t){throw t}}async get({headers:t,url:e,maxRedirects:r,cacheTTL:s,context:a}){return this.request({url:e,method:"get",headers:t,maxRedirects:r,cacheTTL:s,context:a})}async post({headers:t,url:e,maxRedirects:r,cacheTTL:s,context:a,payload:n}){return this.request({url:e,method:"post",headers:t,maxRedirects:r,cacheTTL:s,context:a,payload:n})}}a=new WeakMap,s=new WeakSet,n=function(t){if(!t)return{};const e={};return Object.keys(t).forEach((r=>{e[r.toLowerCase()]=t[r]||""})),e},o=function(t){if(!t)return{};const e={};return Object.keys(t).forEach((r=>{e[r]=t[r]||""})),e},c=function(t){return"application/x-www-form-urlencoded"===t["content-type"]},i=function(t,a){if(t)return r(this,s,"m",c).call(this,a)?e.stringify(t):t};const u=()=>new p;class d{static async getInstance({getHttpClient:t=u}={}){return this.httpClientInstance||(this.httpClientInstance=t()),this.httpClientInstance}static resetInstance(){this.httpClientInstance=null}}d.httpClientInstance=null,exports.HttpClient=p,exports.HttpClientManager=d,exports.HttpMethods=["get","post","put","delete","patch"];
+"use strict";var e=require("axios"),t=require("qs");function r(e,t,r,a){if("a"===r&&!a)throw new TypeError("Private accessor was defined without a getter");if("function"==typeof t?e!==t||!a:!t.has(e))throw new TypeError("Cannot read private member from an object whose class did not declare it");return"m"===r?a:"a"===r?a.call(e):a?a.value:t.get(e)}var a,s,n,o,i,c;"function"==typeof SuppressedError&&SuppressedError;const u=()=>e.create({maxBodyLength:1/0});class h{constructor({transportInstance:e=u()}={}){a.add(this),s.set(this,void 0),function(e,t,r,a,s){if("m"===a)throw new TypeError("Private method is not writable");if("a"===a&&!s)throw new TypeError("Private accessor was defined without a setter");if("function"==typeof t?e!==t||!s:!t.has(e))throw new TypeError("Cannot write private member to an object whose class did not declare it");"a"===a?s.call(e,r):s?s.value=r:t.set(e,r)}(this,s,e,"f")}async request({headers:e={},url:t,method:i="get",queryParams:u,maxRedirects:h=0,responseType:d,cacheTTL:p,context:l,payload:m,httpsAgent:y}){try{const p=new URLSearchParams(u).toString(),l=r(this,a,"m",n).call(this,e),f=await r(this,s,"f").request({headers:l,url:p?`${t}?${p}`:t,method:i,maxRedirects:h,responseType:d,data:r(this,a,"m",c).call(this,m,l),httpsAgent:y});return{data:f.data,status:f.status,headers:r(this,a,"m",o).call(this,f.headers),requestUrl:t,responseType:f?.config?.responseType,responseTime:new Date}}catch(e){throw e}}async get({headers:e,url:t,queryParams:r,maxRedirects:a,cacheTTL:s,context:n}){return this.request({url:t,method:"get",queryParams:r,headers:e,maxRedirects:a,cacheTTL:s,context:n})}async post({headers:e,url:t,maxRedirects:r,cacheTTL:a,context:s,payload:n}){return this.request({url:t,method:"post",headers:e,maxRedirects:r,cacheTTL:a,context:s,payload:n})}}s=new WeakMap,a=new WeakSet,n=function(e){if(!e)return{};const t={};return Object.keys(e).forEach((r=>{t[r.toLowerCase()]=e[r]||""})),t},o=function(e){if(!e)return{};const t={};return Object.keys(e).forEach((r=>{t[r]=e[r]||""})),t},i=function(e){return"application/x-www-form-urlencoded"===e["content-type"]},c=function(e,s){if(e)return r(this,a,"m",i).call(this,s)?t.stringify(e):e};const d=()=>new h;class p{static async getInstance({getHttpClient:e=d}={}){return this.httpClientInstance??=e(),this.httpClientInstance}static resetInstance(){this.httpClientInstance=null}}p.httpClientInstance=null;const l=({username:e,password:t,encoding:r="base64"})=>{const a=r;return{authorization:`Basic ${Buffer.from(`${e}:${t}`).toString(a)}`}},m=({token:e,includeBearer:t=!0})=>({authorization:`${t?"Bearer ":""}${e}`});class y{async performRequest({httpClient:e,url:t,method:r,headers:a,body:s}){return e?.request({method:r,url:t,headers:a,maxRedirects:0,payload:s})}}exports.HttpClient=h,exports.HttpClientManager=p,exports.HttpMethods=["get","post","put","delete","patch"],exports.RequestClientFactory=class{static build(e="rest"){if("rest"===e)return new y;throw new Error(`Unknown request client type: ${e}`)}},exports.RequestParameterLocations=["query","body","headers"],exports.createAuthorizationHeaders=e=>{switch(e.type){case"basic":return l(e);case"bearer":return m(e);default:throw new Error("Invalid authentication type")}},exports.parseRequestParameters=e=>e.reduce(((e,t)=>(Array.isArray(e[t.in][t.name])?e[t.in][t.name]=e[t.in][t.name].concat(t.value):"object"==typeof e[t.in][t.name]&&"object"==typeof t.value?e[t.in][t.name]={...e[t.in][t.name],...t.value}:e[t.in][t.name]="body"===t.in?t.value:String(t.value),e)),{query:{},body:{},headers:{}});

package/dist/types/authorization/authorizationHeaders.d.ts

@@ -0,0 +1,4 @@
+import { BasicAuthorizationParams, BearerAuthorizationParams } from './types';
+export declare const createAuthorizationHeaders: (authenticationParams: BasicAuthorizationParams | BearerAuthorizationParams) => {
+    authorization: string;
+};

package/dist/types/authorization/types.d.ts

@@ -0,0 +1,12 @@
+export type AuthenticationType = 'basic' | 'bearer';
+export type BasicAuthorizationParams = {
+    type: 'basic';
+    username: string;
+    password: string;
+    encoding?: string;
+};
+export type BearerAuthorizationParams = {
+    type: 'bearer';
+    token: string;
+    includeBearer?: boolean;
+};

package/dist/types/{httpClient.d.ts → httpClient/httpClient.d.ts}

@@ -1,15 +1,16 @@
 import https from 'https';
 import { AxiosInstance } from 'axios';
-import { HttpHeaders, HttpMethod, HttpResponse, IHttpClient } from './types';
+import { HttpHeaders, HttpMethod, HttpQueryParams, HttpResponse, IHttpClient } from './types';
 export declare class HttpClient implements IHttpClient {
     #private;
     constructor({ transportInstance, }?: {
         transportInstance?: AxiosInstance;
     });
-    request<P, T>({ headers, url, method, maxRedirects, responseType, cacheTTL, context, payload, httpsAgent, }: {
+    request<P, T>({ headers, url, method, queryParams, maxRedirects, responseType, cacheTTL, context, payload, httpsAgent, }: {
         headers?: HttpHeaders;
         url: string;
         method?: HttpMethod;
+        queryParams?: HttpQueryParams;
         maxRedirects?: number;
         responseType?: 'arraybuffer' | 'blob' | 'document' | 'json' | 'text';
         cacheTTL?: number;
@@ -17,9 +18,10 @@ export declare class HttpClient implements IHttpClient {
         payload?: P;
         httpsAgent?: https.Agent;
     }): Promise<HttpResponse<T>>;
-    get<T>({ headers, url, maxRedirects, cacheTTL, context, }: {
+    get<T>({ headers, url, queryParams, maxRedirects, cacheTTL, context, }: {
         headers?: HttpHeaders;
         url: string;
+        queryParams?: HttpQueryParams;
         maxRedirects?: number;
         cacheTTL?: number;
         context?: unknown;

package/dist/types/{types.d.ts → httpClient/types.d.ts}

@@ -1,7 +1,10 @@
 import https from 'https';
-export interface HttpHeaders {
+export type HttpHeaders = {
     [key: string]: string;
-}
+};
+export type HttpQueryParams = {
+    [key: string]: string;
+};
 export interface CertOptions {
     certs?: string[];
     keys?: string[];
@@ -16,11 +19,17 @@ export type HttpResponse<T = any> = {
     responseType?: string;
     responseTime?: Date;
 };
+export type HttpParameters = {
+    query: HttpQueryParams;
+    body: Record<string, unknown>;
+    headers: HttpHeaders;
+};
 export interface IHttpClient {
-    request<P, T>({ headers, url, method, maxRedirects, responseType, cacheTTL, context, payload, httpsAgent, }: {
+    request<P, T>({ headers, url, method, queryParams, maxRedirects, responseType, cacheTTL, context, payload, httpsAgent, }: {
         headers?: HttpHeaders;
         url: string;
         method?: HttpMethod;
+        queryParams?: HttpQueryParams;
         maxRedirects?: number;
         responseType?: 'arraybuffer' | 'blob' | 'document' | 'json' | 'text';
         cacheTTL?: number;
@@ -28,9 +37,10 @@ export interface IHttpClient {
         payload?: P;
         httpsAgent?: https.Agent;
     }): Promise<HttpResponse<T>>;
-    get<T>({ headers, url, maxRedirects, cacheTTL, context, }: {
+    get<T>({ headers, url, queryParams, maxRedirects, cacheTTL, context, }: {
         headers?: HttpHeaders;
         url: string;
+        queryParams?: HttpQueryParams;
         maxRedirects?: number;
         cacheTTL?: number;
         context?: unknown;

package/dist/types/index.d.ts

@@ -1,3 +1,8 @@
-export { IHttpClient, HttpResponse, HttpMethods, HttpMethod } from './types';
-export { HttpClient } from './httpClient';
-export { HttpClientManager } from './httpClientManager';
+export { IHttpClient, HttpResponse, HttpMethods, HttpParameters, HttpMethod, HttpHeaders, HttpQueryParams, } from './httpClient/types';
+export { HttpClient } from './httpClient/httpClient';
+export { HttpClientManager } from './httpClient/httpClientManager';
+export { createAuthorizationHeaders } from './authorization/authorizationHeaders';
+export { parseRequestParameters } from './parsers/requestParameters';
+export { RequestParameter } from './parsers/types';
+export { RequestClientFactory } from './requestClient/requestClientFactory';
+export { RequestParameterLocations } from './parsers/types';

package/dist/types/parsers/requestParameters.d.ts

@@ -0,0 +1,3 @@
+import { HttpParameters } from '../httpClient/types';
+import { RequestParameter } from './types';
+export declare const parseRequestParameters: (parameters: RequestParameter[]) => HttpParameters;

package/dist/types/parsers/types.d.ts

@@ -0,0 +1,7 @@
+export declare const RequestParameterLocations: readonly ["query", "body", "headers"];
+export type RequestParameterLocation = (typeof RequestParameterLocations)[number];
+export type RequestParameter = {
+    name: string;
+    in: RequestParameterLocation;
+    value?: unknown;
+};

package/dist/types/requestClient/requestClientFactory.d.ts

@@ -0,0 +1,4 @@
+import { IRequestClient, RequestClientType } from './types';
+export declare class RequestClientFactory {
+    static build(type?: RequestClientType): IRequestClient;
+}

package/dist/types/requestClient/restClient.d.ts

@@ -0,0 +1,11 @@
+import { HttpMethod, HttpResponse, IHttpClient } from '../httpClient/types';
+import { IRequestClient } from './types';
+export declare class RestClient implements IRequestClient {
+    performRequest({ httpClient, url, method, headers, body, }: {
+        httpClient: IHttpClient;
+        url: string;
+        method: HttpMethod;
+        headers: Record<string, string>;
+        body: unknown;
+    }): Promise<HttpResponse>;
+}

package/dist/types/requestClient/types.d.ts

@@ -0,0 +1,12 @@
+import { HttpHeaders, HttpMethod, HttpQueryParams, HttpResponse, IHttpClient } from '../httpClient/types';
+export interface IRequestClient {
+    performRequest: ({ httpClient, url, method, headers, body, }: {
+        httpClient: IHttpClient;
+        url: string;
+        method: HttpMethod;
+        headers: HttpHeaders;
+        queryParams?: HttpQueryParams;
+        body: unknown;
+    }) => Promise<HttpResponse>;
+}
+export type RequestClientType = 'rest' | 'soap';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@stackone/transport",
-    "version": "1.1.3",
+    "version": "1.3.0",
     "description": "",
     "main": "dist/index.js",
     "module": "dist/index.es.mjs",
@@ -24,18 +24,18 @@
         "code:check:fix": "biome check --write ./src ./*.mjs",
         "lint": "npm run code:check",
         "lint:fix": "npm run code:check:fix",
-        "test": "vitest run",
-        "test:watch": "vitest watch",
+        "test": "FORCE_COLOR=1 vitest run",
+        "test:watch": "FORCE_COLOR=1 vitest watch --silent",
         "publish-release": "npm publish --access=public"
     },
     "keywords": [],
     "author": "StackOne",
     "license": "ISC",
     "dependencies": {
-        "axios": "^1.7.7",
-        "qs": "^6.11.2"
+        "axios": "1.8.4",
+        "qs": "6.14.0"
     },
     "devDependencies": {
-        "@types/qs": "^6.9.10"
+        "@types/qs": "6.9.18"
     }
 }