# @lcgroup.core/api

> Angular HttpClient simplifier

Latest version **8.0.0** (published 2023-01-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @lcgroup.core/api
pnpm add @lcgroup.core/api
yarn add @lcgroup.core/api
bun add @lcgroup.core/api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 8.0.0 |
| Published | 2023-01-23 |
| First published | 2020-06-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 14.0.0 |
| Dependencies | 1 |
| Unpacked size | 127.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Sergey Romanchuk |
| Maintainers | romanchuk, fayriot, vreactor, quis0 |
| Keywords | api, angular, http, HttpClient, Rest api |

## Links

- npm: https://www.npmjs.com/package/@lcgroup.core/api
- Repository: http://fomina.oa@srv-rep.lime.local:10000/Packages/protoarch
- Homepage: http://srv-rep.lime.local:10000/Packages/protoarch
- npm.io page: https://npm.io/package/@lcgroup.core/api

## Dependencies (1)

- [tslib](https://npm.io/package/tslib.md) ^2.1.0

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 8.0.0 (latest) — 2023-01-23
- 6.0.0-0 (next) — 2021-02-26
- 6.0.0 — 2021-03-24
- 5.0.0 — 2020-07-02
- 4.0.0 — 2020-06-08
- 3.0.0 — 2020-06-04

## README

# @lcgroup.core/api

Angular 9+ HttpClient wrapper for simplify usage

## Features

- endpoint setup
- serializing libraries support
- asp.net web api query string format

### Endpoint setup

Setted up endpoint will prepend any request with relative url: '/exaple'.
Absolute urls in request would not be prepended or modified: 'https://www.yandex.ru/api'.
**Endpoint is optional**: if you don't specify it, requests will be relative to the current domain.

### Serializer

Serialization/deserialization mechanism for your requests to automaticaly convert classes to request json and then convert response json to your domain classes.
Use **any serializer** that **fits ISerializer** interface. For example json2typescript or your custom serializer.

```typescript
export interface ISerializer {
    serialize(data: any): any;
    deserialize(data: any, T?: { new (): any; }): any;
}
```

### Query string builder

Native angular HttpClient query string params builder was changed to custom (WebApiHttpParams) due incorrect query string binding with asp.net web api. **WebApiHttpParams** requrcively analyses any complex object and builds correct query string.

```typescript
it('should serialize complex object to query string', () => {
      const complexObj: any = {
          numeric: 1,
          float: 1.40,
          string: 'text',
          subObject: {
              prop1: 'a',
              prop2: 'b'
          },
          arrayPrimitive: [1],
          arrayObjects: [
              {
                  value: 1
              },
              {
                  value: 2
              }
          ]
      };

      const params = new WebApiHttpParams({ fromObject: complexObj });
      expect(params.toString()).toEqual('numeric=1&float=1.4&string=text&subObject[prop1]=a&subObject[prop2]=b&arrayPrimitive=1&arrayObjects[value]=1&arrayObjects[value]=2');
});
```

## Installation

Installation via npm `npm install @lcgroup.core/api`.

## Example

Example [`json2typescript`](https://www.npmjs.com/package/json2typescript) library:

```typescript
import { CommonModule } from '@angular/common';
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { ApiModule, SERIALIZER_OPTIONS } from '@lcgroup.core/api';
import { AppComponent } from './app.component';
import { JsonConvert, ValueCheckingMode } from 'json2typescript';

export function serializerFactory() {
    const jsonConverter = new JsonConvert();
    jsonConverter.ignorePrimitiveChecks = true;
    jsonConverter.valueCheckingMode = ValueCheckingMode.ALLOW_NULL;
    return jsonConverter;
}

@NgModule({
  declarations: [
    AppComponent,
  ],
  imports: [
    CommonModule,
    BrowserModule,
    ApiModule.forRoot(
        '/api',
        {
            serializeProvider: {
              provide: SERIALIZER_OPTIONS,
              useFactory: serializerFactory
            }
        }
    )
  ],
  bootstrap: [AppComponent]
})
export class AppModule { }

```

Deserialize json to ClientsFilterResult:
```typescript

@Injectable()
export class ClientsService {
  constructor(private api: Api) { }

  public getClientsList(filter: ClientInfoFilterDto): Observable<ClientsFilterResult> {
    return this.api.post(`/clients/search`, filter, { deserializeTo: ClientsFilterResult });
  }
}
```

---
_Source: https://npm.io/package/@lcgroup.core/api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._