@ethlete/query 0.1.0-next.9 → 1.0.0

package/lib/request/request.types.d.ts

@@ -1,18 +1,66 @@
-export declare type Method = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS' | 'TRACE' | 'CONNECT' | 'PURGE' | 'LINK' | 'UNLINK' | 'GQL_QUERY' | 'GQL_MUTATE' | 'CUSTOM';
+import { HttpStatusCode } from './request.util';
+export type Method = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS' | 'TRACE' | 'CONNECT' | 'PURGE' | 'LINK' | 'UNLINK' | 'GQL_QUERY' | 'GQL_MUTATE' | 'CUSTOM';
 export interface RequestError<Detail = unknown> {
-    code: number;
-    message: string;
+    url: string;
+    status: HttpStatusCode;
+    statusText: string;
     detail: Detail;
-    raw: unknown;
-    route: string;
-    requestInit?: RequestInit;
 }
-export declare type ParamPrimitive = string | number | boolean | null | undefined;
-export declare type Params = Record<string | number | symbol, ParamPrimitive | ParamArray>;
-export declare type ParamArray = Array<ParamPrimitive>;
-export declare type UnfilteredParamPrimitive = string | number | boolean | null | undefined;
-export declare type QueryParams = Record<string | number | symbol, UnfilteredParamPrimitive | UnfilteredParamArray>;
-export declare type PathParams = Record<string, string | number>;
-export declare type UnfilteredParamArray = Array<UnfilteredParamPrimitive>;
-export declare type CacheAdapterFn = (headers: Headers) => number | null;
-export declare type RequestHeaders = Record<string, string>;
+export type ParamPrimitive = string | number | boolean | null | undefined;
+export type Params = Record<string | number | symbol, ParamPrimitive | ParamArray>;
+export type ParamArray = Array<ParamPrimitive>;
+export type UnfilteredParamPrimitive = string | number | boolean | null | undefined;
+export type QueryParams = Record<string | number | symbol, UnfilteredParamPrimitive | UnfilteredParamArray>;
+export type PathParams = Record<string, string | number>;
+export type UnfilteredParamArray = Array<UnfilteredParamPrimitive>;
+export type CacheAdapterFn = (headers: RequestHeaders) => number | null;
+export type RequestHeaders = Record<string, string>;
+export type RequestHeadersMethodMap = {
+    [M in Method]?: RequestHeaders;
+};
+export interface PartialXhrState {
+    headers: RequestHeaders;
+    status: number;
+    statusText: string;
+    url: string;
+}
+export interface RequestConfig {
+    method: Method;
+    urlWithParams: string;
+    body?: unknown;
+    reportProgress?: boolean;
+    withCredentials?: boolean;
+    responseType?: 'arraybuffer' | 'blob' | 'json' | 'text';
+    headers?: RequestHeaders;
+    cacheAdapter?: CacheAdapterFn;
+}
+export type RequestProgress = {
+    current: number;
+    percentage?: number;
+    total?: number;
+};
+export type RequestEvent<Response = unknown> = {
+    type: 'start';
+    headers: RequestHeaders;
+} | {
+    type: 'download-progress';
+    headers: RequestHeaders;
+    progress: RequestProgress;
+    partialText?: string;
+} | {
+    type: 'upload-progress';
+    headers: RequestHeaders;
+    progress: RequestProgress;
+} | {
+    type: 'success';
+    headers: RequestHeaders;
+    response: Response;
+    expiresInTimestamp?: number;
+} | {
+    type: 'failure';
+    headers: RequestHeaders;
+    error: RequestError;
+} | {
+    type: 'cancel';
+    headers: RequestHeaders;
+};

package/lib/request/request.util.d.ts

@@ -1,6 +1,5 @@
-import { Method, ParamArray, Params, QueryParams, RequestError, UnfilteredParamPrimitive } from './request.types';
-export declare const isRequestError: (error: unknown) => error is RequestError<unknown>;
-export declare const isAbortRequestError: (error: unknown) => error is RequestError<unknown>;
+import { Method, ParamArray, Params, QueryParams, RequestError, RequestHeaders, UnfilteredParamPrimitive } from './request.types';
+export declare const isRequestError: <T = unknown>(error: unknown) => error is RequestError<T>;
 export declare const buildRoute: (options: {
     base: string;
     route: string | ((args: Record<string, unknown>) => string) | null | undefined;
@@ -12,9 +11,77 @@ export declare const buildQueryArrayString: (key: string, array: ParamArray) =>
 export declare const isFetchResponse: (response: unknown) => response is Response;
 export declare const filterInvalidParams: (params: QueryParams) => Params;
 export declare const isParamValid: (primitive: UnfilteredParamPrimitive) => boolean;
-export declare const extractExpiresInSeconds: (headers: Headers) => number | null;
+export declare const extractExpiresInSeconds: (headers: RequestHeaders) => number | null;
 export declare const buildTimestampFromSeconds: (seconds: number | null) => number | null;
-export declare const buildRequestError: <ErrorResponse = unknown>(error: unknown, route: string, requestInit?: RequestInit) => Promise<RequestError<null> | RequestError<ErrorResponse>>;
-export declare const buildBody: (body: unknown) => string | FormData | null;
+export declare const serializeBody: (body: unknown) => ArrayBuffer | Blob | FormData | string | null;
 export declare const transformMethod: (method: Method) => "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS" | "TRACE" | "CONNECT" | "PURGE" | "LINK" | "UNLINK" | "CUSTOM";
-export declare const guessContentType: (body: unknown) => "text/plain" | "multipart/form-data" | "application/json" | null;
+export declare const detectContentTypeHeader: (body: unknown) => string | null;
+export declare const hasHeader: (headers: RequestHeaders, header: string) => boolean;
+export declare const forEachHeader: (headers: RequestHeaders, callback: (value: string, key: string) => void) => void;
+export declare const parseAllXhrResponseHeaders: (xhr: XMLHttpRequest) => RequestHeaders;
+export declare const getResponseUrl: (xhr: XMLHttpRequest) => string | null;
+export declare const enum HttpStatusCode {
+    Continue = 100,
+    SwitchingProtocols = 101,
+    Processing = 102,
+    EarlyHints = 103,
+    Ok = 200,
+    Created = 201,
+    Accepted = 202,
+    NonAuthoritativeInformation = 203,
+    NoContent = 204,
+    ResetContent = 205,
+    PartialContent = 206,
+    MultiStatus = 207,
+    AlreadyReported = 208,
+    ImUsed = 226,
+    MultipleChoices = 300,
+    MovedPermanently = 301,
+    Found = 302,
+    SeeOther = 303,
+    NotModified = 304,
+    UseProxy = 305,
+    Unused = 306,
+    TemporaryRedirect = 307,
+    PermanentRedirect = 308,
+    BadRequest = 400,
+    Unauthorized = 401,
+    PaymentRequired = 402,
+    Forbidden = 403,
+    NotFound = 404,
+    MethodNotAllowed = 405,
+    NotAcceptable = 406,
+    ProxyAuthenticationRequired = 407,
+    RequestTimeout = 408,
+    Conflict = 409,
+    Gone = 410,
+    LengthRequired = 411,
+    PreconditionFailed = 412,
+    PayloadTooLarge = 413,
+    UriTooLong = 414,
+    UnsupportedMediaType = 415,
+    RangeNotSatisfiable = 416,
+    ExpectationFailed = 417,
+    ImATeapot = 418,
+    MisdirectedRequest = 421,
+    UnprocessableEntity = 422,
+    Locked = 423,
+    FailedDependency = 424,
+    TooEarly = 425,
+    UpgradeRequired = 426,
+    PreconditionRequired = 428,
+    TooManyRequests = 429,
+    RequestHeaderFieldsTooLarge = 431,
+    UnavailableForLegalReasons = 451,
+    InternalServerError = 500,
+    NotImplemented = 501,
+    BadGateway = 502,
+    ServiceUnavailable = 503,
+    GatewayTimeout = 504,
+    HttpVersionNotSupported = 505,
+    VariantAlsoNegotiates = 506,
+    InsufficientStorage = 507,
+    LoopDetected = 508,
+    NotExtended = 510,
+    NetworkAuthenticationRequired = 511
+}

package/package.json

@@ -1,16 +1,13 @@
 {
   "name": "@ethlete/query",
-  "version": "0.1.0-next.9",
+  "version": "1.0.0",
   "dependencies": {
     "tslib": "^2.3.0"
   },
   "peerDependencies": {
     "@angular/common": "^14.2.0 || ^15.0.0",
     "@angular/core": "^14.2.0 || ^15.0.0",
-    "rxjs": "7.5.7",
-    "@ethlete/core": "0.2.0-next.8",
-    "@angular/forms": "15.0.1",
-    "@angular/router": "15.0.1"
+    "@ethlete/core": "1.0.0"
   },
   "module": "fesm2015/ethlete-query.mjs",
   "es2020": "fesm2020/ethlete-query.mjs",