@grandlinex/swagger-mate 1.3.2 → 1.3.4

package/dist/mjs/Swagger/Path/SPathUtil.js

@@ -1,30 +1,6 @@
-import { getEntityMeta, XUtil, getColumnMeta, } from '@grandlinex/core';
+import { getEntityMeta, XUtil } from '@grandlinex/core';
 import map from './SUtilMap.js';
-import { isSwaggerRef, } from '../Meta/SwaggerTypes.js';
-function resolveDBType(dType) {
-    switch (dType) {
-        case 'int':
-        case 'long':
-            return 'integer';
-        case 'double':
-        case 'float':
-            return 'number';
-        case 'blob':
-            return 'string';
-        case 'string':
-        case 'text':
-        case 'uuid':
-            return 'string';
-        case 'boolean':
-            return 'boolean';
-        case 'date':
-            return 'string';
-        case 'json':
-            return 'object';
-        default:
-            throw Error('TypeNotSupported');
-    }
-}
+import { ESchemaEditor } from './ESchemaEditor.js';
 export default class SPathUtil {
     /**
      * Generates a default response mapping for the specified HTTP status types.
@@ -261,32 +237,12 @@ export default class SPathUtil {
      * If no metadata is found for the provided entity, the method returns `undefined`.
      *
      * @param {T} entity - The entity instance for which to create a schema.
-     * @returns {SSchemaEl | undefined} The generated schema object, or `undefined`
+     * @returns {SSchemaElObj | undefined} The generated schema object, or `undefined`
      *          if the entity's metadata could not be retrieved.
+     * @deprecated Use {@link ESchemaEditor.schemaFromEntity} instead.
      */
     static schemaFromEntity(entity) {
-        const schema = {
-            type: 'object',
-            properties: {},
-        };
-        const meta = getEntityMeta(entity);
-        if (!meta) {
-            return undefined;
-        }
-        schema.description = `Entity: ${meta.name}`;
-        schema.required = [];
-        const keys = Object.keys(entity);
-        keys.forEach((k) => {
-            const cMeta = getColumnMeta(entity, k);
-            if (cMeta && schema.properties) {
-                schema.required.push(k);
-                schema.properties[k] = {
-                    type: resolveDBType(cMeta.dataType),
-                    nullable: cMeta.canBeNull,
-                };
-            }
-        });
-        return schema;
+        return ESchemaEditor.schemaFromEntity(entity);
     }
     /**
      * Generates a content schema object for the given entity. The schema contains a description derived from the entity metadata and a JSON content schema based on the entity's structure.
@@ -303,7 +259,7 @@ export default class SPathUtil {
             description: `Entity: ${meta.name}`,
             content: {
                 'application/json': {
-                    schema: this.schemaFromEntity(entity),
+                    schema: ESchemaEditor.schemaFromEntity(entity),
                 },
             },
         };
@@ -319,7 +275,7 @@ export default class SPathUtil {
         e.forEach((el) => {
             const meta = getEntityMeta(el);
             if (meta) {
-                out[meta.name] = SPathUtil.schemaFromEntity(el);
+                out[meta.name] = ESchemaEditor.schemaFromEntity(el);
             }
         });
         return out;
@@ -339,140 +295,12 @@ export default class SPathUtil {
                 i: {
                     type: 'integer',
                 },
-                dat: this.schemaFromEntity(entity),
-                join_map: this.schemaFromEntity(entityMap),
+                dat: ESchemaEditor.schemaFromEntity(entity),
+                join_map: ESchemaEditor.schemaFromEntity(entityMap),
             },
         };
     }
-    /**
-     * Extends an entity schema object by merging additional schema options.
-     *
-     * @param {CoreEntity} entity
-     *   The entity for which the schema should be extended.
-     *
-     * @param {...Object} options
-     *   One or more objects defining schema extensions. Each object may contain:
-     *   - `key` (string): The property key to add or extend.
-     *   - `list` (boolean, optional): Indicates whether the property is a list.
-     *   - `entity` (CoreEntity, optional): The entity type for the property.
-     *   - `schema` (SSchemaEl, optional): A custom schema definition for the property.
-     *   - `required` (boolean, optional): Whether the property is required.
-     *
-     * @return {SSchemaEl}
-     *   The resulting schema element. If a single property is returned by
-     *   `extendEntitySchema`, its schema is returned directly; otherwise an
-     *   object schema with a type of `'object'` is returned.
-     */
-    static extendEntitySchemaObject(entity, ...options) {
-        const schema = this.extendEntitySchema(entity, ...options);
-        const ent = Object.entries(schema);
-        if (ent.length === 1) {
-            return ent[0][1];
-        }
-        return {
-            type: 'object',
-        };
-    }
-    /**
-     * Extends the schema of a given {@link CoreEntity} with additional properties.
-     *
-     * @param {CoreEntity} entity
-     *   The entity whose schema will be extended.
-     *
-     * @param {...{
-     *   key: string,
-     *   list?: boolean,
-     *   entity?: CoreEntity,
-     *   schema?: SSchemaEl,
-     *   required?: boolean
-     * }} options
-     *   One or more option objects specifying the extensions to apply. Each option
-     *   may provide either a direct schema (`schema`) or an entity reference
-     *   (`entity`). The `list` flag indicates whether the property should be
-     *   represented as an array of the provided schema. The `required` flag
-     *   adds the property to the schema’s required list.
-     *
-     * @returns {SKey<SSchemaEl>}
-     *   An object containing the updated schema for the entity, keyed by the
-     *   entity’s name. If the entity metadata cannot be found, an empty
-     *   object is returned.
-     */
-    static extendEntitySchema(entity, ...options) {
-        const meta = getEntityMeta(entity);
-        if (meta) {
-            const schema = SPathUtil.schemaEntryGen(entity)[meta.name];
-            if (schema && !isSwaggerRef(schema) && schema.properties) {
-                for (const option of options) {
-                    if (option.schema) {
-                        if (option.list) {
-                            schema.properties[option.key] = {
-                                type: 'array',
-                                items: option.schema,
-                            };
-                        }
-                        else {
-                            schema.properties[option.key] = option.schema;
-                        }
-                    }
-                    else if (option.entity) {
-                        const eMeta = getEntityMeta(option.entity);
-                        if (eMeta) {
-                            const scheme = SPathUtil.schemaEntryGen(option.entity)[eMeta.name];
-                            if (option.list) {
-                                schema.properties[option.key] = {
-                                    type: 'array',
-                                    items: scheme,
-                                };
-                            }
-                            else {
-                                schema.properties[option.key] = scheme;
-                            }
-                        }
-                    }
-                    if (option.required) {
-                        schema.required = [...(schema.required || []), option.key];
-                    }
-                }
-            }
-            return {
-                [meta.name]: schema,
-            };
-        }
-        return {};
-    }
-    /**
-     * Reduces the entity schema to a single schema element or a generic object.
-     *
-     * @param entity The entity whose schema should be reduced.
-     * @param keys Optional list of keys to include in the reduced schema. If omitted, all keys are considered.
-     * @return Returns the schema element of the sole key if only one key is present; otherwise, returns a generic object schema with type `'object'`. */
-    static reduceEntitySchemaObject(entity, ...keys) {
-        const schema = this.reduceEntitySchema(entity, ...keys);
-        const ent = Object.entries(schema);
-        if (ent.length === 1) {
-            return ent[0][1];
-        }
-        return {
-            type: 'object',
-        };
-    }
-    /**
-     * Creates a reduced version of an entity's schema by excluding specified properties.
-     *
-     * @param {CoreEntity} entity - The entity whose schema is to be processed.
-     * @param {...string} keys - Property names to remove from the schema's `properties` and `required` lists.
-     *
-     * @returns */
-    static reduceEntitySchema(entity, ...keys) {
-        const meta = getEntityMeta(entity);
-        if (meta) {
-            const schema = SPathUtil.schemaEntryGen(entity)[meta.name];
-            if (schema && !isSwaggerRef(schema) && schema.properties) {
-                schema.properties = Object.fromEntries(Object.entries(schema.properties).filter(([e]) => !keys.includes(e)));
-                schema.required = (schema.required || []).filter((e) => !keys.includes(e));
-            }
-            return { [meta.name]: schema };
-        }
-        return {};
+    static editor(e) {
+        return ESchemaEditor.fromEntity(e);
     }
 }

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

@@ -55,10 +55,21 @@ export default class BaseCon {
     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.
@@ -84,11 +95,17 @@ export default class BaseCon {
      */
     isConnected(): boolean;
     /**
-     * Returns the current authorization token.
+     * 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} The authorization token or an empty string if none is set.
+     * @return {string|null} The bearer token prefixed with "Bearer ", or {@code null} when no authorization is present.
      */
-    token(): string;
+    getBearer(): string | null;
     private p;
     /**
      * Sends a ping request to the API to verify connectivity and version availability.
@@ -96,6 +113,18 @@ export default class BaseCon {
      * @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
@@ -126,10 +155,11 @@ export default class BaseCon {
     /**
      * Forces a connection using the provided bearer token.
      *
-     * @param {string} token The token to be used for authentication.
+     * @param {string|null} token The token to be used for authentication.
      * @returns {void}
      */
-    forceConnectWithToken(token: string): 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

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

@@ -14,6 +14,16 @@ export function isErrorType(x) {
  * @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;
@@ -21,6 +31,7 @@ export default class BaseCon {
         this.noAuth = false;
         this.authorization = null;
         this.con = conf.con;
+        this.permanentHeader = conf.permanentHeader || {};
         this.reconnect = async () => {
             this.disconnected = true;
             return false;
@@ -58,12 +69,23 @@ export default class BaseCon {
         return (this.noAuth || this.authorization !== null) && !this.disconnected;
     }
     /**
-     * Returns the current authorization token.
+     * Retrieves the current authorization token.
      *
-     * @return {string} The authorization token or an empty string if none is set.
+     * @return {string|null} The token string used for authorization, or {@code null} if no token is set.
      */
     token() {
-        return this.authorization || '';
+        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;
@@ -102,6 +124,27 @@ export default class BaseCon {
             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
@@ -120,9 +163,7 @@ export default class BaseCon {
         if (ping) {
             try {
                 const con = await this.con.get(this.p('/test/auth'), {
-                    headers: {
-                        Authorization: this.token(),
-                    },
+                    headers: this.tokenHeader(),
                 });
                 return con.code === 200 || con.code === 201;
             }
@@ -157,18 +198,29 @@ export default class BaseCon {
         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} token The token to be used for authentication.
+     * @param {string|null} token The token to be used for authentication.
      * @returns {void}
      */
-    forceConnectWithToken(token) {
-        this.authorization = `Bearer ${token}`;
+    forceConnect(token) {
+        if (token) {
+            this.authorization = token.replace('Bearer ', '').replace('bearer ', '');
+        }
+        else {
+            this.authorization = null;
+        }
         this.disconnected = false;
-        this.noAuth = 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.
@@ -196,7 +248,7 @@ export default class BaseCon {
                 });
                 if (token.code === 200 || token.code === 201) {
                     if (!dry) {
-                        this.authorization = `Bearer ${token.data?.token}`;
+                        this.authorization = token.data.token;
                         this.disconnected = false;
                         this.noAuth = false;
                         this.reconnect = async () => {
@@ -261,7 +313,7 @@ export default class BaseCon {
                 dat = await this.con.get(this.p(path, config), {
                     ...config,
                     headers: {
-                        Authorization: this.token(),
+                        ...this.tokenHeader(),
                         ...formHeader,
                         ...config?.headers,
                         ...this.permanentHeader,
@@ -272,7 +324,7 @@ export default class BaseCon {
                 dat = await this.con.post(this.p(path, config), body, {
                     ...config,
                     headers: {
-                        Authorization: this.token(),
+                        ...this.tokenHeader(),
                         ...formHeader,
                         ...config?.headers,
                         ...this.permanentHeader,
@@ -283,7 +335,7 @@ export default class BaseCon {
                 dat = await this.con.patch(this.p(path, config), body, {
                     ...config,
                     headers: {
-                        Authorization: this.token(),
+                        ...this.tokenHeader(),
                         ...formHeader,
                         ...config?.headers,
                         ...this.permanentHeader,
@@ -294,7 +346,7 @@ export default class BaseCon {
                 dat = await this.con.delete(this.p(path, config), {
                     ...config,
                     headers: {
-                        Authorization: this.token(),
+                        ...this.tokenHeader(),
                         ...formHeader,
                         ...config?.headers,
                         ...this.permanentHeader,

package/dist/mjs/index.d.ts

@@ -1,6 +1,7 @@
 import SwaggerUtil from './Swagger/SwaggerUtil.js';
 import SPathUtil from './Swagger/Path/SPathUtil.js';
 import SwaggerClient from './Swagger/Client/SwaggerClient.js';
+export * from './Swagger/Path/ESchemaEditor.js';
 export * from './Swagger/debug/index.js';
 export * from './Swagger/annotation/index.js';
 export * from './Swagger/Meta/Swagger.js';

package/dist/mjs/index.js

@@ -1,6 +1,7 @@
 import SwaggerUtil from './Swagger/SwaggerUtil.js';
 import SPathUtil from './Swagger/Path/SPathUtil.js';
 import SwaggerClient from './Swagger/Client/SwaggerClient.js';
+export * from './Swagger/Path/ESchemaEditor.js';
 export * from './Swagger/debug/index.js';
 export * from './Swagger/annotation/index.js';
 export * from './Swagger/Meta/Swagger.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grandlinex/swagger-mate",
-  "version": "1.3.2",
+  "version": "1.3.4",
   "type": "module",
   "exports": {
     ".": {

package/res/templates/class/BaseCon.ts

@@ -65,7 +65,7 @@ export interface ConHandle {
 export default class BaseCon {
   private api: string;
 
-  private permanentHeader: undefined | Record<string, string>;
+  private permanentHeader: Record<string, string>;
 
   private authorization: string | null;
 
@@ -81,10 +81,21 @@ export default class BaseCon {
 
   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>;
   }) {
     this.api = conf.endpoint;
     this.logger = conf.logger ?? console.log;
@@ -92,6 +103,7 @@ export default class BaseCon {
     this.noAuth = false;
     this.authorization = null;
     this.con = conf.con;
+    this.permanentHeader = conf.permanentHeader || {};
     this.reconnect = async () => {
       this.disconnected = true;
       return false;
@@ -133,12 +145,24 @@ export default class BaseCon {
   }
 
   /**
-   * Returns the current authorization token.
+   * 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 {
+    return this.authorization;
+  }
+
+  /**
+   * Returns the bearer token string if an authorization value has been set.
    *
-   * @return {string} The authorization token or an empty string if none is set.
+   * @return {string|null} The bearer token prefixed with "Bearer ", or {@code null} when no authorization is present.
    */
-  token(): string {
-    return this.authorization || '';
+  getBearer(): string | null {
+    if (this.authorization) {
+      return `Bearer ${this.authorization}`;
+    }
+    return null;
   }
 
   private p(path: string, config?: ConHandleConfig) {
@@ -179,6 +203,29 @@ export default class BaseCon {
     }
   }
 
+  /**
+   * 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(): Record<string, string> {
+    if (this.authorization) {
+      return {
+        Authorization: this.getBearer()!,
+      };
+    }
+    return {};
+  }
+
+  setPermanentHeader(header: Record<string, string>): void {
+    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
@@ -199,9 +246,7 @@ export default class BaseCon {
         const con = await this.con.get<{ token: string }>(
           this.p('/test/auth'),
           {
-            headers: {
-              Authorization: this.token(),
-            },
+            headers: this.tokenHeader(),
           },
         );
         return con.code === 200 || con.code === 201;
@@ -238,19 +283,31 @@ export default class BaseCon {
     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} token The token to be used for authentication.
+   * @param {string|null} token The token to be used for authentication.
    * @returns {void}
    */
-  forceConnectWithToken(token: string): void {
-    this.authorization = `Bearer ${token}`;
+  forceConnect(token: string | null): void {
+    if (token) {
+      this.authorization = token.replace('Bearer ', '').replace('bearer ', '');
+    } else {
+      this.authorization = null;
+    }
+
     this.disconnected = false;
-    this.noAuth = false;
+    this.noAuth = token === null;
+  }
+
+  coppyFrom(con: BaseCon): void {
+    this.authorization = con.authorization;
+    this.disconnected = con.disconnected;
+    this.noAuth = con.noAuth;
   }
 
   /**
@@ -289,7 +346,7 @@ export default class BaseCon {
         });
         if (token.code === 200 || token.code === 201) {
           if (!dry) {
-            this.authorization = `Bearer ${token.data?.token}`;
+            this.authorization = token.data!.token;
             this.disconnected = false;
             this.noAuth = false;
             this.reconnect = async () => {
@@ -363,7 +420,7 @@ export default class BaseCon {
         dat = await this.con.get<T>(this.p(path, config), {
           ...config,
           headers: {
-            Authorization: this.token(),
+            ...this.tokenHeader(),
             ...formHeader,
             ...config?.headers,
             ...this.permanentHeader,
@@ -374,7 +431,7 @@ export default class BaseCon {
         dat = await this.con.post<T, J>(this.p(path, config), body, {
           ...config,
           headers: {
-            Authorization: this.token(),
+            ...this.tokenHeader(),
             ...formHeader,
             ...config?.headers,
             ...this.permanentHeader,
@@ -385,7 +442,7 @@ export default class BaseCon {
         dat = await this.con.patch<T, J>(this.p(path, config), body, {
           ...config,
           headers: {
-            Authorization: this.token(),
+            ...this.tokenHeader(),
             ...formHeader,
             ...config?.headers,
             ...this.permanentHeader,
@@ -396,7 +453,7 @@ export default class BaseCon {
         dat = await this.con.delete<T>(this.p(path, config), {
           ...config,
           headers: {
-            Authorization: this.token(),
+            ...this.tokenHeader(),
             ...formHeader,
             ...config?.headers,
             ...this.permanentHeader,