@fluidframework/presence 2.91.0 → 2.93.0

package/lib/latestMapTypes.d.ts

@@ -1,343 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { Listenable } from "@fluidframework/core-interfaces";
-import type { DeepReadonly, JsonDeserialized, JsonSerializable } from "@fluidframework/core-interfaces/internal/exposedUtilityTypes";
-import type { BroadcastControls, BroadcastControlSettings } from "./broadcastControlsTypes.js";
-import type { InternalTypes } from "./exposedInternalTypes.js";
-import type { LatestClientData, LatestData, LatestMetadata, ProxiedValueAccessor, RawValueAccessor, StateSchemaValidator, ValueAccessor } from "./latestValueTypes.js";
-import type { Attendee, AttendeeId, Presence } from "./presence.js";
-/**
- * A validator function that can optionally be provided to do runtime validation
- * of the custom key listed in a {@link LatestMap}.
- *
- * @param unvalidatedKey - The unknown key that should be validated.
- *
- * @returns True if the key is valid.
- *
- * @beta
- */
-export type KeySchemaValidator<Keys extends string> = (unvalidatedKey: string) => unvalidatedKey is Keys;
-/**
- * Collection of latest known values for a specific {@link Attendee}.
- *
- * @sealed
- * @beta
- */
-export interface LatestMapClientData<T, Keys extends string, TValueAccessor extends ValueAccessor<T>, SpecificAttendeeId extends AttendeeId = AttendeeId> {
-    /**
-     * Associated {@link Attendee}.
-     */
-    attendee: Attendee<SpecificAttendeeId>;
-    /**
-     * Map of items for the state.
-     *
-     * @privateRemarks This could be regular map currently as no Map is
-     * stored internally and a new instance is created for every request.
-     */
-    items: ReadonlyMap<Keys, LatestData<T, TValueAccessor>>;
-}
-/**
- * State of a single item value, its key, and its metadata.
- *
- * @sealed
- * @beta
- */
-export interface LatestMapItemUpdatedClientData<T, K extends string, TValueAccessor extends ValueAccessor<T>> extends LatestClientData<T, TValueAccessor> {
-    /**
-     * Key of the updated item.
-     */
-    key: K;
-}
-/**
- * Identifier and metadata for a removed item.
- *
- * @sealed
- * @beta
- */
-export interface LatestMapItemRemovedClientData<K extends string> {
-    /**
-     * Associated {@link Attendee}.
-     */
-    attendee: Attendee;
-    /**
-     * Key of the removed item.
-     */
-    key: K;
-    /**
-     * Metadata associated with the removal of the item.
-     */
-    metadata: LatestMetadata;
-}
-/**
- * Events from {@link LatestMapRaw}.
- *
- * @sealed
- * @beta
- */
-export interface LatestMapEvents<T, K extends string, TRemoteValueAccessor extends ValueAccessor<T> = ProxiedValueAccessor<T>> {
-    /**
-     * Raised when any item's value for remote client is updated.
-     * @param updates - Map of one or more values updated.
-     *
-     * @remarks The event does not include item removals.
-     *
-     * @eventProperty
-     */
-    remoteUpdated: (updates: LatestMapClientData<T, K, TRemoteValueAccessor>) => void;
-    /**
-     * Raised when specific item's value of remote client is updated.
-     * @param updatedItem - Updated item value.
-     *
-     * @eventProperty
-     */
-    remoteItemUpdated: (updatedItem: LatestMapItemUpdatedClientData<T, K, TRemoteValueAccessor>) => void;
-    /**
-     * Raised when specific item of remote client is removed.
-     * @param removedItem - Removed item.
-     *
-     * @eventProperty
-     */
-    remoteItemRemoved: (removedItem: LatestMapItemRemovedClientData<K>) => void;
-    /**
-     * Raised when specific local item's value is updated.
-     * @param updatedItem - Updated item value.
-     *
-     * @eventProperty
-     */
-    localItemUpdated: (updatedItem: {
-        value: DeepReadonly<JsonSerializable<T>>;
-        key: K;
-    }) => void;
-    /**
-     * Raised when specific local item is removed.
-     * @param removedItem - Removed item.
-     *
-     * @eventProperty
-     */
-    localItemRemoved: (removedItem: {
-        key: K;
-    }) => void;
-}
-/**
- * Events from {@link LatestMapRaw}.
- *
- * @sealed
- * @beta
- */
-export type LatestMapRawEvents<T, K extends string> = LatestMapEvents<T, K, RawValueAccessor<T>>;
-/**
- * Map of local client's values. Modifications are transmitted to all other connected clients.
- *
- * @sealed
- * @beta
- */
-export interface StateMap<K extends string, V> {
-    /**
-     * ${@link StateMap.delete}s all elements in the StateMap.
-     * @remarks This is not yet implemented.
-     */
-    clear(): void;
-    /**
-     * Removes the element with the specified key from the StateMap, if it exists.
-     *
-     * @returns true if an element in the StateMap existed and has been removed, or false if
-     * the element does not exist.
-     * @remarks No entry is fully removed. Instead an undefined placeholder is locally and
-     * transmitted to all other clients. For better performance limit the number of deleted
-     * entries and reuse keys when possible.
-     * @privateRemarks In the future we may add a mechanism to remove the placeholder, at least
-     * from transmissions after sufficient time has passed.
-     */
-    delete(key: K): boolean;
-    /**
-     * Executes a provided function once per each key/value pair in the StateMap, in arbitrary order.
-     */
-    forEach(callbackfn: (value: DeepReadonly<JsonDeserialized<V>>, key: K, map: StateMap<K, V>) => void, thisArg?: unknown): void;
-    /**
-     * Returns the element with the specified key from the StateMap, if it exists.
-     *
-     * @returns Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
-     */
-    get(key: K): DeepReadonly<JsonDeserialized<V>> | undefined;
-    /**
-     * Checks if an element with the specified key exists in the StateMap.
-     * @returns boolean indicating whether an element with the specified key exists or not.
-     */
-    has(key: K): boolean;
-    /**
-     * Adds a new element with a specified key and value to the StateMap. If an element with the same key already exists, the element will be updated.
-     * The value will be transmitted to all other connected clients.
-     *
-     * @remarks Manager assumes ownership of the value and its references.
-     * Make a deep clone before setting, if needed. No comparison is done to detect changes; all
-     * sets are transmitted.
-     */
-    set(key: K, value: JsonSerializable<V>): this;
-    /**
-     * The number of elements in the StateMap.
-     */
-    readonly size: number;
-    /**
-     * Returns an iterable of entries in the map.
-     */
-    /**
-     * Returns an iterable of key, value pairs for every entry in the map.
-     */
-    /**
-     * Returns an iterable of keys in the map.
-     */
-    keys(): IterableIterator<K>;
-}
-/**
- * State that provides a `Map` of latest known values from this client to
- * others and read access to their values.
- * Entries in the map may vary over time and by client, but all values are expected to
- * be of the same type, which may be a union type.
- *
- * @remarks Create using {@link StateFactory}.{@link LatestMapFactory|latestMap} registered to {@link StatesWorkspace}.
- *
- * @sealed
- * @beta
- */
-export interface LatestMap<T, Keys extends string = string, TRemoteAccessor extends ValueAccessor<T> = ProxiedValueAccessor<T>> {
-    /**
-     * Containing {@link Presence}
-     */
-    readonly presence: Presence;
-    /**
-     * Events for LatestMap.
-     */
-    readonly events: Listenable<LatestMapEvents<T, Keys, TRemoteAccessor>>;
-    /**
-     * Controls for management of sending updates.
-     */
-    readonly controls: BroadcastControls;
-    /**
-     * Current value map for this client.
-     */
-    readonly local: StateMap<Keys, T>;
-    /**
-     * Iterable access to remote clients' map of values.
-     */
-    getRemotes(): IterableIterator<LatestMapClientData<T, Keys, TRemoteAccessor>>;
-    /**
-     * Array of {@link Attendee}s that have provided states.
-     */
-    getStateAttendees(): Attendee[];
-    /**
-     * Access to a specific client's map of values.
-     */
-    getRemote(attendee: Attendee): ReadonlyMap<Keys, LatestData<T, TRemoteAccessor>>;
-}
-/**
- * State that provides a `Map` of latest known values from this client to
- * others and read access to their values.
- * Entries in the map may vary over time and by client, but all values are expected to
- * be of the same type, which may be a union type.
- *
- * @remarks Create using {@link StateFactory}.{@link LatestMapFactory|latestMap} registered to {@link StatesWorkspace}.
- *
- * @sealed
- * @beta
- */
-export type LatestMapRaw<T, Keys extends string = string> = LatestMap<T, Keys, RawValueAccessor<T>>;
-/**
- * Arguments that are passed to the {@link StateFactory}.{@link LatestMapFactory|latestMap} function.
- *
- * @input
- * @beta
- */
-export interface LatestMapArgumentsRaw<T, Keys extends string = string> {
-    /**
-     * The initial value of the local state.
-     */
-    local?: {
-        [K in Keys]: JsonSerializable<T>;
-    };
-    /**
-     * See {@link BroadcastControlSettings}.
-     */
-    settings?: BroadcastControlSettings | undefined;
-}
-/**
- * Arguments that are passed to the {@link StateFactory}.{@link LatestMapFactory|latestMap} function.
- *
- * @input
- * @beta
- */
-export interface LatestMapArguments<T, Keys extends string = string> extends LatestMapArgumentsRaw<T, Keys> {
-    /**
-     * An optional function that will be called at runtime to validate data value
-     * under a key. A runtime validator is strongly recommended.
-     * @see {@link StateSchemaValidator}.
-     */
-    validator: StateSchemaValidator<T>;
-    /**
-     * An optional function that will be called at runtime to validate the presence
-     * data key. A runtime validator is strongly recommended when key type is not
-     * simply `string`.
-     * @see {@link KeySchemaValidator}.
-     */
-    keyValidator?: KeySchemaValidator<Keys>;
-}
-/**
- * Type alias for the return type of {@link LatestMapFactory} when called with
- * {@link LatestMapArguments}.
- *
- * @remarks
- * Use this type instead of any InternalPresenceTypes that may be revealed from
- * examining factory return type.
- *
- * @typeparam RegistrationKeyRestrictions - Optional type parameter to constrain
- * allowed registration keys for this State object within a workspace.
- * Specification is recommended to highlight connection between schema and
- * factory when spread across modules.
- *
- * @beta
- * @sealed
- */
-export type LatestMapConfiguration<T, Keys extends string, RegistrationKeyRestrictions extends string = string> = InternalTypes.ManagerFactory<RegistrationKeyRestrictions, InternalTypes.MapValueState<T, Keys>, LatestMap<T, Keys>>;
-/**
- * Type alias for the return type of {@link LatestMapFactory} when called with
- * {@link LatestMapArgumentsRaw}.
- *
- * @remarks
- * Use this type instead of any InternalPresenceTypes that may be revealed from
- * examining factory return type.
- *
- * @typeparam RegistrationKeyRestrictions - Optional type parameter to constrain
- * allowed registration keys for this State object within a workspace.
- * Specification is recommended to highlight connection between schema and
- * factory when spread across modules.
- *
- * @beta
- * @sealed
- */
-export type LatestMapRawConfiguration<T, Keys extends string, RegistrationKeyRestrictions extends string = string> = InternalTypes.ManagerFactory<RegistrationKeyRestrictions, InternalTypes.MapValueState<T, Keys>, LatestMapRaw<T, Keys>>;
-/**
- * Factory for creating a {@link LatestMap} or {@link LatestMapRaw} State object.
- *
- * @beta
- * @sealed
- */
-export interface LatestMapFactory {
-    /**
-     * Factory for creating a {@link LatestMap} State object.
-     *
-     * @remarks
-     * This overload is used when called with {@link LatestMapArguments}.
-     * That is, if a validator function is provided.
-     */
-    <T, Keys extends string = string, RegistrationKeyRestrictions extends string = string>(args: LatestMapArguments<T, Keys>): LatestMapConfiguration<T, Keys, RegistrationKeyRestrictions>;
-    /**
-     * Factory for creating a {@link LatestMapRaw} State object.
-     *
-     * @remarks
-     * This overload is used when called with {@link LatestMapArgumentsRaw}.
-     * That is, if a validator function is _not_ provided.
-     */
-    <T, Keys extends string = string, RegistrationKeyRestrictions extends string = string>(args?: LatestMapArgumentsRaw<T, Keys>): LatestMapRawConfiguration<T, Keys, RegistrationKeyRestrictions>;
-}
-//# sourceMappingURL=latestMapTypes.d.ts.map

package/lib/latestMapTypes.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"latestMapTypes.d.ts","sourceRoot":"","sources":["../src/latestMapTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,KAAK,EACX,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,EAChB,MAAM,8DAA8D,CAAC;AAEtE,OAAO,KAAK,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AAC/F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,KAAK,EACX,gBAAgB,EAChB,UAAU,EACV,cAAc,EACd,oBAAoB,EACpB,gBAAgB,EAChB,oBAAoB,EACpB,aAAa,EACb,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEpE;;;;;;;;;GASG;AACH,MAAM,MAAM,kBAAkB,CAAC,IAAI,SAAS,MAAM,IAAI,CACrD,cAAc,EAAE,MAAM,KAClB,cAAc,IAAI,IAAI,CAAC;AAE5B;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB,CACnC,CAAC,EACD,IAAI,SAAS,MAAM,EACnB,cAAc,SAAS,aAAa,CAAC,CAAC,CAAC,EACvC,kBAAkB,SAAS,UAAU,GAAG,UAAU;IAElD;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IAEvC;;;;;OAKG;IACH,KAAK,EAAE,WAAW,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC;CACxD;AAED;;;;;GAKG;AACH,MAAM,WAAW,8BAA8B,CAC9C,CAAC,EACD,CAAC,SAAS,MAAM,EAChB,cAAc,SAAS,aAAa,CAAC,CAAC,CAAC,CACtC,SAAQ,gBAAgB,CAAC,CAAC,EAAE,cAAc,CAAC;IAC5C;;OAEG;IACH,GAAG,EAAE,CAAC,CAAC;CACP;AAED;;;;;GAKG;AACH,MAAM,WAAW,8BAA8B,CAAC,CAAC,SAAS,MAAM;IAC/D;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,CAAC,CAAC;IAEP;;OAEG;IACH,QAAQ,EAAE,cAAc,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe,CAC/B,CAAC,EACD,CAAC,SAAS,MAAM,EAChB,oBAAoB,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,oBAAoB,CAAC,CAAC,CAAC;IAEvE;;;;;;;OAOG;IACH,aAAa,EAAE,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,oBAAoB,CAAC,KAAK,IAAI,CAAC;IAElF;;;;;OAKG;IACH,iBAAiB,EAAE,CAClB,WAAW,EAAE,8BAA8B,CAAC,CAAC,EAAE,CAAC,EAAE,oBAAoB,CAAC,KACnE,IAAI,CAAC;IAEV;;;;;OAKG;IACH,iBAAiB,EAAE,CAAC,WAAW,EAAE,8BAA8B,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IAE5E;;;;;OAKG;IACH,gBAAgB,EAAE,CAAC,WAAW,EAAE;QAC/B,KAAK,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;QACzC,GAAG,EAAE,CAAC,CAAC;KACP,KAAK,IAAI,CAAC;IAEX;;;;;OAKG;IACH,gBAAgB,EAAE,CAAC,WAAW,EAAE;QAAE,GAAG,EAAE,CAAC,CAAA;KAAE,KAAK,IAAI,CAAC;CACpD;AAED;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,IAAI,eAAe,CACpE,CAAC,EACD,CAAC,EACD,gBAAgB,CAAC,CAAC,CAAC,CACnB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC;IAC5C;;;OAGG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;;;;;;;;;OAUG;IACH,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC;IAExB;;OAEG;IACH,OAAO,CACN,UAAU,EAAE,CACX,KAAK,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,EACxC,GAAG,EAAE,CAAC,EACN,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,KACf,IAAI,EACT,OAAO,CAAC,EAAE,OAAO,GACf,IAAI,CAAC;IAER;;;;OAIG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IAE3D;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC;IAErB;;;;;;;OAOG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IAGH;;OAEG;IAGH;;OAEG;IACH,IAAI,IAAI,gBAAgB,CAAC,CAAC,CAAC,CAAC;CAM5B;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,SAAS,CACzB,CAAC,EACD,IAAI,SAAS,MAAM,GAAG,MAAM,EAC5B,eAAe,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,oBAAoB,CAAC,CAAC,CAAC;IAElE;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,eAAe,CAAC,CAAC,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC;IAEvE;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,iBAAiB,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAElC;;OAEG;IACH,UAAU,IAAI,gBAAgB,CAAC,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC;IAE9E;;OAEG;IACH,iBAAiB,IAAI,QAAQ,EAAE,CAAC;IAEhC;;OAEG;IACH,SAAS,CAAC,QAAQ,EAAE,QAAQ,GAAG,WAAW,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC;CACjF;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,IAAI,SAAS,MAAM,GAAG,MAAM,IAAI,SAAS,CACpE,CAAC,EACD,IAAI,EACJ,gBAAgB,CAAC,CAAC,CAAC,CACnB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC,EAAE,IAAI,SAAS,MAAM,GAAG,MAAM;IACrE;;OAEG;IACH,KAAK,CAAC,EAAE;SACN,CAAC,IAAI,IAAI,GAAG,gBAAgB,CAAC,CAAC,CAAC;KAChC,CAAC;IAEF;;OAEG;IACH,QAAQ,CAAC,EAAE,wBAAwB,GAAG,SAAS,CAAC;CAChD;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,EAAE,IAAI,SAAS,MAAM,GAAG,MAAM,CAClE,SAAQ,qBAAqB,CAAC,CAAC,EAAE,IAAI,CAAC;IACtC;;;;OAIG;IACH,SAAS,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAC;IAEnC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;CACxC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,sBAAsB,CACjC,CAAC,EACD,IAAI,SAAS,MAAM,EACnB,2BAA2B,SAAS,MAAM,GAAG,MAAM,IAChD,aAAa,CAAC,cAAc,CAC/B,2BAA2B,EAC3B,aAAa,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,EACpC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAClB,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,yBAAyB,CACpC,CAAC,EACD,IAAI,SAAS,MAAM,EACnB,2BAA2B,SAAS,MAAM,GAAG,MAAM,IAChD,aAAa,CAAC,cAAc,CAC/B,2BAA2B,EAC3B,aAAa,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,EACpC,YAAY,CAAC,CAAC,EAAE,IAAI,CAAC,CACrB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAChC;;;;;;OAMG;IACH,CAAC,CAAC,EAAE,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,2BAA2B,SAAS,MAAM,GAAG,MAAM,EACpF,IAAI,EAAE,kBAAkB,CAAC,CAAC,EAAE,IAAI,CAAC,GAC/B,sBAAsB,CAAC,CAAC,EAAE,IAAI,EAAE,2BAA2B,CAAC,CAAC;IAEhE;;;;;;OAMG;IACH,CAAC,CAAC,EAAE,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,2BAA2B,SAAS,MAAM,GAAG,MAAM,EACpF,IAAI,CAAC,EAAE,qBAAqB,CAAC,CAAC,EAAE,IAAI,CAAC,GACnC,yBAAyB,CAAC,CAAC,EAAE,IAAI,EAAE,2BAA2B,CAAC,CAAC;CACnE"}

package/lib/latestMapTypes.js

@@ -1,6 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-export {};
-//# sourceMappingURL=latestMapTypes.js.map

package/lib/latestMapTypes.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"latestMapTypes.js","sourceRoot":"","sources":["../src/latestMapTypes.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 type { Listenable } from \"@fluidframework/core-interfaces\";\nimport type {\n\tDeepReadonly,\n\tJsonDeserialized,\n\tJsonSerializable,\n} from \"@fluidframework/core-interfaces/internal/exposedUtilityTypes\";\n\nimport type { BroadcastControls, BroadcastControlSettings } from \"./broadcastControlsTypes.js\";\nimport type { InternalTypes } from \"./exposedInternalTypes.js\";\nimport type {\n\tLatestClientData,\n\tLatestData,\n\tLatestMetadata,\n\tProxiedValueAccessor,\n\tRawValueAccessor,\n\tStateSchemaValidator,\n\tValueAccessor,\n} from \"./latestValueTypes.js\";\nimport type { Attendee, AttendeeId, Presence } from \"./presence.js\";\n\n/**\n * A validator function that can optionally be provided to do runtime validation\n * of the custom key listed in a {@link LatestMap}.\n *\n * @param unvalidatedKey - The unknown key that should be validated.\n *\n * @returns True if the key is valid.\n *\n * @beta\n */\nexport type KeySchemaValidator<Keys extends string> = (\n\tunvalidatedKey: string,\n) => unvalidatedKey is Keys;\n\n/**\n * Collection of latest known values for a specific {@link Attendee}.\n *\n * @sealed\n * @beta\n */\nexport interface LatestMapClientData<\n\tT,\n\tKeys extends string,\n\tTValueAccessor extends ValueAccessor<T>,\n\tSpecificAttendeeId extends AttendeeId = AttendeeId,\n> {\n\t/**\n\t * Associated {@link Attendee}.\n\t */\n\tattendee: Attendee<SpecificAttendeeId>;\n\n\t/**\n\t * Map of items for the state.\n\t *\n\t * @privateRemarks This could be regular map currently as no Map is\n\t * stored internally and a new instance is created for every request.\n\t */\n\titems: ReadonlyMap<Keys, LatestData<T, TValueAccessor>>;\n}\n\n/**\n * State of a single item value, its key, and its metadata.\n *\n * @sealed\n * @beta\n */\nexport interface LatestMapItemUpdatedClientData<\n\tT,\n\tK extends string,\n\tTValueAccessor extends ValueAccessor<T>,\n> extends LatestClientData<T, TValueAccessor> {\n\t/**\n\t * Key of the updated item.\n\t */\n\tkey: K;\n}\n\n/**\n * Identifier and metadata for a removed item.\n *\n * @sealed\n * @beta\n */\nexport interface LatestMapItemRemovedClientData<K extends string> {\n\t/**\n\t * Associated {@link Attendee}.\n\t */\n\tattendee: Attendee;\n\n\t/**\n\t * Key of the removed item.\n\t */\n\tkey: K;\n\n\t/**\n\t * Metadata associated with the removal of the item.\n\t */\n\tmetadata: LatestMetadata;\n}\n\n/**\n * Events from {@link LatestMapRaw}.\n *\n * @sealed\n * @beta\n */\nexport interface LatestMapEvents<\n\tT,\n\tK extends string,\n\tTRemoteValueAccessor extends ValueAccessor<T> = ProxiedValueAccessor<T>,\n> {\n\t/**\n\t * Raised when any item's value for remote client is updated.\n\t * @param updates - Map of one or more values updated.\n\t *\n\t * @remarks The event does not include item removals.\n\t *\n\t * @eventProperty\n\t */\n\tremoteUpdated: (updates: LatestMapClientData<T, K, TRemoteValueAccessor>) => void;\n\n\t/**\n\t * Raised when specific item's value of remote client is updated.\n\t * @param updatedItem - Updated item value.\n\t *\n\t * @eventProperty\n\t */\n\tremoteItemUpdated: (\n\t\tupdatedItem: LatestMapItemUpdatedClientData<T, K, TRemoteValueAccessor>,\n\t) => void;\n\n\t/**\n\t * Raised when specific item of remote client is removed.\n\t * @param removedItem - Removed item.\n\t *\n\t * @eventProperty\n\t */\n\tremoteItemRemoved: (removedItem: LatestMapItemRemovedClientData<K>) => void;\n\n\t/**\n\t * Raised when specific local item's value is updated.\n\t * @param updatedItem - Updated item value.\n\t *\n\t * @eventProperty\n\t */\n\tlocalItemUpdated: (updatedItem: {\n\t\tvalue: DeepReadonly<JsonSerializable<T>>;\n\t\tkey: K;\n\t}) => void;\n\n\t/**\n\t * Raised when specific local item is removed.\n\t * @param removedItem - Removed item.\n\t *\n\t * @eventProperty\n\t */\n\tlocalItemRemoved: (removedItem: { key: K }) => void;\n}\n\n/**\n * Events from {@link LatestMapRaw}.\n *\n * @sealed\n * @beta\n */\nexport type LatestMapRawEvents<T, K extends string> = LatestMapEvents<\n\tT,\n\tK,\n\tRawValueAccessor<T>\n>;\n\n/**\n * Map of local client's values. Modifications are transmitted to all other connected clients.\n *\n * @sealed\n * @beta\n */\nexport interface StateMap<K extends string, V> {\n\t/**\n\t * ${@link StateMap.delete}s all elements in the StateMap.\n\t * @remarks This is not yet implemented.\n\t */\n\tclear(): void;\n\n\t/**\n\t * Removes the element with the specified key from the StateMap, if it exists.\n\t *\n\t * @returns true if an element in the StateMap existed and has been removed, or false if\n\t * the element does not exist.\n\t * @remarks No entry is fully removed. Instead an undefined placeholder is locally and\n\t * transmitted to all other clients. For better performance limit the number of deleted\n\t * entries and reuse keys when possible.\n\t * @privateRemarks In the future we may add a mechanism to remove the placeholder, at least\n\t * from transmissions after sufficient time has passed.\n\t */\n\tdelete(key: K): boolean;\n\n\t/**\n\t * Executes a provided function once per each key/value pair in the StateMap, in arbitrary order.\n\t */\n\tforEach(\n\t\tcallbackfn: (\n\t\t\tvalue: DeepReadonly<JsonDeserialized<V>>,\n\t\t\tkey: K,\n\t\t\tmap: StateMap<K, V>,\n\t\t) => void,\n\t\tthisArg?: unknown,\n\t): void;\n\n\t/**\n\t * Returns the element with the specified key from the StateMap, if it exists.\n\t *\n\t * @returns Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.\n\t */\n\tget(key: K): DeepReadonly<JsonDeserialized<V>> | undefined;\n\n\t/**\n\t * Checks if an element with the specified key exists in the StateMap.\n\t * @returns boolean indicating whether an element with the specified key exists or not.\n\t */\n\thas(key: K): boolean;\n\n\t/**\n\t * Adds a new element with a specified key and value to the StateMap. If an element with the same key already exists, the element will be updated.\n\t * The value will be transmitted to all other connected clients.\n\t *\n\t * @remarks Manager assumes ownership of the value and its references.\n\t * Make a deep clone before setting, if needed. No comparison is done to detect changes; all\n\t * sets are transmitted.\n\t */\n\tset(key: K, value: JsonSerializable<V>): this;\n\n\t/**\n\t * The number of elements in the StateMap.\n\t */\n\treadonly size: number;\n\n\t/**\n\t * Returns an iterable of entries in the map.\n\t */\n\t// [Symbol.iterator](): IterableIterator<[K, DeepReadonly<JsonDeserialized<V>>]>;\n\n\t/**\n\t * Returns an iterable of key, value pairs for every entry in the map.\n\t */\n\t// entries(): IterableIterator<[K, DeepReadonly<JsonDeserialized<V>>]>;\n\n\t/**\n\t * Returns an iterable of keys in the map.\n\t */\n\tkeys(): IterableIterator<K>;\n\n\t/**\n\t * Returns an iterable of values in the map.\n\t */\n\t// values(): IterableIterator<DeepReadonly<JsonDeserialized<V>>>;\n}\n\n/**\n * State that provides a `Map` of latest known values from this client to\n * others and read access to their values.\n * Entries in the map may vary over time and by client, but all values are expected to\n * be of the same type, which may be a union type.\n *\n * @remarks Create using {@link StateFactory}.{@link LatestMapFactory|latestMap} registered to {@link StatesWorkspace}.\n *\n * @sealed\n * @beta\n */\nexport interface LatestMap<\n\tT,\n\tKeys extends string = string,\n\tTRemoteAccessor extends ValueAccessor<T> = ProxiedValueAccessor<T>,\n> {\n\t/**\n\t * Containing {@link Presence}\n\t */\n\treadonly presence: Presence;\n\n\t/**\n\t * Events for LatestMap.\n\t */\n\treadonly events: Listenable<LatestMapEvents<T, Keys, TRemoteAccessor>>;\n\n\t/**\n\t * Controls for management of sending updates.\n\t */\n\treadonly controls: BroadcastControls;\n\n\t/**\n\t * Current value map for this client.\n\t */\n\treadonly local: StateMap<Keys, T>;\n\n\t/**\n\t * Iterable access to remote clients' map of values.\n\t */\n\tgetRemotes(): IterableIterator<LatestMapClientData<T, Keys, TRemoteAccessor>>;\n\n\t/**\n\t * Array of {@link Attendee}s that have provided states.\n\t */\n\tgetStateAttendees(): Attendee[];\n\n\t/**\n\t * Access to a specific client's map of values.\n\t */\n\tgetRemote(attendee: Attendee): ReadonlyMap<Keys, LatestData<T, TRemoteAccessor>>;\n}\n\n/**\n * State that provides a `Map` of latest known values from this client to\n * others and read access to their values.\n * Entries in the map may vary over time and by client, but all values are expected to\n * be of the same type, which may be a union type.\n *\n * @remarks Create using {@link StateFactory}.{@link LatestMapFactory|latestMap} registered to {@link StatesWorkspace}.\n *\n * @sealed\n * @beta\n */\nexport type LatestMapRaw<T, Keys extends string = string> = LatestMap<\n\tT,\n\tKeys,\n\tRawValueAccessor<T>\n>;\n\n/**\n * Arguments that are passed to the {@link StateFactory}.{@link LatestMapFactory|latestMap} function.\n *\n * @input\n * @beta\n */\nexport interface LatestMapArgumentsRaw<T, Keys extends string = string> {\n\t/**\n\t * The initial value of the local state.\n\t */\n\tlocal?: {\n\t\t[K in Keys]: JsonSerializable<T>;\n\t};\n\n\t/**\n\t * See {@link BroadcastControlSettings}.\n\t */\n\tsettings?: BroadcastControlSettings | undefined;\n}\n\n/**\n * Arguments that are passed to the {@link StateFactory}.{@link LatestMapFactory|latestMap} function.\n *\n * @input\n * @beta\n */\nexport interface LatestMapArguments<T, Keys extends string = string>\n\textends LatestMapArgumentsRaw<T, Keys> {\n\t/**\n\t * An optional function that will be called at runtime to validate data value\n\t * under a key. A runtime validator is strongly recommended.\n\t * @see {@link StateSchemaValidator}.\n\t */\n\tvalidator: StateSchemaValidator<T>;\n\n\t/**\n\t * An optional function that will be called at runtime to validate the presence\n\t * data key. A runtime validator is strongly recommended when key type is not\n\t * simply `string`.\n\t * @see {@link KeySchemaValidator}.\n\t */\n\tkeyValidator?: KeySchemaValidator<Keys>;\n}\n\n/**\n * Type alias for the return type of {@link LatestMapFactory} when called with\n * {@link LatestMapArguments}.\n *\n * @remarks\n * Use this type instead of any InternalPresenceTypes that may be revealed from\n * examining factory return type.\n *\n * @typeparam RegistrationKeyRestrictions - Optional type parameter to constrain\n * allowed registration keys for this State object within a workspace.\n * Specification is recommended to highlight connection between schema and\n * factory when spread across modules.\n *\n * @beta\n * @sealed\n */\nexport type LatestMapConfiguration<\n\tT,\n\tKeys extends string,\n\tRegistrationKeyRestrictions extends string = string,\n> = InternalTypes.ManagerFactory<\n\tRegistrationKeyRestrictions,\n\tInternalTypes.MapValueState<T, Keys>,\n\tLatestMap<T, Keys>\n>;\n\n/**\n * Type alias for the return type of {@link LatestMapFactory} when called with\n * {@link LatestMapArgumentsRaw}.\n *\n * @remarks\n * Use this type instead of any InternalPresenceTypes that may be revealed from\n * examining factory return type.\n *\n * @typeparam RegistrationKeyRestrictions - Optional type parameter to constrain\n * allowed registration keys for this State object within a workspace.\n * Specification is recommended to highlight connection between schema and\n * factory when spread across modules.\n *\n * @beta\n * @sealed\n */\nexport type LatestMapRawConfiguration<\n\tT,\n\tKeys extends string,\n\tRegistrationKeyRestrictions extends string = string,\n> = InternalTypes.ManagerFactory<\n\tRegistrationKeyRestrictions,\n\tInternalTypes.MapValueState<T, Keys>,\n\tLatestMapRaw<T, Keys>\n>;\n\n/**\n * Factory for creating a {@link LatestMap} or {@link LatestMapRaw} State object.\n *\n * @beta\n * @sealed\n */\nexport interface LatestMapFactory {\n\t/**\n\t * Factory for creating a {@link LatestMap} State object.\n\t *\n\t * @remarks\n\t * This overload is used when called with {@link LatestMapArguments}.\n\t * That is, if a validator function is provided.\n\t */\n\t<T, Keys extends string = string, RegistrationKeyRestrictions extends string = string>(\n\t\targs: LatestMapArguments<T, Keys>,\n\t): LatestMapConfiguration<T, Keys, RegistrationKeyRestrictions>;\n\n\t/**\n\t * Factory for creating a {@link LatestMapRaw} State object.\n\t *\n\t * @remarks\n\t * This overload is used when called with {@link LatestMapArgumentsRaw}.\n\t * That is, if a validator function is _not_ provided.\n\t */\n\t<T, Keys extends string = string, RegistrationKeyRestrictions extends string = string>(\n\t\targs?: LatestMapArgumentsRaw<T, Keys>,\n\t): LatestMapRawConfiguration<T, Keys, RegistrationKeyRestrictions>;\n}\n"]}

package/lib/latestMapValueManager.d.ts

@@ -1,52 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { JsonSerializable } from "@fluidframework/core-interfaces/internal/exposedUtilityTypes";
-import type { BroadcastControlSettings } from "./broadcastControlsTypes.js";
-import type { KeySchemaValidator, LatestMapFactory } from "./latestMapTypes.js";
-import type { StateSchemaValidator } from "./latestValueTypes.js";
-/**
- * Arguments that are passed to the {@link StateFactory.latestMap} function.
- *
- * @input
- * @beta
- */
-export interface LatestMapArgumentsRaw<T, Keys extends string = string> {
-    /**
-     * The initial value of the local state.
-     */
-    local?: {
-        [K in Keys]: JsonSerializable<T>;
-    };
-    /**
-     * See {@link BroadcastControlSettings}.
-     */
-    settings?: BroadcastControlSettings | undefined;
-}
-/**
- * Arguments that are passed to the {@link StateFactory.latestMap} function.
- *
- * @input
- * @beta
- */
-export interface LatestMapArguments<T, Keys extends string = string> extends LatestMapArgumentsRaw<T, Keys> {
-    /**
-     * An optional function that will be called at runtime to validate data value
-     * under a key. A runtime validator is strongly recommended.
-     * @see {@link StateSchemaValidator}.
-     */
-    validator: StateSchemaValidator<T>;
-    /**
-     * An optional function that will be called at runtime to validate the presence
-     * data key. A runtime validator is strongly recommended when key type is not
-     * simply `string`.
-     * @see {@link KeySchemaValidator}.
-     */
-    keyValidator?: KeySchemaValidator<Keys>;
-}
-/**
- * Factory for creating a {@link LatestMap} or {@link LatestMapRaw} State object.
- */
-export declare const latestMap: LatestMapFactory;
-//# sourceMappingURL=latestMapValueManager.d.ts.map

package/lib/latestMapValueManager.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"latestMapValueManager.d.ts","sourceRoot":"","sources":["../src/latestMapValueManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAGX,gBAAgB,EAChB,MAAM,8DAA8D,CAAC;AAGtE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AAU5E,OAAO,KAAK,EACX,kBAAkB,EAIlB,gBAAgB,EAIhB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAc,oBAAoB,EAAiB,MAAM,uBAAuB,CAAC;AAgS7F;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC,EAAE,IAAI,SAAS,MAAM,GAAG,MAAM;IACrE;;OAEG;IACH,KAAK,CAAC,EAAE;SACN,CAAC,IAAI,IAAI,GAAG,gBAAgB,CAAC,CAAC,CAAC;KAChC,CAAC;IAEF;;OAEG;IACH,QAAQ,CAAC,EAAE,wBAAwB,GAAG,SAAS,CAAC;CAChD;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,EAAE,IAAI,SAAS,MAAM,GAAG,MAAM,CAClE,SAAQ,qBAAqB,CAAC,CAAC,EAAE,IAAI,CAAC;IACtC;;;;OAIG;IACH,SAAS,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAC;IACnC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;CACxC;AAED;;GAEG;AACH,eAAO,MAAM,SAAS,EAAE,gBA6DvB,CAAC"}