@venizia/ignis 0.4.3 → 0.4.5

package/dist/esm/base/middlewares/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/base/middlewares/index.ts"],"names":[],"mappings":"AAGA,cAAc,uBAAuB,CAAC;AAEtC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC"}

package/dist/esm/base/middlewares/index.js

@@ -0,0 +1,7 @@
+// `common`, `emoji-favicon`, `not-found` and the whole of `app-error`'s logic moved to the kernel.
+// What stays here is the server half: `AppErrorMiddleware`, a subclass restoring the two reads a
+// browser cannot make, and `request-spy`, whose constructor reads `process.env` directly.
+export * from '@venizia/ignis-kernel';
+export * from './app-error/index.js';
+export * from './request-spy/index.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/base/middlewares/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/base/middlewares/index.ts"],"names":[],"mappings":"AAAA,mGAAmG;AACnG,iGAAiG;AACjG,0FAA0F;AAC1F,cAAc,uBAAuB,CAAC;AAEtC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC","sourcesContent":["// `common`, `emoji-favicon`, `not-found` and the whole of `app-error`'s logic moved to the kernel.\n// What stays here is the server half: `AppErrorMiddleware`, a subclass restoring the two reads a\n// browser cannot make, and `request-spy`, whose constructor reads `process.env` directly.\nexport * from '@venizia/ignis-kernel';\n\nexport * from './app-error';\nexport * from './request-spy';\n"]}

package/dist/esm/base/middlewares/request-spy/index.d.ts

@@ -0,0 +1,2 @@
+export * from './request-spy.middleware.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/base/middlewares/request-spy/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/base/middlewares/request-spy/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC"}

package/dist/esm/base/middlewares/request-spy/index.js

@@ -0,0 +1,2 @@
+export * from './request-spy.middleware.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/base/middlewares/request-spy/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/base/middlewares/request-spy/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC","sourcesContent":["export * from './request-spy.middleware';\n"]}

package/dist/esm/base/middlewares/request-spy/request-spy.middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-spy.middleware.d.ts","sourceRoot":"","sources":["../../../../../src/base/middlewares/request-spy/request-spy.middleware.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAA8B,MAAM,6BAA6B,CAAC;AAErF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAE1D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACpD,OAAO,EAAiC,KAAK,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAIrF,mPAAmP;AACnP,qBAAa,oBAAqB,SAAQ,UAAW,YAAW,SAAS,CAAC,iBAAiB,CAAC;IAC1F,MAAM,CAAC,QAAQ,CAAC,cAAc,eAAkB;IAEhD,OAAO,CAAC,WAAW,CAAU;IAE7B;;;;;;;;;OASG;;IAOH,8PAA8P;IACxP,SAAS,CAAC,IAAI,EAAE;QAAE,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAiDjE,wEAAwE;IACxE,KAAK;CAyDN"}

package/dist/esm/base/middlewares/request-spy/request-spy.middleware.js

@@ -0,0 +1,98 @@
+import { NetworkUtility } from '../../../utilities/network.utility.js';
+import { Environment } from '@venizia/ignis-helpers';
+import { BaseHelper, EnvironmentNames, getError } from '@venizia/ignis-helpers/core';
+import { HTTP } from '@venizia/ignis-helpers/common';
+import { createMiddleware } from 'hono/factory';
+import { REQUEST_ID_KEY, RequestErrors } from '@venizia/ignis-kernel';
+const TEXT_CONTENT_TYPE_PREFIX = 'text/';
+/** Logs incoming/outgoing request details. The BODY is parsed and logged only in a recognised development environment - see the constructor for why that test is fail-closed; elsewhere only a JSON body is parsed, for its malformed-body 400. */
+export class RequestSpyMiddleware extends BaseHelper {
+    static { this.REQUEST_ID_KEY = REQUEST_ID_KEY; }
+    /**
+     * Fail-CLOSED, matching {@link BaseAppErrorMiddleware.isProduction}: only an environment this
+     * framework recognises as a development one enables body logging.
+     *
+     * The previous test was `env !== 'production'`, which enabled it for an unset `NODE_ENV` and for
+     * every pre-production name that carries real user data - `staging`, `uat`, `alpha`, `beta`, and
+     * the abbreviation `prod`. `development-envs.test.ts` pins those as NOT development for exactly
+     * that reason. Redaction is no defence here: it masks secret-SHAPED keys, so `nationalId`,
+     * `cardNumber` and `ssn` were written verbatim.
+     */
+    constructor() {
+        super({ scope: 'SpyMW' });
+        const env = Environment.ambient?.toLowerCase();
+        this.isDebugMode = !!env && EnvironmentNames.DEVELOPMENT_ENVS.has(env);
+    }
+    /** Parses the body by Content-Type without draining it for the handler: JSON and form bodies go through the request cache, `text/*` is read from a clone (from the cache once something read it), and any other type is described by its size, never read. */
+    async parseBody(opts) {
+        const contentType = opts.req.header(HTTP.Headers.CONTENT_TYPE);
+        if (!contentType) {
+            return null;
+        }
+        // Only an explicit zero short-circuits: a CHUNKED request carries no Content-Length, so gating on the header's presence would skip every streamed body and let a malformed one detonate deeper as a 500.
+        const contentLength = opts.req.header(HTTP.Headers.CONTENT_LENGTH);
+        if (contentLength === '0' || !opts.req.raw.body) {
+            return null;
+        }
+        try {
+            if (contentType.includes(HTTP.HeaderValues.APPLICATION_JSON)) {
+                const rs = await opts.req.json();
+                return rs;
+            }
+            if (contentType.includes(HTTP.HeaderValues.MULTIPART_FORM_DATA) ||
+                contentType.includes(HTTP.HeaderValues.APPLICATION_FORM_URLENCODED)) {
+                const rs = await opts.req.parseBody();
+                return rs;
+            }
+            if (contentType === HTTP.HeaderValues.APPLICATION_OCTET_STREAM) {
+                return opts.req.raw.body;
+            }
+            // Anything else is read, if at all, from a clone: a handler may stream `req.raw.body` on (an upload proxy), and reading the request itself would drain it and mangle binary bytes.
+            // A body an earlier middleware read cannot be cloned; Hono's cache serves it instead.
+            if (contentType.startsWith(TEXT_CONTENT_TYPE_PREFIX)) {
+                const rs = opts.req.raw.bodyUsed
+                    ? await opts.req.text()
+                    : await opts.req.raw.clone().text();
+                return rs;
+            }
+            return `<${contentLength ?? 'unknown'} bytes, ${contentType}>`;
+        }
+        catch {
+            throw getError({
+                error: RequestErrors.BODY_MALFORMED,
+                message: 'Malformed Body Payload',
+            });
+        }
+    }
+    /** Returns a Hono middleware that logs request details and duration. */
+    value() {
+        return createMiddleware(async (context, next) => {
+            const t = performance.now();
+            const { req } = context;
+            const requestId = context.get(RequestSpyMiddleware.REQUEST_ID_KEY);
+            const incomingIp = NetworkUtility.getIncomingIp(context);
+            const forwardedIp = req.header('x-real-ip') ?? req.header('x-forwarded-for') ?? null;
+            const method = req.method;
+            const path = req.path ?? '/';
+            // Best-effort, never fatal: a unix socket, some proxies and any in-process call yield no connection info - refusing to serve because the client IP is unknown turns a logging gap into an outage.
+            const clientIp = incomingIp ?? forwardedIp ?? 'unknown';
+            const query = req.query() ?? {};
+            if (this.isDebugMode) {
+                const body = await this.parseBody({ req });
+                this.logger.info('[%s][%s][=>] %s %s | query: %j | body: %j', requestId, clientIp, method.padEnd(8, ' '), path, query, body);
+            }
+            else {
+                // Only JSON is parsed here: its clean 400 on a malformed body is a contract. Any other body
+                // would be read for a log line that never prints it, before the route's own size checks.
+                if (req.header(HTTP.Headers.CONTENT_TYPE)?.includes(HTTP.HeaderValues.APPLICATION_JSON)) {
+                    await this.parseBody({ req });
+                }
+                this.logger.info('[%s][%s][=>] %s %s | query: %j', requestId, clientIp, method.padEnd(8, ' '), path, query);
+            }
+            await next();
+            const duration = (performance.now() - t).toFixed(2);
+            this.logger.info('[%s][%s][<=] %s %s | Took: %s (ms)', requestId, clientIp, method.padEnd(8, ' '), path, duration);
+        });
+    }
+}
+//# sourceMappingURL=request-spy.middleware.js.map

package/dist/esm/base/middlewares/request-spy/request-spy.middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-spy.middleware.js","sourceRoot":"","sources":["../../../../../src/base/middlewares/request-spy/request-spy.middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AACrF,OAAO,EAAE,IAAI,EAAE,MAAM,+BAA+B,CAAC;AAErD,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EAAE,cAAc,EAAE,aAAa,EAAiB,MAAM,uBAAuB,CAAC;AAErF,MAAM,wBAAwB,GAAG,OAAO,CAAC;AAEzC,mPAAmP;AACnP,MAAM,OAAO,oBAAqB,SAAQ,UAAU;aAClC,mBAAc,GAAG,cAAc,CAAC;IAIhD;;;;;;;;;OASG;IACH;QACE,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;QAC1B,MAAM,GAAG,GAAG,WAAW,CAAC,OAAO,EAAE,WAAW,EAAE,CAAC;QAC/C,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC,GAAG,IAAI,gBAAgB,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACzE,CAAC;IAED,8PAA8P;IAC9P,KAAK,CAAC,SAAS,CAAC,IAA8B;QAC5C,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAE/D,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,yMAAyM;QACzM,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACnE,IAAI,aAAa,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YAChD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,CAAC;YACH,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBAC7D,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;gBACjC,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,IACE,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC;gBAC3D,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,2BAA2B,CAAC,EACnE,CAAC;gBACD,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;gBACtC,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,IAAI,WAAW,KAAK,IAAI,CAAC,YAAY,CAAC,wBAAwB,EAAE,CAAC;gBAC/D,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC;YAC3B,CAAC;YAED,mLAAmL;YACnL,sFAAsF;YACtF,IAAI,WAAW,CAAC,UAAU,CAAC,wBAAwB,CAAC,EAAE,CAAC;gBACrD,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ;oBAC9B,CAAC,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE;oBACvB,CAAC,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC;gBACtC,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,OAAO,IAAI,aAAa,IAAI,SAAS,WAAW,WAAW,GAAG,CAAC;QACjE,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,QAAQ,CAAC;gBACb,KAAK,EAAE,aAAa,CAAC,cAAc;gBACnC,OAAO,EAAE,wBAAwB;aAClC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,wEAAwE;IACxE,KAAK;QACH,OAAO,gBAAgB,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;YAC9C,MAAM,CAAC,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;YAC5B,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;YAExB,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC;YACnE,MAAM,UAAU,GAAG,cAAc,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YACzD,MAAM,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,IAAI,CAAC;YAErF,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;YAC1B,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC;YAE7B,kMAAkM;YAClM,MAAM,QAAQ,GAAG,UAAU,IAAI,WAAW,IAAI,SAAS,CAAC;YACxD,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC;YAEhC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBACrB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;gBAC3C,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,2CAA2C,EAC3C,SAAS,EACT,QAAQ,EACR,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,EACrB,IAAI,EACJ,KAAK,EACL,IAAI,CACL,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,4FAA4F;gBAC5F,yFAAyF;gBACzF,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE,CAAC;oBACxF,MAAM,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;gBAChC,CAAC;gBAED,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,gCAAgC,EAChC,SAAS,EACT,QAAQ,EACR,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,EACrB,IAAI,EACJ,KAAK,CACN,CAAC;YACJ,CAAC;YAED,MAAM,IAAI,EAAE,CAAC;YAEb,MAAM,QAAQ,GAAG,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACpD,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,oCAAoC,EACpC,SAAS,EACT,QAAQ,EACR,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,EACrB,IAAI,EACJ,QAAQ,CACT,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC","sourcesContent":["import { NetworkUtility } from '@/utilities/network.utility';\nimport { Environment } from '@venizia/ignis-helpers';\nimport { BaseHelper, EnvironmentNames, getError } from '@venizia/ignis-helpers/core';\nimport { HTTP } from '@venizia/ignis-helpers/common';\nimport type { IProvider } from '@venizia/ignis-inversion';\nimport { createMiddleware } from 'hono/factory';\nimport type { MiddlewareHandler } from 'hono/types';\nimport { REQUEST_ID_KEY, RequestErrors, type TContext } from '@venizia/ignis-kernel';\n\nconst TEXT_CONTENT_TYPE_PREFIX = 'text/';\n\n/** Logs incoming/outgoing request details. The BODY is parsed and logged only in a recognised development environment - see the constructor for why that test is fail-closed; elsewhere only a JSON body is parsed, for its malformed-body 400. */\nexport class RequestSpyMiddleware extends BaseHelper implements IProvider<MiddlewareHandler> {\n  static readonly REQUEST_ID_KEY = REQUEST_ID_KEY;\n\n  private isDebugMode: boolean;\n\n  /**\n   * Fail-CLOSED, matching {@link BaseAppErrorMiddleware.isProduction}: only an environment this\n   * framework recognises as a development one enables body logging.\n   *\n   * The previous test was `env !== 'production'`, which enabled it for an unset `NODE_ENV` and for\n   * every pre-production name that carries real user data - `staging`, `uat`, `alpha`, `beta`, and\n   * the abbreviation `prod`. `development-envs.test.ts` pins those as NOT development for exactly\n   * that reason. Redaction is no defence here: it masks secret-SHAPED keys, so `nationalId`,\n   * `cardNumber` and `ssn` were written verbatim.\n   */\n  constructor() {\n    super({ scope: 'SpyMW' });\n    const env = Environment.ambient?.toLowerCase();\n    this.isDebugMode = !!env && EnvironmentNames.DEVELOPMENT_ENVS.has(env);\n  }\n\n  /** Parses the body by Content-Type without draining it for the handler: JSON and form bodies go through the request cache, `text/*` is read from a clone (from the cache once something read it), and any other type is described by its size, never read. */\n  async parseBody(opts: { req: TContext['req'] }): Promise<unknown> {\n    const contentType = opts.req.header(HTTP.Headers.CONTENT_TYPE);\n\n    if (!contentType) {\n      return null;\n    }\n\n    // Only an explicit zero short-circuits: a CHUNKED request carries no Content-Length, so gating on the header's presence would skip every streamed body and let a malformed one detonate deeper as a 500.\n    const contentLength = opts.req.header(HTTP.Headers.CONTENT_LENGTH);\n    if (contentLength === '0' || !opts.req.raw.body) {\n      return null;\n    }\n\n    try {\n      if (contentType.includes(HTTP.HeaderValues.APPLICATION_JSON)) {\n        const rs = await opts.req.json();\n        return rs;\n      }\n\n      if (\n        contentType.includes(HTTP.HeaderValues.MULTIPART_FORM_DATA) ||\n        contentType.includes(HTTP.HeaderValues.APPLICATION_FORM_URLENCODED)\n      ) {\n        const rs = await opts.req.parseBody();\n        return rs;\n      }\n\n      if (contentType === HTTP.HeaderValues.APPLICATION_OCTET_STREAM) {\n        return opts.req.raw.body;\n      }\n\n      // Anything else is read, if at all, from a clone: a handler may stream `req.raw.body` on (an upload proxy), and reading the request itself would drain it and mangle binary bytes.\n      // A body an earlier middleware read cannot be cloned; Hono's cache serves it instead.\n      if (contentType.startsWith(TEXT_CONTENT_TYPE_PREFIX)) {\n        const rs = opts.req.raw.bodyUsed\n          ? await opts.req.text()\n          : await opts.req.raw.clone().text();\n        return rs;\n      }\n\n      return `<${contentLength ?? 'unknown'} bytes, ${contentType}>`;\n    } catch {\n      throw getError({\n        error: RequestErrors.BODY_MALFORMED,\n        message: 'Malformed Body Payload',\n      });\n    }\n  }\n\n  /** Returns a Hono middleware that logs request details and duration. */\n  value() {\n    return createMiddleware(async (context, next) => {\n      const t = performance.now();\n      const { req } = context;\n\n      const requestId = context.get(RequestSpyMiddleware.REQUEST_ID_KEY);\n      const incomingIp = NetworkUtility.getIncomingIp(context);\n      const forwardedIp = req.header('x-real-ip') ?? req.header('x-forwarded-for') ?? null;\n\n      const method = req.method;\n      const path = req.path ?? '/';\n\n      // Best-effort, never fatal: a unix socket, some proxies and any in-process call yield no connection info - refusing to serve because the client IP is unknown turns a logging gap into an outage.\n      const clientIp = incomingIp ?? forwardedIp ?? 'unknown';\n      const query = req.query() ?? {};\n\n      if (this.isDebugMode) {\n        const body = await this.parseBody({ req });\n        this.logger.info(\n          '[%s][%s][=>] %s %s | query: %j | body: %j',\n          requestId,\n          clientIp,\n          method.padEnd(8, ' '),\n          path,\n          query,\n          body,\n        );\n      } else {\n        // Only JSON is parsed here: its clean 400 on a malformed body is a contract. Any other body\n        // would be read for a log line that never prints it, before the route's own size checks.\n        if (req.header(HTTP.Headers.CONTENT_TYPE)?.includes(HTTP.HeaderValues.APPLICATION_JSON)) {\n          await this.parseBody({ req });\n        }\n\n        this.logger.info(\n          '[%s][%s][=>] %s %s | query: %j',\n          requestId,\n          clientIp,\n          method.padEnd(8, ' '),\n          path,\n          query,\n        );\n      }\n\n      await next();\n\n      const duration = (performance.now() - t).toFixed(2);\n      this.logger.info(\n        '[%s][%s][<=] %s %s | Took: %s (ms)',\n        requestId,\n        clientIp,\n        method.padEnd(8, ' '),\n        path,\n        duration,\n      );\n    });\n  }\n}\n"]}

package/dist/esm/common/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/common/constants.ts"],"names":[],"mappings":"AAEA,kCAAkC;AAClC,qBAAa,GAAG;IACd,MAAM,CAAC,QAAQ,CAAC,gBAAgB,SACkC;IAElE,MAAM,CAAC,QAAQ,CAAC,mBAAmB,MAAM;IACzC,MAAM,CAAC,QAAQ,CAAC,oBAAoB,KAAK;IAEzC,MAAM,CAAC,QAAQ,CAAC,WAAW,gBAAgB;IAC3C,MAAM,CAAC,QAAQ,CAAC,SAAS,YAAY;IACrC,MAAM,CAAC,QAAQ,CAAC,QAAQ,WAAW;CACpC"}

package/dist/esm/common/constants.js

@@ -0,0 +1,11 @@
+import { blankToUndefined } from '@venizia/ignis-helpers/core';
+/** Application-wide constants. */
+export class App {
+    static { this.APPLICATION_NAME = blankToUndefined(process.env.APP_ENV_APPLICATION_NAME) ?? 'APP'; }
+    static { this.DEFAULT_QUERY_LIMIT = 50; }
+    static { this.DEFAULT_QUERY_OFFSET = 0; }
+    static { this.DS_POSTGRES = 'postgresql'; }
+    static { this.DS_MEMORY = 'memory'; }
+    static { this.DS_REDIS = 'redis'; }
+}
+//# sourceMappingURL=constants.js.map

package/dist/esm/common/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/common/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAE/D,kCAAkC;AAClC,MAAM,OAAO,GAAG;aACE,qBAAgB,GAC9B,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,IAAI,KAAK,CAAC;aAElD,wBAAmB,GAAG,EAAE,CAAC;aACzB,yBAAoB,GAAG,CAAC,CAAC;aAEzB,gBAAW,GAAG,YAAY,CAAC;aAC3B,cAAS,GAAG,QAAQ,CAAC;aACrB,aAAQ,GAAG,OAAO,CAAC","sourcesContent":["import { blankToUndefined } from '@venizia/ignis-helpers/core';\n\n/** Application-wide constants. */\nexport class App {\n  static readonly APPLICATION_NAME =\n    blankToUndefined(process.env.APP_ENV_APPLICATION_NAME) ?? 'APP';\n\n  static readonly DEFAULT_QUERY_LIMIT = 50;\n  static readonly DEFAULT_QUERY_OFFSET = 0;\n\n  static readonly DS_POSTGRES = 'postgresql';\n  static readonly DS_MEMORY = 'memory';\n  static readonly DS_REDIS = 'redis';\n}\n"]}

package/dist/esm/common/environments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"environments.d.ts","sourceRoot":"","sources":["../../../src/common/environments.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,eAAe;IAG1B,8DAA8D;IAC9D,MAAM,CAAC,QAAQ,CAAC,wBAAwB,8BAA8B;IACtE,2DAA2D;IAC3D,MAAM,CAAC,QAAQ,CAAC,4BAA4B,kCAAkC;IAC9E,yFAAyF;IACzF,MAAM,CAAC,QAAQ,CAAC,0BAA0B,gCAAgC;IAC1E,+DAA+D;IAC/D,MAAM,CAAC,QAAQ,CAAC,mBAAmB,yBAAyB;IAC5D,+DAA+D;IAC/D,MAAM,CAAC,QAAQ,CAAC,mBAAmB,yBAAyB;IAI5D,MAAM,CAAC,QAAQ,CAAC,0BAA0B,gCAAgC;IAC1E,MAAM,CAAC,QAAQ,CAAC,yBAAyB,+BAA+B;IAExE,MAAM,CAAC,QAAQ,CAAC,kBAAkB,wBAAwB;IAC1D,MAAM,CAAC,QAAQ,CAAC,sBAAsB,4BAA4B;IAElE,MAAM,CAAC,QAAQ,CAAC,wBAAwB,8BAA8B;IAEtE,MAAM,CAAC,QAAQ,CAAC,qBAAqB,2BAA2B;IAChE,MAAM,CAAC,QAAQ,CAAC,qBAAqB,2BAA2B;IAChE,MAAM,CAAC,QAAQ,CAAC,yBAAyB,+BAA+B;IACxE,MAAM,CAAC,QAAQ,CAAC,yBAAyB,+BAA+B;IACxE,MAAM,CAAC,QAAQ,CAAC,yBAAyB,+BAA+B;CACzE"}

package/dist/esm/common/environments.js

@@ -0,0 +1,47 @@
+/**
+ * Environment variable names.
+ *
+ * The two groups mean different things and the split is load-bearing: a name in the second group
+ * is a CONVENTION an application reads for itself, and setting it changes nothing in IGNIS. Every
+ * name here was once presented as framework configuration, which is how a deployment came to set
+ * `APP_ENV_APPLICATION_DS_MIGRATION` against a framework that read `APP_ENV_DS_MIGRATION` - and
+ * neither name selected anything, so both are gone.
+ *
+ * A name earns its place by having a reader. `APP_ENV_OAUTH2_VIEW_FOLDER` and
+ * `APP_ENV_DATASOURCE_NAME` had none in either IGNIS or its consumers, only entries in `.env` files
+ * nobody consulted, so they went the same way. Before adding one here, know who reads it.
+ *
+ * Two framework variables are deliberately ABSENT from this class, and adding them would be a trap:
+ * `APPLICATION_ENV_PREFIX` and `ALLOW_EMPTY_ENV_VALUE`. Neither carries the `APP_ENV` prefix, so
+ * `applicationEnvironment` never holds them - a read through `AppEnvs.get()` would answer `undefined`
+ * forever. `APPLICATION_ENV_PREFIX` could not go through it in any case: it is what builds the
+ * filter. Both are bootstrap variables and are read straight off `process.env`, which is the one
+ * legitimate exception to "do not read process.env directly". Neither has to be declared or set:
+ * the prefix defaults to `APP_ENV`, and empty values are allowed unless you set
+ * `ALLOW_EMPTY_ENV_VALUE` to `false` or `0`.
+ */
+export class EnvironmentKeys {
+    // --- Read by the framework -------------------------------------------------------------------
+    /** `AppConstants.APPLICATION_NAME` and the startup banner. */
+    static { this.APP_ENV_APPLICATION_NAME = 'APP_ENV_APPLICATION_NAME'; }
+    /** `DateUtility`'s default zone and the startup banner. */
+    static { this.APP_ENV_APPLICATION_TIMEZONE = 'APP_ENV_APPLICATION_TIMEZONE'; }
+    /** Set it to enable rotating file logs; unset means console. Also the startup banner. */
+    static { this.APP_ENV_LOGGER_FOLDER_PATH = 'APP_ENV_LOGGER_FOLDER_PATH'; }
+    /** Fallback host when `IApplicationConfigs.host` is absent. */
+    static { this.APP_ENV_SERVER_HOST = 'APP_ENV_SERVER_HOST'; }
+    /** Fallback port when `IApplicationConfigs.port` is absent. */
+    static { this.APP_ENV_SERVER_PORT = 'APP_ENV_SERVER_PORT'; }
+    // --- Convention only: nothing in IGNIS reads these ---------------------------------------------
+    static { this.APP_ENV_APPLICATION_SECRET = 'APP_ENV_APPLICATION_SECRET'; }
+    static { this.APP_ENV_APPLICATION_ROLES = 'APP_ENV_APPLICATION_ROLES'; }
+    static { this.APP_ENV_JWT_SECRET = 'APP_ENV_JWT_SECRET'; }
+    static { this.APP_ENV_JWT_EXPIRES_IN = 'APP_ENV_JWT_EXPIRES_IN'; }
+    static { this.APP_ENV_SERVER_BASE_PATH = 'APP_ENV_SERVER_BASE_PATH'; }
+    static { this.APP_ENV_POSTGRES_HOST = 'APP_ENV_POSTGRES_HOST'; }
+    static { this.APP_ENV_POSTGRES_PORT = 'APP_ENV_POSTGRES_PORT'; }
+    static { this.APP_ENV_POSTGRES_USERNAME = 'APP_ENV_POSTGRES_USERNAME'; }
+    static { this.APP_ENV_POSTGRES_PASSWORD = 'APP_ENV_POSTGRES_PASSWORD'; }
+    static { this.APP_ENV_POSTGRES_DATABASE = 'APP_ENV_POSTGRES_DATABASE'; }
+}
+//# sourceMappingURL=environments.js.map

package/dist/esm/common/environments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"environments.js","sourceRoot":"","sources":["../../../src/common/environments.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,eAAe;IAC1B,gGAAgG;IAEhG,8DAA8D;aAC9C,6BAAwB,GAAG,0BAA0B,CAAC;IACtE,2DAA2D;aAC3C,iCAA4B,GAAG,8BAA8B,CAAC;IAC9E,yFAAyF;aACzE,+BAA0B,GAAG,4BAA4B,CAAC;IAC1E,+DAA+D;aAC/C,wBAAmB,GAAG,qBAAqB,CAAC;IAC5D,+DAA+D;aAC/C,wBAAmB,GAAG,qBAAqB,CAAC;IAE5D,kGAAkG;aAElF,+BAA0B,GAAG,4BAA4B,CAAC;aAC1D,8BAAyB,GAAG,2BAA2B,CAAC;aAExD,uBAAkB,GAAG,oBAAoB,CAAC;aAC1C,2BAAsB,GAAG,wBAAwB,CAAC;aAElD,6BAAwB,GAAG,0BAA0B,CAAC;aAEtD,0BAAqB,GAAG,uBAAuB,CAAC;aAChD,0BAAqB,GAAG,uBAAuB,CAAC;aAChD,8BAAyB,GAAG,2BAA2B,CAAC;aACxD,8BAAyB,GAAG,2BAA2B,CAAC;aACxD,8BAAyB,GAAG,2BAA2B,CAAC","sourcesContent":["/**\n * Environment variable names.\n *\n * The two groups mean different things and the split is load-bearing: a name in the second group\n * is a CONVENTION an application reads for itself, and setting it changes nothing in IGNIS. Every\n * name here was once presented as framework configuration, which is how a deployment came to set\n * `APP_ENV_APPLICATION_DS_MIGRATION` against a framework that read `APP_ENV_DS_MIGRATION` - and\n * neither name selected anything, so both are gone.\n *\n * A name earns its place by having a reader. `APP_ENV_OAUTH2_VIEW_FOLDER` and\n * `APP_ENV_DATASOURCE_NAME` had none in either IGNIS or its consumers, only entries in `.env` files\n * nobody consulted, so they went the same way. Before adding one here, know who reads it.\n *\n * Two framework variables are deliberately ABSENT from this class, and adding them would be a trap:\n * `APPLICATION_ENV_PREFIX` and `ALLOW_EMPTY_ENV_VALUE`. Neither carries the `APP_ENV` prefix, so\n * `applicationEnvironment` never holds them - a read through `AppEnvs.get()` would answer `undefined`\n * forever. `APPLICATION_ENV_PREFIX` could not go through it in any case: it is what builds the\n * filter. Both are bootstrap variables and are read straight off `process.env`, which is the one\n * legitimate exception to \"do not read process.env directly\". Neither has to be declared or set:\n * the prefix defaults to `APP_ENV`, and empty values are allowed unless you set\n * `ALLOW_EMPTY_ENV_VALUE` to `false` or `0`.\n */\nexport class EnvironmentKeys {\n  // --- Read by the framework -------------------------------------------------------------------\n\n  /** `AppConstants.APPLICATION_NAME` and the startup banner. */\n  static readonly APP_ENV_APPLICATION_NAME = 'APP_ENV_APPLICATION_NAME';\n  /** `DateUtility`'s default zone and the startup banner. */\n  static readonly APP_ENV_APPLICATION_TIMEZONE = 'APP_ENV_APPLICATION_TIMEZONE';\n  /** Set it to enable rotating file logs; unset means console. Also the startup banner. */\n  static readonly APP_ENV_LOGGER_FOLDER_PATH = 'APP_ENV_LOGGER_FOLDER_PATH';\n  /** Fallback host when `IApplicationConfigs.host` is absent. */\n  static readonly APP_ENV_SERVER_HOST = 'APP_ENV_SERVER_HOST';\n  /** Fallback port when `IApplicationConfigs.port` is absent. */\n  static readonly APP_ENV_SERVER_PORT = 'APP_ENV_SERVER_PORT';\n\n  // --- Convention only: nothing in IGNIS reads these ---------------------------------------------\n\n  static readonly APP_ENV_APPLICATION_SECRET = 'APP_ENV_APPLICATION_SECRET';\n  static readonly APP_ENV_APPLICATION_ROLES = 'APP_ENV_APPLICATION_ROLES';\n\n  static readonly APP_ENV_JWT_SECRET = 'APP_ENV_JWT_SECRET';\n  static readonly APP_ENV_JWT_EXPIRES_IN = 'APP_ENV_JWT_EXPIRES_IN';\n\n  static readonly APP_ENV_SERVER_BASE_PATH = 'APP_ENV_SERVER_BASE_PATH';\n\n  static readonly APP_ENV_POSTGRES_HOST = 'APP_ENV_POSTGRES_HOST';\n  static readonly APP_ENV_POSTGRES_PORT = 'APP_ENV_POSTGRES_PORT';\n  static readonly APP_ENV_POSTGRES_USERNAME = 'APP_ENV_POSTGRES_USERNAME';\n  static readonly APP_ENV_POSTGRES_PASSWORD = 'APP_ENV_POSTGRES_PASSWORD';\n  static readonly APP_ENV_POSTGRES_DATABASE = 'APP_ENV_POSTGRES_DATABASE';\n}\n"]}

package/dist/esm/common/index.d.ts

@@ -0,0 +1,4 @@
+export * from '@venizia/ignis-kernel';
+export * from './constants.js';
+export * from './environments.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/common/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/common/index.ts"],"names":[],"mappings":"AACA,cAAc,uBAAuB,CAAC;AAEtC,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC"}

package/dist/esm/common/index.js

@@ -0,0 +1,5 @@
+// `bindings.ts`, `error-codes.ts` and `statuses.ts` moved to the kernel.
+export * from '@venizia/ignis-kernel';
+export * from './constants.js';
+export * from './environments.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/common/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/common/index.ts"],"names":[],"mappings":"AAAA,yEAAyE;AACzE,cAAc,uBAAuB,CAAC;AAEtC,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC","sourcesContent":["// `bindings.ts`, `error-codes.ts` and `statuses.ts` moved to the kernel.\nexport * from '@venizia/ignis-kernel';\n\nexport * from './constants';\nexport * from './environments';\n"]}

package/dist/esm/components/api-reference/common/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../../src/components/api-reference/common/constants.ts"],"names":[],"mappings":"AAAA,qBAAa,eAAe;IAC1B,MAAM,CAAC,QAAQ,CAAC,OAAO,aAAa;IACpC,MAAM,CAAC,QAAQ,CAAC,MAAM,YAAY;IAElC,MAAM,CAAC,QAAQ,CAAC,UAAU,cAAwC;IAElE,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;CAGvC"}

package/dist/esm/components/api-reference/common/constants.js

@@ -0,0 +1,9 @@
+export class DocumentUITypes {
+    static { this.SWAGGER = 'swagger'; }
+    static { this.SCALAR = 'scalar'; }
+    static { this.SCHEME_SET = new Set([this.SWAGGER, this.SCALAR]); }
+    static isValid(value) {
+        return this.SCHEME_SET.has(value);
+    }
+}
+//# sourceMappingURL=constants.js.map

package/dist/esm/components/api-reference/common/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../../src/components/api-reference/common/constants.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,eAAe;aACV,YAAO,GAAG,SAAS,CAAC;aACpB,WAAM,GAAG,QAAQ,CAAC;aAElB,eAAU,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAElE,MAAM,CAAC,OAAO,CAAC,KAAa;QAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC","sourcesContent":["export class DocumentUITypes {\n  static readonly SWAGGER = 'swagger';\n  static readonly SCALAR = 'scalar';\n\n  static readonly SCHEME_SET = new Set([this.SWAGGER, this.SCALAR]);\n\n  static isValid(value: string): boolean {\n    return this.SCHEME_SET.has(value);\n  }\n}\n"]}

package/dist/esm/components/api-reference/common/index.d.ts

@@ -0,0 +1,4 @@
+export * from './constants.js';
+export * from './keys.js';
+export * from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/components/api-reference/common/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/components/api-reference/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC"}

package/dist/esm/components/api-reference/common/index.js

@@ -0,0 +1,4 @@
+export * from './constants.js';
+export * from './keys.js';
+export * from './types.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/components/api-reference/common/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/components/api-reference/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC","sourcesContent":["export * from './constants';\nexport * from './keys';\nexport * from './types';\n"]}

package/dist/esm/components/api-reference/common/keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.d.ts","sourceRoot":"","sources":["../../../../../src/components/api-reference/common/keys.ts"],"names":[],"mappings":"AAAA,qBAAa,uBAAuB;IAClC,MAAM,CAAC,QAAQ,CAAC,qBAAqB,gCAAgC;CACtE"}

package/dist/esm/components/api-reference/common/keys.js

@@ -0,0 +1,4 @@
+export class ApiReferenceBindingKeys {
+    static { this.API_REFERENCE_OPTIONS = '@app/api-reference/options'; }
+}
+//# sourceMappingURL=keys.js.map

package/dist/esm/components/api-reference/common/keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.js","sourceRoot":"","sources":["../../../../../src/components/api-reference/common/keys.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,uBAAuB;aAClB,0BAAqB,GAAG,4BAA4B,CAAC","sourcesContent":["export class ApiReferenceBindingKeys {\n  static readonly API_REFERENCE_OPTIONS = '@app/api-reference/options';\n}\n"]}

package/dist/esm/components/api-reference/common/types.d.ts

@@ -0,0 +1,49 @@
+import type { Context, Next } from 'hono';
+import type { DocumentUITypes } from './constants.js';
+import type { TConstValue } from '@venizia/ignis-helpers/common';
+export type TDocumentUIType = TConstValue<typeof DocumentUITypes>;
+/** Every field is optional: a partially-filled binding falls back to the component defaults. */
+export interface IApiReferenceOptions {
+    restOptions?: {
+        base?: {
+            path?: string;
+        };
+        doc?: {
+            path?: string;
+        };
+        ui?: {
+            path?: string;
+            type?: TDocumentUIType;
+        };
+    };
+    explorer?: {
+        openapi?: string;
+        info?: {
+            title: string;
+            version: string;
+            description: string;
+            contact?: {
+                name: string;
+                email: string;
+            };
+        };
+        servers?: Array<{
+            url: string;
+            description?: string;
+        }>;
+    };
+    uiConfig?: Record<string, any>;
+    securitySchemes?: Record<string, Record<string, any>>;
+}
+export interface IUIProvider {
+    render(context: Context, config: IUIConfig, next: Next): Promise<Response | void>;
+}
+export interface IUIConfig {
+    title: string;
+    url: string;
+    [key: string]: any;
+}
+export interface IGetProviderParams {
+    type: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/esm/components/api-reference/common/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/components/api-reference/common/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC1C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAEjE,MAAM,MAAM,eAAe,GAAG,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAElE,gGAAgG;AAChG,MAAM,WAAW,oBAAoB;IACnC,WAAW,CAAC,EAAE;QACZ,IAAI,CAAC,EAAE;YAAE,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;QACzB,GAAG,CAAC,EAAE;YAAE,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;QACxB,EAAE,CAAC,EAAE;YAAE,IAAI,CAAC,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,eAAe,CAAA;SAAE,CAAC;KAChD,CAAC;IACF,QAAQ,CAAC,EAAE;QACT,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,IAAI,CAAC,EAAE;YACL,KAAK,EAAE,MAAM,CAAC;YACd,OAAO,EAAE,MAAM,CAAC;YAChB,WAAW,EAAE,MAAM,CAAC;YACpB,OAAO,CAAC,EAAE;gBAAE,IAAI,EAAE,MAAM,CAAC;gBAAC,KAAK,EAAE,MAAM,CAAA;aAAE,CAAC;SAC3C,CAAC;QACF,OAAO,CAAC,EAAE,KAAK,CAAC;YACd,GAAG,EAAE,MAAM,CAAC;YACZ,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB,CAAC,CAAC;KACJ,CAAC;IACF,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/B,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC;CACnF;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;CACd"}

package/dist/esm/components/api-reference/common/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/components/api-reference/common/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../src/components/api-reference/common/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { Context, Next } from 'hono';\nimport type { DocumentUITypes } from './constants';\nimport type { TConstValue } from '@venizia/ignis-helpers/common';\n\nexport type TDocumentUIType = TConstValue<typeof DocumentUITypes>;\n\n/** Every field is optional: a partially-filled binding falls back to the component defaults. */\nexport interface IApiReferenceOptions {\n  restOptions?: {\n    base?: { path?: string };\n    doc?: { path?: string };\n    ui?: { path?: string; type?: TDocumentUIType };\n  };\n  explorer?: {\n    openapi?: string;\n    info?: {\n      title: string;\n      version: string;\n      description: string;\n      contact?: { name: string; email: string };\n    };\n    servers?: Array<{\n      url: string;\n      description?: string;\n    }>;\n  };\n  uiConfig?: Record<string, any>;\n  securitySchemes?: Record<string, Record<string, any>>;\n}\n\nexport interface IUIProvider {\n  render(context: Context, config: IUIConfig, next: Next): Promise<Response | void>;\n}\n\nexport interface IUIConfig {\n  title: string;\n  url: string;\n  [key: string]: any;\n}\n\nexport interface IGetProviderParams {\n  type: string;\n}\n"]}

package/dist/esm/components/api-reference/component.d.ts

@@ -0,0 +1,8 @@
+import { type BaseApplication } from '../../base/applications/index.js';
+import { BaseComponent } from '@venizia/ignis-kernel';
+export declare class ApiReferenceComponent extends BaseComponent {
+    private application;
+    constructor(application: BaseApplication);
+    binding(): Promise<void>;
+}
+//# sourceMappingURL=component.d.ts.map

package/dist/esm/components/api-reference/component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"component.d.ts","sourceRoot":"","sources":["../../../../src/components/api-reference/component.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAK3D,OAAO,EAAE,aAAa,EAAyB,MAAM,uBAAuB,CAAC;AAkC7E,qBAAa,qBAAsB,SAAQ,aAAa;IAEA,OAAO,CAAC,WAAW;gBAAX,WAAW,EAAE,eAAe;IAa3E,OAAO;CAgGvB"}

package/dist/esm/components/api-reference/component.js

@@ -0,0 +1,136 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var ApiReferenceComponent_1;
+import { inject } from '../../base/metadata/index.js';
+import { getError } from '@venizia/ignis-helpers/core';
+import { BaseComponent, Binding, CoreBindings } from '@venizia/ignis-kernel';
+import { Authentication } from '../auth/index.js';
+import { ServiceAssertion } from '@venizia/ignis-kernel';
+import { ApiReferenceBindingKeys, DocumentUITypes } from './common/index.js';
+import { UIProviderFactory } from './ui/index.js';
+const DEFAULT_API_REFERENCE_OPTIONS = {
+    restOptions: {
+        base: { path: '/doc' },
+        doc: { path: '/openapi.json' },
+        ui: { path: '/explorer', type: 'scalar' },
+    },
+    explorer: {
+        openapi: '3.0.0',
+        info: {
+            title: 'API Documentation',
+            version: '1.0.0',
+            description: 'API documentation for your service',
+        },
+    },
+};
+/** Joins rest path segments into a single absolute path (no empty or duplicated separators). */
+const joinRestPath = (segments) => {
+    const joined = segments
+        .filter((segment) => Boolean(segment))
+        .join('/')
+        .replace(/\/+/g, '/')
+        .replace(/\/$/, '');
+    return joined.startsWith('/') ? joined : `/${joined}`;
+};
+let ApiReferenceComponent = ApiReferenceComponent_1 = class ApiReferenceComponent extends BaseComponent {
+    constructor(application) {
+        super({
+            scope: ApiReferenceComponent_1.name,
+            initDefault: { enable: true, container: application },
+            bindings: {
+                [ApiReferenceBindingKeys.API_REFERENCE_OPTIONS]: Binding.bind({
+                    key: ApiReferenceBindingKeys.API_REFERENCE_OPTIONS,
+                }).toValue(DEFAULT_API_REFERENCE_OPTIONS),
+            },
+        });
+        this.application = application;
+    }
+    async binding() {
+        const boundOptions = this.application.get({
+            key: ApiReferenceBindingKeys.API_REFERENCE_OPTIONS,
+            isOptional: true,
+        });
+        const defaultRestOptions = DEFAULT_API_REFERENCE_OPTIONS.restOptions;
+        const restOptions = {
+            base: { ...defaultRestOptions.base, ...boundOptions?.restOptions?.base },
+            doc: { ...defaultRestOptions.doc, ...boundOptions?.restOptions?.doc },
+            ui: { ...defaultRestOptions.ui, ...boundOptions?.restOptions?.ui },
+        };
+        // A fresh explorer object per application: mutating the bound one (or the module default) leaks this application's info/servers into every later application in the process.
+        const explorer = {
+            ...DEFAULT_API_REFERENCE_OPTIONS.explorer,
+            ...boundOptions?.explorer,
+        };
+        const rootRouter = this.application.getRootRouter();
+        const configs = this.application.getProjectConfigs();
+        const appInfo = await this.application.getAppInfo();
+        explorer.info = {
+            title: appInfo.name,
+            version: appInfo.version,
+            description: appInfo.description,
+            contact: appInfo.author,
+        };
+        if (!explorer.servers?.length) {
+            explorer.servers = [
+                {
+                    url: ['http://', this.application.getServerAddress(), configs.path.base ?? ''].join(''),
+                    description: 'Local Application Server URL',
+                },
+            ];
+        }
+        const docPath = joinRestPath([restOptions.base.path, restOptions.doc.path]);
+        const uiPath = joinRestPath([restOptions.base.path, restOptions.ui.path]);
+        rootRouter.doc(docPath, explorer);
+        const uiType = restOptions.ui.type ?? DocumentUITypes.SWAGGER;
+        const uiProviderFactory = UIProviderFactory.getInstance();
+        // A custom provider registered on the factory is honoured; only unknown types are rejected.
+        if (!uiProviderFactory.isBound(uiType)) {
+            if (!DocumentUITypes.isValid(uiType)) {
+                throw getError({
+                    message: `[binding] Invalid document UI Type | uiType: ${uiType} | valids: ${[...DocumentUITypes.SCHEME_SET]}`,
+                });
+            }
+            uiProviderFactory.register({ type: uiType });
+        }
+        const docUrl = joinRestPath([configs.path.base, docPath]);
+        const uiProvider = uiProviderFactory.getProvider({ type: uiType });
+        rootRouter.get(uiPath, async (context, next) => {
+            return uiProvider.render(context, {
+                title: appInfo.name,
+                url: docUrl,
+                ...(boundOptions?.uiConfig ?? {}),
+            }, next);
+        });
+        rootRouter.openAPIRegistry.registerComponent('securitySchemes', Authentication.STRATEGY_JWT, {
+            type: 'http',
+            scheme: 'bearer',
+            bearerFormat: 'JWT',
+        });
+        rootRouter.openAPIRegistry.registerComponent('securitySchemes', Authentication.STRATEGY_BASIC, {
+            type: 'http',
+            scheme: 'basic',
+        });
+        rootRouter.openAPIRegistry.registerComponent('securitySchemes', Authentication.STRATEGY_SERVICE, { type: 'apiKey', in: 'header', name: ServiceAssertion.HEADER });
+        const securitySchemes = boundOptions?.securitySchemes ?? {};
+        const securitySchemesEntries = Object.entries(securitySchemes);
+        for (const [name, scheme] of securitySchemesEntries) {
+            rootRouter.openAPIRegistry.registerComponent('securitySchemes', name, scheme);
+        }
+    }
+};
+ApiReferenceComponent = ApiReferenceComponent_1 = __decorate([
+    __param(0, inject({ key: CoreBindings.APPLICATION_INSTANCE })),
+    __metadata("design:paramtypes", [Function])
+], ApiReferenceComponent);
+export { ApiReferenceComponent };
+//# sourceMappingURL=component.js.map

package/dist/esm/components/api-reference/component.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"component.js","sourceRoot":"","sources":["../../../../src/components/api-reference/component.ts"],"names":[],"mappings":";;;;;;;;;;;;;AACA,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAGzC,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAE7E,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAA6B,MAAM,UAAU,CAAC;AAC/F,OAAO,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAC;AAEzC,MAAM,6BAA6B,GAAyB;IAC1D,WAAW,EAAE;QACX,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;QACtB,GAAG,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE;QAC9B,EAAE,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE;KAC1C;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE;YACJ,KAAK,EAAE,mBAAmB;YAC1B,OAAO,EAAE,OAAO;YAChB,WAAW,EAAE,oCAAoC;SAClD;KACF;CACF,CAAC;AAEF,gGAAgG;AAChG,MAAM,YAAY,GAAG,CAAC,QAAmC,EAAU,EAAE;IACnE,MAAM,MAAM,GAAG,QAAQ;SACpB,MAAM,CAAC,CAAC,OAAO,EAAqB,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SACxD,IAAI,CAAC,GAAG,CAAC;SACT,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;SACpB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAEtB,OAAO,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC;AACxD,CAAC,CAAC;AAEF,IAAa,qBAAqB,6BAAlC,MAAa,qBAAsB,SAAQ,aAAa;IACtD,YAC8D,WAA4B;QAExF,KAAK,CAAC;YACJ,KAAK,EAAE,uBAAqB,CAAC,IAAI;YACjC,WAAW,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE;YACrD,QAAQ,EAAE;gBACR,CAAC,uBAAuB,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC,IAAI,CAAuB;oBAClF,GAAG,EAAE,uBAAuB,CAAC,qBAAqB;iBACnD,CAAC,CAAC,OAAO,CAAC,6BAA6B,CAAC;aAC1C;SACF,CAAC,CAAC;QAVyD,gBAAW,GAAX,WAAW,CAAiB;IAW1F,CAAC;IAEQ,KAAK,CAAC,OAAO;QACpB,MAAM,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAuB;YAC9D,GAAG,EAAE,uBAAuB,CAAC,qBAAqB;YAClD,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;QAEH,MAAM,kBAAkB,GAAG,6BAA6B,CAAC,WAAY,CAAC;QACtE,MAAM,WAAW,GAAG;YAClB,IAAI,EAAE,EAAE,GAAG,kBAAkB,CAAC,IAAI,EAAE,GAAG,YAAY,EAAE,WAAW,EAAE,IAAI,EAAE;YACxE,GAAG,EAAE,EAAE,GAAG,kBAAkB,CAAC,GAAG,EAAE,GAAG,YAAY,EAAE,WAAW,EAAE,GAAG,EAAE;YACrE,EAAE,EAAE,EAAE,GAAG,kBAAkB,CAAC,EAAE,EAAE,GAAG,YAAY,EAAE,WAAW,EAAE,EAAE,EAAE;SACnE,CAAC;QAEF,6KAA6K;QAC7K,MAAM,QAAQ,GAAkD;YAC9D,GAAG,6BAA6B,CAAC,QAAQ;YACzC,GAAG,YAAY,EAAE,QAAQ;SAC1B,CAAC;QAEF,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC;QACpD,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC;QAErD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QACpD,QAAQ,CAAC,IAAI,GAAG;YACd,KAAK,EAAE,OAAO,CAAC,IAAI;YACnB,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,OAAO,EAAE,OAAO,CAAC,MAAM;SACxB,CAAC;QAEF,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;YAC9B,QAAQ,CAAC,OAAO,GAAG;gBACjB;oBACE,GAAG,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;oBACvF,WAAW,EAAE,8BAA8B;iBAC5C;aACF,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,GAAG,YAAY,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5E,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAE1E,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE,QAA+C,CAAC,CAAC;QAEzE,MAAM,MAAM,GAAG,WAAW,CAAC,EAAE,CAAC,IAAI,IAAI,eAAe,CAAC,OAAO,CAAC;QAC9D,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,WAAW,EAAE,CAAC;QAE1D,4FAA4F;QAC5F,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACvC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBACrC,MAAM,QAAQ,CAAC;oBACb,OAAO,EAAE,gDAAgD,MAAM,cAAc,CAAC,GAAG,eAAe,CAAC,UAAU,CAAC,EAAE;iBAC/G,CAAC,CAAC;YACL,CAAC;YAED,iBAAiB,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QAC/C,CAAC;QAED,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QAC1D,MAAM,UAAU,GAAG,iBAAiB,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QAEnE,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,OAAgB,EAAE,IAAU,EAAE,EAAE;YAC5D,OAAO,UAAU,CAAC,MAAM,CACtB,OAAO,EACP;gBACE,KAAK,EAAE,OAAO,CAAC,IAAI;gBACnB,GAAG,EAAE,MAAM;gBACX,GAAG,CAAC,YAAY,EAAE,QAAQ,IAAI,EAAE,CAAC;aAClC,EACD,IAAI,CACL,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,UAAU,CAAC,eAAe,CAAC,iBAAiB,CAAC,iBAAiB,EAAE,cAAc,CAAC,YAAY,EAAE;YAC3F,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,QAAQ;YAChB,YAAY,EAAE,KAAK;SACpB,CAAC,CAAC;QAEH,UAAU,CAAC,eAAe,CAAC,iBAAiB,CAAC,iBAAiB,EAAE,cAAc,CAAC,cAAc,EAAE;YAC7F,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,OAAO;SAChB,CAAC,CAAC;QAEH,UAAU,CAAC,eAAe,CAAC,iBAAiB,CAC1C,iBAAiB,EACjB,cAAc,CAAC,gBAAgB,EAC/B,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,gBAAgB,CAAC,MAAM,EAAE,CAChE,CAAC;QAEF,MAAM,eAAe,GAAG,YAAY,EAAE,eAAe,IAAI,EAAE,CAAC;QAC5D,MAAM,sBAAsB,GAAG,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QAC/D,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,sBAAsB,EAAE,CAAC;YACpD,UAAU,CAAC,eAAe,CAAC,iBAAiB,CAAC,iBAAiB,EAAE,IAAI,EAAE,MAAiB,CAAC,CAAC;QAC3F,CAAC;IACH,CAAC;CACF,CAAA;AA/GY,qBAAqB;IAE7B,WAAA,MAAM,CAAC,EAAE,GAAG,EAAE,YAAY,CAAC,oBAAoB,EAAE,CAAC,CAAA;;GAF1C,qBAAqB,CA+GjC","sourcesContent":["import { type BaseApplication } from '@/base/applications';\nimport { inject } from '@/base/metadata';\nimport { type OpenAPIObjectConfigure } from '@hono/zod-openapi';\nimport type { AnyType } from '@venizia/ignis-helpers/common';\nimport { getError } from '@venizia/ignis-helpers/core';\nimport { BaseComponent, Binding, CoreBindings } from '@venizia/ignis-kernel';\nimport type { Context, Next } from 'hono';\nimport { Authentication } from '../auth';\nimport { ServiceAssertion } from '@venizia/ignis-kernel';\nimport { ApiReferenceBindingKeys, DocumentUITypes, type IApiReferenceOptions } from './common';\nimport { UIProviderFactory } from './ui';\n\nconst DEFAULT_API_REFERENCE_OPTIONS: IApiReferenceOptions = {\n  restOptions: {\n    base: { path: '/doc' },\n    doc: { path: '/openapi.json' },\n    ui: { path: '/explorer', type: 'scalar' },\n  },\n  explorer: {\n    openapi: '3.0.0',\n    info: {\n      title: 'API Documentation',\n      version: '1.0.0',\n      description: 'API documentation for your service',\n    },\n  },\n};\n\n/** Joins rest path segments into a single absolute path (no empty or duplicated separators). */\nconst joinRestPath = (segments: Array<string | undefined>): string => {\n  const joined = segments\n    .filter((segment): segment is string => Boolean(segment))\n    .join('/')\n    .replace(/\\/+/g, '/')\n    .replace(/\\/$/, '');\n\n  return joined.startsWith('/') ? joined : `/${joined}`;\n};\n\nexport class ApiReferenceComponent extends BaseComponent {\n  constructor(\n    @inject({ key: CoreBindings.APPLICATION_INSTANCE }) private application: BaseApplication,\n  ) {\n    super({\n      scope: ApiReferenceComponent.name,\n      initDefault: { enable: true, container: application },\n      bindings: {\n        [ApiReferenceBindingKeys.API_REFERENCE_OPTIONS]: Binding.bind<IApiReferenceOptions>({\n          key: ApiReferenceBindingKeys.API_REFERENCE_OPTIONS,\n        }).toValue(DEFAULT_API_REFERENCE_OPTIONS),\n      },\n    });\n  }\n\n  override async binding() {\n    const boundOptions = this.application.get<IApiReferenceOptions>({\n      key: ApiReferenceBindingKeys.API_REFERENCE_OPTIONS,\n      isOptional: true,\n    });\n\n    const defaultRestOptions = DEFAULT_API_REFERENCE_OPTIONS.restOptions!;\n    const restOptions = {\n      base: { ...defaultRestOptions.base, ...boundOptions?.restOptions?.base },\n      doc: { ...defaultRestOptions.doc, ...boundOptions?.restOptions?.doc },\n      ui: { ...defaultRestOptions.ui, ...boundOptions?.restOptions?.ui },\n    };\n\n    // A fresh explorer object per application: mutating the bound one (or the module default) leaks this application's info/servers into every later application in the process.\n    const explorer: NonNullable<IApiReferenceOptions['explorer']> = {\n      ...DEFAULT_API_REFERENCE_OPTIONS.explorer,\n      ...boundOptions?.explorer,\n    };\n\n    const rootRouter = this.application.getRootRouter();\n    const configs = this.application.getProjectConfigs();\n\n    const appInfo = await this.application.getAppInfo();\n    explorer.info = {\n      title: appInfo.name,\n      version: appInfo.version,\n      description: appInfo.description,\n      contact: appInfo.author,\n    };\n\n    if (!explorer.servers?.length) {\n      explorer.servers = [\n        {\n          url: ['http://', this.application.getServerAddress(), configs.path.base ?? ''].join(''),\n          description: 'Local Application Server URL',\n        },\n      ];\n    }\n\n    const docPath = joinRestPath([restOptions.base.path, restOptions.doc.path]);\n    const uiPath = joinRestPath([restOptions.base.path, restOptions.ui.path]);\n\n    rootRouter.doc(docPath, explorer as OpenAPIObjectConfigure<any, string>);\n\n    const uiType = restOptions.ui.type ?? DocumentUITypes.SWAGGER;\n    const uiProviderFactory = UIProviderFactory.getInstance();\n\n    // A custom provider registered on the factory is honoured; only unknown types are rejected.\n    if (!uiProviderFactory.isBound(uiType)) {\n      if (!DocumentUITypes.isValid(uiType)) {\n        throw getError({\n          message: `[binding] Invalid document UI Type | uiType: ${uiType} | valids: ${[...DocumentUITypes.SCHEME_SET]}`,\n        });\n      }\n\n      uiProviderFactory.register({ type: uiType });\n    }\n\n    const docUrl = joinRestPath([configs.path.base, docPath]);\n    const uiProvider = uiProviderFactory.getProvider({ type: uiType });\n\n    rootRouter.get(uiPath, async (context: Context, next: Next) => {\n      return uiProvider.render(\n        context,\n        {\n          title: appInfo.name,\n          url: docUrl,\n          ...(boundOptions?.uiConfig ?? {}),\n        },\n        next,\n      );\n    });\n\n    rootRouter.openAPIRegistry.registerComponent('securitySchemes', Authentication.STRATEGY_JWT, {\n      type: 'http',\n      scheme: 'bearer',\n      bearerFormat: 'JWT',\n    });\n\n    rootRouter.openAPIRegistry.registerComponent('securitySchemes', Authentication.STRATEGY_BASIC, {\n      type: 'http',\n      scheme: 'basic',\n    });\n\n    rootRouter.openAPIRegistry.registerComponent(\n      'securitySchemes',\n      Authentication.STRATEGY_SERVICE,\n      { type: 'apiKey', in: 'header', name: ServiceAssertion.HEADER },\n    );\n\n    const securitySchemes = boundOptions?.securitySchemes ?? {};\n    const securitySchemesEntries = Object.entries(securitySchemes);\n    for (const [name, scheme] of securitySchemesEntries) {\n      rootRouter.openAPIRegistry.registerComponent('securitySchemes', name, scheme as AnyType);\n    }\n  }\n}\n"]}

package/dist/esm/components/api-reference/index.d.ts

@@ -0,0 +1,4 @@
+export * from './common/index.js';
+export * from './component.js';
+export * from './ui/index.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/components/api-reference/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/api-reference/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,MAAM,CAAC"}

package/dist/esm/components/api-reference/index.js

@@ -0,0 +1,4 @@
+export * from './common/index.js';
+export * from './component.js';
+export * from './ui/index.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/components/api-reference/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/components/api-reference/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,MAAM,CAAC","sourcesContent":["export * from './common';\nexport * from './component';\nexport * from './ui';\n"]}

package/dist/esm/components/api-reference/ui/factory.d.ts

@@ -0,0 +1,14 @@
+import type { IGetProviderParams, IUIProvider } from '../common/index.js';
+import { MemoryStorageHelper } from '@venizia/ignis-helpers';
+export declare class UIProviderFactory extends MemoryStorageHelper<{
+    [key: string | symbol]: IUIProvider;
+}> {
+    private static instance;
+    static getInstance(): UIProviderFactory;
+    getProvider({ type }: IGetProviderParams): IUIProvider;
+    register(opts: {
+        type: string;
+    }): void;
+    getRegisteredProviders(): (string | number | symbol)[];
+}
+//# sourceMappingURL=factory.d.ts.map

package/dist/esm/components/api-reference/ui/factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../../../../src/components/api-reference/ui/factory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAGjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAI7D,qBAAa,iBAAkB,SAAQ,mBAAmB,CAAC;IACzD,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,WAAW,CAAC;CACrC,CAAC;IACA,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAoB;IAE3C,MAAM,CAAC,WAAW;IASlB,WAAW,CAAC,EAAE,IAAI,EAAE,EAAE,kBAAkB,GAAG,WAAW;IAYtD,QAAQ,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI;IAyBtC,sBAAsB;CAGvB"}