@fluid-experimental/oldest-client-observer 2.0.0-dev-rc.1.0.0.224419

package/.eslintrc.js

@@ -0,0 +1,11 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+	extends: [require.resolve("@fluidframework/eslint-config-fluid"), "prettier"],
+	parserOptions: {
+		project: "./tsconfig.json",
+	},
+};

package/CHANGELOG.md

@@ -0,0 +1,144 @@
+# @fluid-experimental/oldest-client-observer
+
+## 2.0.0-internal.8.0.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.0.0
+
+### Major Changes
+
+-   Dependencies on @fluidframework/protocol-definitions package updated to 3.0.0 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    This included the following changes from the protocol-definitions release:
+
+    -   Updating signal interfaces for some planned improvements. The intention is split the interface between signals
+        submitted by clients to the server and the resulting signals sent from the server to clients.
+        -   A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has
+            been added, which will be the typing for signals sent from the client to the server. Both extend a new
+            ISignalMessageBase interface that contains common members.
+    -   The @fluidframework/common-definitions package dependency has been updated to version 1.0.0.
+
+-   Server upgrade: dependencies on Fluid server packages updated to 2.0.1 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    Dependencies on the following Fluid server package have been updated to version 2.0.1:
+
+    -   @fluidframework/gitresources: 2.0.1
+    -   @fluidframework/server-kafka-orderer: 2.0.1
+    -   @fluidframework/server-lambdas: 2.0.1
+    -   @fluidframework/server-lambdas-driver: 2.0.1
+    -   @fluidframework/server-local-server: 2.0.1
+    -   @fluidframework/server-memory-orderer: 2.0.1
+    -   @fluidframework/protocol-base: 2.0.1
+    -   @fluidframework/server-routerlicious: 2.0.1
+    -   @fluidframework/server-routerlicious-base: 2.0.1
+    -   @fluidframework/server-services: 2.0.1
+    -   @fluidframework/server-services-client: 2.0.1
+    -   @fluidframework/server-services-core: 2.0.1
+    -   @fluidframework/server-services-ordering-kafkanode: 2.0.1
+    -   @fluidframework/server-services-ordering-rdkafka: 2.0.1
+    -   @fluidframework/server-services-ordering-zookeeper: 2.0.1
+    -   @fluidframework/server-services-shared: 2.0.1
+    -   @fluidframework/server-services-telemetry: 2.0.1
+    -   @fluidframework/server-services-utils: 2.0.1
+    -   @fluidframework/server-test-utils: 2.0.1
+    -   tinylicious: 2.0.1
+
+-   Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
+
+## 2.0.0-internal.6.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.2.0
+
+### Minor Changes
+
+-   Remove use of @fluidframework/common-definitions ([#16638](https://github.com/microsoft/FluidFramework/issues/16638)) [a8c81509c9](https://github.com/microsoft/FluidFramework/commits/a8c81509c9bf09cfb2092ebcf7265205f9eb6dbf)
+
+    The **@fluidframework/common-definitions** package is being deprecated, so the following interfaces and types are now
+    imported from the **@fluidframework/core-interfaces** package:
+
+    -   interface IDisposable
+    -   interface IErrorEvent
+    -   interface IErrorEvent
+    -   interface IEvent
+    -   interface IEventProvider
+    -   interface ILoggingError
+    -   interface ITaggedTelemetryPropertyType
+    -   interface ITelemetryBaseEvent
+    -   interface ITelemetryBaseLogger
+    -   interface ITelemetryErrorEvent
+    -   interface ITelemetryGenericEvent
+    -   interface ITelemetryLogger
+    -   interface ITelemetryPerformanceEvent
+    -   interface ITelemetryProperties
+    -   type ExtendEventProvider
+    -   type IEventThisPlaceHolder
+    -   type IEventTransformer
+    -   type ReplaceIEventThisPlaceHolder
+    -   type ReplaceIEventThisPlaceHolder
+    -   type TelemetryEventCategory
+    -   type TelemetryEventPropertyType
+
+## 2.0.0-internal.6.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.0.0
+
+### Major Changes
+
+-   Upgraded typescript transpilation target to ES2020 [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
+
+    Upgraded typescript transpilation target to ES2020. This is done in order to decrease the bundle sizes of Fluid Framework packages. This has provided size improvements across the board for ex. Loader, Driver, Runtime etc. Reduced bundle sizes helps to load lesser code in apps and hence also helps to improve the perf.If any app wants to target any older versions of browsers with which this target version is not compatible, then they can use packages like babel to transpile to a older target.
+
+## 2.0.0-internal.5.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.0.0
+
+Dependency updates only.
+
+## 2.0.0-internal.4.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.4.1.0
+
+Dependency updates only.

package/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,39 @@
+# @fluid-experimental/oldest-client-observer
+
+<!-- AUTO-GENERATED-CONTENT:START (README_DEPENDENCY_GUIDELINES_SECTION:includeHeading=TRUE) -->
+
+<!-- prettier-ignore-start -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+
+## Using Fluid Framework libraries
+
+When taking a dependency on a Fluid Framework library, we recommend using a `^` (caret) version range, such as `^1.3.4`.
+While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
+library consumers should always prefer `^`.
+
+Note that when depending on a library version of the form `2.0.0-internal.x.y.z`, called the Fluid internal version scheme,
+you must use a `>= <` dependency range (such as `>=2.0.0-internal.x.y.z <2.0.0-internal.w.0.0` where `w` is `x+1`).
+Standard `^` and `~` ranges will not work as expected.
+See the [@fluid-tools/version-tools](https://github.com/microsoft/FluidFramework/blob/main/build-tools/packages/version-tools/README.md)
+package for more information including tools to convert between version schemes.
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+<!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) -->
+
+<!-- prettier-ignore-start -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+
+## Trademark
+
+This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
+
+Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
+
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->

package/api-extractor-lint.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-lint.json"
+}

package/api-extractor.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-base.json"
+}

package/api-report/oldest-client-observer.api.md

@@ -0,0 +1,54 @@
+## API Report File for "@fluid-experimental/oldest-client-observer"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { AttachState } from '@fluidframework/container-definitions';
+import { IEvent } from '@fluidframework/core-interfaces';
+import { IEventProvider } from '@fluidframework/core-interfaces';
+import { IQuorumClients } from '@fluidframework/protocol-definitions';
+import { TypedEventEmitter } from '@fluid-internal/client-utils';
+
+// @alpha
+export interface IOldestClientObservable extends IEventProvider<IOldestClientObservableEvents> {
+    // (undocumented)
+    attachState: AttachState;
+    // (undocumented)
+    clientId: string | undefined;
+    // (undocumented)
+    connected: boolean;
+    // (undocumented)
+    getQuorum(): IQuorumClients;
+}
+
+// @alpha
+export interface IOldestClientObservableEvents extends IEvent {
+    // (undocumented)
+    (event: "connected", listener: () => void): any;
+    // (undocumented)
+    (event: "disconnected", listener: () => void): any;
+}
+
+// @alpha (undocumented)
+export interface IOldestClientObserver extends IEventProvider<IOldestClientObserverEvents> {
+    // (undocumented)
+    isOldest(): boolean;
+}
+
+// @alpha
+export interface IOldestClientObserverEvents extends IEvent {
+    // (undocumented)
+    (event: "becameOldest" | "lostOldest", listener: () => void): any;
+}
+
+// @alpha
+export class OldestClientObserver extends TypedEventEmitter<IOldestClientObserverEvents> implements IOldestClientObserver {
+    constructor(observable: IOldestClientObservable);
+    // (undocumented)
+    isOldest(): boolean;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/dist/index.cjs

@@ -0,0 +1,10 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OldestClientObserver = void 0;
+var oldestClientObserver_1 = require("./oldestClientObserver.cjs");
+Object.defineProperty(exports, "OldestClientObserver", { enumerable: true, get: function () { return oldestClientObserver_1.OldestClientObserver; } });
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAQH,mEAA8D;AAArD,4HAAA,oBAAoB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tIOldestClientObservable,\n\tIOldestClientObservableEvents,\n\tIOldestClientObserver,\n\tIOldestClientObserverEvents,\n} from \"./interfaces\";\nexport { OldestClientObserver } from \"./oldestClientObserver\";\n"]}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { IOldestClientObservable, IOldestClientObservableEvents, IOldestClientObserver, IOldestClientObserverEvents, } from "./interfaces";
+export { OldestClientObserver } from "./oldestClientObserver";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,uBAAuB,EACvB,6BAA6B,EAC7B,qBAAqB,EACrB,2BAA2B,GAC3B,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/interfaces.cjs

@@ -0,0 +1,7 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=interfaces.cjs.map

package/dist/interfaces.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.cjs","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IEvent, IEventProvider } from \"@fluidframework/core-interfaces\";\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport { IQuorumClients } from \"@fluidframework/protocol-definitions\";\n\n/**\n * Events emitted by {@link IOldestClientObservable}.\n * @alpha\n */\nexport interface IOldestClientObservableEvents extends IEvent {\n\t(event: \"connected\", listener: () => void);\n\t(event: \"disconnected\", listener: () => void);\n}\n\n/**\n * This is to make OldestClientObserver work with either a ContainerRuntime or an IFluidDataStoreRuntime\n * (both expose the relevant API surface and eventing).  However, really this info probably shouldn't live on either,\n * since neither is really the source of truth (they are just the only currently-available plumbing options).\n * It's information about the connection, so the real source of truth is lower (at the connection layer).\n * @alpha\n */\nexport interface IOldestClientObservable extends IEventProvider<IOldestClientObservableEvents> {\n\tgetQuorum(): IQuorumClients;\n\t// Generic usage of attachState is a little unusual here.  We will treat ourselves as \"the oldest client that\n\t// has information about this [container | data store]\", which in the case of detached data store may disagree\n\t// with whether we're the oldest client on the connected container.  So in the data store case, it's only\n\t// safe use this as an indicator about rights to tasks performed against this specific data store, and not\n\t// more broadly.\n\tattachState: AttachState;\n\tconnected: boolean;\n\tclientId: string | undefined;\n}\n\n/**\n * Events emitted by {@link IOldestClientObservable}.\n * @alpha\n */\nexport interface IOldestClientObserverEvents extends IEvent {\n\t(event: \"becameOldest\" | \"lostOldest\", listener: () => void);\n}\n\n/**\n * @alpha\n */\nexport interface IOldestClientObserver extends IEventProvider<IOldestClientObserverEvents> {\n\tisOldest(): boolean;\n}\n"]}

package/dist/interfaces.d.ts

@@ -0,0 +1,42 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IEvent, IEventProvider } from "@fluidframework/core-interfaces";
+import { AttachState } from "@fluidframework/container-definitions";
+import { IQuorumClients } from "@fluidframework/protocol-definitions";
+/**
+ * Events emitted by {@link IOldestClientObservable}.
+ * @alpha
+ */
+export interface IOldestClientObservableEvents extends IEvent {
+    (event: "connected", listener: () => void): any;
+    (event: "disconnected", listener: () => void): any;
+}
+/**
+ * This is to make OldestClientObserver work with either a ContainerRuntime or an IFluidDataStoreRuntime
+ * (both expose the relevant API surface and eventing).  However, really this info probably shouldn't live on either,
+ * since neither is really the source of truth (they are just the only currently-available plumbing options).
+ * It's information about the connection, so the real source of truth is lower (at the connection layer).
+ * @alpha
+ */
+export interface IOldestClientObservable extends IEventProvider<IOldestClientObservableEvents> {
+    getQuorum(): IQuorumClients;
+    attachState: AttachState;
+    connected: boolean;
+    clientId: string | undefined;
+}
+/**
+ * Events emitted by {@link IOldestClientObservable}.
+ * @alpha
+ */
+export interface IOldestClientObserverEvents extends IEvent {
+    (event: "becameOldest" | "lostOldest", listener: () => void): any;
+}
+/**
+ * @alpha
+ */
+export interface IOldestClientObserver extends IEventProvider<IOldestClientObserverEvents> {
+    isOldest(): boolean;
+}
+//# sourceMappingURL=interfaces.d.ts.map

package/dist/interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAEtE;;;GAGG;AACH,MAAM,WAAW,6BAA8B,SAAQ,MAAM;IAC5D,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC3C,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;CAC9C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,uBAAwB,SAAQ,cAAc,CAAC,6BAA6B,CAAC;IAC7F,SAAS,IAAI,cAAc,CAAC;IAM5B,WAAW,EAAE,WAAW,CAAC;IACzB,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,MAAM;IAC1D,CAAC,KAAK,EAAE,cAAc,GAAG,YAAY,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;CAC7D;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,cAAc,CAAC,2BAA2B,CAAC;IACzF,QAAQ,IAAI,OAAO,CAAC;CACpB"}

package/dist/oldest-client-observer-alpha.d.ts

@@ -0,0 +1,111 @@
+import { AttachState } from '@fluidframework/container-definitions';
+import { IEvent } from '@fluidframework/core-interfaces';
+import { IEventProvider } from '@fluidframework/core-interfaces';
+import { IQuorumClients } from '@fluidframework/protocol-definitions';
+import { TypedEventEmitter } from '@fluid-internal/client-utils';
+
+/**
+ * This is to make OldestClientObserver work with either a ContainerRuntime or an IFluidDataStoreRuntime
+ * (both expose the relevant API surface and eventing).  However, really this info probably shouldn't live on either,
+ * since neither is really the source of truth (they are just the only currently-available plumbing options).
+ * It's information about the connection, so the real source of truth is lower (at the connection layer).
+ * @alpha
+ */
+export declare interface IOldestClientObservable extends IEventProvider<IOldestClientObservableEvents> {
+    getQuorum(): IQuorumClients;
+    attachState: AttachState;
+    connected: boolean;
+    clientId: string | undefined;
+}
+
+/**
+ * Events emitted by {@link IOldestClientObservable}.
+ * @alpha
+ */
+export declare interface IOldestClientObservableEvents extends IEvent {
+    (event: "connected", listener: () => void): any;
+    (event: "disconnected", listener: () => void): any;
+}
+
+/**
+ * @alpha
+ */
+export declare interface IOldestClientObserver extends IEventProvider<IOldestClientObserverEvents> {
+    isOldest(): boolean;
+}
+
+/**
+ * Events emitted by {@link IOldestClientObservable}.
+ * @alpha
+ */
+export declare interface IOldestClientObserverEvents extends IEvent {
+    (event: "becameOldest" | "lostOldest", listener: () => void): any;
+}
+
+/**
+ * The `OldestClientObserver` is a utility inspect if the local client is the oldest amongst connected clients (in
+ * terms of when they connected) and watch for changes.
+ *
+ * It is still experimental and under development.  Please do try it out, but expect breaking changes in the future.
+ *
+ * @remarks
+ * ### Creation
+ *
+ * The `OldestClientObserver` constructor takes an `IOldestClientObservable`.  This is most easily satisfied with
+ * either an `IContainerRuntime` or an `IFluidDataStoreRuntime`:
+ *
+ * ```typescript
+ * // E.g. from within a BaseContainerRuntimeFactory:
+ * protected async containerHasInitialized(runtime: IContainerRuntime) {
+ *     const oldestClientObserver = new OldestClientObserver(runtime);
+ *     // ...
+ * }
+ * ```
+ *
+ * ```typescript
+ * // From within a DataObject
+ * protected async hasInitialized() {
+ *     const oldestClientObserver = new OldestClientObserver(this.runtime);
+ *     // ...
+ * }
+ * ```
+ *
+ * ### Usage
+ *
+ * To check if the local client is the oldest, use the `isOldest()` method.
+ *
+ * ```typescript
+ * if (oldestClientObserver.isOldest()) {
+ *     console.log("I'm the oldest");
+ * } else {
+ *     console.log("Someone else is older");
+ * }
+ * ```
+ *
+ * ### Eventing
+ *
+ * `OldestClientObserver` is an `EventEmitter`, and will emit events when the local client becomes the oldest and when
+ * it is no longer the oldest.
+ *
+ * ```typescript
+ * oldestClientObserver.on("becameOldest", () => {
+ *     console.log("I'm the oldest now");
+ * });
+ *
+ * oldestClientObserver.on("lostOldest", () => {
+ *     console.log("I'm not the oldest anymore");
+ * });
+ * ```
+ * @alpha
+ */
+export declare class OldestClientObserver extends TypedEventEmitter<IOldestClientObserverEvents> implements IOldestClientObserver {
+    private readonly observable;
+    private readonly quorum;
+    private currentIsOldest;
+    constructor(observable: IOldestClientObservable);
+    isOldest(): boolean;
+    private readonly updateOldest;
+    private computeIsOldest;
+}
+
+export { }

package/dist/oldest-client-observer-beta.d.ts

@@ -0,0 +1,17 @@
+import { AttachState } from '@fluidframework/container-definitions';
+import { IEvent } from '@fluidframework/core-interfaces';
+import { IEventProvider } from '@fluidframework/core-interfaces';
+import { IQuorumClients } from '@fluidframework/protocol-definitions';
+import { TypedEventEmitter } from '@fluid-internal/client-utils';
+
+/* Excluded from this release type: IOldestClientObservable */
+
+/* Excluded from this release type: IOldestClientObservableEvents */
+
+/* Excluded from this release type: IOldestClientObserver */
+
+/* Excluded from this release type: IOldestClientObserverEvents */
+
+/* Excluded from this release type: OldestClientObserver */
+
+export { }

package/dist/oldest-client-observer-public.d.ts

@@ -0,0 +1,17 @@
+import { AttachState } from '@fluidframework/container-definitions';
+import { IEvent } from '@fluidframework/core-interfaces';
+import { IEventProvider } from '@fluidframework/core-interfaces';
+import { IQuorumClients } from '@fluidframework/protocol-definitions';
+import { TypedEventEmitter } from '@fluid-internal/client-utils';
+
+/* Excluded from this release type: IOldestClientObservable */
+
+/* Excluded from this release type: IOldestClientObservableEvents */
+
+/* Excluded from this release type: IOldestClientObserver */
+
+/* Excluded from this release type: IOldestClientObserverEvents */
+
+/* Excluded from this release type: OldestClientObserver */
+
+export { }

package/dist/oldest-client-observer-untrimmed.d.ts

@@ -0,0 +1,111 @@
+import { AttachState } from '@fluidframework/container-definitions';
+import { IEvent } from '@fluidframework/core-interfaces';
+import { IEventProvider } from '@fluidframework/core-interfaces';
+import { IQuorumClients } from '@fluidframework/protocol-definitions';
+import { TypedEventEmitter } from '@fluid-internal/client-utils';
+
+/**
+ * This is to make OldestClientObserver work with either a ContainerRuntime or an IFluidDataStoreRuntime
+ * (both expose the relevant API surface and eventing).  However, really this info probably shouldn't live on either,
+ * since neither is really the source of truth (they are just the only currently-available plumbing options).
+ * It's information about the connection, so the real source of truth is lower (at the connection layer).
+ * @alpha
+ */
+export declare interface IOldestClientObservable extends IEventProvider<IOldestClientObservableEvents> {
+    getQuorum(): IQuorumClients;
+    attachState: AttachState;
+    connected: boolean;
+    clientId: string | undefined;
+}
+
+/**
+ * Events emitted by {@link IOldestClientObservable}.
+ * @alpha
+ */
+export declare interface IOldestClientObservableEvents extends IEvent {
+    (event: "connected", listener: () => void): any;
+    (event: "disconnected", listener: () => void): any;
+}
+
+/**
+ * @alpha
+ */
+export declare interface IOldestClientObserver extends IEventProvider<IOldestClientObserverEvents> {
+    isOldest(): boolean;
+}
+
+/**
+ * Events emitted by {@link IOldestClientObservable}.
+ * @alpha
+ */
+export declare interface IOldestClientObserverEvents extends IEvent {
+    (event: "becameOldest" | "lostOldest", listener: () => void): any;
+}
+
+/**
+ * The `OldestClientObserver` is a utility inspect if the local client is the oldest amongst connected clients (in
+ * terms of when they connected) and watch for changes.
+ *
+ * It is still experimental and under development.  Please do try it out, but expect breaking changes in the future.
+ *
+ * @remarks
+ * ### Creation
+ *
+ * The `OldestClientObserver` constructor takes an `IOldestClientObservable`.  This is most easily satisfied with
+ * either an `IContainerRuntime` or an `IFluidDataStoreRuntime`:
+ *
+ * ```typescript
+ * // E.g. from within a BaseContainerRuntimeFactory:
+ * protected async containerHasInitialized(runtime: IContainerRuntime) {
+ *     const oldestClientObserver = new OldestClientObserver(runtime);
+ *     // ...
+ * }
+ * ```
+ *
+ * ```typescript
+ * // From within a DataObject
+ * protected async hasInitialized() {
+ *     const oldestClientObserver = new OldestClientObserver(this.runtime);
+ *     // ...
+ * }
+ * ```
+ *
+ * ### Usage
+ *
+ * To check if the local client is the oldest, use the `isOldest()` method.
+ *
+ * ```typescript
+ * if (oldestClientObserver.isOldest()) {
+ *     console.log("I'm the oldest");
+ * } else {
+ *     console.log("Someone else is older");
+ * }
+ * ```
+ *
+ * ### Eventing
+ *
+ * `OldestClientObserver` is an `EventEmitter`, and will emit events when the local client becomes the oldest and when
+ * it is no longer the oldest.
+ *
+ * ```typescript
+ * oldestClientObserver.on("becameOldest", () => {
+ *     console.log("I'm the oldest now");
+ * });
+ *
+ * oldestClientObserver.on("lostOldest", () => {
+ *     console.log("I'm not the oldest anymore");
+ * });
+ * ```
+ * @alpha
+ */
+export declare class OldestClientObserver extends TypedEventEmitter<IOldestClientObserverEvents> implements IOldestClientObserver {
+    private readonly observable;
+    private readonly quorum;
+    private currentIsOldest;
+    constructor(observable: IOldestClientObservable);
+    isOldest(): boolean;
+    private readonly updateOldest;
+    private computeIsOldest;
+}
+
+export { }