@fluidframework/telemetry-utils 2.0.0-dev-rc.3.0.0.254513 → 2.0.0-dev-rc.3.0.0.254674

package/dist/alpha.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */
+export {
+	// public APIs
+	ITelemetryErrorEventExt, 
+	ITelemetryGenericEventExt, 
+	ITelemetryLoggerExt, 
+	ITelemetryPerformanceEventExt, 
+	ITelemetryPropertiesExt, 
+	TelemetryEventCategory, 
+	TelemetryEventPropertyTypeExt,
+ 
+	// alpha APIs
+	EventEmitterWithErrorHandling, 
+	ITelemetryLoggerPropertyBag, 
+	ITelemetryLoggerPropertyBags, 
+	TelemetryEventPropertyTypes, 
+	createChildLogger
+} from "./index.js";

package/dist/beta.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */
+export {
+	// public APIs
+	ITelemetryErrorEventExt, 
+	ITelemetryGenericEventExt, 
+	ITelemetryLoggerExt, 
+	ITelemetryPerformanceEventExt, 
+	ITelemetryPropertiesExt, 
+	TelemetryEventCategory, 
+	TelemetryEventPropertyTypeExt
+} from "./index.js";

package/dist/public.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */
+export {
+	// public APIs
+	ITelemetryErrorEventExt, 
+	ITelemetryGenericEventExt, 
+	ITelemetryLoggerExt, 
+	ITelemetryPerformanceEventExt, 
+	ITelemetryPropertiesExt, 
+	TelemetryEventCategory, 
+	TelemetryEventPropertyTypeExt
+} from "./index.js";

package/lib/alpha.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */
+export {
+	// public APIs
+	ITelemetryErrorEventExt, 
+	ITelemetryGenericEventExt, 
+	ITelemetryLoggerExt, 
+	ITelemetryPerformanceEventExt, 
+	ITelemetryPropertiesExt, 
+	TelemetryEventCategory, 
+	TelemetryEventPropertyTypeExt,
+ 
+	// alpha APIs
+	EventEmitterWithErrorHandling, 
+	ITelemetryLoggerPropertyBag, 
+	ITelemetryLoggerPropertyBags, 
+	TelemetryEventPropertyTypes, 
+	createChildLogger
+} from "./index.js";

package/lib/beta.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */
+export {
+	// public APIs
+	ITelemetryErrorEventExt, 
+	ITelemetryGenericEventExt, 
+	ITelemetryLoggerExt, 
+	ITelemetryPerformanceEventExt, 
+	ITelemetryPropertiesExt, 
+	TelemetryEventCategory, 
+	TelemetryEventPropertyTypeExt
+} from "./index.js";

package/lib/public.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */
+export {
+	// public APIs
+	ITelemetryErrorEventExt, 
+	ITelemetryGenericEventExt, 
+	ITelemetryLoggerExt, 
+	ITelemetryPerformanceEventExt, 
+	ITelemetryPropertiesExt, 
+	TelemetryEventCategory, 
+	TelemetryEventPropertyTypeExt
+} from "./index.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/telemetry-utils",
-  "version": "2.0.0-dev-rc.3.0.0.254513",
+  "version": "2.0.0-dev-rc.3.0.0.254674",
   "description": "Collection of telemetry relates utilities for Fluid",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -15,21 +15,21 @@
   "exports": {
     ".": {
       "import": {
-        "types": "./lib/telemetry-utils-public.d.ts",
+        "types": "./lib/public.d.ts",
         "default": "./lib/index.js"
       },
       "require": {
-        "types": "./dist/telemetry-utils-public.d.ts",
+        "types": "./dist/public.d.ts",
         "default": "./dist/index.js"
       }
     },
     "./alpha": {
       "import": {
-        "types": "./lib/telemetry-utils-alpha.d.ts",
+        "types": "./lib/alpha.d.ts",
         "default": "./lib/index.js"
       },
       "require": {
-        "types": "./dist/telemetry-utils-alpha.d.ts",
+        "types": "./dist/alpha.d.ts",
         "default": "./dist/index.js"
       }
     },
@@ -45,7 +45,7 @@
     }
   },
   "main": "dist/index.js",
-  "types": "./dist/telemetry-utils-public.d.ts",
+  "types": "./dist/public.d.ts",
   "c8": {
     "all": true,
     "cache-dir": "nyc/.cache",
@@ -67,9 +67,9 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.0.0-dev-rc.3.0.0.254513",
-    "@fluidframework/core-interfaces": "2.0.0-dev-rc.3.0.0.254513",
-    "@fluidframework/core-utils": "2.0.0-dev-rc.3.0.0.254513",
+    "@fluid-internal/client-utils": "2.0.0-dev-rc.3.0.0.254674",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.3.0.0.254674",
+    "@fluidframework/core-utils": "2.0.0-dev-rc.3.0.0.254674",
     "@fluidframework/protocol-definitions": "^3.2.0",
     "debug": "^4.3.4",
     "uuid": "^9.0.0"
@@ -77,7 +77,7 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "^1.6.2",
-    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.3.0.0.254513",
+    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.3.0.0.254674",
     "@fluid-tools/build-cli": "^0.35.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.35.0",
@@ -102,18 +102,6 @@
     "sinon": "^17.0.1",
     "typescript": "~5.1.6"
   },
-  "fluidBuild": {
-    "tasks": {
-      "build:docs": {
-        "dependsOn": [
-          "...",
-          "api-extractor:commonjs",
-          "api-extractor:esnext"
-        ],
-        "script": false
-      }
-    }
-  },
   "typeValidation": {
     "broken": {
       "RemovedInterfaceDeclaration_IConfigProviderBase": {
@@ -136,12 +124,12 @@
   },
   "scripts": {
     "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "api-extractor run --config ./api-extractor-cjs.json",
-    "api-extractor:esnext": "api-extractor run --local",
+    "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
+    "api-extractor:esnext": "flub generate entrypoints --outDir ./lib",
     "build": "fluid-build . --task build",
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",
-    "build:docs": "fluid-build . --task api",
+    "build:docs": "api-extractor run --local",
     "build:esnext": "tsc --project ./tsconfig.json",
     "build:test": "npm run build:test:esm && npm run build:test:cjs",
     "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",

package/api-extractor-cjs.json

@@ -1,8 +0,0 @@
-{
-	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-base.cjs.primary.json",
-	// CJS is actually secondary; so, no report.
-	"apiReport": {
-		"enabled": false
-	}
-}

package/dist/telemetry-utils-alpha.d.ts

@@ -1,282 +0,0 @@
-import { ConfigTypes } from '@fluidframework/core-interfaces';
-import type { EventEmitter } from '@fluid-internal/client-utils';
-import { EventEmitterEventType } from '@fluid-internal/client-utils';
-import { IConfigProviderBase } from '@fluidframework/core-interfaces';
-import type { IDisposable } from '@fluidframework/core-interfaces';
-import { IErrorBase } from '@fluidframework/core-interfaces';
-import { IEvent } from '@fluidframework/core-interfaces';
-import { IGenericError } from '@fluidframework/core-interfaces/internal';
-import type { ILoggingError } from '@fluidframework/core-interfaces/internal';
-import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ITelemetryBaseEvent } from '@fluidframework/core-interfaces';
-import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
-import { ITelemetryBaseProperties } from '@fluidframework/core-interfaces';
-import { IUsageError } from '@fluidframework/core-interfaces/internal';
-import { Lazy } from '@fluidframework/core-utils/internal';
-import { LogLevel } from '@fluidframework/core-interfaces';
-import { Tagged } from '@fluidframework/core-interfaces';
-import { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
-import { TypedEventEmitter } from '@fluid-internal/client-utils';
-
-/* Excluded from this release type: connectedEventName */
-
-/**
- * Create a child logger based on the provided props object.
- *
- * @remarks
- * Passing in no props object (i.e. undefined) will return a logger that is effectively a no-op.
- *
- * @param props - logger is the base logger the child will log to after it's processing, namespace will be prefixed to all event names, properties are default properties that will be applied events.
- *
- * @alpha
- */
-export declare function createChildLogger(props?: {
-    logger?: ITelemetryBaseLogger;
-    namespace?: string;
-    properties?: ITelemetryLoggerPropertyBags;
-}): ITelemetryLoggerExt;
-
-/* Excluded from this release type: createChildMonitoringContext */
-
-/* Excluded from this release type: createMultiSinkLogger */
-
-/* Excluded from this release type: createSampledLogger */
-
-/* Excluded from this release type: DataCorruptionError */
-
-/* Excluded from this release type: DataProcessingError */
-
-/* Excluded from this release type: disconnectedEventName */
-
-/**
- * Event Emitter helper class
- *
- * @remarks
- * Any exceptions thrown by listeners will be caught and raised through "error" event.
- * Any exception thrown by "error" listeners will propagate to the caller.
- * @privateRemarks
- * This probably doesn't belong in this package, as it is not telemetry-specific, and is really only intended for internal fluid-framework use.
- * We should consider moving it to the `core-utils` package.
- * @alpha
- */
-export declare class EventEmitterWithErrorHandling<TEvent extends IEvent = IEvent> extends TypedEventEmitter<TEvent> {
-    private readonly errorHandler;
-    constructor(errorHandler: (eventName: EventEmitterEventType, error: any) => void);
-    emit(event: EventEmitterEventType, ...args: unknown[]): boolean;
-}
-
-/* Excluded from this release type: eventNamespaceSeparator */
-
-/* Excluded from this release type: extractLogSafeErrorProperties */
-
-/* Excluded from this release type: extractSafePropertiesFromMessage */
-
-/* Excluded from this release type: formatTick */
-
-/* Excluded from this release type: generateErrorWithStack */
-
-/* Excluded from this release type: generateStack */
-
-/* Excluded from this release type: GenericError */
-
-/* Excluded from this release type: getCircularReplacer */
-
-/* Excluded from this release type: hasErrorInstanceId */
-
-/* Excluded from this release type: IConfigProvider */
-
-/* Excluded from this release type: IEventSampler */
-
-/* Excluded from this release type: IFluidErrorAnnotations */
-
-/* Excluded from this release type: IFluidErrorBase */
-
-/* Excluded from this release type: IGenericError */
-
-/* Excluded from this release type: ILoggingError */
-
-/* Excluded from this release type: IPerformanceEventMarkers */
-
-/* Excluded from this release type: ISampledTelemetryLogger */
-
-/* Excluded from this release type: isExternalError */
-
-/* Excluded from this release type: isFluidError */
-
-/* Excluded from this release type: isILoggingError */
-
-/* Excluded from this release type: isTaggedTelemetryPropertyValue */
-
-/* Excluded from this release type: isValidLegacyError */
-
-/* Excluded from this release type: ITaggedTelemetryPropertyTypeExt */
-
-/**
- * Error telemetry event.
- * @remarks Maps to category = "error"
- * @public
- */
-export declare interface ITelemetryErrorEventExt extends ITelemetryPropertiesExt {
-    eventName: string;
-}
-
-/* Excluded from this release type: ITelemetryEventExt */
-
-/**
- * Informational (non-error) telemetry event
- * @remarks Maps to category = "generic"
- * @public
- */
-export declare interface ITelemetryGenericEventExt extends ITelemetryPropertiesExt {
-    eventName: string;
-    category?: TelemetryEventCategory;
-}
-
-/**
- * An extended {@link @fluidframework/core-interfaces#ITelemetryBaseLogger} which allows for more lenient event types.
- *
- * @remarks
- * This interface is meant to be used internally within the Fluid Framework,
- * and `ITelemetryBaseLogger` should be used when loggers are passed between layers.
- * @public
- */
-export declare interface ITelemetryLoggerExt extends ITelemetryBaseLogger {
-    /**
-     * Send information telemetry event
-     * @param event - Event to send
-     * @param error - optional error object to log
-     * @param logLevel - optional level of the log.
-     */
-    sendTelemetryEvent(event: ITelemetryGenericEventExt, error?: unknown, logLevel?: typeof LogLevel.verbose | typeof LogLevel.default): void;
-    /**
-     * Send error telemetry event
-     * @param event - Event to send
-     * @param error - optional error object to log
-     */
-    sendErrorEvent(event: ITelemetryErrorEventExt, error?: unknown): void;
-    /**
-     * Send performance telemetry event
-     * @param event - Event to send
-     * @param error - optional error object to log
-     * @param logLevel - optional level of the log.
-     */
-    sendPerformanceEvent(event: ITelemetryPerformanceEventExt, error?: unknown, logLevel?: typeof LogLevel.verbose | typeof LogLevel.default): void;
-}
-
-/**
- * @alpha
- */
-export declare interface ITelemetryLoggerPropertyBag {
-    [index: string]: TelemetryEventPropertyTypes | (() => TelemetryEventPropertyTypes);
-}
-
-/**
- * @alpha
- */
-export declare interface ITelemetryLoggerPropertyBags {
-    all?: ITelemetryLoggerPropertyBag;
-    error?: ITelemetryLoggerPropertyBag;
-}
-
-/**
- * Performance telemetry event.
- * @remarks Maps to category = "performance"
- * @public
- */
-export declare interface ITelemetryPerformanceEventExt extends ITelemetryGenericEventExt {
-    duration?: number;
-}
-
-/**
- * JSON-serializable properties, which will be logged with telemetry.
- * @public
- */
-export declare interface ITelemetryPropertiesExt {
-    [index: string]: TelemetryEventPropertyTypeExt | Tagged<TelemetryEventPropertyTypeExt>;
-}
-
-/* Excluded from this release type: IUsageError */
-
-/* Excluded from this release type: Lazy */
-
-/* Excluded from this release type: loggerToMonitoringContext */
-
-/* Excluded from this release type: LoggingError */
-
-/* Excluded from this release type: mixinMonitoringContext */
-
-/* Excluded from this release type: MockLogger */
-
-/* Excluded from this release type: MonitoringContext */
-
-/* Excluded from this release type: MultiSinkLoggerProperties */
-
-/* Excluded from this release type: NORMALIZED_ERROR_TYPE */
-
-/* Excluded from this release type: normalizeError */
-
-/* Excluded from this release type: numberFromString */
-
-/* Excluded from this release type: overwriteStack */
-
-/* Excluded from this release type: PerformanceEvent */
-
-/* Excluded from this release type: raiseConnectedEvent */
-
-/* Excluded from this release type: safeRaiseEvent */
-
-/* Excluded from this release type: SampledTelemetryHelper */
-
-/* Excluded from this release type: sessionStorageConfigProvider */
-
-/* Excluded from this release type: tagCodeArtifacts */
-
-/* Excluded from this release type: tagData */
-
-/* Excluded from this release type: TaggedLoggerAdapter */
-
-/* Excluded from this release type: TelemetryDataTag */
-
-/**
- * The categories FF uses when instrumenting the code.
- *
- * generic - Informational log event
- *
- * error - Error log event, ideally 0 of these are logged during a session
- *
- * performance - Includes duration, and often has _start, _end, or _cancel suffixes for activity tracking
- * @public
- */
-export declare type TelemetryEventCategory = "generic" | "error" | "performance";
-
-/**
- * Property types that can be logged.
- *
- * @remarks
- * Includes extra types beyond {@link @fluidframework/core-interfaces#TelemetryBaseEventPropertyType}, which must be
- * converted before sending to a base logger.
- * @public
- */
-export declare type TelemetryEventPropertyTypeExt = string | number | boolean | undefined | (string | number | boolean)[] | {
-    [key: string]: // Flat objects can have the same properties as the event itself
-    string | number | boolean | undefined | (string | number | boolean)[];
-};
-
-/**
- * @alpha
- */
-export declare type TelemetryEventPropertyTypes = ITelemetryBaseProperties[string];
-
-/* Excluded from this release type: ThresholdCounter */
-
-/* Excluded from this release type: UsageError */
-
-/* Excluded from this release type: validatePrecondition */
-
-/* Excluded from this release type: wrapConfigProviderWithDefaults */
-
-/* Excluded from this release type: wrapError */
-
-/* Excluded from this release type: wrapErrorAndLog */
-
-export { }