axios-annotations 1.3.0 → 1.3.1

package/core/config.d.ts

@@ -0,0 +1,29 @@
+import {AxiosInstance} from "axios";
+
+export default class Config {
+    constructor(protocol?: string, host?: string, port?: number, prefix?: string, plugins?: ((config: Config) => void)[]);
+
+    static forName(name: string): Config;
+
+    host: string;
+
+    port: number | null | string;
+
+    protocol: string;
+
+    prefix: string;
+
+    origin: string;
+
+    baseURL: string;
+
+    axios: AxiosInstance;
+
+    plugins: ((config: Config) => void)[];
+
+    register(name: string): Config;
+
+    unregister(): Config;
+}
+
+export const config: Config;

package/core/parser.d.ts

@@ -0,0 +1,15 @@
+declare const URLSearchParamsParser: {
+    encode: (encoder: object) => string;
+
+    decode: (data: object) => object;
+
+    has: (encoder: object, key: string) => boolean;
+
+    delete: (encoder: object, key: string) => void;
+
+    get: (encoder: object, key: string) => any;
+
+    append: (encoder: object, key: string, value: any) => void;
+}
+
+export default URLSearchParamsParser;

package/core/service.d.ts

@@ -0,0 +1,33 @@
+import Config from "./config";
+import {AxiosPromise, AxiosRequestConfig} from "axios";
+import {AbortControllerAdapter} from "../decorator/abort-source";
+
+export interface RequestController {
+    ignoreResidualParams: (ignore?: boolean) => RequestController;
+
+    param: (key: string, required?: boolean) => RequestController;
+
+    header: (header: string, value: string | ((...args: any[]) => string)) => RequestController;
+
+    body: (key: string) => RequestController;
+
+    config: (config: Partial<AxiosRequestConfig>) => RequestController;
+
+    send: (data?: Record<string, any>) => AxiosPromise<any>;
+
+    with: (registration: string) => RequestController;
+
+    abort: (abortController: (AbortController | AbortControllerAdapter) | ((...args: any[]) => (AbortControllerAdapter | AbortController))) => RequestController;
+}
+
+export default class Service {
+    constructor(path?: string);
+
+    config: Config;
+
+    path: string;
+
+    request(method: string, path: string, data?: any, config?: Partial<AxiosRequestConfig>): AxiosPromise<any>;
+
+    requestWith(method: string, path?: string): RequestController;
+}

package/decorator/abort-source.d.ts

@@ -0,0 +1,9 @@
+import {AxiosPromise, CancelToken} from "axios";
+
+export class AbortControllerAdapter {
+    constructor(CancelToken: CancelToken);
+
+    abort(reason?: string): void;
+}
+
+export default function AbortSource(abortController: (AbortController | AbortControllerAdapter) | ((...args: any[]) => (AbortController | AbortControllerAdapter))): (() => AxiosPromise<any>);

package/decorator/delete-mapping.d.ts

@@ -0,0 +1,3 @@
+import {AxiosPromise} from "axios";
+
+export default function DeleteMapping(path?: string): (() => AxiosPromise<any>);

package/decorator/get-mapping.d.ts

@@ -0,0 +1,3 @@
+import {AxiosPromise} from "axios";
+
+export default function GetMapping(path?: string): (() => AxiosPromise<any>);

package/decorator/ignore-residual-params.d.ts

@@ -0,0 +1,3 @@
+import {AxiosPromise} from "axios";
+
+export default function IgnoreResidualParams(ignore?: boolean): (() => AxiosPromise<any>);

package/decorator/patch-mapping.d.ts

@@ -0,0 +1,3 @@
+import {AxiosPromise} from "axios";
+
+export default function PatchMapping(path?: string): (() => AxiosPromise<any>);

package/decorator/post-mapping.d.ts

@@ -0,0 +1,3 @@
+import {AxiosPromise} from "axios";
+
+export default function PostMapping(path?: string): (() => AxiosPromise<any>);

package/decorator/put-mapping.d.ts

@@ -0,0 +1,3 @@
+import {AxiosPromise} from "axios";
+
+export default function PutMapping(path?: string): (() => AxiosPromise<any>);

package/decorator/request-body.d.ts

@@ -0,0 +1,3 @@
+import {AxiosPromise} from "axios";
+
+export default function RequestBody(name?: string): (() => AxiosPromise<any>);

package/decorator/request-config.d.ts

@@ -0,0 +1,7 @@
+import {AxiosPromise, AxiosRequestConfig} from "axios";
+import Config from "../core/config";
+import Service from "../core/service";
+
+export default function RequestConfig(config: Config): (() => Service);
+
+export default function RequestConfig(config: ((...args: any[]) => Partial<AxiosRequestConfig>) | Partial<AxiosRequestConfig>): (() => AxiosPromise<any>);

package/decorator/request-header.d.ts

@@ -0,0 +1,5 @@
+import {AxiosPromise} from "axios";
+
+export default function RequestHeader(header: string, value: string): (() => AxiosPromise<any>);
+
+export default function RequestHeader(header: string, value: ((...args: any[]) => string)): (() => AxiosPromise<any>);

package/decorator/request-mapping.d.ts

@@ -0,0 +1,6 @@
+import {AxiosPromise} from "axios";
+import Service from "../core/service";
+
+export default function RequestMapping(path: string, method: string): (() => AxiosPromise<any>);
+
+export default function RequestMapping(path: string): (() => Service);

package/decorator/request-param.d.ts

@@ -0,0 +1,3 @@
+import {AxiosPromise} from "axios";
+
+export default function RequestParam(name: string, required?: boolean): (() => AxiosPromise<any>);

package/decorator/request-with.d.ts

@@ -0,0 +1,3 @@
+import {AxiosPromise} from "axios";
+
+export default function RequestWith(registration: string): (() => AxiosPromise<any>);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axios-annotations",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/sitorhy/axios-annotations.git"

package/plugins/auth/authorizer.d.ts

@@ -0,0 +1,49 @@
+import {AxiosError, AxiosPromise, AxiosRequestConfig} from "axios";
+import SessionStorage from "./storage";
+import SessionHistory from "./history";
+
+export interface Session {
+    access_token?: string;
+
+    refresh_token?: string;
+
+    token?: string;
+
+    accessToken?: string;
+
+    refreshToken?: string;
+
+    expires_in?: number;
+
+    expiresIn?: number;
+
+    scope?: string;
+
+    token_type?: string;
+}
+
+export default class Authorizer {
+    sessionKey: string;
+
+    sessionStorage: SessionStorage;
+
+    sessionHistory: SessionHistory;
+
+    getSession(): Promise<Partial<Session>>;
+
+    storageSession(session: Session): Promise<void>;
+
+    refreshSession(session: Session): Promise<Partial<Session>> | Promise<Record<string, any>> | Promise<any>;
+
+    withAuthentication(request: AxiosRequestConfig, session: Partial<Session>): void;
+
+    checkSession(request: AxiosRequestConfig, session: Partial<Session>): boolean;
+
+    checkResponse(response: Response): boolean;
+
+    onAuthorizedDenied(error: AxiosError): Promise<void>;
+
+    onSessionInvalidated(): void;
+
+    invalidateSession(): Promise<void>;
+}

package/plugins/auth/history.d.ts

@@ -0,0 +1,15 @@
+import {Session} from "./authorizer";
+
+export default class SessionHistory {
+    add(session: Session): void;
+
+    check(jwt: string): boolean;
+
+    deprecate(session: Session): void;
+
+    clean(): void;
+
+    isDeprecated(session: Session): boolean;
+
+    size: number;
+}

package/plugins/auth/index.d.ts

@@ -0,0 +1,4 @@
+import Authorizer from "./authorizer";
+import Config from "../../core/config";
+
+export default function AuthorizationPlugin(authorizer: Authorizer): (config: Config) => void;

package/plugins/auth/queue.d.ts

@@ -0,0 +1,16 @@
+import {AxiosError, AxiosPromise} from "axios";
+import Authorizer from "./authorizer";
+
+export default class PendingQueue {
+    constructor(authorizer: Authorizer);
+
+    resend(error: AxiosError, retries?: number): AxiosPromise<any>;
+
+    push(error: AxiosError): AxiosPromise<any>;
+
+    pop(): void;
+
+    clear(): void;
+
+    size: number;
+}

package/plugins/auth/storage.d.ts

@@ -0,0 +1,7 @@
+export default class SessionStorage {
+    set(key: string, value: any): Promise<void>;
+
+    get(key: string): Promise<any>;
+
+    remove(key: string): Promise<void>;
+}