@crimson-education/browser-logger 1.0.1 → 1.0.2

package/lib/index.d.ts

@@ -0,0 +1,23 @@
+import { ILogger, Metadata, ReportUser, ServiceInfo } from './types';
+import { DatadogReporterConfig } from './reporters/datadogReporter';
+import { SentryReporterConfig } from './reporters/sentryReporter';
+export * from './types';
+export declare type ReporterConfig = ServiceInfo & {
+    sentry?: SentryReporterConfig;
+    datadog?: DatadogReporterConfig;
+};
+export declare function init(config: ReporterConfig): void;
+export declare function trackEvent(event: {
+    message: string;
+    category?: string;
+    metadata?: Metadata;
+}): void;
+export declare function addMetadata(metadata: Metadata): void;
+export declare function setUser(user: ReportUser | null): void;
+export declare function reportError(error: unknown, metadata?: Metadata): void;
+export declare function recordSession(): void;
+export declare function recordSessionStop(): void;
+export declare function createLogger(name?: string, options?: {
+    metadata?: Metadata;
+}): ILogger;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACrE,OAAO,EAAkC,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpG,OAAO,EAAkB,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAIlF,cAAc,SAAS,CAAC;AAExB,oBAAY,cAAc,GAAG,WAAW,GAAG;IAEzC,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAG9B,OAAO,CAAC,EAAE,qBAAqB,CAAC;CACjC,CAAC;AAMF,wBAAgB,IAAI,CAAC,MAAM,EAAE,cAAc,QAW1C;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,QAAQ,CAAA;CAAE,GAAG,IAAI,CAInG;AAED,wBAAgB,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAIpD;AAED,wBAAgB,OAAO,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI,GAAG,IAAI,CAIrD;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,CAIrE;AAED,wBAAgB,aAAa,IAAI,IAAI,CAIpC;AAED,wBAAgB,iBAAiB,IAAI,IAAI,CAIxC;AAED,wBAAgB,YAAY,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,QAAQ,CAAA;CAAE,GAAG,OAAO,CAUtF"}

package/lib/reporters/datadogReporter.d.ts

@@ -0,0 +1,18 @@
+import { IReporter } from '.';
+import { Metadata, ServiceInfo } from '../types';
+import { ILogger } from '..';
+export declare type DatadogReporterConfig = {
+    applicationId: string;
+    clientToken: string;
+    version?: string;
+    site?: string;
+    proxyUrl?: string;
+    forwardConsoleLogs?: boolean;
+    trackInteractions?: boolean;
+    sampleRate?: number;
+};
+export declare function datadogReporter(info: ServiceInfo, config: DatadogReporterConfig): IReporter;
+export declare function datadogLogger(name?: string, options?: {
+    metadata?: Metadata;
+}): ILogger;
+//# sourceMappingURL=datadogReporter.d.ts.map

package/lib/reporters/datadogReporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"datadogReporter.d.ts","sourceRoot":"","sources":["../../src/reporters/datadogReporter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,CAAC;AAC9B,OAAO,EAAE,QAAQ,EAAwB,WAAW,EAAE,MAAM,UAAU,CAAC;AAGvE,OAAO,EAAE,OAAO,EAAY,MAAM,IAAI,CAAC;AAEvC,oBAAY,qBAAqB,GAAG;IAClC,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,wBAAgB,eAAe,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,qBAAqB,GAAG,SAAS,CA2E3F;AAED,wBAAgB,aAAa,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,QAAQ,CAAA;CAAE,GAAG,OAAO,CAgDvF"}

package/lib/reporters/index.d.ts

@@ -0,0 +1,14 @@
+import { Metadata, ReportUser } from '../types';
+export interface IReporter {
+    trackEvent(event: {
+        message: string;
+        category?: string;
+        metadata?: Metadata;
+    }): void;
+    addMetadata(metadata: Metadata): void;
+    setUser(user: ReportUser | null): void;
+    reportError(error: unknown, metadata?: Metadata): void;
+    recordSession(): void;
+    recordSessionStop(): void;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/reporters/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/reporters/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEhD,MAAM,WAAW,SAAS;IACxB,UAAU,CAAC,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,QAAQ,CAAA;KAAE,GAAG,IAAI,CAAC;IACrF,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IACtC,OAAO,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI,GAAG,IAAI,CAAC;IACvC,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IACvD,aAAa,IAAI,IAAI,CAAC;IACtB,iBAAiB,IAAI,IAAI,CAAC;CAC3B"}

package/lib/reporters/sentryReporter.d.ts

@@ -0,0 +1,11 @@
+import { IReporter } from '.';
+import { ServiceInfo } from '../types';
+export declare type SentryReporterConfig = {
+    dsn: string;
+    release?: string;
+    proxyUrl?: string;
+    allowUrls?: (string | RegExp)[];
+    sampleRate?: number;
+};
+export declare function sentryReporter(info: ServiceInfo, config: SentryReporterConfig): IReporter;
+//# sourceMappingURL=sentryReporter.d.ts.map

package/lib/reporters/sentryReporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sentryReporter.d.ts","sourceRoot":"","sources":["../../src/reporters/sentryReporter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,CAAC;AAC9B,OAAO,EAAwB,WAAW,EAAE,MAAM,UAAU,CAAC;AAI7D,oBAAY,oBAAoB,GAAG;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,wBAAgB,cAAc,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,oBAAoB,GAAG,SAAS,CAwDzF"}

package/lib/types.d.ts

@@ -0,0 +1,47 @@
+export declare type Metadata = Record<string, any>;
+export declare type ServiceInfo = {
+    service: string;
+    environment: string;
+    version: string;
+    browserHistory?: any;
+    defaultMetadata?: Metadata;
+};
+export declare type ReportUser = {
+    id: string;
+    email?: string;
+    username?: string;
+    name?: string;
+};
+export declare enum LogLevel {
+    Debug = "debug",
+    Info = "info",
+    Warn = "warn",
+    Error = "error"
+}
+export interface LogLevelMethod {
+    (message: string, metadata?: any): ILogger;
+    (message: string, ...meta: any[]): ILogger;
+    (message: any): ILogger;
+}
+export interface LogMethod {
+    (level: LogLevel, message: string, metadata?: any): ILogger;
+    (level: LogLevel, message: string, ...meta: any[]): ILogger;
+    (level: LogLevel, message: any): ILogger;
+}
+export interface Profiler {
+    logger: ILogger;
+    done(info?: {
+        message?: string;
+        level?: LogLevel;
+    }): boolean;
+}
+export interface ILogger {
+    startTimer(): Profiler;
+    child(metadata?: Metadata, name?: string): ILogger;
+    log: LogMethod;
+    debug: LogLevelMethod;
+    info: LogLevelMethod;
+    warn: LogLevelMethod;
+    error: LogLevelMethod;
+}
+//# sourceMappingURL=types.d.ts.map

package/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AACA,oBAAY,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE3C,oBAAY,WAAW,GAAG;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,GAAG,CAAC;IACrB,eAAe,CAAC,EAAE,QAAQ,CAAC;CAC5B,CAAC;AAEF,oBAAY,UAAU,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1F,oBAAY,QAAQ;IAClB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,IAAI,SAAS;IACb,KAAK,UAAU;CAChB;AAED,MAAM,WAAW,cAAc;IAC7B,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC;IAC3C,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IAC3C,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,SAAS;IACxB,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC;IAC5D,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IAC5D,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC;CAC1C;AAED,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,QAAQ,CAAA;KAAE,GAAG,OAAO,CAAC;CAC9D;AAED,MAAM,WAAW,OAAO;IACtB,UAAU,IAAI,QAAQ,CAAC;IACvB,KAAK,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAEnD,GAAG,EAAE,SAAS,CAAC;IACf,KAAK,EAAE,cAAc,CAAC;IACtB,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,cAAc,CAAC;IACrB,KAAK,EAAE,cAAc,CAAC;CACvB"}

package/lib/utils.d.ts

@@ -0,0 +1,5 @@
+import { ILogger, Metadata } from '.';
+export declare function consoleLogger(name?: string, options?: {
+    metadata?: Metadata;
+}): ILogger;
+//# sourceMappingURL=utils.d.ts.map

package/lib/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAuC,QAAQ,EAAY,MAAM,GAAG,CAAC;AAErF,wBAAgB,aAAa,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,QAAQ,CAAA;CAAE,GAAG,OAAO,CA6CvF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crimson-education/browser-logger",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "An abstract logger and reporting utility for browser environments",
   "scripts": {
     "prepack": "npm run build",