@stackone/transport 1.0.0

package/README.md

@@ -0,0 +1,50 @@
+# @stackone/transport
+
+## Description
+
+This package contains the transport layer and communication utils used by the **StackOne** packages.
+
+This package uses the tech stack provided by the **Connect Monorepo** global setup. Please check the [root README](../../README.md) for more information.
+
+## Requirements
+
+Please check the [root README](../../README.md) for requirements.
+
+## Installation
+
+```bash
+# install dependencies
+$ npm run install
+```
+
+## Available commands
+
+```bash
+# clean build output
+$ npm run clean
+```
+
+```bash
+# build package
+$ npm run build
+```
+
+```bash
+# run tests
+$ npm run test
+```
+
+```bash
+# run tests on watch mode
+$ npm run test:watch
+```
+
+```bash
+# run linter
+$ npm run lint
+```
+
+```bash
+# run linter and try to fix any error
+$ npm run lint:fix
+```

package/dist/httpClient.d.ts

@@ -0,0 +1,36 @@
+/// <reference types="node" />
+import { AxiosInstance } from 'axios';
+import { HttpHeaders, HttpResponse, IHttpClient, RequestContext, HttpMethod } from './types';
+import https from 'https';
+export declare class HttpClient implements IHttpClient {
+    #private;
+    constructor({ transportInstance, }?: {
+        transportInstance?: AxiosInstance;
+    });
+    request<P, T>({ headers, url, method, maxRedirects, responseType, cacheTTL, context, payload, httpsAgent, }: {
+        headers?: HttpHeaders;
+        url: string;
+        method?: HttpMethod;
+        maxRedirects?: number;
+        responseType?: 'arraybuffer' | 'blob' | 'document' | 'json' | 'text';
+        cacheTTL?: number;
+        context?: RequestContext;
+        payload?: P;
+        httpsAgent?: https.Agent;
+    }): Promise<HttpResponse<T>>;
+    get<T>({ headers, url, maxRedirects, cacheTTL, context, }: {
+        headers?: HttpHeaders;
+        url: string;
+        maxRedirects?: number;
+        cacheTTL?: number;
+        context?: RequestContext;
+    }): Promise<HttpResponse<T>>;
+    post<P, T>({ headers, url, maxRedirects, cacheTTL, context, payload, }: {
+        headers?: HttpHeaders;
+        url: string;
+        maxRedirects?: number;
+        cacheTTL?: number;
+        context?: RequestContext;
+        payload?: P;
+    }): Promise<HttpResponse<T>>;
+}

package/dist/httpClientManager.d.ts

@@ -0,0 +1,10 @@
+import { IHttpClient } from './types';
+declare const buildHttpClientInstance: () => IHttpClient;
+export declare class HttpClientManager {
+    private static httpClientInstance;
+    static getInstance({ getHttpClient, }?: {
+        getHttpClient?: typeof buildHttpClientInstance;
+    }): Promise<IHttpClient>;
+    static resetInstance(): void;
+}
+export {};

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { IHttpClient, HttpResponse, HttpMethods, HttpMethod } from './types';
+export { HttpClient } from './httpClient';
+export { HttpClientManager } from './httpClientManager';

package/dist/index.es.mjs

@@ -0,0 +1 @@
+import t from"axios";import e from"qs";const r=["get","post","put","delete","patch","job"];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};

package/dist/index.js

@@ -0,0 +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","job"];

package/dist/types.d.ts

@@ -0,0 +1,50 @@
+/// <reference types="node" />
+import https from 'https';
+export interface HttpHeaders {
+    [key: string]: string;
+}
+export interface CertOptions {
+    certs?: string[];
+    keys?: string[];
+}
+export declare const HttpMethods: readonly ["get", "post", "put", "delete", "patch", "job"];
+export type HttpMethod = (typeof HttpMethods)[number];
+export type RequestContext = {
+    accountId: string;
+};
+export type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    headers: HttpHeaders;
+    requestUrl: string;
+    responseType?: string;
+    responseTime?: Date;
+};
+export interface IHttpClient {
+    request<P, T>({ headers, url, method, maxRedirects, responseType, cacheTTL, context, payload, httpsAgent, }: {
+        headers?: HttpHeaders;
+        url: string;
+        method?: HttpMethod;
+        maxRedirects?: number;
+        responseType?: 'arraybuffer' | 'blob' | 'document' | 'json' | 'text';
+        cacheTTL?: number;
+        context?: RequestContext;
+        payload?: P;
+        httpsAgent?: https.Agent;
+    }): Promise<HttpResponse<T>>;
+    get<T>({ headers, url, maxRedirects, cacheTTL, context, }: {
+        headers?: HttpHeaders;
+        url: string;
+        maxRedirects?: number;
+        cacheTTL?: number;
+        context?: RequestContext;
+    }): Promise<HttpResponse<T>>;
+    post<P, T>({ headers, url, maxRedirects, cacheTTL, context, payload, }: {
+        headers?: HttpHeaders;
+        url: string;
+        maxRedirects?: number;
+        cacheTTL?: number;
+        context?: RequestContext;
+        payload?: P;
+    }): Promise<HttpResponse<T>>;
+}

package/package.json

@@ -0,0 +1,33 @@
+{
+    "name": "@stackone/transport",
+    "version": "1.0.0",
+    "description": "",
+    "main": "dist/index.js",
+    "module": "dist/index.es.js",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist",
+        "package.json",
+        "README.md"
+    ],
+    "scripts": {
+        "clean": "rimraf dist",
+        "prebuild": "npm run clean",
+        "build": "rollup -c",
+        "lint": "tsc --project tsconfig.json && eslint \"src/**/*.ts\"",
+        "lint:fix": "npm run lint -- --fix",
+        "test": "vitest run",
+        "test:watch": "vitest watch",
+        "publish": "npm publish --access=public"
+    },
+    "keywords": [],
+    "author": "StackOne",
+    "license": "ISC",
+    "dependencies": {
+        "axios": "^1.6.2",
+        "qs": "^6.11.2"
+    },
+    "devDependencies": {
+        "@types/qs": "^6.9.10"
+    }
+}