@grandlinex/swagger-mate 1.3.1 → 1.3.2

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

@@ -6,13 +6,20 @@ 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 {
     constructor(conf) {
         this.api = conf.endpoint;
-        this.logger = conf.logger || console.log;
+        this.logger = conf.logger ?? console.log;
         this.disconnected = true;
+        this.noAuth = false;
         this.authorization = null;
-        this.failFlag = false;
         this.con = conf.con;
         this.reconnect = async () => {
             this.disconnected = true;
@@ -21,10 +28,40 @@ export default class BaseCon {
         this.onReconnect = () => Promise.resolve(true);
         this.handle = this.handle.bind(this);
     }
-    // Class helper functions
+    /**
+     * 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.authorization !== null && !this.disconnected;
+        return (this.noAuth || this.authorization !== null) && !this.disconnected;
     }
+    /**
+     * Returns the current authorization token.
+     *
+     * @return {string} The authorization token or an empty string if none is set.
+     */
     token() {
         return this.authorization || '';
     }
@@ -50,35 +87,34 @@ export default class BaseCon {
         }
         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 === 1 && version.code === 200;
+            return version.data?.api !== undefined && version.code === 200;
         }
         catch (e) {
             this.logger('ping failed');
             return false;
         }
     }
-    async test(email, password) {
-        const ping = await this.ping();
-        if (ping) {
-            try {
-                this.logger({ email, password });
-                const con = await this.con.post(this.p('/token'), {
-                    username: email,
-                    token: password,
-                });
-                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;
-    }
+    /**
+     * 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) {
@@ -98,7 +134,59 @@ export default class BaseCon {
         this.logger('test ping failed');
         return false;
     }
-    async connect(email, pw) {
+    /**
+     * 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;
+        return false;
+    }
+    /**
+     * Forces a connection using the provided bearer token.
+     *
+     * @param {string} token The token to be used for authentication.
+     * @returns {void}
+     */
+    forceConnectWithToken(token) {
+        this.authorization = `Bearer ${token}`;
+        this.disconnected = false;
+        this.noAuth = false;
+    }
+    /**
+     * 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 {
@@ -106,13 +194,15 @@ export default class BaseCon {
                     username: email,
                     token: pw,
                 });
-                // TODO check token
                 if (token.code === 200 || token.code === 201) {
-                    this.authorization = `Bearer ${token.data?.token}`;
-                    this.disconnected = false;
-                    this.reconnect = async () => {
-                        return (await this.connect(email, pw)) && (await this.testToken());
-                    };
+                    if (!dry) {
+                        this.authorization = `Bearer ${token.data?.token}`;
+                        this.disconnected = false;
+                        this.noAuth = false;
+                        this.reconnect = async () => {
+                            return ((await this.connect(email, pw)) && (await this.testToken()));
+                        };
+                    }
                     return true;
                 }
             }
@@ -123,17 +213,32 @@ export default class BaseCon {
         this.logger('cant connect to backend');
         this.authorization = null;
         this.disconnected = true;
+        this.noAuth = false;
         return false;
     }
     /**
-     * Enable client before auth
+     * 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.
      */
-    fakeEnableClient() {
-        this.authorization = 'DEBUG';
-        this.disconnected = false;
-    }
     async handle(type, path, body, config) {
-        if (!this.authorization || this.disconnected) {
+        if (!this.isConnected()) {
             this.logger('Disconnected');
             return {
                 success: false,
@@ -240,7 +345,6 @@ export default class BaseCon {
                 };
             case 401:
                 this.logger('AUTH NOT VALID');
-                this.disconnected = true;
                 return {
                     success: false,
                     data: null,

package/dist/mjs/cli.js

@@ -38,7 +38,11 @@ async function run() {
             console.log('Serving Swagger Meta');
             const auth = process.env.SW_AUTH || undefined;
             const port = process.env.SW_PORT || undefined;
-            SwaggerUtil.serveMeta(conf, port ? parseInt(port, 10) : undefined, auth);
+            SwaggerUtil.serveMeta(conf, {
+                port: port ? parseInt(port, 10) : undefined,
+                auth,
+                type: 'rapi-doc',
+            });
         }
         if (arg[arg.length - 2] === '--build') {
             console.log('Building Swagger Meta');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grandlinex/swagger-mate",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "type": "module",
   "exports": {
     ".": {
@@ -70,7 +70,7 @@
     "ts-jest": "29.3.4",
     "ts-loader": "9.5.2",
     "ts-node": "10.9.2",
-    "typedoc": "0.28.15",
+    "typedoc": "0.28.16",
     "typescript": "5.9.2"
   }
 }

package/res/html/rapi-doc/index.html

@@ -0,0 +1,28 @@
+<!doctype html>
+<html>
+<head>
+    <meta charset="utf-8"/>
+    <script type="module" src="./rapidoc-min.js"></script>
+    <script defer="defer" src="./rapidoc-min.js"></script>
+</head>
+<body>
+<rapi-doc id="thedoc"
+          spec-url="/spec"
+          allow-server-selection="true"
+          allow-authentication="true"
+          theme="dark"
+          render-style="focused"
+          show-header="false"
+          show-operation-id="true"
+          primary-color="#02802C"
+          bg-color="#121212"
+          text-color="#f2f3f4"
+          show-method-in-nav-bar="as-colored-text"
+          schema-style="table"
+          nav-text-color="#f2f3f4"
+          api-key-name="Authorization"
+          api-key-location="header">
+    <!--api-key-value="Bearer ${token}"-->
+</rapi-doc>
+</body>
+</html>