@fluidframework/fluid-telemetry 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,27 @@
+/*!
+ * 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
+	ICriticalContainerError,
+ 
+	// beta APIs
+	AppInsightsTelemetryConsumer, 
+	ContainerConnectedTelemetry, 
+	ContainerDisconnectedTelemetry, 
+	ContainerDisposedTelemetry, 
+	ContainerTelemetryEventName, 
+	ContainerTelemetryEventNames, 
+	FluidTelemetryEventName, 
+	IContainerTelemetry, 
+	IFluidTelemetry, 
+	ITelemetryConsumer, 
+	TelemetryConfig, 
+	startTelemetry
+} from "./index.js";

package/dist/beta.d.ts

@@ -0,0 +1,27 @@
+/*!
+ * 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
+	ICriticalContainerError,
+ 
+	// beta APIs
+	AppInsightsTelemetryConsumer, 
+	ContainerConnectedTelemetry, 
+	ContainerDisconnectedTelemetry, 
+	ContainerDisposedTelemetry, 
+	ContainerTelemetryEventName, 
+	ContainerTelemetryEventNames, 
+	FluidTelemetryEventName, 
+	IContainerTelemetry, 
+	IFluidTelemetry, 
+	ITelemetryConsumer, 
+	TelemetryConfig, 
+	startTelemetry
+} from "./index.js";

package/dist/public.d.ts

@@ -0,0 +1,13 @@
+/*!
+ * 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
+	ICriticalContainerError
+} from "./index.js";

package/lib/alpha.d.ts

@@ -0,0 +1,27 @@
+/*!
+ * 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
+	ICriticalContainerError,
+ 
+	// beta APIs
+	AppInsightsTelemetryConsumer, 
+	ContainerConnectedTelemetry, 
+	ContainerDisconnectedTelemetry, 
+	ContainerDisposedTelemetry, 
+	ContainerTelemetryEventName, 
+	ContainerTelemetryEventNames, 
+	FluidTelemetryEventName, 
+	IContainerTelemetry, 
+	IFluidTelemetry, 
+	ITelemetryConsumer, 
+	TelemetryConfig, 
+	startTelemetry
+} from "./index.js";

package/lib/beta.d.ts

@@ -0,0 +1,27 @@
+/*!
+ * 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
+	ICriticalContainerError,
+ 
+	// beta APIs
+	AppInsightsTelemetryConsumer, 
+	ContainerConnectedTelemetry, 
+	ContainerDisconnectedTelemetry, 
+	ContainerDisposedTelemetry, 
+	ContainerTelemetryEventName, 
+	ContainerTelemetryEventNames, 
+	FluidTelemetryEventName, 
+	IContainerTelemetry, 
+	IFluidTelemetry, 
+	ITelemetryConsumer, 
+	TelemetryConfig, 
+	startTelemetry
+} from "./index.js";

package/lib/public.d.ts

@@ -0,0 +1,13 @@
+/*!
+ * 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
+	ICriticalContainerError
+} from "./index.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/fluid-telemetry",
-  "version": "2.0.0-dev-rc.3.0.0.254513",
+  "version": "2.0.0-dev-rc.3.0.0.254674",
   "description": "Customer facing Fluid telemetry types and classes for both producing and consuming said telemetry",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -25,21 +25,21 @@
     },
     "./public": {
       "import": {
-        "types": "./lib/fluid-telemetry-public.d.ts",
+        "types": "./lib/public.d.ts",
         "default": "./lib/index.js"
       },
       "require": {
-        "types": "./dist/fluid-telemetry-public.d.ts",
+        "types": "./dist/public.d.ts",
         "default": "./dist/index.js"
       }
     },
     "./beta": {
       "import": {
-        "types": "./lib/fluid-telemetry-beta.d.ts",
+        "types": "./lib/beta.d.ts",
         "default": "./lib/index.js"
       },
       "require": {
-        "types": "./dist/fluid-telemetry-beta.d.ts",
+        "types": "./dist/beta.d.ts",
         "default": "./dist/index.js"
       }
     },
@@ -57,16 +57,16 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@fluidframework/container-definitions": "2.0.0-dev-rc.3.0.0.254513",
-    "@fluidframework/container-loader": "2.0.0-dev-rc.3.0.0.254513",
-    "@fluidframework/fluid-static": "2.0.0-dev-rc.3.0.0.254513",
+    "@fluidframework/container-definitions": "2.0.0-dev-rc.3.0.0.254674",
+    "@fluidframework/container-loader": "2.0.0-dev-rc.3.0.0.254674",
+    "@fluidframework/fluid-static": "2.0.0-dev-rc.3.0.0.254674",
     "@microsoft/applicationinsights-web": "^2.8.11",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
-    "@fluid-internal/client-utils": "2.0.0-dev-rc.3.0.0.254513",
-    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.3.0.0.254513",
+    "@fluid-internal/client-utils": "2.0.0-dev-rc.3.0.0.254674",
+    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.3.0.0.254674",
     "@fluid-tools/build-cli": "^0.35.0",
     "@fluidframework/build-tools": "^0.35.0",
     "@microsoft/api-extractor": "^7.42.3",
@@ -75,6 +75,7 @@
     "@types/sinon": "^17.0.3",
     "@types/uuid": "^9.0.2",
     "chai": "^4.2.0",
+    "copyfiles": "^2.4.1",
     "eslint": "~8.55.0",
     "mocha": "^10.2.0",
     "prettier": "~3.0.3",
@@ -85,14 +86,6 @@
   },
   "fluidBuild": {
     "tasks": {
-      "build:docs": {
-        "dependsOn": [
-          "...",
-          "api-extractor:commonjs",
-          "api-extractor:esnext"
-        ],
-        "script": false
-      },
       "tsc": [
         "...",
         "typetests:gen"
@@ -105,12 +98,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",
     "check:are-the-types-wrong": "attw --pack . --entrypoints .",
     "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",

package/api-extractor-cjs.json

@@ -1,30 +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
-	},
-	"messages": {
-		// The following overrides are workarounds for API-Extractor incorrectly running analysis on our application
-		// insights dependency.
-		"tsdocMessageReporting": {
-			"tsdoc-escape-right-brace": {
-				"logLevel": "none"
-			},
-			"tsdoc-malformed-inline-tag": {
-				"logLevel": "none"
-			},
-			"tsdoc-undefined-tag": {
-				"logLevel": "none"
-			}
-		},
-		"extractorMessageReporting": {
-			// Require documentation on all package-exported API items.
-			"ae-undocumented": {
-				"logLevel": "error",
-				"addToApiReportFile": false
-			}
-		}
-	}
-}

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

@@ -1,229 +0,0 @@
-/**
- * This package provides an implementation and types for producing and consuming telemetry for Fluid Framework applications
- * @packageDocumentation
- */
-
-import { ApplicationInsights } from '@microsoft/applicationinsights-web';
-import { ICriticalContainerError } from '@fluidframework/container-definitions';
-import type { IFluidContainer } from '@fluidframework/fluid-static';
-
-/**
- * An implementation of {@link ITelemetryConsumer} that routes {@link IFluidTelemetry} to Azure App Insights
- * in a format that is supported by Fluid Framework service offerings such as Cloud dashboards and alarms.
- *
- * @beta
- */
-export declare class AppInsightsTelemetryConsumer implements ITelemetryConsumer {
-    private readonly appInsightsClient;
-    constructor(appInsightsClient: ApplicationInsights);
-    /**
-     * Takes the incoming {@link IFluidTelemetry} and sends it to Azure App Insights
-     */
-    consume(event: IFluidTelemetry): void;
-}
-
-/**
- * The container "connected" telemetry event.
- * It is produced from an internal Fluid container system event {@link @fluidframework/container-definitions#IContainerEvents} which is emitted when the {@link @fluidframework/container-definitions#IContainer} completes connecting to the Fluid service.
- *
- * @see More details about {@link @fluidframework/container-definitions#IContainer.connectionState  | the containers connection state}
- * @see More details about {@link @fluidframework/container-definitions#IContainer.connect | the function to connect a container }
- * @see More details about {@link @fluidframework/container-definitions#IContainer.connectionState  | the containers connection state}
- *
- * @beta
- */
-export declare interface ContainerConnectedTelemetry extends IContainerTelemetry {
-    /**
-     * {@inheritDoc IFluidTelemetry.eventName}
-     */
-    eventName: "fluidframework.container.connected";
-}
-
-/**
- * The container "disconnected" telemetry event. This telemetry is produced from an internal Fluid container system event
- * {@link @fluidframework/container-definitions#IContainerEvents} which is emitted when the {@link @fluidframework/container-definitions#IContainer}
- * becomes disconnected from the Fluid service.
- *
- * @see More details about{@link @fluidframework/container-definitions#IContainer.connectionState | the containers connection state}
- *
- * @see More details about{@link @fluidframework/container-definitions#IContainer.disconnect | the function to disconnect a container}
- *
- * @beta
- */
-export declare interface ContainerDisconnectedTelemetry extends IContainerTelemetry {
-    /**
-     * {@inheritDoc IFluidTelemetry.eventName}
-     */
-    eventName: "fluidframework.container.disconnected";
-}
-
-/**
- *
- * The Fluid container "disposed" telemetry event. This telemetry is produced from the "disposed" Fluid container system event
- * which is emitted when the {@link @fluidframework/fluid-static#IFluidContainer} is closed, which permanently disables it.
- *
- * @see More details about{@link @fluidframework/container-definitions#IContainer.close | the container close event}
- *
- * @beta
- */
-export declare interface ContainerDisposedTelemetry extends IContainerTelemetry {
-    /**
-     * {@inheritDoc IFluidTelemetry.eventName}
-     */
-    eventName: "fluidframework.container.disposed";
-    /**
-     * If the container was closed due to error (as opposed to an explicit call to
-     * {@link @fluidframework/fluid-static#IFluidContainer."dispose"}), this will contain details about the error that caused it.
-     */
-    error?: ICriticalContainerError;
-}
-
-/**
- * The aggregate type for all values within {@link ContainerTelemetryEventNames}
- * @beta
- */
-export declare type ContainerTelemetryEventName = (typeof ContainerTelemetryEventNames)[keyof typeof ContainerTelemetryEventNames];
-
-/**
- * This object contains names for Container Telemetry. Unlike the raw {@link @fluidframework/fluid-static#IFluidContainerEvents | IFluidContainer system event names} they contain more information such as the scope
- *
- * @beta
- */
-export declare const ContainerTelemetryEventNames: {
-    /**
-     * Name for the container telemetry event that is intended to be produced from the IFluidContainer "connected" {@link @fluidframework/fluid-static#IFluidContainerEvents | system event}
-     *
-     * @see {@link ContainerConnectedTelemetry}
-     */
-    readonly CONNECTED: "fluidframework.container.connected";
-    /**
-     * Name for the container telemetry event that is intended to be produced from the IFluidContainer "disconnected" {@link @fluidframework/fluid-static#IFluidContainerEvents | system event}
-     *
-     * @see {@link ContainerDisconnectedTelemetry}
-     */
-    readonly DISCONNECTED: "fluidframework.container.disconnected";
-    /**
-     * Name for the container telemetry event that is intended to be produced from the IFluidContainer "disposed" {@link @fluidframework/fluid-static#IFluidContainerEvents | system event}
-     *
-     * @see {@link ContainerDisposedTelemetry}
-     */
-    readonly DISPOSED: "fluidframework.container.disposed";
-};
-
-/**
- * Aggregate type for all the different types of Fluid telemetry event names.
- *
- * @privateremarks This only looks odd right now because {@link ContainerTelemetryEventName} is the only aggregation at the moment.
- *
- * @beta
- */
-export declare type FluidTelemetryEventName = ContainerTelemetryEventName;
-
-/**
- * The base interface for all Container telemetry
- * @beta
- */
-export declare interface IContainerTelemetry extends IFluidTelemetry {
-    /**
-     * {@inheritdoc IFluidTelemetry.eventName}
-     */
-    eventName: ContainerTelemetryEventName;
-    /**
-     * Unique identifier for a container, stable across creation and load.
-     * I.e. different clients loading the same container (or the same client loading the container two separate times)
-     * will agree on this value.
-     *
-     * @remarks This can be undefined for a container that has not been attached.
-     */
-    containerId?: string;
-    /**
-     * Unique identifier for the container instance that generated the telemetry.
-     * This is not a stable identifier for the container across clients/time.
-     * Every load of the container will result in a different value.
-     *
-     */
-    containerInstanceId: string;
-}
-
-export { ICriticalContainerError }
-
-/**
- * The base interface extended by all Fluid telemetry
- *
- * @see {@link @fluidframework/fluid-telemetry#IContainerTelemetry} for an extension of this interface for all container related telemetry.
- *
- * @beta
- */
-export declare interface IFluidTelemetry {
-    /**
-     * The unique name of the telemetry event. The event name contains scope concatenated together
-     * with periods to enable more granular log searching
-     *
-     * @example
-     * "fluidframework.container.connected"
-     */
-    eventName: FluidTelemetryEventName;
-}
-
-/**
- * Base interface for all telemetry consumers.
- * Conusmers are intended to take incoming produced {@link IFluidTelemetry} and do something of your choice with it.
- * This could be sending the telemetry to a cloud platform or just console logging.
- *
- * @example
- * Here is an example of how we construct a consumer to send telemetry to Azure App Insights, a cloud logging platform:
- * ```ts
- * class AppInsightsTelemetryConsumer implements ITelemetryConsumer {
- *	   constructor(private readonly appInsightsClient: ApplicationInsights) {}
- *
- *	   consume(event: IFluidTelemetry) {
- *		   this.appInsightsClient.trackEvent({
- *			   name: event.eventName,
- *			   properties: event,
- *		   });
- *	   }
- * }
- *```
- *
- * @beta
- */
-export declare interface ITelemetryConsumer {
-    /**
-     * This method is intended to take created {@link IFluidTelemetry} and do something with it.
-     * This could be sending the telemetry to a cloud platform, just console logging or something else of your choice.
-     */
-    consume(event: IFluidTelemetry): any;
-}
-
-/**
- * Starts creating {@link @fluidframework/fluid-telemetry#IFluidTelemetry} by transforming raw system events emitted by the specified container
- * into said telemetry and passing it onto to the specified {@link ITelemetryConsumer}
- *
- * @beta
- */
-export declare const startTelemetry: (config: TelemetryConfig) => void;
-
-/**
- * Configuration object for subscribing to {@link @fluidframework/fluid-telemetry#IFluidTelemetry} and consuming said telemetry via one or more {@link ITelemetryConsumer}
- *
- * @beta
- */
-export declare interface TelemetryConfig {
-    /**
-     * The container whose events should be monitored, transformed into Fluid telemetry, and sent to a {@link ITelemetryConsumer}.
-     */
-    container: IFluidContainer;
-    /**
-     * Unique identifier for the passed in container, i.e. the return value of a call
-     * to {@link @fluidframework/fluid-static#IFluidContainer.attach | `IFluidContainer.attach()`} when creating a new
-     * Fluid container, or the id used to load a pre-existing one.
-     */
-    containerId: string;
-    /**
-     * Conusmers take incoming produced {@link @fluidframework/fluid-telemetry#IFluidTelemetry} and do something of your choice with it.
-     * This could be sending the telemetry to a cloud platform or just console logging.
-     */
-    consumers: ITelemetryConsumer[];
-}
-
-export { }