@fluidframework/react 0.41.4 → 2.62.0

package/dist/interface.d.ts

@@ -1,444 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { ISharedMap, IValueChanged } from "@fluidframework/map";
-import { IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
-import { IFluidHandle, IFluidLoadable, IFluidObject } from "@fluidframework/core-interfaces";
-import { SyncedDataObject } from "./syncedDataObject";
-/**
- * The combined state contains the Fluid and view states and the data props
- * that are passed in to all reducers and selectors
- */
-export interface ICombinedState<SV extends IViewState, SF extends IFluidState, C extends IFluidDataProps> {
-    /**
-     * The react view state that will be used for all view renders
-     */
-    viewState: SV;
-    /**
-     * The Fluid state that will be used to update the synced values in the state. This will be
-     * undefined until it is initialized, after which the state will update with the defined values
-     */
-    fluidState?: SF;
-    /**
-     * Data props that are loaded in during the Fluid initialization step. This contains the runtime
-     * and the Fluid object map, along with any other properties the user wants to pass to reducers
-     * and selectors
-     */
-    dataProps: C;
-}
-/**
- * The Fluid schema that is generated on load and will be stored in the synced state
- */
-export interface IFluidSchema {
-    /**
-     * (k,v) = (viewKeys, needsFluidConverter)
-     */
-    viewMatchingMap: ISharedMap;
-    /**
-     * (k,v) = (fluidKeys, needsViewConverter)
-     */
-    fluidMatchingMap: ISharedMap;
-    /**
-     * (k,v) = (path, handle)
-     */
-    storedHandleMap: ISharedMap;
-}
-/**
- * A map of the view state values that need conversion to their Fluid state counterparts and the
- * respective converters
- */
-export declare type ViewToFluidMap<SV, SF> = Map<keyof SV, IFluidConverter<SV, SF>>;
-/**
- * A map of the Fluid state values that need conversion to their view state counterparts and the
- * respective converters
- */
-export declare type FluidToViewMap<SV, SF> = Map<keyof SF, IViewConverter<SV, SF>>;
-/**
- * The Fluid reducer, containing an object that is keyed by function name and contains state update and
- * effect functions. Each function will have the view state, fluid state, and data props passed into it
- * as parameters in the combined state. State update functions are used to modify values on the state and return
- * the updated state and any new Fluid object handles. Effect functions use values on the state to apply changes
- * elsewhere. They do not return any new objects or state.
- */
-export interface IFluidReducer<SV extends IViewState, SF extends IFluidState, C extends IFluidDataProps> {
-    [key: string]: FluidAsyncStateUpdateFunction<SV, SF, C> | FluidStateUpdateFunction<SV, SF, C> | FluidEffectFunction<SV, SF, C> | FluidAsyncEffectFunction<SV, SF, C>;
-}
-/**
- * The Fluid selector, containing an object that is keyed by function name and contains selector
- * functions. Each function will have the view state, fluid state, and data props passed into it
- * as parameters in the combined state. Selector functions can also optionally pass in a
- * handle to fetch from the Fluid object map.
- * Selector functions are used to retrieve Fluid objects or parameters from other Fluid objects.
- * It offers a way to fetch these values and return them to the view, with the
- * Fluid object map being updated if the view requires a Fluid object that hasn't been locally loaded yet
- */
-export interface IFluidSelector<SV extends IViewState, SF extends IFluidState, C extends IFluidDataProps> {
-    [key: string]: FluidSelectorFunction<SV, SF, C> | FluidObjectSelectorFunction<SV, SF, C>;
-}
-/**
- * Props passed in to create a FluidReactView or passed in to the useStateFluid hook
- */
-export interface IFluidProps<SV extends IViewState, SF extends IFluidState> {
-    /**
-     *  Unique ID to use for storing the synced state in the SyncedDataObject's syncedState SharedMap
-     */
-    syncedStateId: string;
-    /**
-     * An instance of the SyncedDataObject that this view will be rendered in
-     */
-    syncedDataObject: SyncedDataObject;
-    /**
-     * Data props containing the Fluid object map and the runtime
-     * Optional as the above two will be passed by default. This only need to be defined
-     * if there are additional values from the Fluid object lifecycle that need to be made
-     * available to the reducers
-     */
-    dataProps?: IFluidDataProps;
-}
-/**
- * View converters to take the synced state Fluid value that they are keyed against in the FluidToView map
- * and convert them into their view state counterparts
- */
-export interface IViewConverter<SV extends IViewState, SF extends IFluidState> {
-    /**
-     * The type of object this key in the Fluid state holds
-     */
-    type: string;
-    /**
-     * The corresponding value key within the view state type
-     */
-    viewKey: keyof SV;
-    /**
-     * A callback that takes in the partial Fluid state containing the value that
-     * this converter maps to, and returns the corresponding partial view state
-     */
-    viewConverter?: (viewState: SV, fluidState: Partial<SF>, fluidObjectMap: FluidObjectMap) => Partial<SV>;
-    /**
-     * If this is a fluid DDS SharedObject type (i.e. SharedCounter, SharedMap), supply its create function
-     * here and add any events that it will fire to the listenedEvents param below to trigger state updates
-     */
-    sharedObjectCreate?: (runtime: IFluidDataStoreRuntime) => any;
-    /**
-     * List of events fired on this Fluid object that will trigger a state update
-     */
-    listenedEvents?: string[];
-    /**
-     * If this Fluid object is stored on the Fluid DataObject root under a different key
-     * than the name of this Fluid state key within the synced state map,
-     * provide the key on the root for this object here. The changes will also
-     * reflect under that key if the data needs to be used elsewhere
-     */
-    rootKey?: string;
-}
-/**
- * Fluid converters to take the view state value that they are keyed against in the ViewToFluid map
- * and convert them into their synced Fluid state counterparts
- */
-export interface IFluidConverter<SV extends IViewState, SF extends IFluidState> {
-    /**
-     * The type of object this key in the view state holds
-     */
-    type: string;
-    /**
-     * The corresponding value within the Fluid state
-     */
-    fluidKey: keyof SF;
-    /**
-     * A callback that takes in the partial view state containing the value that
-     * this converter maps to, and optionally returns a value. This value will be automatically set on the synced state
-     * under the view key this converter maps to
-     */
-    fluidConverter?: (viewState: SV, fluidState: Partial<SF>) => any;
-}
-/**
- * Base interface to extend from for the Fluid state. These values can and should be left
- * undefined when passing in the initial state as they will be used to establish the Fluid state
- */
-export interface IFluidState {
-    /**
-     * The unique state ID for this React Fluid view
-     */
-    syncedStateId?: string;
-    /**
-     * Boolean indicating if any DDSes or Fluid objects on this state are being listened on
-     * for synced state updates to trigger React state updates
-     */
-    isInitialized?: boolean;
-}
-/**
- * Base interface to extend from for the view state.
- * This should be crafted based off of what the view will use from the Fluid state.
- */
-export interface IViewState extends IFluidState {
-    /**
-     * The map containing the locally available Fluid objects that have been loaded. If there are
-     * any Fluid objects loaded during initialization that the view needs to use,
-     * they should be fetched and loaded in here.
-     * Any new Fluid objects added through reducers/selectors during the React lifecycle
-     * will be automatically added to this map and the state will re-update when they become asynchronously available
-     */
-    fluidObjectMap?: FluidObjectMap;
-}
-export declare type IFluidReactState = IFluidState & IViewState;
-export declare const instanceOfIFluidLoadable: (object: any) => object is IFluidLoadable;
-/**
- * The values stored in the Fluid object map
- */
-export interface IFluidObjectMapItem {
-    /**
-     * The actual Fluid object that the path this value is keyed against leads to
-     */
-    fluidObject?: IFluidObject & IFluidLoadable;
-    /**
-     * Boolean indicating if we are listening to changes on this Fluid object's synced state to trigger React
-     * state updates. Only set if you want custom behavior for adding listeners to your Fluid state
-     */
-    isListened?: boolean;
-    /**
-     * List of events fired on this Fluid object that will trigger a state update
-     */
-    listenedEvents?: string[];
-    /**
-     * INTERNAL
-     * Does not need to be set
-     * Is this a SharedMap that was added as a Fluid React requirement
-     */
-    isRuntimeMap?: boolean;
-}
-/**
- * A map of the Fluid object handle absolute path to the Fluid object
- */
-export declare type FluidObjectMap = Map<string, IFluidObjectMapItem>;
-/**
- * Base interface to extend from for the data props that will be passed in for reducers and
- * selectors to use to offer inter-Fluid object operability
- */
-export interface IFluidDataProps {
-    /**
-     * The Fluid data store runtime passed in from Fluid object initialization
-     */
-    runtime: IFluidDataStoreRuntime;
-    /**
-     * The running map of all the Fluid objects being used to render the React view. This
-     * can be view/data Fluid objects, and they will be asynchronously loaded here so that they are,
-     * in turn, synchronously available for the view when the state updates after they are fetched
-     */
-    fluidObjectMap: FluidObjectMap;
-}
-/**
- * Definition for an effect function used in reducers
- */
-export interface FluidEffectFunction<SV extends IViewState, SF extends IFluidState, C extends IFluidDataProps> {
-    /**
-     * The function defined here will take the combined state and apply some
-     * logic that does not cause any state update changes
-     */
-    function: (oldState?: ICombinedState<SV, SF, C>, ...args: any) => void;
-}
-export declare const instanceOfEffectFunction: <SV extends IViewState, SF extends IFluidState, C extends IFluidDataProps>(object: any) => object is FluidEffectFunction<SV, SF, C>;
-/**
- * Definition for an async effect function used in reducers
- */
-export interface FluidAsyncEffectFunction<SV extends IViewState, SF extends IFluidState, C extends IFluidDataProps> {
-    /**
-     *  The function defined here will take the combined state and apply some
-     * async logic that does not cause any state update changes
-     */
-    asyncFunction: (oldState?: ICombinedState<SV, SF, C>, ...args: any) => Promise<void>;
-}
-export declare const instanceOfAsyncEffectFunction: <SV extends IViewState, SF extends IFluidState, C extends IFluidDataProps>(object: any) => object is FluidAsyncEffectFunction<SV, SF, C>;
-/**
- * Definition for a state update function used in reducers
- */
-export interface FluidStateUpdateFunction<SV extends IViewState, SF extends IFluidState, C extends IFluidDataProps> {
-    /**
-     * The function defined here will take the combined state and update either
-     * the Fluid state, the view state, or both. The new combined state and any new Fluid object
-     * handles to load in are returned by the function.
-     */
-    function: (oldState?: ICombinedState<SV, SF, C>, ...args: any) => IStateUpdateResult<SV, SF, C>;
-}
-export declare const instanceOfStateUpdateFunction: <SV extends IViewState, SF extends IFluidState, C extends IFluidDataProps>(object: any) => object is FluidStateUpdateFunction<SV, SF, C>;
-/**
- * Definition for an async state update function used in reducers
- */
-export interface FluidAsyncStateUpdateFunction<SV extends IViewState, SF extends IFluidState, C extends IFluidDataProps> {
-    /**
-     * The function defined here will take the combined state and update either
-     * the Fluid state, the view state, or both in an async manner. The new combined state and any new
-     * Fluid object handles to load in will be returned by the function when it finishes.
-     */
-    asyncFunction: (oldState?: ICombinedState<SV, SF, C>, ...args: any) => Promise<IStateUpdateResult<SV, SF, C>>;
-}
-/**
- * The value returned by state update functions.
- */
-export interface IStateUpdateResult<SV extends IViewState, SF extends IFluidState, C extends IFluidDataProps> {
-    /**
-     * The new view and Fluid states that were updated by the function
-     */
-    state: ICombinedState<SV, SF, C>;
-    /**
-     * Any new Fluid objects that were added in due this function need to have
-     * their corresponding handles passed in so that the object can also be loaded for all other users
-     */
-    newFluidHandles?: IFluidHandle[];
-}
-export declare const instanceOfAsyncStateUpdateFunction: <SV extends IViewState, SF extends IFluidState, C extends IFluidDataProps>(object: any) => object is FluidAsyncStateUpdateFunction<SF, SV, C>;
-/**
- * Definition for a selector function used in selectors
- */
-export interface FluidSelectorFunction<SV extends IViewState, SF extends IFluidState, C extends IFluidDataProps> {
-    /**
-     * The function defined here will take the combined state and return
-     * to the view any values that it needs  from other values/Fluid objects that were passed
-     * in to the data props on initializing.
-     * It will also return any new Fluid handles that will be needed for other users to render the view value
-     */
-    function: (state?: ICombinedState<SV, SF, C>) => {
-        result: any | undefined;
-        newFluidHandles?: IFluidHandle[];
-    };
-}
-/**
- * Definition for a Fluid object selector function used in selectors
- */
-export interface FluidObjectSelectorFunction<SV extends IViewState, SF extends IFluidState, C extends IFluidDataProps> {
-    /**
-     * Similar to the FluidSelectorFunction's function but this also takes in a
-     * handle if we need to fetch a Fluid object from the fluidObjectMap
-     */
-    function: (handle: IFluidHandle<any>, state?: ICombinedState<SV, SF, C>) => {
-        result: IFluidObject | undefined;
-        newFluidHandles?: IFluidHandle[];
-    };
-}
-export declare const instanceOfSelectorFunction: <SV extends IViewState, SF extends IFluidState, C extends IFluidDataProps>(object: any) => object is FluidSelectorFunction<SV, SF, C>;
-export declare const instanceOfFluidObjectSelectorFunction: <SV extends IViewState, SF extends IFluidState, C extends IFluidDataProps>(object: any) => object is FluidObjectSelectorFunction<SV, SF, C>;
-/**
- * Props passed in to the useReducerFluid hook
- */
-export interface IFluidReducerProps<SV extends IViewState, SF extends IFluidState, A extends IFluidReducer<SV, SF, C>, B, C extends IFluidDataProps> {
-    /**
-     * Unique ID to use for storing the view's synced state in the SyncedDataObject's syncedState SharedMap
-     */
-    syncedStateId: string;
-    /**
-     * An instance of the SyncedDataObject that this will be rendered in
-     */
-    syncedDataObject: SyncedDataObject;
-    /**
-     * The Fluid reducer containing all the functions as defined by an extension of the IFluidReducer type.
-     * Any mutations to the state, or effects outside of the Fluid object involving the state should be done here.
-     */
-    reducer: A;
-    /**
-     * The Fluid selector containing all the functions as defined by an extension of the IFluidSelector
-     * type. Any fetching of new Fluid objects or data from other Fluid objects should be done here.
-     */
-    selector: B;
-    /**
-     * Data props that are loaded in during the Fluid initialization step. This contains the runtime
-     * and the Fluid object map
-     * TODO: Move data props out as it can be fetched from synced Fluid data object but
-     * still needs to be extensible for reducers
-     */
-    dataProps?: C;
-}
-/**
- * Props containing the context that will be passed down through the Fluid context provider to the consumer
- */
-export interface IFluidContextProps<SV, SF, C> extends IFluidProps<SV, SF> {
-    /**
-     * The additional data that will be passed through the Fluid context
-     */
-    reactContext?: C;
-}
-/**
- * The state that is available through the react context
- */
-export interface FluidContextState<SV extends IViewState, C> {
-    /**
-     * The view state
-     */
-    state: SV;
-    /**
-     * Callback to update the state
-     */
-    setState: (state: SV) => void;
-    /**
-     * The context passed in from the props
-     */
-    reactContext: Partial<C>;
-}
-/**
- * The returned value of createFluidContext
- */
-export interface FluidContext<SV extends IViewState, C> {
-    /**
-     * The context provider React component that will give the FluidContextState to
-     * its children
-     */
-    Provider: React.ProviderExoticComponent<React.ProviderProps<FluidContextState<SV, C>>>;
-    /**
-     * The context consumer that allows children to use the FluidContextState
-     */
-    Consumer: React.Consumer<FluidContextState<SV, C>>;
-    /**
-     * Callback to get the context
-     */
-    usePrimedContext: () => FluidContextState<SV, C>;
-    /**
-     * The view state
-     */
-    state: SV;
-    /**
-     * Callback to update the state
-     */
-    setState: (newState: SV) => void;
-}
-export interface ISyncedStateConfig<SV, SF> {
-    /**
-     * Unique ID to use for storing the view's synced state in the SyncedDataObject's syncedState SharedMap
-     */
-    syncedStateId: string;
-    /**
-     * The backup default view that any view with this ID will use prior to Fluid state initializing, this can be
-     * overridden by the view developer themselves
-     */
-    defaultViewState: SV;
-    /**
-     * A map of the Fluid state values that need conversion to their view state counterparts and the
-     * respective converters
-     */
-    fluidToView: FluidToViewMap<SV, SF>;
-    /**
-     * A map of the view state values that need conversion to their Fluid state counterparts and the
-     * respective converters
-     */
-    viewToFluid?: ViewToFluidMap<SV, SF>;
-}
-/**
- * The configurations that define the relationships between Fluid and view states for
- * views that are rendered in a SyncedDataObject
- */
-export declare type SyncedStateConfig = Map<string, ISyncedStateConfig<any, any>>;
-/**
- * The interface for interacting with the synced state that is stored on a SyncedDataObject
- */
-export interface ISyncedState {
-    /**
-     * Set values on the synced state for a syncedStateId as key
-     */
-    set: (key: string, value: any) => void;
-    /**
-     * Get values from the synced state for a syncedStateId as key
-     */
-    get: <T>(key: string) => T | undefined;
-    /**
-     * Add a listener to the synced state using a provided callback
-     */
-    addValueChangedListener: (callback: (changed: IValueChanged, local: boolean) => void) => void;
-}
-//# sourceMappingURL=interface.d.ts.map

package/dist/interface.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"interface.d.ts","sourceRoot":"","sources":["../src/interface.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAC/E,OAAO,EACH,YAAY,EACZ,cAAc,EACd,YAAY,EACf,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD;;;GAGG;AACH,MAAM,WAAW,cAAc,CAC3B,EAAE,SAAS,UAAU,EACrB,EAAE,SAAS,WAAW,EACtB,CAAC,SAAS,eAAe;IAEzB;;OAEG;IACH,SAAS,EAAE,EAAE,CAAC;IACd;;;OAGG;IACH,UAAU,CAAC,EAAE,EAAE,CAAC;IAChB;;;;OAIG;IACH,SAAS,EAAE,CAAC,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,eAAe,EAAE,UAAU,CAAC;IAC5B;;OAEG;IACH,gBAAgB,EAAE,UAAU,CAAC;IAC7B;;OAEG;IACH,eAAe,EAAE,UAAU,CAAC;CAC/B;AAED;;;GAGG;AACH,oBAAY,cAAc,CAAC,EAAE,EAAE,EAAE,IAAI,GAAG,CAAC,MAAM,EAAE,EAAE,eAAe,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;AAE5E;;;GAGG;AACH,oBAAY,cAAc,CAAC,EAAE,EAAE,EAAE,IAAI,GAAG,CAAC,MAAM,EAAE,EAAE,cAAc,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;AAE3E;;;;;;GAMG;AACH,MAAM,WAAW,aAAa,CAC1B,EAAE,SAAS,UAAU,EACrB,EAAE,SAAS,WAAW,EACtB,CAAC,SAAS,eAAe;IAEzB,CAAC,GAAG,EAAE,MAAM,GACV,6BAA6B,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,GACxC,wBAAwB,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,GACnC,mBAAmB,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,GAC9B,wBAAwB,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;CACzC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,cAAc,CAC3B,EAAE,SAAS,UAAU,EACrB,EAAE,SAAS,WAAW,EACtB,CAAC,SAAS,eAAe;IAEzB,CAAC,GAAG,EAAE,MAAM,GACV,qBAAqB,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,GAChC,2BAA2B,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CACxB,EAAE,SAAS,UAAU,EACrB,EAAE,SAAS,WAAW;IAEtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,CAAC;IACnC;;;;;OAKG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc,CAC3B,EAAE,SAAS,UAAU,EACrB,EAAE,SAAS,WAAW;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB;;;OAGG;IACH,aAAa,CAAC,EAAE,CACZ,SAAS,EAAE,EAAE,EACb,UAAU,EAAE,OAAO,CAAC,EAAE,CAAC,EACvB,cAAc,EAAE,cAAc,KAC7B,OAAO,CAAC,EAAE,CAAC,CAAC;IACjB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,CAAC,OAAO,EAAE,sBAAsB,KAAK,GAAG,CAAC;IAC9D;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe,CAC5B,EAAE,SAAS,UAAU,EACrB,EAAE,SAAS,WAAW;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB;;;;OAIG;IACH,cAAc,CAAC,EAAE,CAAC,SAAS,EAAE,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,CAAC,KAAK,GAAG,CAAC;CACpE;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IACxB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,UACb,SAAQ,WAAW;IACnB;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;CACnC;AAED,oBAAY,gBAAgB,GAAG,WAAW,GAAG,UAAU,CAAC;AAExD,eAAO,MAAM,wBAAwB,WACzB,GAAG,6BAE4C,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,WAAW,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;IAC5C;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,oBAAY,cAAc,GAAG,GAAG,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;AAE9D;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC;IAChC;;;;OAIG;IACH,cAAc,EAAE,cAAc,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAChC,EAAE,SAAS,UAAU,EACrB,EAAE,SAAS,WAAW,EACtB,CAAC,SAAS,eAAe;IAEzB;;;OAGG;IACH,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,cAAc,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,IAAI,CAAC;CAC1E;AAED,eAAO,MAAM,wBAAwB,qFAKzB,GAAG,6CAEsC,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,wBAAwB,CACrC,EAAE,SAAS,UAAU,EACrB,EAAE,SAAS,WAAW,EACtB,CAAC,SAAS,eAAe;IAEzB;;;OAGG;IACH,aAAa,EAAE,CACX,QAAQ,CAAC,EAAE,cAAc,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,EACpC,GAAG,IAAI,EAAE,GAAG,KACX,OAAO,CAAC,IAAI,CAAC,CAAC;CACtB;AAED,eAAO,MAAM,6BAA6B,qFAK9B,GAAG,kDAE2C,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,wBAAwB,CACrC,EAAE,SAAS,UAAU,EACrB,EAAE,SAAS,WAAW,EACtB,CAAC,SAAS,eAAe;IAEzB;;;;OAIG;IACH,QAAQ,EAAE,CACN,QAAQ,CAAC,EAAE,cAAc,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,EACpC,GAAG,IAAI,EAAE,GAAG,KACX,kBAAkB,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;CACtC;AAED,eAAO,MAAM,6BAA6B,qFAK9B,GAAG,kDAEsC,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,6BAA6B,CAC1C,EAAE,SAAS,UAAU,EACrB,EAAE,SAAS,WAAW,EACtB,CAAC,SAAS,eAAe;IAEzB;;;;OAIG;IACH,aAAa,EAAE,CACX,QAAQ,CAAC,EAAE,cAAc,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,EACpC,GAAG,IAAI,EAAE,GAAG,KACX,OAAO,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAC/B,EAAE,SAAS,UAAU,EACrB,EAAE,SAAS,WAAW,EACtB,CAAC,SAAS,eAAe;IAEzB;;OAEG;IACH,KAAK,EAAE,cAAc,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IACjC;;;OAGG;IACH,eAAe,CAAC,EAAE,YAAY,EAAE,CAAC;CACpC;AAED,eAAO,MAAM,kCAAkC,qFAKnC,GAAG,uDAE2C,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAClC,EAAE,SAAS,UAAU,EACrB,EAAE,SAAS,WAAW,EACtB,CAAC,SAAS,eAAe;IAEzB;;;;;OAKG;IACH,QAAQ,EAAE,CACN,KAAK,CAAC,EAAE,cAAc,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,KAChC;QACD,MAAM,EAAE,GAAG,GAAG,SAAS,CAAC;QACxB,eAAe,CAAC,EAAE,YAAY,EAAE,CAAC;KACpC,CAAC;CACL;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B,CACxC,EAAE,SAAS,UAAU,EACrB,EAAE,SAAS,WAAW,EACtB,CAAC,SAAS,eAAe;IAEzB;;;OAGG;IACH,QAAQ,EAAE,CACN,MAAM,EAAE,YAAY,CAAC,GAAG,CAAC,EACzB,KAAK,CAAC,EAAE,cAAc,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,KAChC;QACD,MAAM,EAAE,YAAY,GAAG,SAAS,CAAC;QACjC,eAAe,CAAC,EAAE,YAAY,EAAE,CAAC;KACpC,CAAC;CACL;AAED,eAAO,MAAM,0BAA0B,qFAK3B,GAAG,+CAEsC,CAAC;AAEtD,eAAO,MAAM,qCAAqC,qFAKtC,GAAG,qDAEsC,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAC/B,EAAE,SAAS,UAAU,EACrB,EAAE,SAAS,WAAW,EACtB,CAAC,SAAS,aAAa,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,EAClC,CAAC,EACD,CAAC,SAAS,eAAe;IAEzB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,CAAC;IACnC;;;OAGG;IACH,OAAO,EAAE,CAAC,CAAC;IACX;;;OAGG;IACH,QAAQ,EAAE,CAAC,CAAC;IACZ;;;;;OAKG;IACH,SAAS,CAAC,EAAE,CAAC,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAE,SAAQ,WAAW,CAAC,EAAE,EAAE,EAAE,CAAC;IACtE;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAC9B,EAAE,SAAS,UAAU,EACrB,CAAC;IAED;;OAEG;IACH,KAAK,EAAE,EAAE,CAAC;IACV;;OAEG;IACH,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,KAAK,IAAI,CAAC;IAC9B;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY,CACzB,EAAE,SAAS,UAAU,EACrB,CAAC;IAED;;;OAGG;IACH,QAAQ,EAAE,KAAK,CAAC,uBAAuB,CACnC,KAAK,CAAC,aAAa,CAAC,iBAAiB,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAChD,CAAC;IACF;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IACnD;;OAEG;IACH,gBAAgB,EAAE,MAAM,iBAAiB,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IACjD;;OAEG;IACH,KAAK,EAAE,EAAE,CAAC;IACV;;OAEG;IACH,QAAQ,EAAE,CAAC,QAAQ,EAAE,EAAE,KAAK,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,kBAAkB,CAAC,EAAE,EAAE,EAAE;IACtC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,gBAAgB,EAAE,EAAE,CAAC;IACrB;;;OAGG;IACH,WAAW,EAAE,cAAc,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACpC;;;OAGG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;CACxC;AAED;;;GAGG;AACH,oBAAY,iBAAiB,GAAG,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AAE1E;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,IAAI,CAAC;IACvC;;OAEG;IACH,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,uBAAuB,EAAE,CACrB,QAAQ,EAAE,CAAC,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,KAAK,IAAI,CAAC;CAC3E"}

package/dist/interface.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.instanceOfFluidObjectSelectorFunction = exports.instanceOfSelectorFunction = exports.instanceOfAsyncStateUpdateFunction = exports.instanceOfStateUpdateFunction = exports.instanceOfAsyncEffectFunction = exports.instanceOfEffectFunction = exports.instanceOfIFluidLoadable = void 0;
-const instanceOfIFluidLoadable = (object) => object === Object(object) && "IFluidLoadable" in object;
-exports.instanceOfIFluidLoadable = instanceOfIFluidLoadable;
-const instanceOfEffectFunction = (object) => object === Object(object) && "function" in object;
-exports.instanceOfEffectFunction = instanceOfEffectFunction;
-const instanceOfAsyncEffectFunction = (object) => object === Object(object) && "asyncFunction" in object;
-exports.instanceOfAsyncEffectFunction = instanceOfAsyncEffectFunction;
-const instanceOfStateUpdateFunction = (object) => object === Object(object) && "function" in object;
-exports.instanceOfStateUpdateFunction = instanceOfStateUpdateFunction;
-const instanceOfAsyncStateUpdateFunction = (object) => object === Object(object) && "asyncFunction" in object;
-exports.instanceOfAsyncStateUpdateFunction = instanceOfAsyncStateUpdateFunction;
-const instanceOfSelectorFunction = (object) => object === Object(object) && "function" in object;
-exports.instanceOfSelectorFunction = instanceOfSelectorFunction;
-const instanceOfFluidObjectSelectorFunction = (object) => object === Object(object) && "function" in object;
-exports.instanceOfFluidObjectSelectorFunction = instanceOfFluidObjectSelectorFunction;
-//# sourceMappingURL=interface.js.map

package/dist/interface.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"interface.js","sourceRoot":"","sources":["../src/interface.ts"],"names":[],"mappings":";;;AAwOO,MAAM,wBAAwB,GAAG,CACpC,MAAW,EACa,EAAE,CAC1B,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,gBAAgB,IAAI,MAAM,CAAC;AAH/C,QAAA,wBAAwB,4BAGuB;AAgErD,MAAM,wBAAwB,GAAG,CAKpC,MAAW,EAC6B,EAAE,CAC1C,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,UAAU,IAAI,MAAM,CAAC;AAPzC,QAAA,wBAAwB,4BAOiB;AAoB/C,MAAM,6BAA6B,GAAG,CAKzC,MAAW,EACkC,EAAE,CAC/C,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,eAAe,IAAI,MAAM,CAAC;AAP9C,QAAA,6BAA6B,iCAOiB;AAqBpD,MAAM,6BAA6B,GAAG,CAKzC,MAAW,EACkC,EAAE,CAC/C,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,UAAU,IAAI,MAAM,CAAC;AAPzC,QAAA,6BAA6B,iCAOY;AAwC/C,MAAM,kCAAkC,GAAG,CAK9C,MAAW,EACuC,EAAE,CACpD,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,eAAe,IAAI,MAAM,CAAC;AAP9C,QAAA,kCAAkC,sCAOY;AA6CpD,MAAM,0BAA0B,GAAG,CAKtC,MAAW,EAC+B,EAAE,CAC5C,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,UAAU,IAAI,MAAM,CAAC;AAPzC,QAAA,0BAA0B,8BAOe;AAE/C,MAAM,qCAAqC,GAAG,CAKjD,MAAW,EACqC,EAAE,CAClD,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,UAAU,IAAI,MAAM,CAAC;AAPzC,QAAA,qCAAqC,yCAOI","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { ISharedMap, IValueChanged } from \"@fluidframework/map\";\nimport { IFluidDataStoreRuntime } from \"@fluidframework/datastore-definitions\";\nimport {\n    IFluidHandle,\n    IFluidLoadable,\n    IFluidObject,\n} from \"@fluidframework/core-interfaces\";\nimport { SyncedDataObject } from \"./syncedDataObject\";\n\n/**\n * The combined state contains the Fluid and view states and the data props\n * that are passed in to all reducers and selectors\n */\nexport interface ICombinedState<\n    SV extends IViewState,\n    SF extends IFluidState,\n    C extends IFluidDataProps\n    > {\n    /**\n     * The react view state that will be used for all view renders\n     */\n    viewState: SV;\n    /**\n     * The Fluid state that will be used to update the synced values in the state. This will be\n     * undefined until it is initialized, after which the state will update with the defined values\n     */\n    fluidState?: SF;\n    /**\n     * Data props that are loaded in during the Fluid initialization step. This contains the runtime\n     * and the Fluid object map, along with any other properties the user wants to pass to reducers\n     * and selectors\n     */\n    dataProps: C;\n}\n\n/**\n * The Fluid schema that is generated on load and will be stored in the synced state\n */\nexport interface IFluidSchema {\n    /**\n     * (k,v) = (viewKeys, needsFluidConverter)\n     */\n    viewMatchingMap: ISharedMap;\n    /**\n     * (k,v) = (fluidKeys, needsViewConverter)\n     */\n    fluidMatchingMap: ISharedMap;\n    /**\n     * (k,v) = (path, handle)\n     */\n    storedHandleMap: ISharedMap;\n}\n\n/**\n * A map of the view state values that need conversion to their Fluid state counterparts and the\n * respective converters\n */\nexport type ViewToFluidMap<SV, SF> = Map<keyof SV, IFluidConverter<SV, SF>>;\n\n/**\n * A map of the Fluid state values that need conversion to their view state counterparts and the\n * respective converters\n */\nexport type FluidToViewMap<SV, SF> = Map<keyof SF, IViewConverter<SV, SF>>;\n\n/**\n * The Fluid reducer, containing an object that is keyed by function name and contains state update and\n * effect functions. Each function will have the view state, fluid state, and data props passed into it\n * as parameters in the combined state. State update functions are used to modify values on the state and return\n * the updated state and any new Fluid object handles. Effect functions use values on the state to apply changes\n * elsewhere. They do not return any new objects or state.\n */\nexport interface IFluidReducer<\n    SV extends IViewState,\n    SF extends IFluidState,\n    C extends IFluidDataProps\n    > {\n    [key: string]:\n    | FluidAsyncStateUpdateFunction<SV, SF, C>\n    | FluidStateUpdateFunction<SV, SF, C>\n    | FluidEffectFunction<SV, SF, C>\n    | FluidAsyncEffectFunction<SV, SF, C>;\n}\n\n/**\n * The Fluid selector, containing an object that is keyed by function name and contains selector\n * functions. Each function will have the view state, fluid state, and data props passed into it\n * as parameters in the combined state. Selector functions can also optionally pass in a\n * handle to fetch from the Fluid object map.\n * Selector functions are used to retrieve Fluid objects or parameters from other Fluid objects.\n * It offers a way to fetch these values and return them to the view, with the\n * Fluid object map being updated if the view requires a Fluid object that hasn't been locally loaded yet\n */\nexport interface IFluidSelector<\n    SV extends IViewState,\n    SF extends IFluidState,\n    C extends IFluidDataProps\n    > {\n    [key: string]:\n    | FluidSelectorFunction<SV, SF, C>\n    | FluidObjectSelectorFunction<SV, SF, C>;\n}\n\n/**\n * Props passed in to create a FluidReactView or passed in to the useStateFluid hook\n */\nexport interface IFluidProps<\n    SV extends IViewState,\n    SF extends IFluidState\n    > {\n    /**\n     *  Unique ID to use for storing the synced state in the SyncedDataObject's syncedState SharedMap\n     */\n    syncedStateId: string;\n    /**\n     * An instance of the SyncedDataObject that this view will be rendered in\n     */\n    syncedDataObject: SyncedDataObject;\n    /**\n     * Data props containing the Fluid object map and the runtime\n     * Optional as the above two will be passed by default. This only need to be defined\n     * if there are additional values from the Fluid object lifecycle that need to be made\n     * available to the reducers\n     */\n    dataProps?: IFluidDataProps;\n}\n\n/**\n * View converters to take the synced state Fluid value that they are keyed against in the FluidToView map\n * and convert them into their view state counterparts\n */\nexport interface IViewConverter<\n    SV extends IViewState,\n    SF extends IFluidState\n    > {\n    /**\n     * The type of object this key in the Fluid state holds\n     */\n    type: string;\n    /**\n     * The corresponding value key within the view state type\n     */\n    viewKey: keyof SV;\n    /**\n     * A callback that takes in the partial Fluid state containing the value that\n     * this converter maps to, and returns the corresponding partial view state\n     */\n    viewConverter?: (\n        viewState: SV,\n        fluidState: Partial<SF>,\n        fluidObjectMap: FluidObjectMap\n    ) => Partial<SV>;\n    /**\n     * If this is a fluid DDS SharedObject type (i.e. SharedCounter, SharedMap), supply its create function\n     * here and add any events that it will fire to the listenedEvents param below to trigger state updates\n     */\n    sharedObjectCreate?: (runtime: IFluidDataStoreRuntime) => any;\n    /**\n     * List of events fired on this Fluid object that will trigger a state update\n     */\n    listenedEvents?: string[];\n    /**\n     * If this Fluid object is stored on the Fluid DataObject root under a different key\n     * than the name of this Fluid state key within the synced state map,\n     * provide the key on the root for this object here. The changes will also\n     * reflect under that key if the data needs to be used elsewhere\n     */\n    rootKey?: string;\n}\n\n/**\n * Fluid converters to take the view state value that they are keyed against in the ViewToFluid map\n * and convert them into their synced Fluid state counterparts\n */\nexport interface IFluidConverter<\n    SV extends IViewState,\n    SF extends IFluidState\n    > {\n    /**\n     * The type of object this key in the view state holds\n     */\n    type: string;\n    /**\n     * The corresponding value within the Fluid state\n     */\n    fluidKey: keyof SF;\n    /**\n     * A callback that takes in the partial view state containing the value that\n     * this converter maps to, and optionally returns a value. This value will be automatically set on the synced state\n     * under the view key this converter maps to\n     */\n    fluidConverter?: (viewState: SV, fluidState: Partial<SF>) => any;\n}\n\n/**\n * Base interface to extend from for the Fluid state. These values can and should be left\n * undefined when passing in the initial state as they will be used to establish the Fluid state\n */\nexport interface IFluidState {\n    /**\n     * The unique state ID for this React Fluid view\n     */\n    syncedStateId?: string;\n    /**\n     * Boolean indicating if any DDSes or Fluid objects on this state are being listened on\n     * for synced state updates to trigger React state updates\n     */\n    isInitialized?: boolean;\n}\n\n/**\n * Base interface to extend from for the view state.\n * This should be crafted based off of what the view will use from the Fluid state.\n */\nexport interface IViewState\n    extends IFluidState {\n    /**\n     * The map containing the locally available Fluid objects that have been loaded. If there are\n     * any Fluid objects loaded during initialization that the view needs to use,\n     * they should be fetched and loaded in here.\n     * Any new Fluid objects added through reducers/selectors during the React lifecycle\n     * will be automatically added to this map and the state will re-update when they become asynchronously available\n     */\n    fluidObjectMap?: FluidObjectMap;\n}\n\nexport type IFluidReactState = IFluidState & IViewState;\n\nexport const instanceOfIFluidLoadable = (\n    object: any,\n): object is IFluidLoadable =>\n    object === Object(object) && \"IFluidLoadable\" in object;\n\n/**\n * The values stored in the Fluid object map\n */\nexport interface IFluidObjectMapItem {\n    /**\n     * The actual Fluid object that the path this value is keyed against leads to\n     */\n    fluidObject?: IFluidObject & IFluidLoadable;\n    /**\n     * Boolean indicating if we are listening to changes on this Fluid object's synced state to trigger React\n     * state updates. Only set if you want custom behavior for adding listeners to your Fluid state\n     */\n    isListened?: boolean;\n    /**\n     * List of events fired on this Fluid object that will trigger a state update\n     */\n    listenedEvents?: string[];\n    /**\n     * INTERNAL\n     * Does not need to be set\n     * Is this a SharedMap that was added as a Fluid React requirement\n     */\n    isRuntimeMap?: boolean;\n}\n\n/**\n * A map of the Fluid object handle absolute path to the Fluid object\n */\nexport type FluidObjectMap = Map<string, IFluidObjectMapItem>;\n\n/**\n * Base interface to extend from for the data props that will be passed in for reducers and\n * selectors to use to offer inter-Fluid object operability\n */\nexport interface IFluidDataProps {\n    /**\n     * The Fluid data store runtime passed in from Fluid object initialization\n     */\n    runtime: IFluidDataStoreRuntime;\n    /**\n     * The running map of all the Fluid objects being used to render the React view. This\n     * can be view/data Fluid objects, and they will be asynchronously loaded here so that they are,\n     * in turn, synchronously available for the view when the state updates after they are fetched\n     */\n    fluidObjectMap: FluidObjectMap;\n}\n\n/**\n * Definition for an effect function used in reducers\n */\nexport interface FluidEffectFunction<\n    SV extends IViewState,\n    SF extends IFluidState,\n    C extends IFluidDataProps\n    > {\n    /**\n     * The function defined here will take the combined state and apply some\n     * logic that does not cause any state update changes\n     */\n    function: (oldState?: ICombinedState<SV, SF, C>, ...args: any) => void;\n}\n\nexport const instanceOfEffectFunction = <\n    SV extends IViewState,\n    SF extends IFluidState,\n    C extends IFluidDataProps\n>(\n    object: any,\n): object is FluidEffectFunction<SV, SF, C> =>\n    object === Object(object) && \"function\" in object;\n\n/**\n * Definition for an async effect function used in reducers\n */\nexport interface FluidAsyncEffectFunction<\n    SV extends IViewState,\n    SF extends IFluidState,\n    C extends IFluidDataProps\n    > {\n    /**\n     *  The function defined here will take the combined state and apply some\n     * async logic that does not cause any state update changes\n     */\n    asyncFunction: (\n        oldState?: ICombinedState<SV, SF, C>,\n        ...args: any\n    ) => Promise<void>;\n}\n\nexport const instanceOfAsyncEffectFunction = <\n    SV extends IViewState,\n    SF extends IFluidState,\n    C extends IFluidDataProps\n>(\n    object: any,\n): object is FluidAsyncEffectFunction<SV, SF, C> =>\n    object === Object(object) && \"asyncFunction\" in object;\n\n/**\n * Definition for a state update function used in reducers\n */\nexport interface FluidStateUpdateFunction<\n    SV extends IViewState,\n    SF extends IFluidState,\n    C extends IFluidDataProps\n    > {\n    /**\n     * The function defined here will take the combined state and update either\n     * the Fluid state, the view state, or both. The new combined state and any new Fluid object\n     * handles to load in are returned by the function.\n     */\n    function: (\n        oldState?: ICombinedState<SV, SF, C>,\n        ...args: any\n    ) => IStateUpdateResult<SV, SF, C>;\n}\n\nexport const instanceOfStateUpdateFunction = <\n    SV extends IViewState,\n    SF extends IFluidState,\n    C extends IFluidDataProps\n>(\n    object: any,\n): object is FluidStateUpdateFunction<SV, SF, C> =>\n    object === Object(object) && \"function\" in object;\n\n/**\n * Definition for an async state update function used in reducers\n */\nexport interface FluidAsyncStateUpdateFunction<\n    SV extends IViewState,\n    SF extends IFluidState,\n    C extends IFluidDataProps\n    > {\n    /**\n     * The function defined here will take the combined state and update either\n     * the Fluid state, the view state, or both in an async manner. The new combined state and any new\n     * Fluid object handles to load in will be returned by the function when it finishes.\n     */\n    asyncFunction: (\n        oldState?: ICombinedState<SV, SF, C>,\n        ...args: any\n    ) => Promise<IStateUpdateResult<SV, SF, C>>;\n}\n\n/**\n * The value returned by state update functions.\n */\nexport interface IStateUpdateResult<\n    SV extends IViewState,\n    SF extends IFluidState,\n    C extends IFluidDataProps\n    > {\n    /**\n     * The new view and Fluid states that were updated by the function\n     */\n    state: ICombinedState<SV, SF, C>;\n    /**\n     * Any new Fluid objects that were added in due this function need to have\n     * their corresponding handles passed in so that the object can also be loaded for all other users\n     */\n    newFluidHandles?: IFluidHandle[];\n}\n\nexport const instanceOfAsyncStateUpdateFunction = <\n    SV extends IViewState,\n    SF extends IFluidState,\n    C extends IFluidDataProps\n>(\n    object: any,\n): object is FluidAsyncStateUpdateFunction<SF, SV, C> =>\n    object === Object(object) && \"asyncFunction\" in object;\n\n/**\n * Definition for a selector function used in selectors\n */\nexport interface FluidSelectorFunction<\n    SV extends IViewState,\n    SF extends IFluidState,\n    C extends IFluidDataProps\n    > {\n    /**\n     * The function defined here will take the combined state and return\n     * to the view any values that it needs  from other values/Fluid objects that were passed\n     * in to the data props on initializing.\n     * It will also return any new Fluid handles that will be needed for other users to render the view value\n     */\n    function: (\n        state?: ICombinedState<SV, SF, C>\n    ) => {\n        result: any | undefined;\n        newFluidHandles?: IFluidHandle[];\n    };\n}\n\n/**\n * Definition for a Fluid object selector function used in selectors\n */\nexport interface FluidObjectSelectorFunction<\n    SV extends IViewState,\n    SF extends IFluidState,\n    C extends IFluidDataProps\n    > {\n    /**\n     * Similar to the FluidSelectorFunction's function but this also takes in a\n     * handle if we need to fetch a Fluid object from the fluidObjectMap\n     */\n    function: (\n        handle: IFluidHandle<any>,\n        state?: ICombinedState<SV, SF, C>,\n    ) => {\n        result: IFluidObject | undefined;\n        newFluidHandles?: IFluidHandle[];\n    };\n}\n\nexport const instanceOfSelectorFunction = <\n    SV extends IViewState,\n    SF extends IFluidState,\n    C extends IFluidDataProps\n>(\n    object: any,\n): object is FluidSelectorFunction<SV, SF, C> =>\n    object === Object(object) && \"function\" in object;\n\nexport const instanceOfFluidObjectSelectorFunction = <\n    SV extends IViewState,\n    SF extends IFluidState,\n    C extends IFluidDataProps\n>(\n    object: any,\n): object is FluidObjectSelectorFunction<SV, SF, C> =>\n    object === Object(object) && \"function\" in object;\n\n/**\n * Props passed in to the useReducerFluid hook\n */\nexport interface IFluidReducerProps<\n    SV extends IViewState,\n    SF extends IFluidState,\n    A extends IFluidReducer<SV, SF, C>,\n    B,\n    C extends IFluidDataProps\n    > {\n    /**\n     * Unique ID to use for storing the view's synced state in the SyncedDataObject's syncedState SharedMap\n     */\n    syncedStateId: string;\n    /**\n     * An instance of the SyncedDataObject that this will be rendered in\n     */\n    syncedDataObject: SyncedDataObject;\n    /**\n     * The Fluid reducer containing all the functions as defined by an extension of the IFluidReducer type.\n     * Any mutations to the state, or effects outside of the Fluid object involving the state should be done here.\n     */\n    reducer: A;\n    /**\n     * The Fluid selector containing all the functions as defined by an extension of the IFluidSelector\n     * type. Any fetching of new Fluid objects or data from other Fluid objects should be done here.\n     */\n    selector: B;\n    /**\n     * Data props that are loaded in during the Fluid initialization step. This contains the runtime\n     * and the Fluid object map\n     * TODO: Move data props out as it can be fetched from synced Fluid data object but\n     * still needs to be extensible for reducers\n     */\n    dataProps?: C;\n}\n\n/**\n * Props containing the context that will be passed down through the Fluid context provider to the consumer\n */\nexport interface IFluidContextProps<SV, SF, C> extends IFluidProps<SV, SF> {\n    /**\n     * The additional data that will be passed through the Fluid context\n     */\n    reactContext?: C;\n}\n\n/**\n * The state that is available through the react context\n */\nexport interface FluidContextState<\n    SV extends IViewState,\n    C\n    > {\n    /**\n     * The view state\n     */\n    state: SV;\n    /**\n     * Callback to update the state\n     */\n    setState: (state: SV) => void;\n    /**\n     * The context passed in from the props\n     */\n    reactContext: Partial<C>;\n}\n\n/**\n * The returned value of createFluidContext\n */\nexport interface FluidContext<\n    SV extends IViewState,\n    C\n    > {\n    /**\n     * The context provider React component that will give the FluidContextState to\n     * its children\n     */\n    Provider: React.ProviderExoticComponent<\n        React.ProviderProps<FluidContextState<SV, C>>\n    >;\n    /**\n     * The context consumer that allows children to use the FluidContextState\n     */\n    Consumer: React.Consumer<FluidContextState<SV, C>>;\n    /**\n     * Callback to get the context\n     */\n    usePrimedContext: () => FluidContextState<SV, C>;\n    /**\n     * The view state\n     */\n    state: SV;\n    /**\n     * Callback to update the state\n     */\n    setState: (newState: SV) => void;\n}\n\nexport interface ISyncedStateConfig<SV, SF> {\n    /**\n     * Unique ID to use for storing the view's synced state in the SyncedDataObject's syncedState SharedMap\n     */\n    syncedStateId: string;\n    /**\n     * The backup default view that any view with this ID will use prior to Fluid state initializing, this can be\n     * overridden by the view developer themselves\n     */\n    defaultViewState: SV;\n    /**\n     * A map of the Fluid state values that need conversion to their view state counterparts and the\n     * respective converters\n     */\n    fluidToView: FluidToViewMap<SV, SF>;\n    /**\n     * A map of the view state values that need conversion to their Fluid state counterparts and the\n     * respective converters\n     */\n    viewToFluid?: ViewToFluidMap<SV, SF>;\n}\n\n/**\n * The configurations that define the relationships between Fluid and view states for\n * views that are rendered in a SyncedDataObject\n */\nexport type SyncedStateConfig = Map<string, ISyncedStateConfig<any, any>>;\n\n/**\n * The interface for interacting with the synced state that is stored on a SyncedDataObject\n */\nexport interface ISyncedState {\n    /**\n     * Set values on the synced state for a syncedStateId as key\n     */\n    set: (key: string, value: any) => void;\n    /**\n     * Get values from the synced state for a syncedStateId as key\n     */\n    get: <T>(key: string) => T | undefined;\n    /**\n     * Add a listener to the synced state using a provided callback\n     */\n    addValueChangedListener: (\n        callback: (changed: IValueChanged, local: boolean) => void) => void;\n}\n"]}

package/dist/reactView.d.ts

@@ -1,32 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import * as React from "react";
-import { IFluidProps, IFluidState, IViewState } from "./interface";
-/**
- * A React view with a synced state, initial props, and a Fluid-to-view state two-way mapping
- */
-export declare abstract class FluidReactView<SV extends IViewState, SF extends IFluidState> extends React.Component<IFluidProps<SV, SF>, SV> {
-    private readonly _syncedStateId;
-    private readonly _syncedState;
-    private readonly _dataProps;
-    private readonly _viewToFluid;
-    private readonly _fluidToView;
-    constructor(props: IFluidProps<SV, SF>);
-    componentDidMount(): Promise<void>;
-    /**
-     * Function to update the state from both synced state updates or local ones. Only updates the synced state
-     * on local updates
-     * @param newState - the new state to be set
-     * @param fromRootUpdate - is this update coming locally or from a synced state value change
-     * @param isLocal - should this update be applied only locally
-     */
-    private _setState;
-    /**
-     * Function to update the current state. It overloads the React setState function
-     * @param newState - New state to be set both locally and on the synced state
-     */
-    setState(newState: SV): void;
-}
-//# sourceMappingURL=reactView.d.ts.map

package/dist/reactView.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"reactView.d.ts","sourceRoot":"","sources":["../src/reactView.tsx"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EACH,WAAW,EACX,WAAW,EACX,UAAU,EAKb,MAAM,aAAa,CAAC;AAGrB;;GAEG;AACH,8BAAsB,cAAc,CAAC,EAAE,SAAS,UAAU,EACtD,EAAE,SAAS,WAAW,CAAE,SAAQ,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;IACxE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAS;IACxC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAe;IAC5C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAkB;IAC7C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAyC;IACtE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAwC;gBACzD,KAAK,EAAE,WAAW,CAAC,EAAE,EAAE,EAAE,CAAC;IAkBzB,iBAAiB;IAY9B;;;;;;OAMG;IACH,OAAO,CAAC,SAAS;IA0BjB;;;OAGG;IACI,QAAQ,CAAC,QAAQ,EAAE,EAAE;CAa/B"}

package/dist/reactView.js

@@ -1,79 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FluidReactView = void 0;
-const React = __importStar(require("react"));
-const helpers_1 = require("./helpers");
-/**
- * A React view with a synced state, initial props, and a Fluid-to-view state two-way mapping
- */
-class FluidReactView extends React.Component {
-    constructor(props) {
-        super(props);
-        const { syncedStateId, syncedDataObject, } = props;
-        const config = syncedDataObject.getConfig(syncedStateId);
-        if (config === undefined) {
-            throw Error(`Failed to find configuration for synced state ID: ${syncedStateId}`);
-        }
-        this._viewToFluid = config.viewToFluid;
-        this._fluidToView = config.fluidToView;
-        this._syncedStateId = syncedStateId;
-        this._syncedState = syncedDataObject.syncedState;
-        this._dataProps = syncedDataObject.dataProps;
-        this.state = config.defaultViewState;
-    }
-    async componentDidMount() {
-        await helpers_1.initializeState(this._syncedStateId, this._syncedState, this._dataProps, this.state, this._setState.bind(this), this._fluidToView, this._viewToFluid);
-    }
-    /**
-     * Function to update the state from both synced state updates or local ones. Only updates the synced state
-     * on local updates
-     * @param newState - the new state to be set
-     * @param fromRootUpdate - is this update coming locally or from a synced state value change
-     * @param isLocal - should this update be applied only locally
-     */
-    _setState(newState, fromRootUpdate, isLocal) {
-        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
-        if (isLocal) {
-            super.setState(newState);
-            // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
-        }
-        else if (fromRootUpdate) {
-            helpers_1.syncState(true, this._syncedStateId, this._syncedState, this._dataProps.runtime, newState, this._setState.bind(this), this._dataProps.fluidObjectMap, this._fluidToView, this._viewToFluid);
-        }
-        else {
-            this.setState(newState);
-        }
-    }
-    /**
-     * Function to update the current state. It overloads the React setState function
-     * @param newState - New state to be set both locally and on the synced state
-     */
-    setState(newState) {
-        helpers_1.syncState(false, this._syncedStateId, this._syncedState, this._dataProps.runtime, newState, this._setState.bind(this), this._dataProps.fluidObjectMap, this._fluidToView, this._viewToFluid);
-    }
-}
-exports.FluidReactView = FluidReactView;
-//# sourceMappingURL=reactView.js.map