@grandlinex/swagger-mate 1.3.4 → 1.3.5

package/dist/cjs/Swagger/debug/index.js

@@ -1,27 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseCon = exports.FetchCon = exports.NodeCon = void 0;
-const BaseCon_js_1 = __importDefault(require("./BaseCon.js"));
-exports.BaseCon = BaseCon_js_1.default;
-const NodeCon_js_1 = __importDefault(require("./NodeCon.js"));
-exports.NodeCon = NodeCon_js_1.default;
-const FetchCon_js_1 = __importDefault(require("./FetchCon.js"));
-exports.FetchCon = FetchCon_js_1.default;
-__exportStar(require("./BaseCon.js"), exports);

package/dist/mjs/Swagger/debug/BaseCon.d.ts

@@ -1,202 +0,0 @@
-/**
- * THIS FILE IS AUTOMATICALLY GENERATED
- * DO NOT EDIT THIS FILE
- */
-export type ErrorType = {
-    type: string;
-    global?: string[];
-    field?: {
-        key: string;
-        message: string;
-    }[];
-};
-export type HeaderType = string | string[] | number | undefined;
-export type HandleRes<T> = {
-    success: boolean;
-    data: T | null;
-    code?: number;
-    error?: ErrorType;
-    headers?: Record<string, HeaderType>;
-};
-export type PathParam = {
-    [key: string]: string | number | undefined;
-};
-export declare function isErrorType(x: any): x is ErrorType;
-export interface ConHandleConfig {
-    headers?: Record<string, string>;
-    param?: PathParam;
-    query?: PathParam;
-}
-export interface ConHandleResponse<T> {
-    code: number;
-    data: T | null;
-    headers: Record<string, HeaderType>;
-}
-export interface ConHandle {
-    get<T>(url: string, config?: ConHandleConfig): Promise<ConHandleResponse<T>>;
-    post<T, J>(url: string, body?: J, config?: ConHandleConfig): Promise<ConHandleResponse<T>>;
-    patch<T, J>(url: string, body?: J, config?: ConHandleConfig): Promise<ConHandleResponse<T>>;
-    delete<T>(url: string, config?: ConHandleConfig): Promise<ConHandleResponse<T>>;
-}
-/**
- * BaseCon provides a minimal client for interacting with an HTTP backend.
- * It manages connection state, authentication tokens, and reconnection
- * logic while delegating actual HTTP requests to a supplied {@link ConHandle}.
- *
- * @class
- */
-export default class BaseCon {
-    private api;
-    private permanentHeader;
-    private authorization;
-    private noAuth;
-    private disconnected;
-    private readonly logger;
-    con: ConHandle;
-    reconnect: () => Promise<boolean>;
-    onReconnect: (con: BaseCon) => Promise<boolean>;
-    /**
-     * Initializes a new instance of the client.
-     *
-     * @param {Object} conf Configuration object.
-     * @param {ConHandle} conf.con - Connection handle.
-     * @param {string} conf.endpoint - API endpoint URL.
-     * @param {(arg: any) => void} [conf.logger] - Optional logger function; defaults to console.log.
-     * @param {Record<string, string>} [conf.permanentHeader] - Optional permanent headers to include in requests.
-     * @return {void}
-     */
-    constructor(conf: {
-        con: ConHandle;
-        endpoint: string;
-        logger?: (arg: any) => void;
-        permanentHeader?: Record<string, string>;
-    });
-    /**
-     * Retrieves the API endpoint.
-     *
-     * @return {string} The API endpoint string.
-     */
-    getApiEndpoint(): string;
-    /**
-     * Sets the API endpoint URL used by the client.
-     *
-     * @param {string} endpoint - The full URL of the API endpoint.
-     * @returns {void}
-     */
-    setApiEndpoint(endpoint: string): void;
-    /**
-     * Indicates whether the instance is considered connected.
-     *
-     * The instance is regarded as connected when it either does not require authentication
-     * (`noAuth` is true) or it has an authorization token set (`authorization` is not null),
-     * and it is not currently marked as disconnected.
-     *
-     * @return {boolean} `true` if the instance is connected, `false` otherwise.
-     */
-    isConnected(): boolean;
-    /**
-     * Retrieves the current authorization token.
-     *
-     * @return {string|null} The token string used for authorization, or {@code null} if no token is set.
-     */
-    token(): string | null;
-    /**
-     * Returns the bearer token string if an authorization value has been set.
-     *
-     * @return {string|null} The bearer token prefixed with "Bearer ", or {@code null} when no authorization is present.
-     */
-    getBearer(): string | null;
-    private p;
-    /**
-     * Sends a ping request to the API to verify connectivity and version availability.
-     *
-     * @return {boolean} `true` if the API responded with a 200 status code and a valid version object; `false` otherwise.
-     */
-    ping(): Promise<boolean>;
-    /**
-     * Builds the Authorization header for HTTP requests.
-     *
-     * If the instance has an authorization token, this method returns an object
-     * containing a single `Authorization` header with the Bearer token value.
-     * When no token is available, an empty header object is returned.
-     *
-     * @return {Record<string, string>} The headers object containing the
-     * `Authorization` header when applicable, otherwise an empty object.
-     */
-    private tokenHeader;
-    setPermanentHeader(header: Record<string, string>): void;
-    /**
-     * Validates the current authentication token by performing a ping and a test request
-     * to the backend. The method first ensures connectivity via {@link ping}. If the ping
-     * succeeds, it attempts to retrieve a token from the `/test/auth` endpoint using the
-     * current token in the `Authorization` header. The operation is considered successful
-     * if the response status code is 200 or 201.
-     *
-     * If any step fails, an error is logged and the method returns {@code false}. On
-     * success, it returns {@code true}.
-     *
-     * @return {Promise<boolean>} A promise that resolves to {@code true} if the token
-     * test succeeds, otherwise {@code false}.
-     */
-    testToken(): Promise<boolean>;
-    /**
-     * Attempts to establish a connection to the backend without authentication.
-     *
-     * This method sends a ping request.  If the ping succeeds, it clears any
-     * existing authorization data, marks the instance as connected,
-     * enables the no‑authentication mode, and returns `true`.  If the ping
-     * fails, it logs a warning, clears authorization, marks the instance
-     * as disconnected, and returns `false`.
-     *
-     * @return {Promise<boolean>} `true` when a connection is successfully
-     * established without authentication, otherwise `false`.
-     */
-    connectNoAuth(): Promise<boolean>;
-    /**
-     * Forces a connection using the provided bearer token.
-     *
-     * @param {string|null} token The token to be used for authentication.
-     * @returns {void}
-     */
-    forceConnect(token: string | null): void;
-    coppyFrom(con: BaseCon): void;
-    /**
-     * Establishes a connection to the backend using the supplied credentials.
-     * Performs a health‑check ping first; if successful, it requests an authentication
-     * token from the `/token` endpoint.  When the token is obtained, the method
-     * updates internal state (authorization header, connection flags) and, unless
-     * a dry run is requested, sets up a reconnection routine.  Any errors are
-     * logged and the method resolves to `false`.
-     *
-     * @param {string} email - The user's email address for authentication.
-     * @param {string} pw - The password (or token) for the specified user.
-     * @param {boolean} [dry=false] - If `true`, the method performs a dry run
-     *   without persisting credentials or configuring reconnection logic.
-     *
-     * @returns  Promise<boolean>  `true` if the connection was successfully
-     *   established, otherwise `false`.
-     */
-    connect(email: string, pw: string, dry?: boolean): Promise<boolean>;
-    /**
-     * Performs an HTTP request using the client’s internal connection.
-     *
-     * The method verifies that the client is connected before attempting a request.
-     * It automatically injects the authorization token, permanent headers, and any
-     * headers supplied in `config`. If the request body is a `FormData` instance
-     * (or provides a `getHeaders` method), the appropriate form headers are added.
-     *
-     * Response handling:
-     * - `200` or `201`: returns `success: true` with the received data.
-     * - `498`: attempts to reconnect and retries the request once.
-     * - `401`: logs an authentication error, marks the client as disconnected.
-     * - `403` and other status codes: return `success: false` with the status code.
-     *
-     * @param {'POST'|'GET'|'PATCH'|'DELETE'} type The HTTP method to use.
-     * @param {string} path The endpoint path relative to the base URL.
-     * @param {J} [body] Optional request payload. May be `FormData` or a plain object.
-     * @param {ConHandleConfig} [config] Optional Axios-like configuration for the request.
-     * @returns {Promise<HandleRes<T>>} A promise that resolves to a `HandleRes` object
-     * containing the response data, status code, any error information, and headers.
-     */
-    handle<T, J>(type: 'POST' | 'GET' | 'PATCH' | 'DELETE', path: string, body?: J, config?: ConHandleConfig): Promise<HandleRes<T>>;
-}

package/dist/mjs/Swagger/debug/BaseCon.js

@@ -1,425 +0,0 @@
-/**
- * THIS FILE IS AUTOMATICALLY GENERATED
- * DO NOT EDIT THIS FILE
- */
-import FormData from 'form-data';
-export function isErrorType(x) {
-    return x && typeof x === 'object' && x.type === 'error';
-}
-/**
- * BaseCon provides a minimal client for interacting with an HTTP backend.
- * It manages connection state, authentication tokens, and reconnection
- * logic while delegating actual HTTP requests to a supplied {@link ConHandle}.
- *
- * @class
- */
-export default class BaseCon {
-    /**
-     * Initializes a new instance of the client.
-     *
-     * @param {Object} conf Configuration object.
-     * @param {ConHandle} conf.con - Connection handle.
-     * @param {string} conf.endpoint - API endpoint URL.
-     * @param {(arg: any) => void} [conf.logger] - Optional logger function; defaults to console.log.
-     * @param {Record<string, string>} [conf.permanentHeader] - Optional permanent headers to include in requests.
-     * @return {void}
-     */
-    constructor(conf) {
-        this.api = conf.endpoint;
-        this.logger = conf.logger ?? console.log;
-        this.disconnected = true;
-        this.noAuth = false;
-        this.authorization = null;
-        this.con = conf.con;
-        this.permanentHeader = conf.permanentHeader || {};
-        this.reconnect = async () => {
-            this.disconnected = true;
-            return false;
-        };
-        this.onReconnect = () => Promise.resolve(true);
-        this.handle = this.handle.bind(this);
-    }
-    /**
-     * Retrieves the API endpoint.
-     *
-     * @return {string} The API endpoint string.
-     */
-    getApiEndpoint() {
-        return this.api;
-    }
-    /**
-     * Sets the API endpoint URL used by the client.
-     *
-     * @param {string} endpoint - The full URL of the API endpoint.
-     * @returns {void}
-     */
-    setApiEndpoint(endpoint) {
-        this.api = endpoint;
-    }
-    /**
-     * Indicates whether the instance is considered connected.
-     *
-     * The instance is regarded as connected when it either does not require authentication
-     * (`noAuth` is true) or it has an authorization token set (`authorization` is not null),
-     * and it is not currently marked as disconnected.
-     *
-     * @return {boolean} `true` if the instance is connected, `false` otherwise.
-     */
-    isConnected() {
-        return (this.noAuth || this.authorization !== null) && !this.disconnected;
-    }
-    /**
-     * Retrieves the current authorization token.
-     *
-     * @return {string|null} The token string used for authorization, or {@code null} if no token is set.
-     */
-    token() {
-        return this.authorization;
-    }
-    /**
-     * Returns the bearer token string if an authorization value has been set.
-     *
-     * @return {string|null} The bearer token prefixed with "Bearer ", or {@code null} when no authorization is present.
-     */
-    getBearer() {
-        if (this.authorization) {
-            return `Bearer ${this.authorization}`;
-        }
-        return null;
-    }
-    p(path, config) {
-        let pp = path;
-        if (config?.param) {
-            const e = Object.keys(config.param);
-            for (const d of e) {
-                pp = pp.replace(`{${d}}`, `${config.param[d]}`);
-            }
-        }
-        if (config?.query) {
-            const e = Object.keys(config.query);
-            const slices = [];
-            for (const d of e) {
-                if (config.query[d]) {
-                    slices.push(`${d}=${config.query[d]}`);
-                }
-            }
-            if (slices.length > 0) {
-                pp += `?${slices.join('&')}`;
-            }
-        }
-        return `${this.api}${pp}`;
-    }
-    /**
-     * Sends a ping request to the API to verify connectivity and version availability.
-     *
-     * @return {boolean} `true` if the API responded with a 200 status code and a valid version object; `false` otherwise.
-     */
-    async ping() {
-        try {
-            const version = await this.con.get(this.p('/version'));
-            return version.data?.api !== undefined && version.code === 200;
-        }
-        catch (e) {
-            this.logger('ping failed');
-            return false;
-        }
-    }
-    /**
-     * Builds the Authorization header for HTTP requests.
-     *
-     * If the instance has an authorization token, this method returns an object
-     * containing a single `Authorization` header with the Bearer token value.
-     * When no token is available, an empty header object is returned.
-     *
-     * @return {Record<string, string>} The headers object containing the
-     * `Authorization` header when applicable, otherwise an empty object.
-     */
-    tokenHeader() {
-        if (this.authorization) {
-            return {
-                Authorization: this.getBearer(),
-            };
-        }
-        return {};
-    }
-    setPermanentHeader(header) {
-        this.permanentHeader = header;
-    }
-    /**
-     * Validates the current authentication token by performing a ping and a test request
-     * to the backend. The method first ensures connectivity via {@link ping}. If the ping
-     * succeeds, it attempts to retrieve a token from the `/test/auth` endpoint using the
-     * current token in the `Authorization` header. The operation is considered successful
-     * if the response status code is 200 or 201.
-     *
-     * If any step fails, an error is logged and the method returns {@code false}. On
-     * success, it returns {@code true}.
-     *
-     * @return {Promise<boolean>} A promise that resolves to {@code true} if the token
-     * test succeeds, otherwise {@code false}.
-     */
-    async testToken() {
-        const ping = await this.ping();
-        if (ping) {
-            try {
-                const con = await this.con.get(this.p('/test/auth'), {
-                    headers: this.tokenHeader(),
-                });
-                return con.code === 200 || con.code === 201;
-            }
-            catch (e) {
-                this.logger(e);
-                this.logger('cant connect to backend');
-            }
-        }
-        this.logger('test ping failed');
-        return false;
-    }
-    /**
-     * Attempts to establish a connection to the backend without authentication.
-     *
-     * This method sends a ping request.  If the ping succeeds, it clears any
-     * existing authorization data, marks the instance as connected,
-     * enables the no‑authentication mode, and returns `true`.  If the ping
-     * fails, it logs a warning, clears authorization, marks the instance
-     * as disconnected, and returns `false`.
-     *
-     * @return {Promise<boolean>} `true` when a connection is successfully
-     * established without authentication, otherwise `false`.
-     */
-    async connectNoAuth() {
-        const ping = await this.ping();
-        if (ping) {
-            this.authorization = null;
-            this.disconnected = false;
-            this.noAuth = true;
-            return true;
-        }
-        this.logger('cant connect to backend');
-        this.authorization = null;
-        this.disconnected = true;
-        this.noAuth = false;
-        return false;
-    }
-    /**
-     * Forces a connection using the provided bearer token.
-     *
-     * @param {string|null} token The token to be used for authentication.
-     * @returns {void}
-     */
-    forceConnect(token) {
-        if (token) {
-            this.authorization = token.replace('Bearer ', '').replace('bearer ', '');
-        }
-        else {
-            this.authorization = null;
-        }
-        this.disconnected = false;
-        this.noAuth = token === null;
-    }
-    coppyFrom(con) {
-        this.authorization = con.authorization;
-        this.disconnected = con.disconnected;
-        this.noAuth = con.noAuth;
-    }
-    /**
-     * Establishes a connection to the backend using the supplied credentials.
-     * Performs a health‑check ping first; if successful, it requests an authentication
-     * token from the `/token` endpoint.  When the token is obtained, the method
-     * updates internal state (authorization header, connection flags) and, unless
-     * a dry run is requested, sets up a reconnection routine.  Any errors are
-     * logged and the method resolves to `false`.
-     *
-     * @param {string} email - The user's email address for authentication.
-     * @param {string} pw - The password (or token) for the specified user.
-     * @param {boolean} [dry=false] - If `true`, the method performs a dry run
-     *   without persisting credentials or configuring reconnection logic.
-     *
-     * @returns  Promise<boolean>  `true` if the connection was successfully
-     *   established, otherwise `false`.
-     */
-    async connect(email, pw, dry = false) {
-        const ping = await this.ping();
-        if (ping) {
-            try {
-                const token = await this.con.post(this.p('/token'), {
-                    username: email,
-                    token: pw,
-                });
-                if (token.code === 200 || token.code === 201) {
-                    if (!dry) {
-                        this.authorization = token.data.token;
-                        this.disconnected = false;
-                        this.noAuth = false;
-                        this.reconnect = async () => {
-                            return ((await this.connect(email, pw)) && (await this.testToken()));
-                        };
-                    }
-                    return true;
-                }
-            }
-            catch (e) {
-                this.logger(e);
-            }
-        }
-        this.logger('cant connect to backend');
-        this.authorization = null;
-        this.disconnected = true;
-        this.noAuth = false;
-        return false;
-    }
-    /**
-     * Performs an HTTP request using the client’s internal connection.
-     *
-     * The method verifies that the client is connected before attempting a request.
-     * It automatically injects the authorization token, permanent headers, and any
-     * headers supplied in `config`. If the request body is a `FormData` instance
-     * (or provides a `getHeaders` method), the appropriate form headers are added.
-     *
-     * Response handling:
-     * - `200` or `201`: returns `success: true` with the received data.
-     * - `498`: attempts to reconnect and retries the request once.
-     * - `401`: logs an authentication error, marks the client as disconnected.
-     * - `403` and other status codes: return `success: false` with the status code.
-     *
-     * @param {'POST'|'GET'|'PATCH'|'DELETE'} type The HTTP method to use.
-     * @param {string} path The endpoint path relative to the base URL.
-     * @param {J} [body] Optional request payload. May be `FormData` or a plain object.
-     * @param {ConHandleConfig} [config] Optional Axios-like configuration for the request.
-     * @returns {Promise<HandleRes<T>>} A promise that resolves to a `HandleRes` object
-     * containing the response data, status code, any error information, and headers.
-     */
-    async handle(type, path, body, config) {
-        if (!this.isConnected()) {
-            this.logger('Disconnected');
-            return {
-                success: false,
-                data: null,
-                code: -1,
-            };
-        }
-        let formHeader = null;
-        const cK = body;
-        if (cK &&
-            (cK instanceof FormData || typeof cK?.getHeaders === 'function')) {
-            formHeader = cK?.getHeaders?.() || {};
-        }
-        else {
-            formHeader = {};
-        }
-        let dat;
-        switch (type) {
-            case 'GET':
-                dat = await this.con.get(this.p(path, config), {
-                    ...config,
-                    headers: {
-                        ...this.tokenHeader(),
-                        ...formHeader,
-                        ...config?.headers,
-                        ...this.permanentHeader,
-                    },
-                });
-                break;
-            case 'POST':
-                dat = await this.con.post(this.p(path, config), body, {
-                    ...config,
-                    headers: {
-                        ...this.tokenHeader(),
-                        ...formHeader,
-                        ...config?.headers,
-                        ...this.permanentHeader,
-                    },
-                });
-                break;
-            case 'PATCH':
-                dat = await this.con.patch(this.p(path, config), body, {
-                    ...config,
-                    headers: {
-                        ...this.tokenHeader(),
-                        ...formHeader,
-                        ...config?.headers,
-                        ...this.permanentHeader,
-                    },
-                });
-                break;
-            case 'DELETE':
-                dat = await this.con.delete(this.p(path, config), {
-                    ...config,
-                    headers: {
-                        ...this.tokenHeader(),
-                        ...formHeader,
-                        ...config?.headers,
-                        ...this.permanentHeader,
-                    },
-                });
-                break;
-            default:
-                return {
-                    success: false,
-                    data: null,
-                    code: -1,
-                };
-        }
-        let error;
-        if (isErrorType(dat.data)) {
-            error = dat.data;
-        }
-        let x = false;
-        switch (dat.code) {
-            case 200:
-            case 201:
-                return {
-                    success: true,
-                    data: dat.data,
-                    code: dat.code,
-                    error,
-                    headers: dat.headers,
-                };
-            case 498:
-                x = await this.reconnect();
-                if (x) {
-                    this.onReconnect(this).catch((dx) => {
-                        this.logger(dx);
-                    });
-                    return this.handle(type, path, body, config);
-                }
-                this.reconnect = async () => {
-                    this.disconnected = true;
-                    return false;
-                };
-                this.disconnected = true;
-                return {
-                    success: false,
-                    data: null,
-                    code: dat.code,
-                    error,
-                    headers: dat.headers,
-                };
-            case 401:
-                this.logger('AUTH NOT VALID');
-                return {
-                    success: false,
-                    data: null,
-                    code: dat.code,
-                    error,
-                    headers: dat.headers,
-                };
-            case 403:
-                return {
-                    success: false,
-                    data: null,
-                    error,
-                    code: dat.code,
-                    headers: dat.headers,
-                };
-            default:
-                return {
-                    success: false,
-                    data: null,
-                    error,
-                    code: dat.code,
-                    headers: dat.headers,
-                };
-        }
-    }
-}

package/dist/mjs/Swagger/debug/FetchCon.d.ts

@@ -1,3 +0,0 @@
-import { ConHandle } from './BaseCon.js';
-declare const FetchCon: ConHandle;
-export default FetchCon;