jinqu-ng-http v1.1.7

jinqu-ng-http

Jinqu Angular HttpClient Ajax provider for the jinqu-odata ODataService. Usage:

import { Injectable } from "@angular/core";
import { HttpClient, HttpResponseBase } from "@angular/common/http";
import { ODataService, ODataQuery } from 'jinqu-odata';
import { AjaxOptions } from "jinqu";
import { AngularHttpProvider } from 'jinqu-ng-http';
import { Product } from '../model/all-models';

export type NgODataQuery<T extends object> = ODataQuery<T, AjaxOptions, HttpResponseBase>;

@Injectable()
export class NorthwindContext extends ODataService<HttpResponseBase> {
  constructor(http: HttpClient) {
    super('api/', new AngularHttpProvider(http));
  }

  get products(): NgODataQuery<Product> { return this.createQuery<Product>('products'); }
}

Date/Time values

By default jinqu-odata represents OData Date and DateTimeOffset values as strings. You may want to represent them as Date objects in your data model. JSON.stringify() automatically converts Date objects to ISO 8601 format with zero timezone when data is being sent, but JSON.parse() leaves dates as strings on reception. You may pass one of the predefined JSON converter static classes (JsonDateOnlyConverter, JsonDateTimeOffsetConverter or JsonDateConverter) as the second parameter to the AngularHttpProvider constructor, e.g.

import { AngularHttpProvider, JsonDateConverter } from 'jinqu-ng-http';
...
const ngHttpProv = new AngularHttpProvider(http, JsonDateConverter);

Built-in converters makes conversion from string to Date object if a property value matches the respective RegExp mask:

• JsonDateOnlyConverter: convertes OData Date values (e.g. '2012-12-03') to JS Date on receive;
• JsonDateTimeOffsetConverter: convertes DateTimeOffset values (e.g. '2012-12-03T07:16:23Z') to JS Date on receive, stringifies JS Date to ISO 8601 Extended Format with local timezone;
• JsonDateConverter: covers both cases.

You may want to use ts-odata-model-gen with --useDateProps option to generate data models with Edm.Date and Edm.DateTimeOffset fields as Date objects from OData service $metadata endpoint.

Custom converter

You can also write your own implementation of IJsonConverter interface in order to take full control over any data conversion upon sending or receiving:

export class SomeJsonConverter {
    // receive
    public static revive(this: any, key: string, value: any): any {
        if (typeof value === 'string' && value === "orange") {
            return "potatoes";
        } else {
            return value;
        }
    }
    // send
    public static replace(this: any, key: string, value: any): any {
        if (typeof value === 'string' && key === "product") {
            return 'orange';
        } else {
            return value;
        }
    }
}

SomeJsonConverter.revive and SomeJsonConverter.replace will be passed as the second argument to JSON.parse() and JSON.stringify() respectively.

Error handling

If an error is returned by the underlying service as an HTTP payload, jinqu-ng-http reads it from Blob and returns in HttpErrorResponse.error field. If the error is a JSON object, it is returned as an object. E.g. for OData v4 errors:

context.products().toArrayAsync()
    .then((result: Product[]) => {
        ...
    }, (httpErr: HttpErrorResponse) => {
        const errMsg = httpErr.error?.error ? `${httpErr.error.error.code} ${httpErr.error.error.message}` :
            httpErr.message ? httpErr.message :
                httpErr.status ? `${httpErr.status} ${httpErr.statusText}` :
                    'Server or network error';
        console.log(errMsg);
    }
);