@anglr/common 10.0.0 → 11.0.0

package/structured-log/common-structured-log.internal.d.ts

@@ -1,418 +0,0 @@
-import { AnimationTriggerMetadata } from '@angular/animations';
-import { ChangeDetectorRef } from '@angular/core';
-import * as i0 from '@angular/core';
-import * as i2 from '@angular/common';
-import { InjectionToken } from '@angular/core';
-import { LogEvent } from 'structured-log';
-import { LogEventLevel } from 'structured-log';
-import { Logger } from '@anglr/common';
-import { ModuleWithProviders } from '@angular/core';
-import { Observable } from 'rxjs';
-import { OnDestroy } from '@angular/core';
-import { OnInit } from '@angular/core';
-import { Provider } from '@angular/core';
-import { Sink } from 'structured-log';
-
-/**
- * Provider for ConsoleComponentSink for logger
- */
-export declare const CONSOLE_COMPONENT_SINK: Provider;
-
-/**
- * Injection token for obtaining sink service for `ConsoleComponent`
- */
-export declare const CONSOLE_COMPONENT_SINK_SERVICE: InjectionToken<ConsoleComponentSink>;
-
-/**
- * Provider for ConsoleComponentSinkService for logger
- */
-export declare const CONSOLE_COMPONENT_SINK_SERVICE_PROVIDER: Provider;
-
-/**
- * Show hide animation for console component
- */
-export declare const consoleAnimationTrigger: AnimationTriggerMetadata;
-
-/**
- * Component used for displaying console logs
- */
-export declare class ConsoleComponent implements OnInit, OnDestroy {
-    private _consoleSvc;
-    private _changeDetector;
-    /**
-     * Subscription for log changes
-     */
-    private _logsChangeSubscription;
-    /**
-     * Current state of logger
-     */
-    currentLogs: ConsoleComponentLog[];
-    /**
-     * Indication whether can use copy to clipboard
-     */
-    canCopy: Clipboard;
-    /**
-     * Current value of filter
-     */
-    filterValue: string;
-    constructor(_consoleSvc: ConsoleComponentSink, _changeDetector: ChangeDetectorRef);
-    /**
-     * Initialize component
-     */
-    ngOnInit(): void;
-    /**
-     * Called when component is destroyed
-     */
-    ngOnDestroy(): void;
-    /**
-     * Copies content of whole console log into clipboard
-     */
-    copy(): void;
-    /**
-     * Copies message to clipboard
-     * @param message - Message to be copied
-     */
-    copyMessage(message: string): void;
-    /**
-     * Clears existing logs
-     */
-    clear(): void;
-    /**
-     * Sets messages using filter
-     */
-    setMessages(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ConsoleComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ConsoleComponent, "console", never, {}, {}, never, never>;
-}
-
-/**
- * Definition of logs available for `ConsoleComponent`
- */
-export declare interface ConsoleComponentLog {
-    /**
-     * Text of log to be displayed
-     */
-    text: string;
-    /**
-     * Log level of log
-     */
-    logLevel: string;
-    /**
-     * Indication whether detail of line is expanded or not
-     */
-    expanded?: boolean;
-}
-
-/**
- * Definition of sink that will write to `ConsoleComponent`
- */
-export declare interface ConsoleComponentSink {
-    /**
-     * Occurs when logs change
-     */
-    readonly logsChange: Observable<void>;
-    /**
-     * Gets current logs
-     */
-    readonly logs: ConsoleComponentLog[];
-    /**
-     * Clears all current logs
-     */
-    clear(): void;
-}
-
-/**
- * Factory method for `ConsoleComponentSink`
- */
-export declare function consoleComponentSinkFactory(configSvc: ConsoleSinkConfigService): ConsoleComponentSinkService;
-
-/**
- * Sink that is used for storing logs in `ConsoleComponent`
- */
-export declare class ConsoleComponentSinkService implements Sink, ConsoleComponentSink {
-    private _configSvc;
-    /**
-     * Indication that prototype of MessageTemplate was updated
-     */
-    private _prototypeUpdated;
-    /**
-     * Array of current logs
-     */
-    private _currentLogs;
-    /**
-     * Subject used for indicating logs change
-     */
-    private _logsChangeSubject;
-    /**
-     * Occurs when logs change
-     */
-    get logsChange(): Observable<void>;
-    /**
-     * Gets current logs
-     */
-    get logs(): ConsoleComponentLog[];
-    constructor(_configSvc: ConsoleSinkConfigService);
-    /**
-     * Clears all current logs
-     */
-    clear(): void;
-    emit(events: LogEvent[]): void;
-    flush(): Promise<void>;
-    /**
-     * Updates prototype of MessageTemplate
-     */
-    private _updatePrototype;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ConsoleComponentSinkService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<ConsoleComponentSinkService>;
-}
-
-/**
- * Module containing component Console (log)
- */
-export declare class ConsoleLogModule {
-    /**
-     * Registers structured-log as logger service, with console component sink
-     */
-    static forRoot(): ModuleWithProviders<ConsoleLogModule>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ConsoleLogModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<ConsoleLogModule, [typeof i1.ConsoleComponent], [typeof i2.CommonModule], [typeof i1.ConsoleComponent]>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<ConsoleLogModule>;
-}
-
-/**
- * Service used as configuration for *console sink component*
- */
-export declare class ConsoleSinkConfigService {
-    maxLogsCount?: number;
-    restrictToLevel?: LogEventLevel;
-    /**
-     * Creates instance of `ConsoleSinkConfigService`
-     * @param maxLogsCount - Maximal number of logs that can be stored
-     * @param restrictToLevel - Minimal log level to be displayed
-     */
-    constructor(maxLogsCount?: number, restrictToLevel?: LogEventLevel);
-    static ɵfac: i0.ɵɵFactoryDeclaration<ConsoleSinkConfigService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<ConsoleSinkConfigService>;
-}
-
-declare namespace i1 {
-    export {
-        ConsoleComponent
-    }
-}
-
-/**
- * Checks if a log event level includes the target log event level.
- * @param level - The level to check.
- * @param target - The target level.
- * @returns True if the checked level contains the target level, or if the checked level is undefined.
- */
-export declare function isEnabled(level: LogEventLevel, target: LogEventLevel): boolean;
-
-/**
- * Injection token for obtaining rest client for rest sink
- */
-export declare const LOGGER_REST_CLIENT: InjectionToken<LoggerRestClient>;
-
-/**
- * Injection token for obtaining loggers sinks
- */
-export declare const LOGGER_SINKS: InjectionToken<Sink[]>;
-
-/**
- * Client used for logging logs using REST
- */
-export declare interface LoggerRestClient {
-    /**
-     * Logs message on server using REST
-     * @param logs - Array of logs to be logged
-     */
-    log(logs: RestLog[]): Observable<void>;
-}
-
-/**
- * Service used for logging using structured-log
- */
-export declare class LoggerService implements Logger {
-    /**
-     * Currently used instance of logger
-     */
-    private _logger;
-    constructor(sinks: Sink[]);
-    /**
-     * Logs an event with the LogEventLevel.fatal severity.
-     * @param messageTemplate - Message template for the log event.
-     * @param properties - Properties that can be used to render the message template.
-     */
-    fatal(messageTemplate: string, ...properties: any[]): void;
-    /**
-     * Logs an event with the LogEventLevel.fatal severity.
-     * @param error - Error for the log event.
-     * @param messageTemplate - Message template for the log event.
-     * @param properties - Properties that can be used to render the message template.
-     */
-    fatal(error: Error, messageTemplate: string, ...properties: any[]): void;
-    /**
-     * Logs an event with the LogEventLevel.error severity.
-     * @param messageTemplate - Message template for the log event.
-     * @param properties - Properties that can be used to render the message template.
-     */
-    error(messageTemplate: string, ...properties: any[]): void;
-    /**
-     * Logs an event with the LogEventLevel.error severity.
-     * @param error - Error for the log event.
-     * @param messageTemplate - Message template for the log event.
-     * @param properties - Properties that can be used to render the message template.
-     */
-    error(error: Error, messageTemplate: string, ...properties: any[]): void;
-    /**
-     * Logs an event with the LogEventLevel.warning severity.
-     * @param messageTemplate - Message template for the log event.
-     * @param properties - Properties that can be used to render the message template.
-     */
-    warn(messageTemplate: string, ...properties: any[]): void;
-    /**
-     * Logs an event with the LogEventLevel.warning severity.
-     * @param error - Error for the log event.
-     * @param messageTemplate - Message template for the log event.
-     * @param properties - Properties that can be used to render the message template.
-     */
-    warn(error: Error, messageTemplate: string, ...properties: any[]): void;
-    /**
-     * Logs an event with the LogEventLevel.information severity.
-     * @param messageTemplate - Message template for the log event.
-     * @param properties - Properties that can be used to render the message template.
-     */
-    info(messageTemplate: string, ...properties: any[]): void;
-    /**
-     * Logs an event with the LogEventLevel.information severity.
-     * @param error - Error for the log event.
-     * @param messageTemplate - Message template for the log event.
-     * @param properties - Properties that can be used to render the message template.
-     */
-    info(error: Error, messageTemplate: string, ...properties: any[]): void;
-    /**
-     * Logs an event with the LogEventLevel.debug severity.
-     * @param messageTemplate - Message template for the log event.
-     * @param properties - Properties that can be used to render the message template.
-     */
-    debug(messageTemplate: string, ...properties: any[]): void;
-    /**
-     * Logs an event with the LogEventLevel.debug severity.
-     * @param error - Error for the log event.
-     * @param messageTemplate - Message template for the log event.
-     * @param properties - Properties that can be used to render the message template.
-     */
-    debug(error: Error, messageTemplate: string, ...properties: any[]): void;
-    /**
-     * Logs an event with the LogEventLevel.verbose severity.
-     * @param messageTemplate - Message template for the log event.
-     * @param properties - Properties that can be used to render the message template.
-     */
-    verbose(messageTemplate: string, ...properties: any[]): void;
-    /**
-     * Logs an event with the LogEventLevel.verbose severity.
-     * @param error - Error for the log event.
-     * @param messageTemplate - Message template for the log event.
-     * @param properties - Properties that can be used to render the message template.
-     */
-    verbose(error: Error, messageTemplate: string, ...properties: any[]): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<LoggerService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<LoggerService>;
-}
-
-/**
- * Provider for RestSinkService for logger
- */
-export declare const REST_SINK: Provider;
-
-/**
- * Definition of log object that is sent to server
- */
-export declare interface RestLog {
-    /**
-     * Timestamp when log occured
-     */
-    timestamp: string;
-    /**
-     * Level of log
-     */
-    logLevel: string;
-    /**
-     * Message to be logged
-     */
-    message: string;
-}
-
-/**
- * Service used as configuration for *rest sink*
- */
-export declare class RestSinkConfigService {
-    secondsToFlushAfter?: number;
-    flushAfterNumberOfLogs?: number;
-    immediateFlushMinLevel?: LogEventLevel;
-    restrictToLevel?: LogEventLevel;
-    /**
-     * Creates instance of `RestSinkConfigService`
-     * @param secondsToFlushAfter - Number of seconds after which should be flush called
-     * @param flushAfterNumberOfLogs - Number of logs after which should be flush called
-     * @param immediateFlushMinLevel - Minimal log level that will be flushed immediately
-     * @param restrictToLevel - Minimal log level to be displayed
-     */
-    constructor(secondsToFlushAfter?: number, flushAfterNumberOfLogs?: number, immediateFlushMinLevel?: LogEventLevel, restrictToLevel?: LogEventLevel);
-    static ɵfac: i0.ɵɵFactoryDeclaration<RestSinkConfigService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<RestSinkConfigService>;
-}
-
-/**
- * Sink that is used for storing logs using REST
- */
-export declare class RestSinkService implements Sink {
-    private _configSvc;
-    private _restClient;
-    /**
-     * Indication that prototype of MessageTemplate was updated
-     */
-    private _prototypeUpdated;
-    /**
-     * Array of unflushed logs
-     */
-    private _logs;
-    /**
-     * Interval timer id
-     */
-    private _timer;
-    constructor(_configSvc: RestSinkConfigService, isStable: Promise<void>, _restClient: LoggerRestClient);
-    /**
-     * Called when component is destroyed
-     */
-    ngOnDestroy(): void;
-    /**
-     * Emits events into log
-     * @param events - Events to be emitted
-     */
-    emit(events: LogEvent[]): void;
-    /**
-     * Flushes logs
-     */
-    flush(): Promise<void>;
-    /**
-     * Updates prototype of MessageTemplate
-     */
-    private _updatePrototype;
-    static ɵfac: i0.ɵɵFactoryDeclaration<RestSinkService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<RestSinkService>;
-}
-
-/**
- * Provider for logger that is using structured log implementation
- */
-export declare const STRUCTURED_LOG_LOGGER: Provider;
-
-/**
- * Transforms property to text
- * @param property - Property to be transformed to text
- */
-export declare function toText(property: any): string;
-
-export { }

package/structured-log/temp/common-structured-log.api.md

@@ -1,193 +0,0 @@
-## API Report File for "@anglr/common-structured-log"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-import { AnimationTriggerMetadata } from '@angular/animations';
-import { ChangeDetectorRef } from '@angular/core';
-import * as i0 from '@angular/core';
-import * as i2 from '@angular/common';
-import { InjectionToken } from '@angular/core';
-import { LogEvent } from 'structured-log';
-import { LogEventLevel } from 'structured-log';
-import { Logger } from '@anglr/common';
-import { ModuleWithProviders } from '@angular/core';
-import { Observable } from 'rxjs';
-import { OnDestroy } from '@angular/core';
-import { OnInit } from '@angular/core';
-import { Provider } from '@angular/core';
-import { Sink } from 'structured-log';
-
-// @public
-export const CONSOLE_COMPONENT_SINK: Provider;
-
-// @public
-export const CONSOLE_COMPONENT_SINK_SERVICE: InjectionToken<ConsoleComponentSink>;
-
-// @public
-export const CONSOLE_COMPONENT_SINK_SERVICE_PROVIDER: Provider;
-
-// @public
-export const consoleAnimationTrigger: AnimationTriggerMetadata;
-
-// @public
-export class ConsoleComponent implements OnInit, OnDestroy {
-    constructor(_consoleSvc: ConsoleComponentSink, _changeDetector: ChangeDetectorRef);
-    canCopy: Clipboard;
-    clear(): void;
-    copy(): void;
-    copyMessage(message: string): void;
-    currentLogs: ConsoleComponentLog[];
-    filterValue: string;
-    ngOnDestroy(): void;
-    ngOnInit(): void;
-    setMessages(): void;
-    // (undocumented)
-    static ɵcmp: i0.ɵɵComponentDeclaration<ConsoleComponent, "console", never, {}, {}, never, never>;
-    // (undocumented)
-    static ɵfac: i0.ɵɵFactoryDeclaration<ConsoleComponent, never>;
-}
-
-// @public
-export interface ConsoleComponentLog {
-    expanded?: boolean;
-    logLevel: string;
-    text: string;
-}
-
-// @public
-export interface ConsoleComponentSink {
-    clear(): void;
-    readonly logs: ConsoleComponentLog[];
-    readonly logsChange: Observable<void>;
-}
-
-// @public
-export function consoleComponentSinkFactory(configSvc: ConsoleSinkConfigService): ConsoleComponentSinkService;
-
-// @public
-export class ConsoleComponentSinkService implements Sink, ConsoleComponentSink {
-    constructor(_configSvc: ConsoleSinkConfigService);
-    clear(): void;
-    // (undocumented)
-    emit(events: LogEvent[]): void;
-    // (undocumented)
-    flush(): Promise<void>;
-    get logs(): ConsoleComponentLog[];
-    get logsChange(): Observable<void>;
-    // (undocumented)
-    static ɵfac: i0.ɵɵFactoryDeclaration<ConsoleComponentSinkService, never>;
-    // (undocumented)
-    static ɵprov: i0.ɵɵInjectableDeclaration<ConsoleComponentSinkService>;
-}
-
-// @public
-export class ConsoleLogModule {
-    static forRoot(): ModuleWithProviders<ConsoleLogModule>;
-    // (undocumented)
-    static ɵfac: i0.ɵɵFactoryDeclaration<ConsoleLogModule, never>;
-    // (undocumented)
-    static ɵinj: i0.ɵɵInjectorDeclaration<ConsoleLogModule>;
-    // Warning: (ae-forgotten-export) The symbol "i1" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    static ɵmod: i0.ɵɵNgModuleDeclaration<ConsoleLogModule, [typeof i1.ConsoleComponent], [typeof i2.CommonModule], [typeof i1.ConsoleComponent]>;
-}
-
-// @public
-export class ConsoleSinkConfigService {
-    constructor(maxLogsCount?: number, restrictToLevel?: LogEventLevel);
-    // (undocumented)
-    maxLogsCount?: number;
-    // (undocumented)
-    restrictToLevel?: LogEventLevel;
-    // (undocumented)
-    static ɵfac: i0.ɵɵFactoryDeclaration<ConsoleSinkConfigService, never>;
-    // (undocumented)
-    static ɵprov: i0.ɵɵInjectableDeclaration<ConsoleSinkConfigService>;
-}
-
-// @public
-export function isEnabled(level: LogEventLevel, target: LogEventLevel): boolean;
-
-// @public
-export const LOGGER_REST_CLIENT: InjectionToken<LoggerRestClient>;
-
-// @public
-export const LOGGER_SINKS: InjectionToken<Sink[]>;
-
-// @public
-export interface LoggerRestClient {
-    log(logs: RestLog[]): Observable<void>;
-}
-
-// @public
-export class LoggerService implements Logger {
-    constructor(sinks: Sink[]);
-    debug(messageTemplate: string, ...properties: any[]): void;
-    debug(error: Error, messageTemplate: string, ...properties: any[]): void;
-    error(messageTemplate: string, ...properties: any[]): void;
-    error(error: Error, messageTemplate: string, ...properties: any[]): void;
-    fatal(messageTemplate: string, ...properties: any[]): void;
-    fatal(error: Error, messageTemplate: string, ...properties: any[]): void;
-    info(messageTemplate: string, ...properties: any[]): void;
-    info(error: Error, messageTemplate: string, ...properties: any[]): void;
-    verbose(messageTemplate: string, ...properties: any[]): void;
-    verbose(error: Error, messageTemplate: string, ...properties: any[]): void;
-    warn(messageTemplate: string, ...properties: any[]): void;
-    warn(error: Error, messageTemplate: string, ...properties: any[]): void;
-    // (undocumented)
-    static ɵfac: i0.ɵɵFactoryDeclaration<LoggerService, never>;
-    // (undocumented)
-    static ɵprov: i0.ɵɵInjectableDeclaration<LoggerService>;
-}
-
-// @public
-export const REST_SINK: Provider;
-
-// @public
-export interface RestLog {
-    logLevel: string;
-    message: string;
-    timestamp: string;
-}
-
-// @public
-export class RestSinkConfigService {
-    constructor(secondsToFlushAfter?: number, flushAfterNumberOfLogs?: number, immediateFlushMinLevel?: LogEventLevel, restrictToLevel?: LogEventLevel);
-    // (undocumented)
-    flushAfterNumberOfLogs?: number;
-    // (undocumented)
-    immediateFlushMinLevel?: LogEventLevel;
-    // (undocumented)
-    restrictToLevel?: LogEventLevel;
-    // (undocumented)
-    secondsToFlushAfter?: number;
-    // (undocumented)
-    static ɵfac: i0.ɵɵFactoryDeclaration<RestSinkConfigService, never>;
-    // (undocumented)
-    static ɵprov: i0.ɵɵInjectableDeclaration<RestSinkConfigService>;
-}
-
-// @public
-export class RestSinkService implements Sink {
-    constructor(_configSvc: RestSinkConfigService, isStable: Promise<void>, _restClient: LoggerRestClient);
-    emit(events: LogEvent[]): void;
-    flush(): Promise<void>;
-    ngOnDestroy(): void;
-    // (undocumented)
-    static ɵfac: i0.ɵɵFactoryDeclaration<RestSinkService, never>;
-    // (undocumented)
-    static ɵprov: i0.ɵɵInjectableDeclaration<RestSinkService>;
-}
-
-// @public
-export const STRUCTURED_LOG_LOGGER: Provider;
-
-// @public
-export function toText(property: any): string;
-
-// (No @packageDocumentation comment for this package)
-
-```