curl-wrap 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Hitesh Khandelwal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,210 @@
+# curl-wrap
+Nodejs library that wraps curl command line
+
+## Install
+```sh
+npm install curl-wrap
+# OR
+yarn add curl-wrap
+```
+
+## Usage
+
+```js
+const {Curl} = require('curl-wrap');
+
+const response = await Curl.get('https://www.google.com');
+console.log(response.body);
+console.log(response.statusCode);
+```
+
+hit12369: write documentation for this library
+
+Workspace: # curl-wrap
+
+Node.js library that wraps the curl command line.
+
+## Install
+
+```sh
+npm install curl-wrap
+# OR
+yarn add curl-wrap
+```
+
+## Usage
+
+### Basic Usage
+
+```js
+const {Curl} = require('curl-wrap');
+
+const response = await Curl.get('https://www.example.com');
+console.log(response.body);
+console.log(response.statusCode);
+```
+
+### Creating a Curl Instance
+
+```js
+const response = await Curl.url('https://www.example.com')
+    .post()
+    .header('Accept', 'application/json')
+    .followRedirect(true)
+    .timeout(30);
+
+// you can also use
+const curl = new Curl();
+curl.url('https://www.example.com');
+curl.post();
+curl.header('Accept', 'application/json');
+curl.followRedirect(true);
+curl.timeout(30);
+const res = await curl;
+```
+
+### Setting Headers
+
+```js
+curl.header('Content-Type', 'application/json');
+curl.headers({
+    'User-Agent': 'curl-wrap/1.0',
+    'Accept': 'application/json'
+});
+```
+
+### Setting Cookies
+
+```js
+curl.cookie('sessionId', 'abc123');
+curl.cookies({
+    'sessionId': 'abc123',
+    'userId': 'user456'
+});
+
+// enable in memory cookie storage for all requests
+curl.globalCookies();
+
+// use a cookie file to store and read cookies
+curl.cookieFile('cookies.json');
+```
+
+### Setting Proxy
+
+```js
+curl.proxy('http://proxy.example.com:8080');
+curl.proxy({
+    address: 'proxy.example.com',
+    port: 8080,
+    type: 'http',
+    auth: {
+        username: 'user',
+        password: 'pass'
+    }
+});
+```
+
+### Authentication
+
+```js
+curl.httpAuth('username', 'password');
+curl.bearerToken('your-token');
+curl.apiToken('your-api-token');
+```
+
+### Impersonating a Browser
+
+**NOTE**: it will use `curl-impersonate-chrome` and `curl-impersonate-ff` if they are in `PATH`
+
+```js
+curl.impersonate('chrome');
+curl.impersonate('chromeMobile');
+curl.impersonate('firefox');
+curl.impersonate('safari');
+curl.impersonate('edge');
+```
+
+### Setting Request Method
+
+```js
+curl.method('POST');
+curl.get();
+curl.post();
+curl.put();
+```
+
+### Setting Request Body
+
+```js
+curl.body({key: 'value'});
+curl.body('any data');
+curl.json({key: 'value'});
+```
+
+### Setting POST/PUT Fields
+
+```js
+curl.field('key', 'value');
+curl.fields({
+    key1: value1,
+    key2: value2,
+});
+```
+
+### Setting Query Parameters
+
+```js
+curl.query('search', 'term');
+curl.query({
+    search: 'term',
+    page: 1
+});
+```
+
+### Setting Timeout
+
+```js
+curl.timeout(30); // in seconds
+curl.timeoutMs(30000); // in milliseconds
+```
+
+### Handling Responses
+
+```js
+try {
+    const response = await curl;
+    console.log(response.body);
+    console.log(response.statusCode);
+}
+catch (error) {
+    console.error(error);
+}
+```
+
+### Verbose Output
+
+```js
+curl.verbose(true);
+const response = await curl;
+console.log(response.stderr);
+```
+
+### Method Chaining
+
+```js
+Curl.url('https://www.example.com')
+    .method('GET')
+    .header('Accept', 'application/json')
+    .followRedirect(true)
+    .maxRedirects(5)
+    .timeout(30)
+    .then(response => {
+        console.log(response.body);
+    })
+    .catch(error => {
+        console.error(error);
+    })
+    .finally(() => {
+        console.log('Request completed');
+    });
+```