@utiliread/http 1.16.2 → 1.17.2

package/dist/index.d.ts

@@ -0,0 +1,227 @@
+export interface Subscription {
+    dispose(): void;
+}
+export type ProblemDetails = {
+    detail?: string;
+    instance?: string;
+    status?: number;
+    title?: string;
+    type: string;
+} & Record<string, any>;
+export class HttpError extends Error {
+    statusCode: number;
+    get hasDetails(): boolean | undefined;
+    constructor(statusCode: number, response?: HttpResponse | undefined);
+    details<TDetails = ProblemDetails>(): Promise<TDetails>;
+}
+export class HttpResponse {
+    rawResponse: Response;
+    get url(): string;
+    get statusCode(): number;
+    get headers(): Headers;
+    get isInformational(): boolean;
+    get isSuccessful(): boolean;
+    get isRedirection(): boolean;
+    get isClientError(): boolean;
+    get isServerError(): boolean;
+    constructor(rawResponse: Response);
+    ensureSuccessfulStatusCode(): this;
+}
+export class HttpResponseOfT<T> extends HttpResponse {
+    constructor(rawResponse: Response, handler: (response: HttpResponse) => Promise<T>);
+    receive(): Promise<T>;
+}
+export class TimeoutError extends Error {
+    constructor();
+}
+export class HttpBuilder {
+    message: Message;
+    options: RequestOptions;
+    constructor(message: Message, options: RequestOptions, /** @internal */ http: Http);
+    onSend(callback: (request: Message) => void | Promise<void>): this;
+    onSent(callback: (response: HttpResponse, request: Message) => void | Promise<void>): this;
+    useHandler<T>(handler: (response: HttpResponse) => Promise<T>): HttpBuilderOfT<T>;
+    send(abortSignal?: AbortSignal): Promise<HttpResponse>;
+    getUrl(): string;
+    ensureSuccessStatusCode(ensureSuccessStatusCode?: boolean): this;
+    useCors(mode: RequestMode): this;
+    useTimeout(timeout: number | null): this;
+    with(content: any, contentType?: string): this;
+    withForm(content: FormData): this;
+    addHeader(name: string, value: string): this;
+    expectString(): HttpBuilderOfT<string>;
+    expectBinary(): HttpBuilderOfT<ArrayBuffer>;
+}
+export class HttpBuilderOfT<T> extends HttpBuilder {
+    constructor(inner: HttpBuilder, handler: (response: HttpResponse) => Promise<T>);
+    onSend(callback: (request: Message) => void | Promise<void>): this;
+    onSent(callback: (response: HttpResponse, request: Message) => void | Promise<void>): this;
+    ensureSuccessStatusCode(ensureSuccessStatusCode?: boolean): this;
+    useCors(mode: RequestMode): this;
+    useTimeout(timeout: number): this;
+    allowEmptyResponse(): HttpBuilderOfT<T | null>;
+    onReceived(callback: (response: HttpResponseOfT<T>, request: Message, value: T) => void | Promise<void>): this;
+    send(abortSignal?: AbortSignal): SendPromise<T>;
+    transfer(abortSignal?: AbortSignal): Promise<T>;
+}
+type HttpMethod = "HEAD" | "POST" | "GET" | "PUT" | "PATCH" | "DELETE";
+export interface Message {
+    method: HttpMethod;
+    url: string;
+    headers: Headers;
+    content?: any;
+    contentType?: string;
+    mode?: RequestMode;
+    properties: {
+        [key: string]: any;
+    };
+}
+interface RequestOptions {
+    fetch: Fetch;
+    timeout?: number;
+    baseUrl?: string;
+}
+interface SendPromise<T> extends Promise<HttpResponseOfT<T>> {
+    thenReceive(): Promise<T>;
+}
+export class QueryString {
+    static serialize(params: any): string;
+    static append(url: string, params: any): string;
+    static getParameter(name: string): string | null | undefined;
+}
+export type Fetch = (input: RequestInfo, init?: RequestInit) => Promise<Response>;
+export class Http {
+    static defaults: HttpOptions;
+    options: HttpOptions;
+    constructor(options?: Partial<HttpOptions>);
+    static request(method: HttpMethod, url: string, params?: any): HttpBuilder;
+    static head(url: string, params?: any): HttpBuilder;
+    static post(url: string, params?: any): HttpBuilder;
+    static get(url: string, params?: any): HttpBuilder;
+    static put(url: string, params?: any): HttpBuilder;
+    static patch(url: string, params?: any): HttpBuilder;
+    static delete(url: string, params?: any): HttpBuilder;
+    request(method: HttpMethod, url: string, params?: any): HttpBuilder;
+    head(url: string, params?: any): HttpBuilder;
+    post(url: string, params?: any): HttpBuilder;
+    get(url: string, params?: any): HttpBuilder;
+    put(url: string, params?: any): HttpBuilder;
+    patch(url: string, params?: any): HttpBuilder;
+    delete(url: string, params?: any): HttpBuilder;
+    onSend(callback: (request: Message) => void | Promise<void>): Subscription;
+    onSent(callback: (response: HttpResponse, request: Message) => void | Promise<void>): Subscription;
+    onReceived(callback: (response: HttpResponseOfT<any>, request: Message, value: any) => void | Promise<void>): Subscription;
+}
+interface HttpOptions {
+    fetch?: Fetch;
+    timeout?: number;
+    baseUrl?: string;
+}
+export interface Page {
+    number?: number;
+    size: number;
+}
+export interface PaginationResult<T> {
+    meta: {
+        pageCount: number;
+        pageSize: number;
+        totalItems: number;
+    };
+    data: T[];
+}
+export interface InfinitePage {
+    continuationToken?: string;
+    size: number;
+}
+export interface InfinitePaginationResult<T> {
+    meta: {
+        pageSize: number;
+        continuationToken: string | null;
+    };
+    data: T[];
+}
+interface Events {
+    sent: (response: HttpResponse, request: Message) => void | Promise<void>;
+}
+interface EventsOfT<T> extends Events {
+    received: (response: HttpResponse, request: Message, value: T) => void | Promise<void>;
+}
+export function events<P extends any[]>(action: (...params: P) => HttpBuilder, configure: (...params: P) => Partial<Events>): (...params: P) => HttpBuilder;
+export function events<B extends HttpBuilderOfT<T>, P extends any[], T>(action: (...params: P) => B, configure: (...params: P) => Partial<EventsOfT<T>>): (...params: P) => B;
+export function isHttpError(error: Error): error is HttpError;
+export function isAbortError(error: Error): boolean;
+export function isTimeoutError(error: Error): error is TimeoutError;
+export const statusCodes: Readonly<{
+    status100Continue: number;
+    status101SwitchingProtocols: number;
+    status102Processing: number;
+    status200OK: number;
+    status201Created: number;
+    status202Accepted: number;
+    status203NonAuthoritative: number;
+    status204NoContent: number;
+    status205ResetContent: number;
+    status206PartialContent: number;
+    status207MultiStatus: number;
+    status208AlreadyReported: number;
+    status226IMUsed: number;
+    status300MultipleChoices: number;
+    status301MovedPermanently: number;
+    status302Found: number;
+    status303SeeOther: number;
+    status304NotModified: number;
+    status305UseProxy: number;
+    status306SwitchProxy: number;
+    status307TemporaryRedirect: number;
+    status308PermanentRedirect: number;
+    status400BadRequest: number;
+    status401Unauthorized: number;
+    status402PaymentRequired: number;
+    status403Forbidden: number;
+    status404NotFound: number;
+    status405MethodNotAllowed: number;
+    status406NotAcceptable: number;
+    status407ProxyAuthenticationRequired: number;
+    status408RequestTimeout: number;
+    status409Conflict: number;
+    status410Gone: number;
+    status411LengthRequired: number;
+    status412PreconditionFailed: number;
+    status413RequestEntityTooLarge: number;
+    status413PayloadTooLarge: number;
+    status414RequestUriTooLong: number;
+    status414UriTooLong: number;
+    status415UnsupportedMediaType: number;
+    status416RequestedRangeNotSatisfiable: number;
+    status416RangeNotSatisfiable: number;
+    status417ExpectationFailed: number;
+    status418ImATeapot: number;
+    status419AuthenticationTimeout: number;
+    status421MisdirectedRequest: number;
+    status422UnprocessableEntity: number;
+    status423Locked: number;
+    status424FailedDependency: number;
+    status426UpgradeRequired: number;
+    status428PreconditionRequired: number;
+    status429TooManyRequests: number;
+    status431RequestHeaderFieldsTooLarge: number;
+    status451UnavailableForLegalReasons: number;
+    status500InternalServerError: number;
+    status501NotImplemented: number;
+    status502BadGateway: number;
+    status503ServiceUnavailable: number;
+    status504GatewayTimeout: number;
+    status505HttpVersionNotsupported: number;
+    status506VariantAlsoNegotiates: number;
+    status507InsufficientStorage: number;
+    status508LoopDetected: number;
+    status510NotExtended: number;
+    status511NetworkAuthenticationRequired: number;
+}>;
+type Type<T> = {
+    new (): T;
+};
+type Mapper<T> = ((source: any) => T);
+export type TypeOrMapper<T> = Type<T> | Mapper<T>;
+
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AA6BA;IACI,OAAO,IAAI,IAAI,CAAC;CACnB;AC/BD,6BAA6B;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CAChB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;ACHxB,sBAAuB,SAAQ,KAAK;IAQb,UAAU,EAAE,MAAM;IALrC,IAAI,UAAU,wBAGb;gBAEkB,UAAU,EAAE,MAAM,EAAU,QAAQ,GAAE,YAAY,GAAG,SAAqB;IAS7F,OAAO,CAAC,QAAQ,GAAG,cAAc;CAUpC;AC5BD;IAiCqB,WAAW,EAAE,QAAQ;IAhCxC,IAAI,GAAG,WAEN;IAED,IAAI,UAAU,WAEb;IAED,IAAI,OAAO,YAEV;IAED,IAAI,eAAe,YAElB;IAED,IAAI,YAAY,YAEf;IAED,IAAI,aAAa,YAEhB;IAED,IAAI,aAAa,YAEhB;IAED,IAAI,aAAa,YAEhB;gBAEkB,WAAW,EAAE,QAAQ;IAEjC,0BAA0B;CAOlC;AAED,6BAA6B,CAAC,CAAE,SAAQ,YAAY;gBAEhD,WAAW,EAAE,QAAQ,EACb,OAAO,EAAE,CAAC,QAAQ,EAAE,YAAY,KAAK,OAAO,CAAC,CAAC,CAAC;IAKzD,OAAO;CAGR;ACzDD,yBAA0B,SAAQ,KAAK;;CAStC;ACHD;IAKuB,OAAO,EAAE,OAAO;IAAS,OAAO,EAAE,cAAc;gBAAhD,OAAO,EAAE,OAAO,EAAS,OAAO,EAAE,cAAc,EAAE,gBAAgB,CAAQ,IAAI,EAAE,IAAI;IAGvG,MAAM,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAK3D,MAAM,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAKnF,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,QAAQ,EAAE,YAAY,KAAK,OAAO,CAAC,CAAC,CAAC;IAIvD,IAAI,CAAC,WAAW,CAAC,EAAE,WAAW;IA0DpC,MAAM;IAkBN,uBAAuB,CAAC,uBAAuB,CAAC,EAAE,OAAO;IAMzD,OAAO,CAAC,IAAI,EAAE,WAAW;IAKzB,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAOjC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,MAAM;IAMvC,QAAQ,CAAC,OAAO,EAAE,QAAQ;IAQ1B,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAOrC,YAAY;IAMZ,YAAY;CAKf;AAED,4BAA4B,CAAC,CAAE,SAAQ,WAAW;gBAG1B,KAAK,EAAE,WAAW,EAAU,OAAO,EAAE,CAAC,QAAQ,EAAE,YAAY,KAAK,OAAO,CAAC,CAAC,CAAC;IAI/F,MAAM,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAK3D,MAAM,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAKnF,uBAAuB,CAAC,uBAAuB,CAAC,EAAE,OAAO;IAKzD,OAAO,CAAC,IAAI,EAAE,WAAW;IAKzB,UAAU,CAAC,OAAO,EAAE,MAAM;IAK1B,kBAAkB;IAclB,UAAU,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAKvG,IAAI,CAAC,WAAW,CAAC,EAAE,WAAW;IAM9B,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW;CAarC;AAED,kBAAyB,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE9E;IACI,MAAM,EAAE,UAAU,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,UAAU,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,CAAC;CACpC;AAED;IACI,KAAK,EAAE,KAAK,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,sBAA6B,CAAC,CAAE,SAAQ,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC/D,WAAW,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;CAC7B;ACtPD;IACI,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,GAAG;IAW5B,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG;IAUtC,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM;CA6CnC;AC/DD,oBAAoB,CAClB,KAAK,EAAE,WAAW,EAClB,IAAI,CAAC,EAAE,WAAW,KACf,OAAO,CAAC,QAAQ,CAAC,CAAC;AAEvB;IACE,MAAM,CAAC,QAAQ,EAAE,WAAW,CAE1B;IAEF,OAAO,EAAE,WAAW,CAAC;gBAQT,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC;IAI1C,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG;IAI5D,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG;IAIrC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG;IAIrC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG;IAIpC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG;IAIpC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG;IAItC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG;IAavC,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG;IAuBrD,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG;IAI9B,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG;IAI9B,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG;IAI7B,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG;IAI7B,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG;IAI/B,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG;IAIhC,MAAM,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,YAAY;IAI1E,MAAM,CACJ,QAAQ,EAAE,CAAC,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAC3E,YAAY;IAIf,UAAU,CACR,QAAQ,EAAE,CACR,QAAQ,EAAE,gBAAgB,GAAG,CAAC,EAC9B,OAAO,EAAE,OAAO,EAChB,KAAK,EAAE,GAAG,KACP,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GACxB,YAAY;CAGhB;AAED;IACE,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;ACzID;IACI,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,kCAAkC,CAAC;IAC/B,IAAI,EAAE;QACF,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,IAAI,EAAE,CAAC,EAAE,CAAC;CACb;AAED;IACI,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,0CAA0C,CAAC;IACvC,IAAI,EAAE;QACF,QAAQ,EAAE,MAAM,CAAC;QACjB,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;KACpC,CAAC;IACF,IAAI,EAAE,CAAC,EAAE,CAAC;CACb;ACtBD;IACE,IAAI,EAAE,CAAC,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1E;AAED,oBAAoB,CAAC,CAAE,SAAQ,MAAM;IACnC,QAAQ,EAAE,CACR,QAAQ,EAAE,YAAY,EACtB,OAAO,EAAE,OAAO,EAChB,KAAK,EAAE,CAAC,KACL,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3B;AAED,uBAAuB,CAAC,SAAS,GAAG,EAAE,EACpC,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,KAAK,WAAW,EACrC,SAAS,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,GAC3C,CAAC,GAAG,MAAM,EAAE,CAAC,KAAK,WAAW,CAAC;AACjC,uBAAuB,CAAC,SAAS,eAAe,CAAC,CAAC,EAAE,CAAC,SAAS,GAAG,EAAE,EAAE,CAAC,EACpE,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,KAAK,CAAC,EAC3B,SAAS,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,GACjD,CAAC,GAAG,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC;ACnBvB,4BAA4B,KAAK,EAAE,KAAK,GAAG,KAAK,IAAI,SAAS,CAE5D;AAED,6BAA6B,KAAK,EAAE,KAAK,GAAG,OAAO,CAElD;AAED,+BAA+B,KAAK,EAAE,KAAK,GAAG,KAAK,IAAI,YAAY,CAElE;ACbD,OAAO,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkEX,CAAC;ACjEH,UAAiB,CAAC,IAAI;IAAE,QAAO,CAAC,CAAA;CAAE,CAAC;AACnC,YAAmB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;AAC7C,yBAAyB,CAAC,IAAI,KAAK,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC","sources":["src/src/event-aggregator.ts","src/src/problem-details.ts","src/src/http-error.ts","src/src/http-response.ts","src/src/timeout-error.ts","src/src/http-builder.ts","src/src/query-string.ts","src/src/http.ts","src/src/pagination.ts","src/src/events.ts","src/src/helpers.ts","src/src/status-codes.ts","src/src/mapping.ts","src/src/index.ts","src/index.ts"],"sourcesContent":[null,null,null,null,null,null,null,null,null,null,null,null,null,null,"export { Http } from \"./http\";\nexport type {\n  Page,\n  PaginationResult,\n  InfinitePage,\n  InfinitePaginationResult,\n} from \"./pagination\";\nexport type { ProblemDetails } from \"./problem-details\";\nexport { QueryString } from \"./query-string\";\nexport { HttpResponse, HttpResponseOfT } from \"./http-response\";\nexport { HttpBuilder, HttpBuilderOfT } from \"./http-builder\";\nexport type { Message } from \"./http-builder\";\nexport { HttpError } from \"./http-error\";\nexport { TimeoutError } from \"./timeout-error\";\nexport { events } from \"./events\";\nexport * from \"./helpers\";\nexport type { Fetch } from \"./http\";\nexport type { Subscription } from \"./event-aggregator\";\nexport { statusCodes } from \"./status-codes\";\nexport type { TypeOrMapper } from \"./mapping\";"],"names":[],"version":3,"file":"index.d.ts.map"}