@stackone/transport 1.4.1 → 1.5.0

package/dist/index.es.mjs

@@ -1 +1 @@
-import e from"axios";import t from"qs";import{notMissing as r}from"@stackone/utils";const a=["get","post","put","delete","patch"];function n(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 s,o,i,c,u,h;"function"==typeof SuppressedError&&SuppressedError;const d=()=>e.create({maxBodyLength:1/0});class l{constructor({transportInstance:e=d()}={}){s.add(this),o.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,o,e,"f")}async request({headers:e={},url:t,method:r="get",queryParams:a,maxRedirects:u=0,responseType:d,cacheTTL:l,context:p,payload:m,httpsAgent:y}){try{const l=new URLSearchParams(a).toString(),p=n(this,s,"m",i).call(this,e),f=await n(this,o,"f").request({headers:p,url:l?`${t}?${l}`:t,method:r,maxRedirects:u,responseType:d,data:n(this,s,"m",h).call(this,m,p),httpsAgent:y});return{data:f.data,status:f.status,headers:n(this,s,"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})}}o=new WeakMap,s=new WeakSet,i=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},u=function(e){return"application/x-www-form-urlencoded"===e["content-type"]},h=function(e,r){if(e)return n(this,s,"m",u).call(this,r)?t.stringify(e):e};const p=()=>new l;class m{static async getInstance({getHttpClient:e=p}={}){return this.httpClientInstance??=e(),this.httpClientInstance}static resetInstance(){this.httpClientInstance=null}}m.httpClientInstance=null;const y=e=>{switch(e.type){case"basic":return f(e);case"bearer":return w(e);default:throw new Error("Invalid authentication type")}},f=({username:e="",password:t="",encoding:r="base64"})=>{const a=r;return{authorization:`Basic ${Buffer.from(`${e}:${t}`).toString(a)}`}},w=({token:e,includeBearer:t=!0})=>({authorization:`${t?"Bearer ":""}${e}`}),T=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 b{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 g{static build(e="rest"){if("rest"===e)return new b;throw new Error(`Unknown request client type: ${e}`)}}const x=["query","body","headers"],v=e=>r(e)&&e>=200&&e<=299,q=e=>r(e)&&e>=400&&e<=599,E=e=>r(e)&&e>=100&&e<=199;export{l as HttpClient,m as HttpClientManager,a as HttpMethods,g as RequestClientFactory,x as RequestParameterLocations,y as createAuthorizationHeaders,q as isFailedStatusCode,E as isInfoStatusCode,v as isSuccessStatusCode,T as parseRequestParameters};
+import e from"axios";import t from"qs";import{safeEvaluate as r}from"@stackone/expressions";import{isMissing as a,notMissing as n}from"@stackone/utils";import{z as s}from"zod";const o=["get","post","put","delete","patch"];function i(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 c,u,h,d,l,p;"function"==typeof SuppressedError&&SuppressedError;const m=()=>e.create({maxBodyLength:1/0});class f{constructor({transportInstance:e=m()}={}){c.add(this),u.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,u,e,"f")}async request({headers:e={},url:t,method:r="get",queryParams:a,maxRedirects:n=0,responseType:s,cacheTTL:o,context:l,payload:m,httpsAgent:f}){try{const o=new URLSearchParams(a).toString(),l=i(this,c,"m",h).call(this,e),y=await i(this,u,"f").request({headers:l,url:o?`${t}?${o}`:t,method:r,maxRedirects:n,responseType:s,data:i(this,c,"m",p).call(this,m,l),httpsAgent:f});return{data:y.data,status:y.status,headers:i(this,c,"m",d).call(this,y.headers),requestUrl:t,responseType:y?.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})}}u=new WeakMap,c=new WeakSet,h=function(e){if(!e)return{};const t={};return Object.keys(e).forEach((r=>{t[r.toLowerCase()]=e[r]||""})),t},d=function(e){if(!e)return{};const t={};return Object.keys(e).forEach((r=>{t[r]=e[r]||""})),t},l=function(e){return"application/x-www-form-urlencoded"===e["content-type"]},p=function(e,r){if(e)return i(this,c,"m",l).call(this,r)?t.stringify(e):e};const y=()=>new f;class w{static async getInstance({getHttpClient:e=y}={}){return this.httpClientInstance??=e(),this.httpClientInstance}static resetInstance(){this.httpClientInstance=null}}w.httpClientInstance=null;const g=e=>{switch(e.type){case"basic":return b(e);case"bearer":return T(e);default:throw new Error("Invalid authentication type")}},b=({username:e="",password:t="",encoding:r="base64"})=>{const a=r;return{authorization:`Basic ${Buffer.from(`${e}:${t}`).toString(a)}`}},T=({token:e,includeBearer:t=!0})=>({authorization:`${t?"Bearer ":""}${e}`}),v=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 x{async performRequest({httpClient:e,url:t,method:n,headers:s,body:o,customErrorConfigs:i}){return((e,t)=>{if(a(t)||0===t.length||a(e))return e;const n=t?.filter((t=>t.receivedStatus===e.status));if(n?.length)for(const t of n){const n=t.condition,s=r(n,e);if(a(n)||s)return{...e,status:t.targetStatus,message:t?.message}}return e})(await(e?.request({method:n,url:t,headers:s,maxRedirects:0,payload:o})),i)}}class q{static build(e="rest"){if("rest"===e)return new x;throw new Error(`Unknown request client type: ${e}`)}}const E=["query","body","headers"],S=e=>n(e)&&e>=200&&e<=299,C=e=>n(e)&&e>=400&&e<=599,R=e=>n(e)&&e>=100&&e<=199,k=s.object({receivedStatus:s.number(),targetStatus:s.number(),message:s.string().optional(),condition:s.string().optional()});export{k as CUSTOM_ERROR_CONFIG_SCHEMA,f as HttpClient,w as HttpClientManager,o as HttpMethods,q as RequestClientFactory,E as RequestParameterLocations,g as createAuthorizationHeaders,C as isFailedStatusCode,R as isInfoStatusCode,S as isSuccessStatusCode,v as parseRequestParameters};

package/dist/index.js

@@ -1 +1 @@
-"use strict";var e=require("axios"),t=require("qs"),r=require("@stackone/utils");function s(e,t,r,s){if("a"===r&&!s)throw new TypeError("Private accessor was defined without a getter");if("function"==typeof t?e!==t||!s:!t.has(e))throw new TypeError("Cannot read private member from an object whose class did not declare it");return"m"===r?s:"a"===r?s.call(e):s?s.value:t.get(e)}var a,n,o,i,c,u;"function"==typeof SuppressedError&&SuppressedError;const h=()=>e.create({maxBodyLength:1/0});class d{constructor({transportInstance:e=h()}={}){a.add(this),n.set(this,void 0),function(e,t,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 t?e!==t||!a:!t.has(e))throw new TypeError("Cannot write private member to an object whose class did not declare it");"a"===s?a.call(e,r):a?a.value=r:t.set(e,r)}(this,n,e,"f")}async request({headers:e={},url:t,method:r="get",queryParams:c,maxRedirects:h=0,responseType:d,cacheTTL:p,context:l,payload:m,httpsAgent:y}){try{const p=new URLSearchParams(c).toString(),l=s(this,a,"m",o).call(this,e),f=await s(this,n,"f").request({headers:l,url:p?`${t}?${p}`:t,method:r,maxRedirects:h,responseType:d,data:s(this,a,"m",u).call(this,m,l),httpsAgent:y});return{data:f.data,status:f.status,headers:s(this,a,"m",i).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:s,cacheTTL:a,context:n}){return this.request({url:t,method:"get",queryParams:r,headers:e,maxRedirects:s,cacheTTL:a,context:n})}async post({headers:e,url:t,maxRedirects:r,cacheTTL:s,context:a,payload:n}){return this.request({url:t,method:"post",headers:e,maxRedirects:r,cacheTTL:s,context:a,payload:n})}}n=new WeakMap,a=new WeakSet,o=function(e){if(!e)return{};const t={};return Object.keys(e).forEach((r=>{t[r.toLowerCase()]=e[r]||""})),t},i=function(e){if(!e)return{};const t={};return Object.keys(e).forEach((r=>{t[r]=e[r]||""})),t},c=function(e){return"application/x-www-form-urlencoded"===e["content-type"]},u=function(e,r){if(e)return s(this,a,"m",c).call(this,r)?t.stringify(e):e};const p=()=>new d;class l{static async getInstance({getHttpClient:e=p}={}){return this.httpClientInstance??=e(),this.httpClientInstance}static resetInstance(){this.httpClientInstance=null}}l.httpClientInstance=null;const m=({username:e="",password:t="",encoding:r="base64"})=>{const s=r;return{authorization:`Basic ${Buffer.from(`${e}:${t}`).toString(s)}`}},y=({token:e,includeBearer:t=!0})=>({authorization:`${t?"Bearer ":""}${e}`});class f{async performRequest({httpClient:e,url:t,method:r,headers:s,body:a}){return e?.request({method:r,url:t,headers:s,maxRedirects:0,payload:a})}}exports.HttpClient=d,exports.HttpClientManager=l,exports.HttpMethods=["get","post","put","delete","patch"],exports.RequestClientFactory=class{static build(e="rest"){if("rest"===e)return new f;throw new Error(`Unknown request client type: ${e}`)}},exports.RequestParameterLocations=["query","body","headers"],exports.createAuthorizationHeaders=e=>{switch(e.type){case"basic":return m(e);case"bearer":return y(e);default:throw new Error("Invalid authentication type")}},exports.isFailedStatusCode=e=>r.notMissing(e)&&e>=400&&e<=599,exports.isInfoStatusCode=e=>r.notMissing(e)&&e>=100&&e<=199,exports.isSuccessStatusCode=e=>r.notMissing(e)&&e>=200&&e<=299,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:{}});
+"use strict";var e=require("axios"),t=require("qs"),r=require("@stackone/expressions"),s=require("@stackone/utils"),a=require("zod");function n(e,t,r,s){if("a"===r&&!s)throw new TypeError("Private accessor was defined without a getter");if("function"==typeof t?e!==t||!s:!t.has(e))throw new TypeError("Cannot read private member from an object whose class did not declare it");return"m"===r?s:"a"===r?s.call(e):s?s.value:t.get(e)}var o,i,c,u,h,d;"function"==typeof SuppressedError&&SuppressedError;const l=()=>e.create({maxBodyLength:1/0});class p{constructor({transportInstance:e=l()}={}){o.add(this),i.set(this,void 0),function(e,t,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 t?e!==t||!a:!t.has(e))throw new TypeError("Cannot write private member to an object whose class did not declare it");"a"===s?a.call(e,r):a?a.value=r:t.set(e,r)}(this,i,e,"f")}async request({headers:e={},url:t,method:r="get",queryParams:s,maxRedirects:a=0,responseType:h,cacheTTL:l,context:p,payload:m,httpsAgent:f}){try{const l=new URLSearchParams(s).toString(),p=n(this,o,"m",c).call(this,e),y=await n(this,i,"f").request({headers:p,url:l?`${t}?${l}`:t,method:r,maxRedirects:a,responseType:h,data:n(this,o,"m",d).call(this,m,p),httpsAgent:f});return{data:y.data,status:y.status,headers:n(this,o,"m",u).call(this,y.headers),requestUrl:t,responseType:y?.config?.responseType,responseTime:new Date}}catch(e){throw e}}async get({headers:e,url:t,queryParams:r,maxRedirects:s,cacheTTL:a,context:n}){return this.request({url:t,method:"get",queryParams:r,headers:e,maxRedirects:s,cacheTTL:a,context:n})}async post({headers:e,url:t,maxRedirects:r,cacheTTL:s,context:a,payload:n}){return this.request({url:t,method:"post",headers:e,maxRedirects:r,cacheTTL:s,context:a,payload:n})}}i=new WeakMap,o=new WeakSet,c=function(e){if(!e)return{};const t={};return Object.keys(e).forEach((r=>{t[r.toLowerCase()]=e[r]||""})),t},u=function(e){if(!e)return{};const t={};return Object.keys(e).forEach((r=>{t[r]=e[r]||""})),t},h=function(e){return"application/x-www-form-urlencoded"===e["content-type"]},d=function(e,r){if(e)return n(this,o,"m",h).call(this,r)?t.stringify(e):e};const m=()=>new p;class f{static async getInstance({getHttpClient:e=m}={}){return this.httpClientInstance??=e(),this.httpClientInstance}static resetInstance(){this.httpClientInstance=null}}f.httpClientInstance=null;const y=({username:e="",password:t="",encoding:r="base64"})=>{const s=r;return{authorization:`Basic ${Buffer.from(`${e}:${t}`).toString(s)}`}},w=({token:e,includeBearer:t=!0})=>({authorization:`${t?"Bearer ":""}${e}`});class g{async performRequest({httpClient:e,url:t,method:a,headers:n,body:o,customErrorConfigs:i}){return((e,t)=>{if(s.isMissing(t)||0===t.length||s.isMissing(e))return e;const a=t?.filter((t=>t.receivedStatus===e.status));if(a?.length)for(const t of a){const a=t.condition,n=r.safeEvaluate(a,e);if(s.isMissing(a)||n)return{...e,status:t.targetStatus,message:t?.message}}return e})(await(e?.request({method:a,url:t,headers:n,maxRedirects:0,payload:o})),i)}}const x=a.z.object({receivedStatus:a.z.number(),targetStatus:a.z.number(),message:a.z.string().optional(),condition:a.z.string().optional()});exports.CUSTOM_ERROR_CONFIG_SCHEMA=x,exports.HttpClient=p,exports.HttpClientManager=f,exports.HttpMethods=["get","post","put","delete","patch"],exports.RequestClientFactory=class{static build(e="rest"){if("rest"===e)return new g;throw new Error(`Unknown request client type: ${e}`)}},exports.RequestParameterLocations=["query","body","headers"],exports.createAuthorizationHeaders=e=>{switch(e.type){case"basic":return y(e);case"bearer":return w(e);default:throw new Error("Invalid authentication type")}},exports.isFailedStatusCode=e=>s.notMissing(e)&&e>=400&&e<=599,exports.isInfoStatusCode=e=>s.notMissing(e)&&e>=100&&e<=199,exports.isSuccessStatusCode=e=>s.notMissing(e)&&e>=200&&e<=299,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/customErrors/index.d.ts

@@ -0,0 +1,3 @@
+import { HttpResponse } from '../httpClient/types';
+import { CustomErrorConfig } from './types';
+export declare const translateCustomError: (response: HttpResponse, configs?: CustomErrorConfig[]) => HttpResponse;

package/dist/types/customErrors/schemas.d.ts

@@ -0,0 +1,17 @@
+import { z } from 'zod';
+export declare const CUSTOM_ERROR_CONFIG_SCHEMA: z.ZodObject<{
+    receivedStatus: z.ZodNumber;
+    targetStatus: z.ZodNumber;
+    message: z.ZodOptional<z.ZodString>;
+    condition: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    receivedStatus: number;
+    targetStatus: number;
+    message?: string | undefined;
+    condition?: string | undefined;
+}, {
+    receivedStatus: number;
+    targetStatus: number;
+    message?: string | undefined;
+    condition?: string | undefined;
+}>;

package/dist/types/customErrors/types.d.ts

@@ -0,0 +1,3 @@
+import { z } from 'zod';
+import { CUSTOM_ERROR_CONFIG_SCHEMA } from './schemas';
+export type CustomErrorConfig = z.infer<typeof CUSTOM_ERROR_CONFIG_SCHEMA>;

package/dist/types/httpClient/types.d.ts

@@ -18,6 +18,7 @@ export type HttpResponse<T = any> = {
     requestUrl: string;
     responseType?: string;
     responseTime?: Date;
+    message?: string;
 };
 export type HttpParameters = {
     query: HttpQueryParams;

package/dist/types/index.d.ts

@@ -7,3 +7,5 @@ export { RequestParameter } from './parsers/types';
 export { RequestClientFactory } from './requestClient/requestClientFactory';
 export { RequestParameterLocations } from './parsers/types';
 export { isSuccessStatusCode, isFailedStatusCode, isInfoStatusCode, } from './validators/statusCodes';
+export { CustomErrorConfig } from './customErrors/types';
+export { CUSTOM_ERROR_CONFIG_SCHEMA } from './customErrors/schemas';

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

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

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@stackone/transport",
-    "version": "1.4.1",
+    "version": "1.5.0",
     "description": "",
     "main": "dist/index.js",
     "module": "dist/index.es.mjs",
@@ -34,7 +34,8 @@
     "dependencies": {
         "axios": "1.8.4",
         "qs": "6.14.0",
-        "@stackone/utils": "*"
+        "@stackone/utils": "*",
+        "@stackone/expressions": "*"
     },
     "devDependencies": {
         "@types/qs": "6.9.18"