@aws-amplify/core 4.4.1 → 4.4.2-api-logging.5

package/src/types/types.ts

@@ -1,62 +1,106 @@
-import { InputLogEvent, LogGroup } from '@aws-sdk/client-cloudwatch-logs';
-import { Credentials } from '@aws-sdk/types';
-
-export interface AmplifyConfig {
-	Analytics?: object;
-	Auth?: object;
-	API?: object;
-	Logging?: object;
-	Storage?: object;
-	Cache?: object;
-	Geo?: object;
-	ssr?: boolean;
-}
-
-export interface ICredentials {
-	accessKeyId: string;
-	sessionToken: string;
-	secretAccessKey: string;
-	identityId: string;
-	authenticated: boolean;
-	// Long term creds do not provide an expiration date
-	expiration?: Date;
-}
-
-/**
- * @private
- * Internal use of Amplify only
- */
-
-export type DelayFunction = (
-	attempt: number,
-	args?: any[],
-	error?: Error
-) => number | false;
-
-export interface LoggingProvider {
-	// return the name of you provider
-	getProviderName(): string;
-
-	// return the name of you category
-	getCategoryName(): string;
-
-	// configure the plugin
-	configure(config?: object): object;
-
-	// take logs and push to provider
-	pushLogs(logs: InputLogEvent[]): void;
-}
-
-export interface AWSCloudWatchProviderOptions {
-	logGroupName?: string;
-	logStreamName?: string;
-	region?: string;
-	credentials?: Credentials;
-	endpoint?: string;
-}
-
-export interface CloudWatchDataTracker {
-	eventUploadInProgress: boolean;
-	logEvents: InputLogEvent[];
-	verifiedLogGroup?: LogGroup;
-}
+import { InputLogEvent, LogGroup } from '@aws-sdk/client-cloudwatch-logs';
+import { Credentials } from '@aws-sdk/types';
+import { LOG_TYPE } from '../Logger/ConsoleLogger';
+export interface AmplifyConfig {
+	Analytics?: object;
+	Auth?: object;
+	API?: object;
+	Logging?: object;
+	Storage?: object;
+	Cache?: object;
+	Geo?: object;
+	ssr?: boolean;
+}
+
+export interface ICredentials {
+	accessKeyId: string;
+	sessionToken: string;
+	secretAccessKey: string;
+	identityId: string;
+	authenticated: boolean;
+	// Long term creds do not provide an expiration date
+	expiration?: Date;
+}
+
+/**
+ * @private
+ * Internal use of Amplify only
+ */
+
+export type DelayFunction = (
+	attempt: number,
+	args?: any[],
+	error?: Error
+) => number | false;
+
+export interface LoggingProvider {
+	// return the name of you provider
+	getProviderName(): string;
+
+	// return the name of you category
+	getCategoryName(): string;
+
+	// configure the plugin
+	configure(config?: object): object;
+
+	// take logs and push to provider
+	pushLogs?(logs: InputLogEvent[]): void;
+}
+
+export interface AWSCloudWatchProviderOptions {
+	logGroupName?: string;
+	logStreamName?: string;
+	region?: string;
+	credentials?: Credentials;
+	endpoint?: string;
+}
+
+export interface CloudWatchDataTracker {
+	eventUploadInProgress: boolean;
+	logEvents: InputLogEvent[];
+	verifiedLogGroup?: LogGroup;
+}
+
+export interface APILoggingProviderOptions {
+	endpoint: string;
+	apiKey?: string;
+	enabled?: boolean;
+	level?: LOG_TYPE;
+	excludeClassList?: string[];
+	metadata?: { [key: string]: any };
+	bufferInterval?: number;
+}
+
+export interface LoggerEvent extends InputLogEvent {
+	loggerInfo?: {
+		level: string;
+		name: string;
+		data?: object;
+		error?: {
+			message: string;
+			name: string;
+		};
+	};
+}
+
+export function isLoggerEvent(
+	inputLogEvent: any
+): inputLogEvent is LoggerEvent {
+	return (
+		inputLogEvent && !!Object.keys(inputLogEvent).find(k => k === 'loggerInfo')
+	);
+}
+
+export interface GenericLogEvent {
+	level: string;
+	message?: string;
+	context: {
+		category: string;
+		logTime: number;
+		data?: object;
+	};
+	error?: {
+		errorMessage: string;
+		errorName: string;
+	};
+}