smartrequest/readme.md

# @push.rocks/smartrequest
A module providing a drop-in replacement for the deprecated Request library, focusing on modern HTTP/HTTPS requests with support for form data, file uploads, JSON, binary data, and streams. The library offers both a legacy API and a modern fluent API for maximum flexibility.

## Install
To install `@push.rocks/smartrequest`, use one of the following commands:

```bash
# Using npm
npm install @push.rocks/smartrequest --save

# Using pnpm
pnpm add @push.rocks/smartrequest

# Using yarn
yarn add @push.rocks/smartrequest
```

This will add `@push.rocks/smartrequest` to your project's dependencies.

## Usage
`@push.rocks/smartrequest` is designed as a versatile, modern HTTP client library for making HTTP/HTTPS requests. It supports a range of features, including handling form data, file uploads, JSON requests, binary data, streaming, pagination, and much more, all within a modern, promise-based API.

The library provides two distinct APIs:

1. **Legacy API** - Simple function-based API for quick and straightforward HTTP requests
2. **Modern Fluent API** - A chainable, builder-style API for more complex scenarios and better TypeScript integration

Below we will cover key usage scenarios of `@push.rocks/smartrequest`, showcasing its capabilities and providing you with a solid starting point to integrate it into your projects.

### Simple GET Request

For fetching data from a REST API or any web service that returns JSON:

```typescript
import { getJson } from '@push.rocks/smartrequest';

async function fetchGitHubUserInfo(username: string) {
  const response = await getJson(`https://api.github.com/users/${username}`);
  console.log(response.body); // The body contains the JSON response
}

fetchGitHubUserInfo('octocat');
```

The `getJson` function simplifies the process of sending a GET request and parsing the JSON response.

### POST Requests with JSON

When you need to send JSON data to a server, for example, creating a new resource:

```typescript
import { postJson } from '@push.rocks/smartrequest';

async function createTodoItem(todoDetails: { title: string; completed: boolean }) {
  const response = await postJson('https://jsonplaceholder.typicode.com/todos', {
    requestBody: todoDetails
  });
  console.log(response.body); // Log the created todo item
}

createTodoItem({ title: 'Implement smartrequest', completed: false });
```

`postJson` handles setting the appropriate content-type header and stringifies the JSON body.

### Handling Form Data and File Uploads

`@push.rocks/smartrequest` simplifies the process of uploading files and submitting form data to a server:

```typescript
import { postFormData, IFormField } from '@push.rocks/smartrequest';

async function uploadProfilePicture(formDataFields: IFormField[]) {
  await postFormData('https://api.example.com/upload', {}, formDataFields);
}

uploadProfilePicture([
  { name: 'avatar', type: 'filePath', payload: './path/to/avatar.jpg', fileName: 'avatar.jpg', contentType: 'image/jpeg' },
  { name: 'user_id', type: 'string', payload: '12345' }
]);
```

### Streaming Support

For cases when dealing with large datasets or streaming APIs, `@push.rocks/smartrequest` provides streaming capabilities:

```typescript
import { getStream } from '@push.rocks/smartrequest';

async function streamLargeFile(url: string) {
  const stream = await getStream(url);

  stream.on('data', (chunk) => {
    console.log('Received chunk of data.');
  });

  stream.on('end', () => {
    console.log('Stream ended.');
  });
}

streamLargeFile('https://example.com/largefile');
```

`getStream` allows you to handle data as it's received, which can be beneficial for performance and scalability.

### Advanced Options and Customization

`@push.rocks/smartrequest` is built to be flexible, allowing you to specify additional options to tailor requests to your needs:

```typescript
import { request, ISmartRequestOptions } from '@push.rocks/smartrequest';

async function customRequestExample() {
  const options: ISmartRequestOptions = {
    method: 'GET',
    headers: {
      'Custom-Header': 'Value'
    },
    keepAlive: true // Enables connection keep-alive
  };

  const response = await request('https://example.com/data', options);
  console.log(response.body);
}

customRequestExample();
```

`request` is the underlying function that powers the simpler `getJson`, `postJson`, etc., and provides you with full control over the HTTP request.

## Modern Fluent API

In addition to the legacy API shown above, `@push.rocks/smartrequest` provides a modern, fluent API that offers a more chainable and TypeScript-friendly approach to making HTTP requests.

### Basic Usage with the Modern API

```typescript
import { SmartRequestClient } from '@push.rocks/smartrequest';

// Simple GET request
async function fetchUserData(userId: number) {
  const response = await SmartRequestClient.create()
    .url(`https://jsonplaceholder.typicode.com/users/${userId}`)
    .get();

  console.log(response.body); // The JSON response
}

// POST request with JSON body
async function createPost(title: string, body: string, userId: number) {
  const response = await SmartRequestClient.create()
    .url('https://jsonplaceholder.typicode.com/posts')
    .json({ title, body, userId })
    .post();

  console.log(response.body); // The created post
}
```

### Setting Headers and Query Parameters

```typescript
import { SmartRequestClient } from '@push.rocks/smartrequest';

async function searchRepositories(query: string, perPage: number = 10) {
  const response = await SmartRequestClient.create()
    .url('https://api.github.com/search/repositories')
    .header('Accept', 'application/vnd.github.v3+json')
    .query({
      q: query,
      per_page: perPage.toString()
    })
    .get();

  return response.body.items;
}
```

### Handling Timeouts and Retries

```typescript
import { SmartRequestClient } from '@push.rocks/smartrequest';

async function fetchWithRetry(url: string) {
  const response = await SmartRequestClient.create()
    .url(url)
    .timeout(5000) // 5 seconds timeout
    .retry(3) // Retry up to 3 times on failure
    .get();

  return response.body;
}
```

### Working with Different Response Types

```typescript
import { SmartRequestClient } from '@push.rocks/smartrequest';

// Binary data
async function downloadImage(url: string) {
  const response = await SmartRequestClient.create()
    .url(url)
    .responseType('binary')
    .get();

  // response.body is a Buffer
  return response.body;
}

// Streaming response
async function streamLargeFile(url: string) {
  const response = await SmartRequestClient.create()
    .url(url)
    .responseType('stream')
    .get();

  // response is a stream
  response.on('data', (chunk) => {
    console.log(`Received ${chunk.length} bytes of data`);
  });

  return new Promise((resolve, reject) => {
    response.on('end', resolve);
    response.on('error', reject);
  });
}
```

### Pagination Support

The modern API includes built-in support for various pagination strategies:

```typescript
import { SmartRequestClient, PaginationStrategy } from '@push.rocks/smartrequest';

// Offset-based pagination (page & limit)
async function fetchAllUsers() {
  const client = SmartRequestClient.create()
    .url('https://api.example.com/users')
    .withOffsetPagination({
      pageParam: 'page',
      limitParam: 'limit',
      startPage: 1,
      pageSize: 20,
      totalPath: 'meta.total'
    });

  // Get first page with pagination info
  const firstPage = await client.getPaginated();
  console.log(`Found ${firstPage.items.length} users on first page`);
  console.log(`Has more pages: ${firstPage.hasNextPage}`);

  if (firstPage.hasNextPage) {
    // Get next page
    const secondPage = await firstPage.getNextPage();
    console.log(`Found ${secondPage.items.length} more users`);
  }

  // Or get all pages at once (use with caution for large datasets)
  const allUsers = await client.getAllPages();
  console.log(`Retrieved ${allUsers.length} users in total`);
}

// Cursor-based pagination
async function fetchAllPosts() {
  const allPosts = await SmartRequestClient.create()
    .url('https://api.example.com/posts')
    .withCursorPagination({
      cursorParam: 'cursor',
      cursorPath: 'meta.nextCursor',
      hasMorePath: 'meta.hasMore'
    })
    .getAllPages();

  console.log(`Retrieved ${allPosts.length} posts in total`);
}

// Link header-based pagination (GitHub API style)
async function fetchAllIssues(repo: string) {
  const paginatedResponse = await SmartRequestClient.create()
    .url(`https://api.github.com/repos/${repo}/issues`)
    .header('Accept', 'application/vnd.github.v3+json')
    .withLinkPagination()
    .getPaginated();

  return paginatedResponse.getAllPages();
}
```

### Convenience Factory Functions

The library provides several factory functions for common use cases:

```typescript
import { createJsonClient, createBinaryClient, createStreamClient } from '@push.rocks/smartrequest';

// Pre-configured for JSON requests
const jsonClient = createJsonClient()
  .url('https://api.example.com/data')
  .get();

// Pre-configured for binary data
const binaryClient = createBinaryClient()
  .url('https://example.com/image.jpg')
  .get();

// Pre-configured for streaming
const streamClient = createStreamClient()
  .url('https://example.com/large-file')
  .get();
```

Through its comprehensive set of features tailored for modern web development, `@push.rocks/smartrequest` aims to provide developers with a powerful tool for handling HTTP/HTTPS requests efficiently. Whether it's a simple API call, handling form data, processing streams, or working with paginated APIs, `@push.rocks/smartrequest` delivers a robust, type-safe solution to fit your project's requirements.

## Migration Guide: Legacy API to Modern API

If you're currently using the legacy API and want to migrate to the modern fluent API, here's a quick reference guide:

| Legacy API | Modern API |
|------------|------------|
| `getJson(url)` | `SmartRequestClient.create().url(url).get()` |
| `postJson(url, { requestBody: data })` | `SmartRequestClient.create().url(url).json(data).post()` |
| `putJson(url, { requestBody: data })` | `SmartRequestClient.create().url(url).json(data).put()` |
| `delJson(url)` | `SmartRequestClient.create().url(url).delete()` |
| `postFormData(url, {}, fields)` | `SmartRequestClient.create().url(url).formData(fields).post()` |
| `getStream(url)` | `SmartRequestClient.create().url(url).responseType('stream').get()` |
| `request(url, options)` | `SmartRequestClient.create().url(url).[...configure options...].get()` |

The modern API provides more flexibility and better TypeScript integration, making it the recommended approach for new projects.

## License and Legal Information

This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.

**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.

### Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.

### Company Information

Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany

For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.

By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.