@fluid-experimental/oldest-client-observer 2.0.0-internal.7.1.0 → 2.0.0-internal.7.2.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @fluid-experimental/oldest-client-observer
 
+## 2.0.0-internal.7.2.0
+
+Dependency updates only.
+
 ## 2.0.0-internal.7.1.0
 
 Dependency updates only.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-experimental/oldest-client-observer",
-  "version": "2.0.0-internal.7.1.0",
+  "version": "2.0.0-internal.7.2.0",
   "description": "Data object to determine if the local client is the oldest amongst connected clients",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -35,22 +35,21 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
-    "@fluidframework/container-definitions": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
-    "@fluidframework/core-utils": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
+    "@fluid-internal/client-utils": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
+    "@fluidframework/container-definitions": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
+    "@fluidframework/core-utils": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
     "@fluidframework/protocol-definitions": "^3.0.0"
   },
   "devDependencies": {
-    "@fluid-internal/test-dds-utils": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
-    "@fluid-tools/build-cli": "^0.25.0",
-    "@fluidframework/build-common": "^2.0.1",
-    "@fluidframework/build-tools": "^0.25.0",
+    "@fluid-internal/test-dds-utils": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
+    "@fluid-tools/build-cli": "^0.26.1",
+    "@fluidframework/build-common": "^2.0.3",
+    "@fluidframework/build-tools": "^0.26.1",
     "@fluidframework/eslint-config-fluid": "^3.0.0",
-    "@fluidframework/test-runtime-utils": ">=2.0.0-internal.7.1.0 <2.0.0-internal.7.2.0",
+    "@fluidframework/test-runtime-utils": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
     "@microsoft/api-extractor": "^7.37.0",
     "@types/node": "^16.18.38",
-    "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
     "eslint": "~8.50.0",
     "prettier": "~3.0.3",
@@ -76,7 +75,7 @@
     "build:docs": "api-extractor run --local",
     "build:esnext": "tsc --project ./tsconfig.esnext.json",
     "ci:build:docs": "api-extractor run",
-    "clean": "rimraf --glob 'dist' 'lib' '*.tsbuildinfo' '*.build.log' '_api-extractor-temp'",
+    "clean": "rimraf --glob dist lib \"*.tsbuildinfo\" \"*.build.log\" _api-extractor-temp",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run prettier:fix",

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

@@ -1,116 +0,0 @@
-import { AttachState } from '@fluidframework/container-definitions';
-import { IEvent } from '@fluidframework/core-interfaces';
-import { IEventProvider } from '@fluidframework/core-interfaces';
-import { IQuorumClients } from '@fluidframework/protocol-definitions';
-
-/**
- * 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).
- *
- * @public
- */
-export declare interface IOldestClientObservable extends IEventProvider<IOldestClientObservableEvents> {
-    getQuorum(): IQuorumClients;
-    attachState: AttachState;
-    connected: boolean;
-    clientId: string | undefined;
-}
-
-/**
- * Events emitted by {@link IOldestClientObservable}.
- *
- * @public
- */
-export declare interface IOldestClientObservableEvents extends IEvent {
-    (event: "connected", listener: () => void): any;
-    (event: "disconnected", listener: () => void): any;
-}
-
-/**
- * @public
- */
-export declare interface IOldestClientObserver extends IEventProvider<IOldestClientObserverEvents> {
-    isOldest(): boolean;
-}
-
-/**
- * Events emitted by {@link IOldestClientObservable}.
- *
- * @public
- */
-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");
- * });
- * ```
- *
- * @public
- */
-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;
-}
-
-/* Excluded from this release type: TypedEventEmitter */
-
-export { }

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

@@ -1,116 +0,0 @@
-import { AttachState } from '@fluidframework/container-definitions';
-import { IEvent } from '@fluidframework/core-interfaces';
-import { IEventProvider } from '@fluidframework/core-interfaces';
-import { IQuorumClients } from '@fluidframework/protocol-definitions';
-
-/**
- * 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).
- *
- * @public
- */
-export declare interface IOldestClientObservable extends IEventProvider<IOldestClientObservableEvents> {
-    getQuorum(): IQuorumClients;
-    attachState: AttachState;
-    connected: boolean;
-    clientId: string | undefined;
-}
-
-/**
- * Events emitted by {@link IOldestClientObservable}.
- *
- * @public
- */
-export declare interface IOldestClientObservableEvents extends IEvent {
-    (event: "connected", listener: () => void): any;
-    (event: "disconnected", listener: () => void): any;
-}
-
-/**
- * @public
- */
-export declare interface IOldestClientObserver extends IEventProvider<IOldestClientObserverEvents> {
-    isOldest(): boolean;
-}
-
-/**
- * Events emitted by {@link IOldestClientObservable}.
- *
- * @public
- */
-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");
- * });
- * ```
- *
- * @public
- */
-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;
-}
-
-/* Excluded from this release type: TypedEventEmitter */
-
-export { }

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

@@ -1,116 +0,0 @@
-import { AttachState } from '@fluidframework/container-definitions';
-import { IEvent } from '@fluidframework/core-interfaces';
-import { IEventProvider } from '@fluidframework/core-interfaces';
-import { IQuorumClients } from '@fluidframework/protocol-definitions';
-
-/**
- * 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).
- *
- * @public
- */
-export declare interface IOldestClientObservable extends IEventProvider<IOldestClientObservableEvents> {
-    getQuorum(): IQuorumClients;
-    attachState: AttachState;
-    connected: boolean;
-    clientId: string | undefined;
-}
-
-/**
- * Events emitted by {@link IOldestClientObservable}.
- *
- * @public
- */
-export declare interface IOldestClientObservableEvents extends IEvent {
-    (event: "connected", listener: () => void): any;
-    (event: "disconnected", listener: () => void): any;
-}
-
-/**
- * @public
- */
-export declare interface IOldestClientObserver extends IEventProvider<IOldestClientObserverEvents> {
-    isOldest(): boolean;
-}
-
-/**
- * Events emitted by {@link IOldestClientObservable}.
- *
- * @public
- */
-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");
- * });
- * ```
- *
- * @public
- */
-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;
-}
-
-/* Excluded from this release type: TypedEventEmitter */
-
-export { }

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

@@ -1,115 +0,0 @@
-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).
- *
- * @public
- */
-export declare interface IOldestClientObservable extends IEventProvider<IOldestClientObservableEvents> {
-    getQuorum(): IQuorumClients;
-    attachState: AttachState;
-    connected: boolean;
-    clientId: string | undefined;
-}
-
-/**
- * Events emitted by {@link IOldestClientObservable}.
- *
- * @public
- */
-export declare interface IOldestClientObservableEvents extends IEvent {
-    (event: "connected", listener: () => void): any;
-    (event: "disconnected", listener: () => void): any;
-}
-
-/**
- * @public
- */
-export declare interface IOldestClientObserver extends IEventProvider<IOldestClientObserverEvents> {
-    isOldest(): boolean;
-}
-
-/**
- * Events emitted by {@link IOldestClientObservable}.
- *
- * @public
- */
-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");
- * });
- * ```
- *
- * @public
- */
-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 { }