Compare commits
69 Commits
Author | SHA1 | Date | |
---|---|---|---|
7b49bba0d2 | |||
6600a23a00 | |||
e2845c9992 | |||
5e6f2c6fbf | |||
d3d0649b73 | |||
fba43df3c4 | |||
c6fa540543 | |||
1891b54389 | |||
fee8443af1 | |||
c48f956ae3 | |||
4a4b64a2c4 | |||
43d4b47782 | |||
6d970cb925 | |||
43710c930e | |||
306dd7c366 | |||
3d69d97891 | |||
a6d52702fd | |||
de31ee6093 | |||
cd2d7b2525 | |||
2d4a75c9cd | |||
557fec0386 | |||
e803f9e48d | |||
76c714a931 | |||
e8669f0420 | |||
d9e6214a7e | |||
7c4227bfc6 | |||
e55a521395 | |||
06fc279caf | |||
e89e317bbc | |||
d182832e47 | |||
92059a50de | |||
db80f2df7e | |||
145505b891 | |||
f4f50c6a94 | |||
d204059313 | |||
00210566d5 | |||
14245b2521 | |||
f0fa91e2db | |||
19a1fe1524 | |||
27770a8ad1 | |||
ab48f11e83 | |||
a0a9e3f824 | |||
c829b06169 | |||
80fa40baf4 | |||
3659b80e1e | |||
770e7d46ea | |||
2a46f2a306 | |||
eae4d09664 | |||
23a2f597fc | |||
c278249c32 | |||
a32c372374 | |||
f98972d9fe | |||
acebe6a381 | |||
7031504852 | |||
3010a1da9a | |||
cdead33be4 | |||
5e23649702 | |||
cc6bd5726a | |||
f487584e80 | |||
443bccd4c9 | |||
f359856b1d | |||
bda04f124b | |||
466187fd52 | |||
d22504317e | |||
6e31d84798 | |||
36472b7306 | |||
e86f14b8d8 | |||
2b9e7f6dd2 | |||
5e4afccf9c |
4
.gitignore
vendored
4
.gitignore
vendored
@ -15,8 +15,6 @@ node_modules/
|
||||
|
||||
# builds
|
||||
dist/
|
||||
dist_web/
|
||||
dist_serve/
|
||||
dist_ts_web/
|
||||
dist_*/
|
||||
|
||||
# custom
|
@ -4,7 +4,7 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
cache:
|
||||
paths:
|
||||
- .npmci_cache/
|
||||
key: "$CI_BUILD_STAGE"
|
||||
key: '$CI_BUILD_STAGE'
|
||||
|
||||
stages:
|
||||
- security
|
||||
@ -12,27 +12,35 @@ stages:
|
||||
- release
|
||||
- metadata
|
||||
|
||||
before_script:
|
||||
- npm install -g @shipzone/npmci
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
mirror:
|
||||
stage: security
|
||||
script:
|
||||
- npmci git mirror
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
snyk:
|
||||
auditProductionDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install -g snyk
|
||||
- npmci command npm install --ignore-scripts
|
||||
- npmci command snyk test
|
||||
- npmci command npm install --production --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high --only=prod --production
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
allow_failure: true
|
||||
|
||||
auditDevDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high --only=dev
|
||||
tags:
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
# ====================
|
||||
# test stage
|
||||
@ -48,28 +56,27 @@ testStable:
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
- priv
|
||||
|
||||
testBuild:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install lts
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci command npm run build
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci node install lts
|
||||
- npmci node install stable
|
||||
- npmci npm publish
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
@ -79,11 +86,14 @@ release:
|
||||
codequality:
|
||||
stage: metadata
|
||||
allow_failure: true
|
||||
only:
|
||||
- tags
|
||||
script:
|
||||
- npmci command npm install -g tslint typescript
|
||||
- npmci command npm install -g typescript
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- priv
|
||||
|
||||
@ -94,20 +104,19 @@ trigger:
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
pages:
|
||||
image: hosttoday/ht-docker-dbase:npmci
|
||||
services:
|
||||
- docker:stable-dind
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci command npm install -g @gitzone/tsdoc
|
||||
- npmci node install stable
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command tsdoc
|
||||
- npmci command npm run buildDocs
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
only:
|
||||
|
11
.vscode/launch.json
vendored
Normal file
11
.vscode/launch.json
vendored
Normal file
@ -0,0 +1,11 @@
|
||||
{
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"command": "npm test",
|
||||
"name": "Run npm test",
|
||||
"request": "launch",
|
||||
"type": "node-terminal"
|
||||
}
|
||||
]
|
||||
}
|
26
.vscode/settings.json
vendored
Normal file
26
.vscode/settings.json
vendored
Normal file
@ -0,0 +1,26 @@
|
||||
{
|
||||
"json.schemas": [
|
||||
{
|
||||
"fileMatch": ["/npmextra.json"],
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"npmci": {
|
||||
"type": "object",
|
||||
"description": "settings for npmci"
|
||||
},
|
||||
"gitzone": {
|
||||
"type": "object",
|
||||
"description": "settings for gitzone",
|
||||
"properties": {
|
||||
"projectType": {
|
||||
"type": "string",
|
||||
"enum": ["website", "element", "service", "npm", "wcc"]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
69
README.md
69
README.md
@ -1,69 +0,0 @@
|
||||
# @pushrocks/smartrequest
|
||||
dropin replacement for request
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartrequest)
|
||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartrequest)
|
||||
* [github.com (source mirror)](https://github.com/pushrocks/smartrequest)
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartrequest/)
|
||||
|
||||
## Status for master
|
||||
[](https://gitlab.com/pushrocks/smartrequest/commits/master)
|
||||
[](https://gitlab.com/pushrocks/smartrequest/commits/master)
|
||||
[](https://www.npmjs.com/package/@pushrocks/smartrequest)
|
||||
[](https://snyk.io/test/npm/@pushrocks/smartrequest)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](https://prettier.io/)
|
||||
|
||||
## Usage
|
||||
|
||||
Use TypeScript for best in class instellisense.
|
||||
|
||||
> note: smartrequest uses the **native** node request module under the hood (not the one from npm)
|
||||
|
||||
```javascript
|
||||
import * as smartrequest from 'smartrequest'
|
||||
|
||||
// simple post
|
||||
let options: smartrequest.ISmartRequestOptions = { // typed options
|
||||
headers: {
|
||||
"Content-Type": "application/json"
|
||||
"Authorization": "Bearer token"
|
||||
},
|
||||
requestBody: {
|
||||
key1: 'value1',
|
||||
key2: 3
|
||||
}
|
||||
}
|
||||
|
||||
smartrequest.post('https://example.com', options).then(res => {
|
||||
console.log(res.status)
|
||||
console.log(res.body) // if json, body will be parsed automatically
|
||||
}).catch(err => {
|
||||
console.log(err)
|
||||
})
|
||||
|
||||
// also available
|
||||
smartrequest.get(...)
|
||||
smartrequest.put(...)
|
||||
smartrequest.del(...)
|
||||
|
||||
// streaming
|
||||
smartrequest.get('https://example.com/bigfile.mp4', optionsArg, true).then(res => { // third arg = true signals streaming
|
||||
console.log(res.status)
|
||||
res.on('data', data => {
|
||||
// do something with the data chunk here
|
||||
}
|
||||
res.on('end', () => {
|
||||
// do something when things have ended
|
||||
})
|
||||
})
|
||||
```
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
@ -7,11 +7,12 @@
|
||||
"npmAccessLevel": "public"
|
||||
},
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"gitrepo": "smartrequest",
|
||||
"shortDescription": "dropin replacement for request",
|
||||
"description": "dropin replacement for request",
|
||||
"npmPackagename": "@pushrocks/smartrequest",
|
||||
"license": "MIT"
|
||||
}
|
||||
|
14266
package-lock.json
generated
14266
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
48
package.json
48
package.json
@ -1,13 +1,15 @@
|
||||
{
|
||||
"name": "@pushrocks/smartrequest",
|
||||
"version": "1.1.33",
|
||||
"version": "2.0.10",
|
||||
"private": false,
|
||||
"description": "dropin replacement for request",
|
||||
"main": "dist/index.js",
|
||||
"typings": "dist/index.d.ts",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"test": "(tstest test/)",
|
||||
"build": "(tsbuild)"
|
||||
"test": "(tstest test/ --web)",
|
||||
"build": "(tsbuild --web)",
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
@ -23,29 +25,31 @@
|
||||
},
|
||||
"homepage": "https://gitlab.com/pushrocks/smartrequest#README",
|
||||
"dependencies": {
|
||||
"@pushrocks/smartpromise": "^3.0.5",
|
||||
"@types/form-data": "^2.5.0",
|
||||
"agentkeepalive": "^4.0.2",
|
||||
"form-data": "^2.5.1"
|
||||
"@pushrocks/smartpromise": "^3.1.7",
|
||||
"@pushrocks/smarturl": "^3.0.3",
|
||||
"agentkeepalive": "^4.2.1",
|
||||
"form-data": "^4.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.1.17",
|
||||
"@gitzone/tsrun": "^1.2.8",
|
||||
"@gitzone/tstest": "^1.0.24",
|
||||
"@pushrocks/tapbundle": "^3.0.13",
|
||||
"@types/node": "^12.7.8",
|
||||
"tslint": "^5.20.0",
|
||||
"tslint-config-prettier": "^1.18.0"
|
||||
"@gitzone/tsbuild": "^2.1.65",
|
||||
"@gitzone/tsrun": "^1.2.37",
|
||||
"@gitzone/tstest": "^1.0.73",
|
||||
"@pushrocks/tapbundle": "^5.0.4",
|
||||
"@types/node": "^18.6.4"
|
||||
},
|
||||
"files": [
|
||||
"ts/*",
|
||||
"ts_web/*",
|
||||
"dist/*",
|
||||
"dist_web/*",
|
||||
"dist_ts_web/*",
|
||||
"assets/*",
|
||||
"ts/**/*",
|
||||
"ts_web/**/*",
|
||||
"dist/**/*",
|
||||
"dist_*/**/*",
|
||||
"dist_ts/**/*",
|
||||
"dist_ts_web/**/*",
|
||||
"assets/**/*",
|
||||
"cli.js",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
],
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
]
|
||||
}
|
||||
|
96
readme.md
Normal file
96
readme.md
Normal file
@ -0,0 +1,96 @@
|
||||
# @pushrocks/smartrequest
|
||||
dropin replacement for request
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartrequest)
|
||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartrequest)
|
||||
* [github.com (source mirror)](https://github.com/pushrocks/smartrequest)
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartrequest/)
|
||||
|
||||
## Status for master
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||
|
||||
## Usage
|
||||
|
||||
Use TypeScript for best in class instellisense.
|
||||
|
||||
### Features
|
||||
|
||||
- supports http
|
||||
- supports https
|
||||
- supports unix socks
|
||||
- supports formData
|
||||
- supports file uploads
|
||||
- supports best practice keepAlive
|
||||
- dedicated functions for working with JSON request/response cycles
|
||||
- written in TypeScript
|
||||
- continuously updated
|
||||
- uses node native http and https modules
|
||||
- used in modules like @pushrocks/smartproxy and @apiglobal/typedrequest
|
||||
- commercial support available at [https://lossless.support](https://lossless.support)
|
||||
|
||||
> note: smartrequest uses the **native** node http/https modules under the hood (not the bloated one from npm)
|
||||
|
||||
```javascript
|
||||
import * as smartrequest from 'smartrequest'
|
||||
|
||||
// simple post
|
||||
const options: smartrequest.ISmartRequestOptions = { // typed options
|
||||
headers: {
|
||||
"Content-Type": "application/json"
|
||||
"Authorization": "Bearer token"
|
||||
},
|
||||
requestBody: JSON.stringify({
|
||||
key1: 'value1',
|
||||
key2: 3
|
||||
})
|
||||
}
|
||||
|
||||
smartrequest.request('https://example.com', options).then(res => {
|
||||
console.log(res.status)
|
||||
console.log(res.body) // if json, body will be parsed automatically
|
||||
}).catch(err => {
|
||||
console.log(err)
|
||||
})
|
||||
|
||||
// dedicated JSON methods are available:
|
||||
smartrequest.getJson(...)
|
||||
smartrequest.postJson(...)
|
||||
smartrequest.putJson(...)
|
||||
smartrequest.delJson(...)
|
||||
|
||||
// streaming
|
||||
smartrequest.get('https://example.com/bigfile.mp4', optionsArg, true).then(res => { // third arg = true signals streaming
|
||||
console.log(res.status)
|
||||
res.on('data', data => {
|
||||
// do something with the data chunk here
|
||||
}
|
||||
res.on('end', () => {
|
||||
// do something when things have ended
|
||||
})
|
||||
})
|
||||
```
|
||||
|
||||
## Contribution
|
||||
|
||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
30
test/test.ts
30
test/test.ts
@ -1,31 +1,23 @@
|
||||
import { tap, expect } from '@pushrocks/tapbundle';
|
||||
import { tap, expect, expectAsync } from '@pushrocks/tapbundle';
|
||||
|
||||
import * as smartrequest from '../ts/index';
|
||||
import * as smartrequest from '../ts/index.js';
|
||||
|
||||
tap.test('should request a html document over https', async () => {
|
||||
await expect(smartrequest.getJson('https://encrypted.google.com/'))
|
||||
.to.eventually.property('body')
|
||||
.be.a('string');
|
||||
await expect(smartrequest.getJson('https://encrypted.google.com/'))
|
||||
.to.eventually.property('body')
|
||||
.be.a('string');
|
||||
await expect(smartrequest.getJson('https://encrypted.google.com/'))
|
||||
.to.eventually.property('body')
|
||||
.be.a('string');
|
||||
await expectAsync(smartrequest.getJson('https://encrypted.google.com/')).toHaveProperty('body');
|
||||
});
|
||||
|
||||
tap.test('should request a JSON document over https', async () => {
|
||||
await expect(smartrequest.getJson('https://jsonplaceholder.typicode.com/posts/1'))
|
||||
.to.eventually.property('body')
|
||||
await expectAsync(smartrequest.getJson('https://jsonplaceholder.typicode.com/posts/1'))
|
||||
.property('body')
|
||||
.property('id')
|
||||
.equal(1);
|
||||
.toEqual(1);
|
||||
});
|
||||
|
||||
tap.skip.test('should post a JSON document over http', async () => {
|
||||
await expect(smartrequest.postJson('http://md5.jsontest.com/?text=example_text'))
|
||||
.to.eventually.property('body')
|
||||
await expectAsync(smartrequest.postJson('http://md5.jsontest.com/?text=example_text'))
|
||||
.property('body')
|
||||
.property('md5')
|
||||
.equal('fa4c6baa0812e5b5c80ed8885e55a8a6');
|
||||
.toEqual('fa4c6baa0812e5b5c80ed8885e55a8a6');
|
||||
});
|
||||
|
||||
tap.skip.test('should deal with unix socks', async () => {
|
||||
@ -34,8 +26,8 @@ tap.skip.test('should deal with unix socks', async () => {
|
||||
{
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
Host: 'docker.sock'
|
||||
}
|
||||
Host: 'docker.sock',
|
||||
},
|
||||
}
|
||||
);
|
||||
console.log(socketResponse.body);
|
||||
|
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@ -0,0 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@pushrocks/smartrequest',
|
||||
version: '2.0.10',
|
||||
description: 'dropin replacement for request'
|
||||
}
|
11
ts/index.ts
11
ts/index.ts
@ -1,6 +1,7 @@
|
||||
export { request, IExtendedIncomingMessage } from './smartrequest.request';
|
||||
export { ISmartRequestOptions } from './smartrequest.interfaces';
|
||||
export { request } from './smartrequest.request.js';
|
||||
export type { IExtendedIncomingMessage } from './smartrequest.request.js';
|
||||
export type { ISmartRequestOptions } from './smartrequest.interfaces.js';
|
||||
|
||||
export * from './smartrequest.jsonrest';
|
||||
export * from './smartrequest.binaryrest';
|
||||
export * from './smartrequest.formdata';
|
||||
export * from './smartrequest.jsonrest.js';
|
||||
export * from './smartrequest.binaryrest.js';
|
||||
export * from './smartrequest.formdata.js';
|
||||
|
@ -1,19 +1,23 @@
|
||||
// this file implements methods to get and post binary data.
|
||||
import * as interfaces from './smartrequest.interfaces';
|
||||
import { request } from './smartrequest.request';
|
||||
import * as interfaces from './smartrequest.interfaces.js';
|
||||
import { request } from './smartrequest.request.js';
|
||||
|
||||
import * as plugins from './smartrequest.plugins';
|
||||
import * as plugins from './smartrequest.plugins.js';
|
||||
|
||||
export const getBinary = async (
|
||||
domainArg: string,
|
||||
optionsArg: interfaces.ISmartRequestOptions = {}
|
||||
) => {
|
||||
optionsArg = {
|
||||
...optionsArg,
|
||||
autoJsonParse: false,
|
||||
};
|
||||
const done = plugins.smartpromise.defer();
|
||||
const response = await request(domainArg, optionsArg, true);
|
||||
const data = [];
|
||||
const data: Array<Buffer> = [];
|
||||
|
||||
response
|
||||
.on('data', function(chunk) {
|
||||
.on('data', function (chunk: Buffer) {
|
||||
data.push(chunk);
|
||||
})
|
||||
.on('end', function () {
|
||||
@ -21,7 +25,7 @@ export const getBinary = async (
|
||||
//so Buffer.concat() can make us a new Buffer
|
||||
//of all of them together
|
||||
const buffer = Buffer.concat(data);
|
||||
response.body = buffer.toString('binary');
|
||||
response.body = buffer;
|
||||
done.resolve();
|
||||
});
|
||||
await done.promise;
|
||||
|
@ -1,6 +1,6 @@
|
||||
import * as plugins from './smartrequest.plugins';
|
||||
import * as interfaces from './smartrequest.interfaces';
|
||||
import { request } from './smartrequest.request';
|
||||
import * as plugins from './smartrequest.plugins.js';
|
||||
import * as interfaces from './smartrequest.interfaces.js';
|
||||
import { request } from './smartrequest.request.js';
|
||||
|
||||
/**
|
||||
* the interfae for FormFieldData
|
||||
@ -8,16 +8,38 @@ import { request } from './smartrequest.request';
|
||||
export interface IFormField {
|
||||
name: string;
|
||||
type: 'string' | 'filePath' | 'Buffer';
|
||||
payload: string;
|
||||
payload: string | Buffer;
|
||||
fileName?: string;
|
||||
contentType?: string;
|
||||
}
|
||||
|
||||
const appendFormField = async (formDataArg: plugins.formData, formDataField: IFormField) => {
|
||||
if (formDataField.type === 'filePath') {
|
||||
let fileData = plugins.fs.readFileSync(plugins.path.join(process.cwd(), formDataField.payload));
|
||||
switch (formDataField.type) {
|
||||
case 'string':
|
||||
formDataArg.append(formDataField.name, formDataField.payload);
|
||||
break;
|
||||
case 'filePath':
|
||||
if (typeof formDataField.payload !== 'string') {
|
||||
throw new Error(
|
||||
`Payload for key ${
|
||||
formDataField.name
|
||||
} must be of type string. Got ${typeof formDataField.payload} instead.`
|
||||
);
|
||||
}
|
||||
const fileData = plugins.fs.readFileSync(
|
||||
plugins.path.join(process.cwd(), formDataField.payload)
|
||||
);
|
||||
formDataArg.append('file', fileData, {
|
||||
filename: 'upload.pdf',
|
||||
contentType: 'application/pdf'
|
||||
filename: formDataField.fileName ? formDataField.fileName : 'upload.pdf',
|
||||
contentType: 'application/pdf',
|
||||
});
|
||||
break;
|
||||
case 'Buffer':
|
||||
formDataArg.append(formDataField.name, formDataField.payload, {
|
||||
filename: formDataField.fileName ? formDataField.fileName : 'upload.pdf',
|
||||
contentType: formDataField.contentType ? formDataField.contentType : 'application/pdf',
|
||||
});
|
||||
break;
|
||||
}
|
||||
};
|
||||
|
||||
@ -30,14 +52,46 @@ export const postFormData = async (
|
||||
for (const formField of payloadArg) {
|
||||
await appendFormField(form, formField);
|
||||
}
|
||||
const requestOptions = Object.assign({}, optionsArg, {
|
||||
const requestOptions = {
|
||||
...optionsArg,
|
||||
method: 'POST',
|
||||
headers: {
|
||||
...optionsArg.headers,
|
||||
...form.getHeaders()
|
||||
...form.getHeaders(),
|
||||
},
|
||||
requestBody: form
|
||||
});
|
||||
requestBody: form,
|
||||
};
|
||||
|
||||
// lets fire the actual request for sending the formdata
|
||||
const response = await request(urlArg, requestOptions);
|
||||
return response;
|
||||
};
|
||||
|
||||
export const postFormDataUrlEncoded = async (
|
||||
urlArg: string,
|
||||
optionsArg: interfaces.ISmartRequestOptions = {},
|
||||
payloadArg: { key: string; content: string }[]
|
||||
) => {
|
||||
let resultString = '';
|
||||
|
||||
for (const keyContentPair of payloadArg) {
|
||||
if (resultString) {
|
||||
resultString += '&';
|
||||
}
|
||||
resultString += `${encodeURIComponent(keyContentPair.key)}=${encodeURIComponent(
|
||||
keyContentPair.content
|
||||
)}`;
|
||||
}
|
||||
|
||||
const requestOptions: interfaces.ISmartRequestOptions = {
|
||||
...optionsArg,
|
||||
method: 'POST',
|
||||
headers: {
|
||||
...optionsArg.headers,
|
||||
'content-type': 'application/x-www-form-urlencoded',
|
||||
},
|
||||
requestBody: resultString,
|
||||
};
|
||||
|
||||
// lets fire the actual request for sending the formdata
|
||||
const response = await request(urlArg, requestOptions);
|
||||
|
@ -1,8 +1,9 @@
|
||||
import * as plugins from './smartrequest.plugins';
|
||||
import * as plugins from './smartrequest.plugins.js';
|
||||
import * as https from 'https';
|
||||
|
||||
export interface ISmartRequestOptions extends https.RequestOptions {
|
||||
keepAlive?: boolean;
|
||||
requestBody?: any;
|
||||
autoJsonParse?: boolean;
|
||||
queryParams?: { [key: string]: string };
|
||||
}
|
||||
|
@ -1,7 +1,7 @@
|
||||
// This file implements methods to get and post JSON in a simple manner.
|
||||
|
||||
import * as interfaces from './smartrequest.interfaces';
|
||||
import { request } from './smartrequest.request';
|
||||
import * as interfaces from './smartrequest.interfaces.js';
|
||||
import { request } from './smartrequest.request.js';
|
||||
|
||||
/**
|
||||
* gets Json and puts the right headers + handles response aggregation
|
||||
@ -14,7 +14,7 @@ export const getJson = async (
|
||||
) => {
|
||||
optionsArg.method = 'GET';
|
||||
optionsArg.headers = {
|
||||
...optionsArg.headers
|
||||
...optionsArg.headers,
|
||||
};
|
||||
let response = await request(domainArg, optionsArg);
|
||||
return response;
|
||||
@ -37,7 +37,7 @@ export const postJson = async (
|
||||
// assign the right Content-Type, leaving all other headers in place
|
||||
optionsArg.headers = {
|
||||
...optionsArg.headers,
|
||||
'Content-Type': 'application/json'
|
||||
'Content-Type': 'application/json',
|
||||
};
|
||||
}
|
||||
let response = await request(domainArg, optionsArg);
|
||||
|
@ -1,17 +1,19 @@
|
||||
import formData from 'form-data';
|
||||
// node native scope
|
||||
import * as fs from 'fs';
|
||||
import * as http from 'http';
|
||||
import * as https from 'https';
|
||||
import * as path from 'path';
|
||||
import * as url from 'url';
|
||||
|
||||
export { http, https, fs, path };
|
||||
|
||||
// pushrocks scope
|
||||
import * as smartpromise from '@pushrocks/smartpromise';
|
||||
import * as smarturl from '@pushrocks/smarturl';
|
||||
|
||||
export { formData, http, https, fs, path, url, smartpromise };
|
||||
export { smartpromise, smarturl };
|
||||
|
||||
// third party scope
|
||||
import * as agentkeepalive from 'agentkeepalive';
|
||||
import agentkeepalive from 'agentkeepalive';
|
||||
import formData from 'form-data';
|
||||
|
||||
export {
|
||||
agentkeepalive
|
||||
};
|
||||
export { agentkeepalive, formData };
|
||||
|
@ -1,5 +1,5 @@
|
||||
import * as plugins from './smartrequest.plugins';
|
||||
import * as interfaces from './smartrequest.interfaces';
|
||||
import * as plugins from './smartrequest.plugins.js';
|
||||
import * as interfaces from './smartrequest.interfaces.js';
|
||||
|
||||
import { IncomingMessage } from 'http';
|
||||
|
||||
@ -14,7 +14,7 @@ const buildUtf8Response = (
|
||||
const done = plugins.smartpromise.defer<IExtendedIncomingMessage>();
|
||||
// Continuously update stream with data
|
||||
let body = '';
|
||||
incomingMessageArg.on('data', chunkArg => {
|
||||
incomingMessageArg.on('data', (chunkArg) => {
|
||||
body += chunkArg;
|
||||
});
|
||||
|
||||
@ -50,67 +50,81 @@ const parseSocketPathAndRoute = (stringToParseArg: string) => {
|
||||
const result = parseRegex.exec(stringToParseArg);
|
||||
return {
|
||||
socketPath: result[1],
|
||||
path: result[2]
|
||||
path: result[2],
|
||||
};
|
||||
};
|
||||
|
||||
/**
|
||||
* a custom http agent to make sure we can set custom keepAlive options for speedy subsequent calls
|
||||
*/
|
||||
const httpAgent = new plugins.agentkeepalive.default();
|
||||
const httpAgent = new plugins.agentkeepalive({
|
||||
keepAlive: true,
|
||||
maxFreeSockets: 10,
|
||||
maxSockets: 100,
|
||||
maxTotalSockets: 1000,
|
||||
timeout: 60000,
|
||||
});
|
||||
|
||||
/**
|
||||
* a custom http agent to make sure we can set custom keepAlive options for speedy subsequent calls
|
||||
*/
|
||||
const httpAgentKeepAliveFalse = new plugins.http.Agent({
|
||||
maxFreeSockets: 0,
|
||||
const httpAgentKeepAliveFalse = new plugins.agentkeepalive({
|
||||
keepAlive: false,
|
||||
keepAliveMsecs: 0
|
||||
timeout: 60000
|
||||
});
|
||||
|
||||
/**
|
||||
* a custom https agent to make sure we can set custom keepAlive options for speedy subsequent calls
|
||||
*/
|
||||
const httpsAgent = new plugins.agentkeepalive.HttpsAgent();
|
||||
const httpsAgent = new plugins.agentkeepalive.HttpsAgent({
|
||||
keepAlive: true,
|
||||
maxFreeSockets: 10,
|
||||
maxSockets: 100,
|
||||
maxTotalSockets: 1000,
|
||||
timeout: 60000
|
||||
});
|
||||
|
||||
/**
|
||||
* a custom https agent to make sure we can set custom keepAlive options for speedy subsequent calls
|
||||
*/
|
||||
const httpsAgentKeepAliveFalse = new plugins.https.Agent({
|
||||
maxFreeSockets: 0,
|
||||
const httpsAgentKeepAliveFalse = new plugins.agentkeepalive.HttpsAgent({
|
||||
keepAlive: false,
|
||||
keepAliveMsecs: 0
|
||||
timeout: 60000
|
||||
});
|
||||
|
||||
export let request = async (
|
||||
domainArg: string,
|
||||
urlArg: string,
|
||||
optionsArg: interfaces.ISmartRequestOptions = {},
|
||||
streamArg: boolean = false
|
||||
responseStreamArg: boolean = false,
|
||||
requestDataFunc: (req: plugins.http.ClientRequest) => void = null
|
||||
): Promise<IExtendedIncomingMessage> => {
|
||||
const done = plugins.smartpromise.defer<any>();
|
||||
const done = plugins.smartpromise.defer<IExtendedIncomingMessage>();
|
||||
|
||||
// merge options
|
||||
const defaultOptions: interfaces.ISmartRequestOptions = {
|
||||
// agent: agent,
|
||||
autoJsonParse: true,
|
||||
keepAlive: true
|
||||
keepAlive: true,
|
||||
};
|
||||
|
||||
optionsArg = {
|
||||
...defaultOptions,
|
||||
...optionsArg
|
||||
...optionsArg,
|
||||
};
|
||||
|
||||
// parse url
|
||||
const parsedUrl = plugins.url.parse(domainArg);
|
||||
const parsedUrl = plugins.smarturl.Smarturl.createFromUrl(urlArg, {
|
||||
searchParams: optionsArg.queryParams || {},
|
||||
});
|
||||
optionsArg.hostname = parsedUrl.hostname;
|
||||
if (parsedUrl.port) {
|
||||
optionsArg.port = parseInt(parsedUrl.port, 10);
|
||||
}
|
||||
optionsArg.path = parsedUrl.path;
|
||||
optionsArg.queryParams = parsedUrl.searchParams;
|
||||
|
||||
// determine if unixsock
|
||||
if (testForUnixSock(domainArg)) {
|
||||
if (testForUnixSock(urlArg)) {
|
||||
const detailedUnixPath = parseSocketPathAndRoute(optionsArg.path);
|
||||
optionsArg.socketPath = detailedUnixPath.socketPath;
|
||||
optionsArg.path = detailedUnixPath.path;
|
||||
@ -124,22 +138,27 @@ export let request = async (
|
||||
case parsedUrl.protocol === 'https:' && optionsArg.keepAlive:
|
||||
optionsArg.agent = httpsAgent;
|
||||
return plugins.https;
|
||||
case parsedUrl.protocol === 'https:' && (!optionsArg.keepAlive):
|
||||
case parsedUrl.protocol === 'https:' && !optionsArg.keepAlive:
|
||||
optionsArg.agent = httpsAgentKeepAliveFalse;
|
||||
return plugins.https;
|
||||
case parsedUrl.protocol === 'http:' && optionsArg.keepAlive:
|
||||
optionsArg.agent = httpAgent;
|
||||
return plugins.http;
|
||||
case parsedUrl.protocol === 'http:' && (!optionsArg.keepAlive):
|
||||
case parsedUrl.protocol === 'http:' && !optionsArg.keepAlive:
|
||||
optionsArg.agent = httpAgentKeepAliveFalse;
|
||||
return plugins.http;
|
||||
}
|
||||
})() as typeof plugins.https;
|
||||
|
||||
if (!requestModule) {
|
||||
console.error(`The request to ${urlArg} is missing a viable protocol. Must be http or https`);
|
||||
return;
|
||||
}
|
||||
|
||||
// lets perform the actual request
|
||||
const requestToFire = requestModule.request(optionsArg, async response => {
|
||||
if (streamArg) {
|
||||
done.resolve(response);
|
||||
const requestToFire = requestModule.request(optionsArg, async (response) => {
|
||||
if (responseStreamArg) {
|
||||
done.resolve(response as IExtendedIncomingMessage);
|
||||
} else {
|
||||
const builtResponse = await buildUtf8Response(response, optionsArg.autoJsonParse);
|
||||
done.resolve(builtResponse);
|
||||
@ -149,7 +168,7 @@ export let request = async (
|
||||
// lets write the requestBody
|
||||
if (optionsArg.requestBody) {
|
||||
if (optionsArg.requestBody instanceof plugins.formData) {
|
||||
optionsArg.requestBody.pipe(requestToFire).on('finish', event => {
|
||||
optionsArg.requestBody.pipe(requestToFire).on('finish', (event: any) => {
|
||||
requestToFire.end();
|
||||
});
|
||||
} else {
|
||||
@ -159,15 +178,22 @@ export let request = async (
|
||||
requestToFire.write(optionsArg.requestBody);
|
||||
requestToFire.end();
|
||||
}
|
||||
} else if (requestDataFunc) {
|
||||
requestDataFunc(requestToFire);
|
||||
} else {
|
||||
requestToFire.end();
|
||||
}
|
||||
|
||||
// lets handle an error
|
||||
requestToFire.on('error', e => {
|
||||
requestToFire.on('error', (e) => {
|
||||
console.error(e);
|
||||
requestToFire.destroy();
|
||||
});
|
||||
|
||||
const result = await done.promise;
|
||||
return result;
|
||||
const response = await done.promise;
|
||||
response.on('error', (err) => {
|
||||
console.log(err);
|
||||
response.destroy();
|
||||
})
|
||||
return response;
|
||||
};
|
||||
|
10
tsconfig.json
Normal file
10
tsconfig.json
Normal file
@ -0,0 +1,10 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "ES2022",
|
||||
"moduleResolution": "nodenext",
|
||||
"esModuleInterop": true
|
||||
}
|
||||
}
|
17
tslint.json
17
tslint.json
@ -1,17 +0,0 @@
|
||||
{
|
||||
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||
"rules": {
|
||||
"semicolon": [true, "always"],
|
||||
"no-console": false,
|
||||
"ordered-imports": false,
|
||||
"object-literal-sort-keys": false,
|
||||
"member-ordering": {
|
||||
"options":{
|
||||
"order": [
|
||||
"static-method"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"defaultSeverity": "warning"
|
||||
}
|
Reference in New Issue
Block a user