mirror of
https://github.com/goauthentik/authentik
synced 2026-05-15 03:16:22 +02:00
75a62b7dca
* Updgrade Typescript to use Typescript 7 (aka TSGO) * web: drop `packages/` and composite from `tsc -p .` graph (#22100) Excluding the workspace subpackages cuts the program graph from 2719 to 1800 non-`node_modules` files (-34%) — most of the drop is the 912 generated files in `packages/client-ts/src/`, which are pulled in by the recursive include glob even though that package has its own composite tsconfig and is consumed via `@goauthentik/api/dist/*.d.ts`. The base `@goauthentik/tsconfig` sets `composite: true`, which forced TS6307 the moment we tried to exclude `packages/` (`@goauthentik/core` imports get followed into `web/packages/core/`). Nothing references `web` in this repo, so disabling composite is safe; `incremental` is inherited from the base and still drives the `.tsbuildinfo` cache. On this branch: - cold `tsc -p .` 26.3s → 22.7s (-14%) - warm `tsc -p .` 4.1s → 3.5s (-15%) - `npm run precommit` 39.9s → 37.9s warm Type coverage is unchanged: each excluded package already type-checks itself via its own tsconfig + build, and stories/tests/e2e remain in the include set. Co-Authored-By: Agent (authentik-i22100-affordable-constant-chartreuse) <279763771+playpen-agent@users.noreply.github.com> * Fix types. --------- Co-authored-by: Teffen Ellis <592134+GirlBossRush@users.noreply.github.com> Co-authored-by: Agent (authentik-i22100-affordable-constant-chartreuse) <279763771+playpen-agent@users.noreply.github.com>
140 lines
3.2 KiB
JavaScript
140 lines
3.2 KiB
JavaScript
/**
|
|
* @file Console logger for browser environments.
|
|
*
|
|
* @remarks
|
|
* The repetition of log levels, typedefs, and method signatures is intentional
|
|
* to give IDEs and type checkers a mapping of log methods to the TypeScript
|
|
* provided JSDoc comments.
|
|
*
|
|
* Additionally, no wrapper functions are used to avoid the browser's console
|
|
* reported call site being the wrapper instead of the actual caller.
|
|
*/
|
|
|
|
/* eslint-disable no-console */
|
|
|
|
//#region Functions
|
|
|
|
/**
|
|
* @typedef {object} Logger
|
|
* @property {typeof console.info} info;
|
|
* @property {typeof console.warn} warn;
|
|
* @property {typeof console.error} error;
|
|
* @property {typeof console.debug} debug;
|
|
* @property {typeof console.trace} trace;
|
|
*/
|
|
|
|
/**
|
|
* Labels log levels in the browser console.
|
|
*/
|
|
const LogLevelLabel = /** @type {const} */ ({
|
|
info: "[INFO]",
|
|
warn: "[WARN]",
|
|
error: "[ERROR]",
|
|
debug: "[DEBUG]",
|
|
trace: "[TRACE]",
|
|
});
|
|
|
|
/**
|
|
* @typedef {keyof typeof LogLevelLabel} LogLevel
|
|
*/
|
|
|
|
/**
|
|
* Predefined log levels.
|
|
*/
|
|
const LogLevels = /** @type {LogLevel[]} */ (Object.keys(LogLevelLabel));
|
|
|
|
/**
|
|
* Colors for log levels in the browser console.
|
|
*
|
|
* @remarks
|
|
*
|
|
* The colors are derived from Carbon Design System's palette to ensure
|
|
* sufficient contrast and accessibility across light and dark themes.
|
|
*/
|
|
const LogLevelColors = /** @type {const} */ ({
|
|
info: `light-dark(#0043CE, #4589FF)`,
|
|
warn: `light-dark(#F1C21B, #F1C21B)`,
|
|
error: `light-dark(#DA1E28, #FA4D56)`,
|
|
debug: `light-dark(#8A3FFC, #A56EFF)`,
|
|
trace: `light-dark(#8A3FFC, #A56EFF)`,
|
|
});
|
|
|
|
/**
|
|
* Creates a logger with the given prefix.
|
|
*
|
|
* @param {string} [prefix]
|
|
* @param {...string[]} args
|
|
* @returns {Logger}
|
|
*
|
|
*/
|
|
export function createLogger(prefix, ...args) {
|
|
const suffix = prefix ? `(${prefix}):` : ":";
|
|
|
|
/**
|
|
* @type {Partial<Logger>}
|
|
*/
|
|
const logger = {};
|
|
|
|
for (const level of LogLevels) {
|
|
const label = LogLevelLabel[level];
|
|
const color = LogLevelColors[level];
|
|
|
|
logger[level] = console[level].bind(
|
|
console,
|
|
`%c${label}%c ${suffix}%c`,
|
|
`font-weight: 700; color: ${color};`,
|
|
`font-weight: 600; color: CanvasText;`,
|
|
"",
|
|
...args,
|
|
);
|
|
}
|
|
|
|
return /** @type {Logger} */ (logger);
|
|
}
|
|
|
|
//#endregion
|
|
|
|
//#region Console Logger
|
|
|
|
/**
|
|
* @typedef {Logger & {prefix: (logPrefix: string) => Logger}} IConsoleLogger
|
|
*/
|
|
|
|
/**
|
|
* A singleton logger instance for the browser.
|
|
*
|
|
* ```js
|
|
* import { ConsoleLogger } from "#logger/browser";
|
|
*
|
|
* ConsoleLogger.info("Hello, world!");
|
|
* ```
|
|
*
|
|
* @implements {IConsoleLogger}
|
|
* @runtime browser
|
|
*/
|
|
// @ts-expect-error Logging properties are dynamically assigned.
|
|
export class ConsoleLogger {
|
|
/** @type {typeof console.info} */
|
|
static info;
|
|
/** @type {typeof console.warn} */
|
|
static warn;
|
|
/** @type {typeof console.error} */
|
|
static error;
|
|
/** @type {typeof console.debug} */
|
|
static debug;
|
|
/** @type {typeof console.trace} */
|
|
static trace;
|
|
|
|
/**
|
|
* Creates a logger with the given prefix.
|
|
* @param {string} logPrefix
|
|
*/
|
|
static prefix(logPrefix) {
|
|
return createLogger(logPrefix);
|
|
}
|
|
}
|
|
|
|
Object.assign(ConsoleLogger, createLogger());
|
|
|
|
//#endregion
|