Skip to content

improvement(client DIS): use ISubscribable for eventing #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jason-ha wants to merge 1 commit into
base: lcedds-proto
Choose a base branch
from
Draft

improvement(client DIS): use ISubscribable for eventing #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 21 additions & 10 deletions experimental/framework/independent-state/api-report/independent-state.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ import type { AliasResult } from '@fluidframework/runtime-definitions/internal';
import { FluidDataStoreRuntime } from '@fluidframework/datastore/internal';
import type { IContainerRuntime } from '@fluidframework/container-runtime-definitions/internal';
import type { IContainerRuntimeBase } from '@fluidframework/runtime-definitions/internal';
import type { IEvent } from '@fluidframework/core-interfaces';
import type { IEventProvider } from '@fluidframework/core-interfaces';
import type { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
import type { NamedFluidDataStoreRegistryEntry } from '@fluidframework/runtime-definitions/internal';

Expand All @@ -19,6 +17,11 @@ export type ClientId = string;
// @internal
export function createIndependentMap<TSchema extends IndependentMapSchema>(runtime: IFluidEphemeralDataStoreRuntime, initialContent: TSchema): IndependentMap<TSchema>;

// @beta
export type Events<E> = {
[P in (string | symbol) & keyof E as IsEvent<E[P]> extends true ? P : never]: E[P];
};

// @beta
type FlattenIntersection<T> = T extends Record<string | number | symbol, unknown> ? {
[K in keyof T]: T[K];
Expand Down Expand Up @@ -115,9 +118,17 @@ type IsEnumLike<T extends object> = T extends readonly (infer _)[] ? false : T e
[K in keyof T]: T[K] extends never ? true : never;
}[keyof T] ? false : true : false;

// @beta
export type IsEvent<Event> = Event extends (...args: any[]) => any ? true : false;

// @beta
type IsExactlyObject<T extends object> = object extends Required<T> ? false extends T ? false : true : false;

// @beta
export interface ISubscribable<E extends Events<E>> {
on<K extends keyof Events<E>>(eventName: K, listener: E[K]): () => void;
}

// @beta
export type JsonDeserialized<T, TReplaced = never> = boolean extends (T extends never ? true : false) ? JsonTypeWith<TReplaced> : unknown extends T ? JsonTypeWith<TReplaced> : T extends null | boolean | number | string | TReplaced ? T : Extract<T, Function> extends never ? T extends object ? T extends readonly (infer _)[] ? {
[K in keyof T]: JsonForArrayItem<T[K], TReplaced, JsonDeserialized<T[K], TReplaced>>;
Expand Down Expand Up @@ -182,18 +193,18 @@ export interface LatestMapValueManager<T, Keys extends string | number = string
clients(): ClientId[];
clientValue<SpecificClientId extends ClientId>(clientId: SpecificClientId): LatestMapValueClientData<SpecificClientId, T, Keys>;
clientValues(): IterableIterator<LatestMapValueClientData<ClientId, T, Keys>>;
readonly events: IEventProvider<LatestMapValueManagerEvents<T, Keys>>;
readonly events: ISubscribable<LatestMapValueManagerEvents<T, Keys>>;
readonly local: ValueMap<Keys, T>;
}

// @beta (undocumented)
export interface LatestMapValueManagerEvents<T, K extends string | number> extends IEvent {
export interface LatestMapValueManagerEvents<T, K extends string | number> {
// @eventProperty
(event: "updated", listener: (updates: LatestMapValueClientData<ClientId, T, K>) => void): void;
itemRemoved: (removedItem: LatestMapItemRemovedClientData<K>) => void;
// @eventProperty
(event: "itemUpdated", listener: (updatedItem: LatestMapItemValueClientData<T, K>) => void): void;
itemUpdated: (updatedItem: LatestMapItemValueClientData<T, K>) => void;
// @eventProperty
(event: "itemRemoved", listener: (removedItem: LatestMapItemRemovedClientData<K>) => void): void;
updated: (updates: LatestMapValueClientData<ClientId, T, K>) => void;
}

// @beta
Expand All @@ -215,15 +226,15 @@ export interface LatestValueManager<T> {
clients(): ClientId[];
clientValue(clientId: ClientId): LatestValueData<T>;
clientValues(): IterableIterator<LatestValueClientData<T>>;
readonly events: IEventProvider<LatestValueManagerEvents<T>>;
readonly events: ISubscribable<LatestValueManagerEvents<T>>;
get local(): FullyReadonly<JsonDeserialized<T>>;
set local(value: JsonEncodable<T> & JsonDeserialized<T>);
}

// @beta (undocumented)
export interface LatestValueManagerEvents<T> extends IEvent {
export interface LatestValueManagerEvents<T> {
// @eventProperty
(event: "updated", listener: (update: LatestValueClientData<T>) => void): void;
updated: (update: LatestValueClientData<T>) => void;
}

// @beta
Expand Down
1 change: 0 additions & 1 deletion experimental/framework/independent-state/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,6 @@
"tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist"
},
"dependencies": {
"@fluid-internal/client-utils": "workspace:~",
"@fluidframework/container-runtime-definitions": "workspace:~",
"@fluidframework/core-interfaces": "workspace:~",
"@fluidframework/core-utils": "workspace:~",
Expand Down
Loading