@fluidframework/react 0.41.3 → 2.62.0

package/lib/helpers/utils.js

@@ -1,67 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-export function getByFluidKey(searchValue, map) {
-    for (const [key, value] of map.entries()) {
-        if (value.fluidKey === searchValue) {
-            return key;
-        }
-    }
-}
-export async function asyncForEach(array, callback, fluidObjectMap, syncedStateCallback, refreshView, storedHandleMap) {
-    const promises = [];
-    for (const value of array) {
-        promises.push(callback(value, fluidObjectMap, syncedStateCallback, refreshView, storedHandleMap));
-    }
-    await Promise.all(promises);
-}
-export const addFluidObject = async (handle, fluidObjectMap, syncedStateCallback, refreshView, storedHandleMap) => {
-    const maybeValue = fluidObjectMap.get(handle.absolutePath);
-    let value = {
-        isListened: false,
-        isRuntimeMap: false,
-    };
-    if (maybeValue === undefined) {
-        fluidObjectMap.set(handle.absolutePath, value);
-    }
-    else {
-        value = maybeValue;
-    }
-    value.isListened = false;
-    fluidObjectMap.set(handle.absolutePath, value);
-    if (!storedHandleMap.has(handle.absolutePath)) {
-        storedHandleMap.set(handle.absolutePath, handle);
-    }
-    return handle.get().then((fluidObject) => {
-        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
-        if (value.isRuntimeMap) {
-            fluidObject.on("valueChanged", syncedStateCallback);
-        }
-        else if (value.listenedEvents !== undefined) {
-            for (const event of value.listenedEvents) {
-                fluidObject.on(event, refreshView);
-            }
-        }
-        value.fluidObject = fluidObject;
-        value.isListened = true;
-        fluidObjectMap.set(handle.absolutePath, value);
-    });
-};
-export function isEquivalent(a, b) {
-    if (a === undefined || b === undefined) {
-        return a === b;
-    }
-    const aKeys = Object.getOwnPropertyNames(a);
-    const bKeys = Object.getOwnPropertyNames(b);
-    if (aKeys.length !== bKeys.length) {
-        return false;
-    }
-    for (const i of aKeys) {
-        if (a[i] !== b[i]) {
-            return false;
-        }
-    }
-    return true;
-}
-//# sourceMappingURL=utils.js.map

package/lib/helpers/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/helpers/utils.tsx"],"names":[],"mappings":"AAAA;;;GAGG;AAaH,MAAM,UAAU,aAAa,CAG3B,WAAmB,EAAE,GAA2C;IAC9D,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE,EAAE;QACtC,IAAI,KAAK,CAAC,QAAQ,KAAK,WAAW,EAAE;YAChC,OAAO,GAAG,CAAC;SACd;KACJ;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAC9B,KAAqB,EACrB,QAMkB,EAClB,cAA8B,EAC9B,mBAA6E,EAC7E,WAAuB,EACvB,eAA0B;IAE1B,MAAM,QAAQ,GAAoB,EAAE,CAAC;IACrC,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE;QACvB,QAAQ,CAAC,IAAI,CACT,QAAQ,CAAC,KAAK,EAAE,cAAc,EAAE,mBAAmB,EAAE,WAAW,EAAE,eAAe,CAAC,CACrF,CAAC;KACL;IACD,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAChC,CAAC;AAED,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EAI/B,MAAoB,EACpB,cAA8B,EAC9B,mBAA6E,EAC7E,WAAuB,EACvB,eAA0B,EACb,EAAE;IACf,MAAM,UAAU,GAAoC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAC5F,IAAI,KAAK,GAAwB;QAC7B,UAAU,EAAE,KAAK;QACjB,YAAY,EAAE,KAAK;KACtB,CAAC;IACF,IAAI,UAAU,KAAK,SAAS,EAAE;QAC1B,cAAc,CAAC,GAAG,CACd,MAAM,CAAC,YAAY,EACnB,KAAK,CACR,CAAC;KACL;SAAM;QACH,KAAK,GAAG,UAAU,CAAC;KACtB;IACD,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC;IACzB,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IAC/C,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE;QAC3C,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;KACpD;IACD,OAAO,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE;QACrC,yEAAyE;QACzE,IAAI,KAAK,CAAC,YAAY,EAAE;YACnB,WAAyB,CAAC,EAAE,CAAC,cAAc,EAAE,mBAAmB,CAAC,CAAC;SACtE;aAAM,IAAI,KAAK,CAAC,cAAc,KAAK,SAAS,EAAE;YAC3C,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,cAAc,EAAE;gBACrC,WAA4B,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;aACxD;SACJ;QACD,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;QAChC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC;QACxB,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,MAAM,UAAU,YAAY,CAAC,CAAC,EAAE,CAAC;IAC7B,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,SAAS,EAAE;QACpC,OAAO,CAAC,KAAK,CAAC,CAAC;KAClB;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAC5C,MAAM,KAAK,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAC5C,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,EAAE;QAC/B,OAAO,KAAK,CAAC;KAChB;IACD,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE;QACnB,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;YACf,OAAO,KAAK,CAAC;SAChB;KACJ;IACD,OAAO,IAAI,CAAC;AAChB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport { IDirectoryValueChanged, SharedMap } from \"@fluidframework/map\";\nimport { SharedObject } from \"@fluidframework/shared-object-base\";\nimport {\n    FluidObjectMap,\n    IFluidState,\n    IViewState,\n    IFluidConverter,\n} from \"../interface\";\nimport { IFluidObjectMapItem } from \"..\";\n\nexport function getByFluidKey<\n    SV extends IViewState,\n    SF extends IFluidState\n>(searchValue: string, map: Map<keyof SV, IFluidConverter<SV, SF>>) {\n    for (const [key, value] of map.entries()) {\n        if (value.fluidKey === searchValue) {\n            return key;\n        }\n    }\n}\n\nexport async function asyncForEach(\n    array: IFluidHandle[],\n    callback: (\n        handle: IFluidHandle,\n        fluidObjectMap: FluidObjectMap,\n        syncedStateCallback: (change: IDirectoryValueChanged, local: boolean) => void,\n        refreshView: () => void,\n        storedHandleMap: SharedMap,\n    ) => Promise<void>,\n    fluidObjectMap: FluidObjectMap,\n    syncedStateCallback: (change: IDirectoryValueChanged, local: boolean) => void,\n    refreshView: () => void,\n    storedHandleMap: SharedMap,\n): Promise<void> {\n    const promises: Promise<void>[] = [];\n    for (const value of array) {\n        promises.push(\n            callback(value, fluidObjectMap, syncedStateCallback, refreshView, storedHandleMap),\n        );\n    }\n    await Promise.all(promises);\n}\n\nexport const addFluidObject = async <\n    SV extends IViewState,\n    SF extends IFluidState\n>(\n    handle: IFluidHandle,\n    fluidObjectMap: FluidObjectMap,\n    syncedStateCallback: (change: IDirectoryValueChanged, local: boolean) => void,\n    refreshView: () => void,\n    storedHandleMap: SharedMap,\n): Promise<void> => {\n    const maybeValue: IFluidObjectMapItem | undefined = fluidObjectMap.get(handle.absolutePath);\n    let value: IFluidObjectMapItem = {\n        isListened: false,\n        isRuntimeMap: false,\n    };\n    if (maybeValue === undefined) {\n        fluidObjectMap.set(\n            handle.absolutePath,\n            value,\n        );\n    } else {\n        value = maybeValue;\n    }\n    value.isListened = false;\n    fluidObjectMap.set(handle.absolutePath, value);\n    if (!storedHandleMap.has(handle.absolutePath)) {\n        storedHandleMap.set(handle.absolutePath, handle);\n    }\n    return handle.get().then((fluidObject) => {\n        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions\n        if (value.isRuntimeMap) {\n            (fluidObject as SharedMap).on(\"valueChanged\", syncedStateCallback);\n        } else if (value.listenedEvents !== undefined) {\n            for (const event of value.listenedEvents) {\n                (fluidObject as SharedObject).on(event, refreshView);\n            }\n        }\n        value.fluidObject = fluidObject;\n        value.isListened = true;\n        fluidObjectMap.set(handle.absolutePath, value);\n    });\n};\n\nexport function isEquivalent(a, b) {\n    if (a === undefined || b === undefined) {\n        return a === b;\n    }\n    const aKeys = Object.getOwnPropertyNames(a);\n    const bKeys = Object.getOwnPropertyNames(b);\n    if (aKeys.length !== bKeys.length) {\n        return false;\n    }\n    for (const i of aKeys) {\n        if (a[i] !== b[i]) {\n            return false;\n        }\n    }\n    return true;\n}\n"]}

package/lib/interface.js

@@ -1,8 +0,0 @@
-export const instanceOfIFluidLoadable = (object) => object === Object(object) && "IFluidLoadable" in object;
-export const instanceOfEffectFunction = (object) => object === Object(object) && "function" in object;
-export const instanceOfAsyncEffectFunction = (object) => object === Object(object) && "asyncFunction" in object;
-export const instanceOfStateUpdateFunction = (object) => object === Object(object) && "function" in object;
-export const instanceOfAsyncStateUpdateFunction = (object) => object === Object(object) && "asyncFunction" in object;
-export const instanceOfSelectorFunction = (object) => object === Object(object) && "function" in object;
-export const instanceOfFluidObjectSelectorFunction = (object) => object === Object(object) && "function" in object;
-//# sourceMappingURL=interface.js.map

package/lib/interface.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"interface.js","sourceRoot":"","sources":["../src/interface.ts"],"names":[],"mappings":"AAwOA,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACpC,MAAW,EACa,EAAE,CAC1B,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,gBAAgB,IAAI,MAAM,CAAC;AAgE5D,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAKpC,MAAW,EAC6B,EAAE,CAC1C,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,UAAU,IAAI,MAAM,CAAC;AAoBtD,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAKzC,MAAW,EACkC,EAAE,CAC/C,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,eAAe,IAAI,MAAM,CAAC;AAqB3D,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAKzC,MAAW,EACkC,EAAE,CAC/C,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,UAAU,IAAI,MAAM,CAAC;AAwCtD,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAK9C,MAAW,EACuC,EAAE,CACpD,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,eAAe,IAAI,MAAM,CAAC;AA6C3D,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAKtC,MAAW,EAC+B,EAAE,CAC5C,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,UAAU,IAAI,MAAM,CAAC;AAEtD,MAAM,CAAC,MAAM,qCAAqC,GAAG,CAKjD,MAAW,EACqC,EAAE,CAClD,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,UAAU,IAAI,MAAM,CAAC","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/lib/reactView.js

@@ -1,56 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import * as React from "react";
-import { syncState, initializeState } from "./helpers";
-/**
- * A React view with a synced state, initial props, and a Fluid-to-view state two-way mapping
- */
-export 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 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) {
-            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) {
-        syncState(false, this._syncedStateId, this._syncedState, this._dataProps.runtime, newState, this._setState.bind(this), this._dataProps.fluidObjectMap, this._fluidToView, this._viewToFluid);
-    }
-}
-//# sourceMappingURL=reactView.js.map

package/lib/reactView.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"reactView.js","sourceRoot":"","sources":["../src/reactView.tsx"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAU/B,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAEvD;;GAEG;AACH,MAAM,OAAgB,cACM,SAAQ,KAAK,CAAC,SAAkC;IAMxE,YAAY,KAA0B;QAClC,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,MAAM,EACF,aAAa,EACb,gBAAgB,GACnB,GAAG,KAAK,CAAC;QACV,MAAM,MAAM,GAAG,gBAAgB,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QACzD,IAAI,MAAM,KAAK,SAAS,EAAE;YACtB,MAAM,KAAK,CAAC,qDAAqD,aAAa,EAAE,CAAC,CAAC;SACrF;QACD,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,WAAkB,CAAC;QAC9C,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,WAAkB,CAAC;QAC9C,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,YAAY,GAAG,gBAAgB,CAAC,WAAW,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG,gBAAgB,CAAC,SAAS,CAAC;QAC7C,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,gBAAgB,CAAC;IACzC,CAAC;IAEM,KAAK,CAAC,iBAAiB;QAC1B,MAAM,eAAe,CACjB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EACzB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,YAAY,CACpB,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACK,SAAS,CACb,QAAY,EACZ,cAAwB,EACxB,OAAiB;QAEjB,yEAAyE;QACzE,IAAI,OAAO,EAAE;YACT,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAC7B,yEAAyE;SACxE;aAAM,IAAI,cAAc,EAAE;YACvB,SAAS,CACL,IAAI,EACJ,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,UAAU,CAAC,OAAO,EACvB,QAAQ,EACR,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EACzB,IAAI,CAAC,UAAU,CAAC,cAAc,EAC9B,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,YAAY,CACpB,CAAC;SACL;aAAM;YACH,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC3B;IACL,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,QAAY;QACxB,SAAS,CACL,KAAK,EACL,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,UAAU,CAAC,OAAO,EACvB,QAAQ,EACR,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EACzB,IAAI,CAAC,UAAU,CAAC,cAAc,EAC9B,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,YAAY,CACpB,CAAC;IACN,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport * as React from \"react\";\nimport {\n    IFluidProps,\n    IFluidState,\n    IViewState,\n    IFluidConverter,\n    IViewConverter,\n    IFluidDataProps,\n    ISyncedState,\n} from \"./interface\";\nimport { syncState, initializeState } from \"./helpers\";\n\n/**\n * A React view with a synced state, initial props, and a Fluid-to-view state two-way mapping\n */\nexport abstract class FluidReactView<SV extends IViewState,\n    SF extends IFluidState> extends React.Component<IFluidProps<SV, SF>, SV> {\n    private readonly _syncedStateId: string;\n    private readonly _syncedState: ISyncedState;\n    private readonly _dataProps: IFluidDataProps;\n    private readonly _viewToFluid: Map<keyof SV, IFluidConverter<SV, SF>>;\n    private readonly _fluidToView: Map<keyof SF, IViewConverter<SV, SF>>;\n    constructor(props: IFluidProps<SV, SF>) {\n        super(props);\n        const {\n            syncedStateId,\n            syncedDataObject,\n        } = props;\n        const config = syncedDataObject.getConfig(syncedStateId);\n        if (config === undefined) {\n            throw Error(`Failed to find configuration for synced state ID: ${syncedStateId}`);\n        }\n        this._viewToFluid = config.viewToFluid as any;\n        this._fluidToView = config.fluidToView as any;\n        this._syncedStateId = syncedStateId;\n        this._syncedState = syncedDataObject.syncedState;\n        this._dataProps = syncedDataObject.dataProps;\n        this.state = config.defaultViewState;\n    }\n\n    public async componentDidMount() {\n        await initializeState(\n            this._syncedStateId,\n            this._syncedState,\n            this._dataProps,\n            this.state,\n            this._setState.bind(this),\n            this._fluidToView,\n            this._viewToFluid,\n        );\n    }\n\n    /**\n     * Function to update the state from both synced state updates or local ones. Only updates the synced state\n     * on local updates\n     * @param newState - the new state to be set\n     * @param fromRootUpdate - is this update coming locally or from a synced state value change\n     * @param isLocal - should this update be applied only locally\n     */\n    private _setState(\n        newState: SV,\n        fromRootUpdate?: boolean,\n        isLocal?: boolean,\n    ) {\n        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions\n        if (isLocal) {\n            super.setState(newState);\n        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions\n        } else if (fromRootUpdate) {\n            syncState(\n                true,\n                this._syncedStateId,\n                this._syncedState,\n                this._dataProps.runtime,\n                newState,\n                this._setState.bind(this),\n                this._dataProps.fluidObjectMap,\n                this._fluidToView,\n                this._viewToFluid,\n            );\n        } else {\n            this.setState(newState);\n        }\n    }\n\n    /**\n     * Function to update the current state. It overloads the React setState function\n     * @param newState - New state to be set both locally and on the synced state\n     */\n    public setState(newState: SV) {\n        syncState(\n            false,\n            this._syncedStateId,\n            this._syncedState,\n            this._dataProps.runtime,\n            newState,\n            this._setState.bind(this),\n            this._dataProps.fluidObjectMap,\n            this._fluidToView,\n            this._viewToFluid,\n        );\n    }\n}\n"]}

package/lib/syncedDataObject.js

@@ -1,245 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { DataObject } from "@fluidframework/aqueduct";
-import { SharedMap } from "@fluidframework/map";
-import { generateFluidObjectSchema, setSchema, getSchema, } from "./helpers";
-/**
- * SyncedDataObject is a base class for Fluid data objects with views. It extends DataObject.
- * In addition to the root and task manager, the SyncedDataObject also provides a syncedStateConfig
- * and assures that the syncedState will be initialized according the config by the time the view
- * is rendered.
- *
- * As this is used for views, it also implements the IFluidHTMLView interface, and requires
- * the render function to be filled in.
- */
-export class SyncedDataObject extends DataObject {
-    constructor() {
-        super(...arguments);
-        this.syncedStateConfig = new Map();
-        this.fluidObjectMap = new Map();
-        this.syncedStateDirectoryId = "syncedState";
-    }
-    get IFluidHTMLView() {
-        return this;
-    }
-    /**
-     * Runs the first time the SyncedDataObject is generated and sets up all necessary data structures for the view
-     * To extend this function, please call super() prior to adding to functionality to ensure correct initializing
-     */
-    async initializingFirstTime() {
-        // Initialize our synced state map for the first time using our
-        // syncedStateConfig values
-        await this.initializeStateFirstTime();
-    }
-    /**
-     * Runs any time the SyncedDataObject is rendered again. It sets up all necessary data structures for the view,
-     * along with any additional ones that may have been added due to user behavior
-     * To extend this function, please call super() prior to adding to functionality to ensure correct initializing
-     */
-    async initializingFromExisting() {
-        // Load our existing state values to be ready for the render lifecycle
-        await this.initializeStateFromExisting();
-    }
-    /**
-     * Returns an interface to interact with the stored synced state for the SyncedDataObject.
-     * Views can get and fetch values from it based on their syncedStateId to retrieve their view-specific information.
-     * They can also attach listeners using the addValueChangedListener
-     */
-    get syncedState() {
-        if (this.internalSyncedState === undefined) {
-            throw new Error(this.getUninitializedErrorString(`syncedState`));
-        }
-        return {
-            set: this.internalSyncedState.set.bind(this.internalSyncedState),
-            get: this.internalSyncedState.get.bind(this.internalSyncedState),
-            addValueChangedListener: (callback) => {
-                if (this.internalSyncedState === undefined) {
-                    throw new Error(this.getUninitializedErrorString(`syncedState`));
-                }
-                this.internalSyncedState.on("valueChanged", callback);
-            },
-        };
-    }
-    /**
-     * Returns the data props used by the view to manage the different DDSes and add any new ones
-     */
-    get dataProps() {
-        return {
-            // The return type is defined explicitly here to prevent TypeScript from generating dynamic imports
-            // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-            runtime: this.runtime,
-            fluidObjectMap: this.fluidObjectMap,
-        };
-    }
-    /**
-     * Set values to the syncedStateConfig where the view and Fluid states have the same values defined by S.
-     * Each view with a unique syncedStateId needs its own value in the syncedStateConfig.
-     * @param key - The syncedStateId that maps to the view that will be using these definitions
-     * @param value - The config value containing the syncedStateId and the fluidToView and viewToFluid maps
-     */
-    // eslint-disable-next-line @typescript-eslint/no-shadow
-    setConfig(key, value) {
-        this.syncedStateConfig.set(key, value);
-    }
-    /**
-     * Set values to the syncedStateConfig with different view and Fluid state definitions.
-     * Each view with a unique syncedStateId needs its own value in the syncedStateConfig,
-     * with SV being the view state definition and SF being the Fluid state definition.
-     * @param key - The syncedStateId that maps to the view that will be using these definitions
-     * @param value - The config value containing the syncedStateId and the fluidToView and viewToFluid maps
-     * that establish the relationship between SV and SF
-     */
-    setFluidConfig(key, value) {
-        this.syncedStateConfig.set(key, value);
-    }
-    /**
-     * Get a config for a specific view with the key as its syncedStateId
-     * @param key - The syncedStateId to get the config for
-     */
-    getConfig(key) {
-        return this.syncedStateConfig.get(key);
-    }
-    /**
-     * Returns a view. This function need to be implemented for any consumer of SyncedDataObject
-     * to render values that have been initialized using the syncedStateConfig
-     * @param element - The document that the rendered value will be displayed in
-     */
-    render(element) {
-        throw Error("Render function was not implemented");
-    }
-    async initializeStateFirstTime() {
-        var _a;
-        this.internalSyncedState = SharedMap.create(this.runtime, this.syncedStateDirectoryId);
-        this.internalSyncedState.bindToContext();
-        for (const stateConfig of this.syncedStateConfig.values()) {
-            const { syncedStateId, fluidToView, viewToFluid, defaultViewState, } = stateConfig;
-            // Add the SharedMap to store the Fluid state
-            const storedFluidState = SharedMap.create(this.runtime);
-            // Add it to the Fluid object map so that it will have a listener added to it once
-            // we enter the render lifecycle
-            this.fluidObjectMap.set(storedFluidState.handle.absolutePath, {
-                fluidObject: storedFluidState,
-                isRuntimeMap: true,
-            });
-            // Add the state to our map of synced states so that we can load it later for persistence
-            this.syncedState.set(`syncedState-${syncedStateId}`, storedFluidState.handle);
-            // Initialize any DDSes needed for the state or fetch any values from the root if they are stored
-            // on the root under a different key
-            for (const [key, value] of fluidToView.entries()) {
-                const fluidKey = key;
-                const rootKey = value.rootKey;
-                const createCallback = value.sharedObjectCreate;
-                if (createCallback !== undefined) {
-                    const sharedObject = createCallback(this.runtime);
-                    this.fluidObjectMap.set(sharedObject.handle.absolutePath, {
-                        fluidObject: sharedObject,
-                        listenedEvents: (_a = value.listenedEvents) !== null && _a !== void 0 ? _a : ["valueChanged"],
-                    });
-                    storedFluidState.set(fluidKey, sharedObject.handle);
-                    if (rootKey !== undefined) {
-                        this.root.set(rootKey, sharedObject.handle);
-                    }
-                }
-                else if (rootKey !== undefined) {
-                    storedFluidState.set(fluidKey, this.root.get(rootKey));
-                }
-            }
-            // Generate our schema and store it, so that we don't need to parse our maps each time
-            const schema = generateFluidObjectSchema(this.runtime, defaultViewState, fluidToView, viewToFluid);
-            const schemaHandles = {
-                fluidMatchingMapHandle: schema.fluidMatchingMap
-                    .handle,
-                viewMatchingMapHandle: schema.viewMatchingMap
-                    .handle,
-                storedHandleMapHandle: schema.storedHandleMap
-                    .handle,
-            };
-            this.fluidObjectMap.set(schema.fluidMatchingMap.handle.absolutePath, {
-                fluidObject: schema.fluidMatchingMap,
-                isRuntimeMap: true,
-            });
-            this.fluidObjectMap.set(schema.viewMatchingMap.handle.absolutePath, {
-                fluidObject: schema.viewMatchingMap,
-                isRuntimeMap: true,
-            });
-            this.fluidObjectMap.set(schema.storedHandleMap.handle.absolutePath, {
-                fluidObject: schema.storedHandleMap,
-                isRuntimeMap: true,
-            });
-            setSchema(syncedStateId, this.syncedState, schemaHandles);
-        }
-    }
-    async initializeStateFromExisting() {
-        var _a, _b;
-        // Fetch our synced state that stores all of our information to re-initialize the view state
-        this.internalSyncedState = (await this.runtime.getChannel(this.syncedStateDirectoryId));
-        // Reload the stored state for each config provided
-        for (const stateConfig of this.syncedStateConfig.values()) {
-            const { syncedStateId, fluidToView } = stateConfig;
-            // Fetch this specific view's state using the syncedStateId
-            const storedFluidStateHandle = this.syncedState.get(`syncedState-${syncedStateId}`);
-            if (storedFluidStateHandle === undefined) {
-                throw new Error(this.getUninitializedErrorString(`syncedState-${syncedStateId}`));
-            }
-            const storedFluidState = await storedFluidStateHandle.get();
-            // Add it to the Fluid object map so that it will have a listener added to it once
-            // we enter the render lifecycle
-            this.fluidObjectMap.set(storedFluidStateHandle.absolutePath, {
-                fluidObject: storedFluidState,
-                isRuntimeMap: true,
-            });
-            // If the view is using any Fluid data stores or SharedObjects, asynchronously fetch them
-            // from their stored handles
-            for (const [key, value] of fluidToView.entries()) {
-                const fluidKey = key;
-                const rootKey = value.rootKey;
-                const createCallback = value.sharedObjectCreate;
-                if (createCallback !== undefined) {
-                    const handle = rootKey !== undefined
-                        ? this.root.get(rootKey)
-                        : storedFluidState.get(fluidKey);
-                    if (handle === undefined) {
-                        throw new Error(`Failed to find ${fluidKey} in synced state`);
-                    }
-                    this.fluidObjectMap.set(handle.absolutePath, {
-                        fluidObject: await handle.get(),
-                        listenedEvents: (_a = value.listenedEvents) !== null && _a !== void 0 ? _a : ["valueChanged"],
-                    });
-                }
-                else {
-                    const storedValue = rootKey !== undefined
-                        ? this.root.get(rootKey)
-                        : storedFluidState.get(fluidKey);
-                    const handle = storedValue === null || storedValue === void 0 ? void 0 : storedValue.IFluidHandle;
-                    if (handle !== undefined) {
-                        this.fluidObjectMap.set(handle.absolutePath, {
-                            fluidObject: await handle.get(),
-                            listenedEvents: (_b = value.listenedEvents) !== null && _b !== void 0 ? _b : [
-                                "valueChanged",
-                            ],
-                        });
-                    }
-                }
-            }
-            const schemaHandles = getSchema(syncedStateId, this.syncedState);
-            if (schemaHandles === undefined) {
-                throw new Error(this.getUninitializedErrorString(`schema-${syncedStateId}`));
-            }
-            this.fluidObjectMap.set(schemaHandles.fluidMatchingMapHandle.absolutePath, {
-                fluidObject: await schemaHandles.fluidMatchingMapHandle.get(),
-                isRuntimeMap: true,
-            });
-            this.fluidObjectMap.set(schemaHandles.viewMatchingMapHandle.absolutePath, {
-                fluidObject: await schemaHandles.viewMatchingMapHandle.get(),
-                isRuntimeMap: true,
-            });
-            this.fluidObjectMap.set(schemaHandles.storedHandleMapHandle.absolutePath, {
-                fluidObject: await schemaHandles.storedHandleMapHandle.get(),
-                isRuntimeMap: true,
-            });
-        }
-    }
-}
-//# sourceMappingURL=syncedDataObject.js.map

package/lib/syncedDataObject.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"syncedDataObject.js","sourceRoot":"","sources":["../src/syncedDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAMtD,OAAO,EAAE,SAAS,EAAc,MAAM,qBAAqB,CAAC;AAY5D,OAAO,EACH,yBAAyB,EACzB,SAAS,EACT,SAAS,GACZ,MAAM,WAAW,CAAC;AAEnB;;;;;;;;GAQG;AACH,MAAM,OAAgB,gBAKhB,SAAQ,UAAmB;IALjC;;QAMqB,sBAAiB,GAAsB,IAAI,GAAG,EAAE,CAAC;QACjD,mBAAc,GAAmB,IAAI,GAAG,EAAE,CAAC;QAC3C,2BAAsB,GAAG,aAAa,CAAC;IAmS5D,CAAC;IAhSG,IAAW,cAAc;QACrB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,qBAAqB;QACjC,+DAA+D;QAC/D,2BAA2B;QAC3B,MAAM,IAAI,CAAC,wBAAwB,EAAE,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,wBAAwB;QACpC,sEAAsE;QACtE,MAAM,IAAI,CAAC,2BAA2B,EAAE,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACH,IAAW,WAAW;QAClB,IAAI,IAAI,CAAC,mBAAmB,KAAK,SAAS,EAAE;YACxC,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,2BAA2B,CAAC,aAAa,CAAC,CAAC,CAAC;SACpE;QACD,OAAO;YACH,GAAG,EAAE,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC;YAChE,GAAG,EAAE,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC;YAChE,uBAAuB,EAAE,CAAC,QAAQ,EAAE,EAAE;gBAClC,IAAI,IAAI,CAAC,mBAAmB,KAAK,SAAS,EAAE;oBACxC,MAAM,IAAI,KAAK,CACX,IAAI,CAAC,2BAA2B,CAAC,aAAa,CAAC,CAClD,CAAC;iBACL;gBACD,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;YAC1D,CAAC;SACJ,CAAC;IACN,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAChB,OAAO;YACH,mGAAmG;YACnG,4EAA4E;YAC5E,OAAO,EAAE,IAAI,CAAC,OAAiC;YAC/C,cAAc,EAAE,IAAI,CAAC,cAAc;SACtC,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,wDAAwD;IACjD,SAAS,CAAI,GAAW,EAAE,KAA+B;QAC5D,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;OAOG;IACI,cAAc,CAGnB,GAAW,EAAE,KAAiC;QAC5C,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACI,SAAS,CAAC,GAAW;QACxB,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAoB;QAC9B,MAAM,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACvD,CAAC;IAEO,KAAK,CAAC,wBAAwB;;QAClC,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAC,MAAM,CACvC,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,sBAAsB,CAC9B,CAAC;QACF,IAAI,CAAC,mBAAmB,CAAC,aAAa,EAAE,CAAC;QACzC,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,EAAE;YACvD,MAAM,EACF,aAAa,EACb,WAAW,EACX,WAAW,EACX,gBAAgB,GACnB,GAAG,WAAW,CAAC;YAChB,6CAA6C;YAC7C,MAAM,gBAAgB,GAAG,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACxD,kFAAkF;YAClF,gCAAgC;YAChC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,gBAAgB,CAAC,MAAM,CAAC,YAAY,EAAE;gBAC1D,WAAW,EAAE,gBAAgB;gBAC7B,YAAY,EAAE,IAAI;aACrB,CAAC,CAAC;YACH,yFAAyF;YACzF,IAAI,CAAC,WAAW,CAAC,GAAG,CAChB,eAAe,aAAa,EAAE,EAC9B,gBAAgB,CAAC,MAAM,CAC1B,CAAC;YACF,iGAAiG;YACjG,oCAAoC;YACpC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE;gBAC9C,MAAM,QAAQ,GAAG,GAAa,CAAC;gBAC/B,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;gBAC9B,MAAM,cAAc,GAAG,KAAK,CAAC,kBAAkB,CAAC;gBAChD,IAAI,cAAc,KAAK,SAAS,EAAE;oBAC9B,MAAM,YAAY,GAAG,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBAClD,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,YAAY,EAAE;wBACtD,WAAW,EAAE,YAAY;wBACzB,cAAc,QAAE,KAAK,CAAC,cAAc,mCAAI,CAAC,cAAc,CAAC;qBAC3D,CAAC,CAAC;oBACH,gBAAgB,CAAC,GAAG,CAAC,QAAQ,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;oBACpD,IAAI,OAAO,KAAK,SAAS,EAAE;wBACvB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;qBAC/C;iBACJ;qBAAM,IAAI,OAAO,KAAK,SAAS,EAAE;oBAC9B,gBAAgB,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;iBAC1D;aACJ;YAED,sFAAsF;YACtF,MAAM,MAAM,GAAG,yBAAyB,CACpC,IAAI,CAAC,OAAO,EACZ,gBAAgB,EAChB,WAAW,EACX,WAAW,CACd,CAAC;YACF,MAAM,aAAa,GAAG;gBAClB,sBAAsB,EAAE,MAAM,CAAC,gBAAgB;qBAC1C,MAAiC;gBACtC,qBAAqB,EAAE,MAAM,CAAC,eAAe;qBACxC,MAAiC;gBACtC,qBAAqB,EAAE,MAAM,CAAC,eAAe;qBACxC,MAAiC;aACzC,CAAC;YACF,IAAI,CAAC,cAAc,CAAC,GAAG,CACnB,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,YAAY,EAC3C;gBACI,WAAW,EAAE,MAAM,CAAC,gBAAgB;gBACpC,YAAY,EAAE,IAAI;aACrB,CACJ,CAAC;YACF,IAAI,CAAC,cAAc,CAAC,GAAG,CACnB,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,YAAY,EAC1C;gBACI,WAAW,EAAE,MAAM,CAAC,eAAe;gBACnC,YAAY,EAAE,IAAI;aACrB,CACJ,CAAC;YACF,IAAI,CAAC,cAAc,CAAC,GAAG,CACnB,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,YAAY,EAC1C;gBACI,WAAW,EAAE,MAAM,CAAC,eAAe;gBACnC,YAAY,EAAE,IAAI;aACrB,CACJ,CAAC;YAEF,SAAS,CACL,aAAa,EACb,IAAI,CAAC,WAAW,EAChB,aAAa,CAChB,CAAC;SACL;IACL,CAAC;IAEO,KAAK,CAAC,2BAA2B;;QACrC,4FAA4F;QAC5F,IAAI,CAAC,mBAAmB,GAAG,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CACrD,IAAI,CAAC,sBAAsB,CAC9B,CAAe,CAAC;QACjB,mDAAmD;QACnD,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,EAAE;YACvD,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC;YACnD,2DAA2D;YAC3D,MAAM,sBAAsB,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAEjD,eAAe,aAAa,EAAE,CAAC,CAAC;YAClC,IAAI,sBAAsB,KAAK,SAAS,EAAE;gBACtC,MAAM,IAAI,KAAK,CACX,IAAI,CAAC,2BAA2B,CAC5B,eAAe,aAAa,EAAE,CACjC,CACJ,CAAC;aACL;YACD,MAAM,gBAAgB,GAAG,MAAM,sBAAsB,CAAC,GAAG,EAAE,CAAC;YAC5D,kFAAkF;YAClF,gCAAgC;YAChC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,sBAAsB,CAAC,YAAY,EAAE;gBACzD,WAAW,EAAE,gBAAgB;gBAC7B,YAAY,EAAE,IAAI;aACrB,CAAC,CAAC;YACH,yFAAyF;YACzF,4BAA4B;YAC5B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE;gBAC9C,MAAM,QAAQ,GAAG,GAAa,CAAC;gBAC/B,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;gBAC9B,MAAM,cAAc,GAAG,KAAK,CAAC,kBAAkB,CAAC;gBAChD,IAAI,cAAc,KAAK,SAAS,EAAE;oBAC9B,MAAM,MAAM,GAAG,OAAO,KAAK,SAAS;wBAChC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC;wBACxB,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;oBACrC,IAAI,MAAM,KAAK,SAAS,EAAE;wBACtB,MAAM,IAAI,KAAK,CACX,kBAAkB,QAAQ,kBAAkB,CAC/C,CAAC;qBACL;oBACD,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,EAAE;wBACzC,WAAW,EAAE,MAAM,MAAM,CAAC,GAAG,EAAE;wBAC/B,cAAc,QAAE,KAAK,CAAC,cAAc,mCAAI,CAAC,cAAc,CAAC;qBAC3D,CAAC,CAAC;iBACN;qBAAM;oBACH,MAAM,WAAW,GAAG,OAAO,KAAK,SAAS;wBACrC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC;wBACxB,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;oBACrC,MAAM,MAAM,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,YAAY,CAAC;oBACzC,IAAI,MAAM,KAAK,SAAS,EAAE;wBACtB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,EAAE;4BACzC,WAAW,EAAE,MAAM,MAAM,CAAC,GAAG,EAAE;4BAC/B,cAAc,QAAE,KAAK,CAAC,cAAc,mCAAI;gCACpC,cAAc;6BACjB;yBACJ,CAAC,CAAC;qBACN;iBACJ;aACJ;YACD,MAAM,aAAa,GAAG,SAAS,CAC3B,aAAa,EACb,IAAI,CAAC,WAAW,CACnB,CAAC;YACF,IAAI,aAAa,KAAK,SAAS,EAAE;gBAC7B,MAAM,IAAI,KAAK,CACX,IAAI,CAAC,2BAA2B,CAC5B,UAAU,aAAa,EAAE,CAC5B,CACJ,CAAC;aACL;YACD,IAAI,CAAC,cAAc,CAAC,GAAG,CACnB,aAAa,CAAC,sBAAsB,CAAC,YAAY,EACjD;gBACI,WAAW,EAAE,MAAM,aAAa,CAAC,sBAAsB,CAAC,GAAG,EAAE;gBAC7D,YAAY,EAAE,IAAI;aACrB,CACJ,CAAC;YACF,IAAI,CAAC,cAAc,CAAC,GAAG,CACnB,aAAa,CAAC,qBAAqB,CAAC,YAAY,EAChD;gBACI,WAAW,EAAE,MAAM,aAAa,CAAC,qBAAqB,CAAC,GAAG,EAAE;gBAC5D,YAAY,EAAE,IAAI;aACrB,CACJ,CAAC;YACF,IAAI,CAAC,cAAc,CAAC,GAAG,CACnB,aAAa,CAAC,qBAAqB,CAAC,YAAY,EAChD;gBACI,WAAW,EAAE,MAAM,aAAa,CAAC,qBAAqB,CAAC,GAAG,EAAE;gBAC5D,YAAY,EAAE,IAAI;aACrB,CACJ,CAAC;SACL;IACL,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { DataObject } from \"@fluidframework/aqueduct\";\nimport {\n    IFluidObject,\n    IFluidHandle,\n} from \"@fluidframework/core-interfaces\";\nimport { IEvent } from \"@fluidframework/common-definitions\";\nimport { SharedMap, ISharedMap } from \"@fluidframework/map\";\nimport { IFluidHTMLView } from \"@fluidframework/view-interfaces\";\nimport type { IFluidDataStoreRuntime } from \"@fluidframework/datastore-definitions\";\n\nimport {\n    FluidObjectMap,\n    SyncedStateConfig,\n    ISyncedStateConfig,\n    IViewState,\n    IFluidState,\n    ISyncedState,\n} from \"./interface\";\nimport {\n    generateFluidObjectSchema,\n    setSchema,\n    getSchema,\n} from \"./helpers\";\n\n/**\n * SyncedDataObject is a base class for Fluid data objects with views. It extends DataObject.\n * In addition to the root and task manager, the SyncedDataObject also provides a syncedStateConfig\n * and assures that the syncedState will be initialized according the config by the time the view\n * is rendered.\n *\n * As this is used for views, it also implements the IFluidHTMLView interface, and requires\n * the render function to be filled in.\n */\nexport abstract class SyncedDataObject<\n    // eslint-disable-next-line @typescript-eslint/ban-types\n    P extends IFluidObject = object,\n    S = undefined,\n    E extends IEvent = IEvent\n    > extends DataObject<P, S, E> implements IFluidHTMLView {\n    private readonly syncedStateConfig: SyncedStateConfig = new Map();\n    private readonly fluidObjectMap: FluidObjectMap = new Map();\n    private readonly syncedStateDirectoryId = \"syncedState\";\n    private internalSyncedState: ISharedMap | undefined;\n\n    public get IFluidHTMLView() {\n        return this;\n    }\n\n    /**\n     * Runs the first time the SyncedDataObject is generated and sets up all necessary data structures for the view\n     * To extend this function, please call super() prior to adding to functionality to ensure correct initializing\n     */\n    protected async initializingFirstTime(): Promise<void> {\n        // Initialize our synced state map for the first time using our\n        // syncedStateConfig values\n        await this.initializeStateFirstTime();\n    }\n\n    /**\n     * Runs any time the SyncedDataObject is rendered again. It sets up all necessary data structures for the view,\n     * along with any additional ones that may have been added due to user behavior\n     * To extend this function, please call super() prior to adding to functionality to ensure correct initializing\n     */\n    protected async initializingFromExisting(): Promise<void> {\n        // Load our existing state values to be ready for the render lifecycle\n        await this.initializeStateFromExisting();\n    }\n\n    /**\n     * Returns an interface to interact with the stored synced state for the SyncedDataObject.\n     * Views can get and fetch values from it based on their syncedStateId to retrieve their view-specific information.\n     * They can also attach listeners using the addValueChangedListener\n     */\n    public get syncedState(): ISyncedState {\n        if (this.internalSyncedState === undefined) {\n            throw new Error(this.getUninitializedErrorString(`syncedState`));\n        }\n        return {\n            set: this.internalSyncedState.set.bind(this.internalSyncedState),\n            get: this.internalSyncedState.get.bind(this.internalSyncedState),\n            addValueChangedListener: (callback) => {\n                if (this.internalSyncedState === undefined) {\n                    throw new Error(\n                        this.getUninitializedErrorString(`syncedState`),\n                    );\n                }\n                this.internalSyncedState.on(\"valueChanged\", callback);\n            },\n        };\n    }\n\n    /**\n     * Returns the data props used by the view to manage the different DDSes and add any new ones\n     */\n    public get dataProps() {\n        return {\n            // The return type is defined explicitly here to prevent TypeScript from generating dynamic imports\n            // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\n            runtime: this.runtime as IFluidDataStoreRuntime,\n            fluidObjectMap: this.fluidObjectMap,\n        };\n    }\n\n    /**\n     * Set values to the syncedStateConfig where the view and Fluid states have the same values defined by S.\n     * Each view with a unique syncedStateId needs its own value in the syncedStateConfig.\n     * @param key - The syncedStateId that maps to the view that will be using these definitions\n     * @param value - The config value containing the syncedStateId and the fluidToView and viewToFluid maps\n     */\n    // eslint-disable-next-line @typescript-eslint/no-shadow\n    public setConfig<S>(key: string, value: ISyncedStateConfig<S, S>) {\n        this.syncedStateConfig.set(key, value);\n    }\n\n    /**\n     * Set values to the syncedStateConfig with different view and Fluid state definitions.\n     * Each view with a unique syncedStateId needs its own value in the syncedStateConfig,\n     * with SV being the view state definition and SF being the Fluid state definition.\n     * @param key - The syncedStateId that maps to the view that will be using these definitions\n     * @param value - The config value containing the syncedStateId and the fluidToView and viewToFluid maps\n     * that establish the relationship between SV and SF\n     */\n    public setFluidConfig<\n        SV extends IViewState,\n        SF extends IFluidState\n    >(key: string, value: ISyncedStateConfig<SV, SF>) {\n        this.syncedStateConfig.set(key, value);\n    }\n\n    /**\n     * Get a config for a specific view with the key as its syncedStateId\n     * @param key - The syncedStateId to get the config for\n     */\n    public getConfig(key: string) {\n        return this.syncedStateConfig.get(key);\n    }\n\n    /**\n     * Returns a view. This function need to be implemented for any consumer of SyncedDataObject\n     * to render values that have been initialized using the syncedStateConfig\n     * @param element - The document that the rendered value will be displayed in\n     */\n    public render(element: HTMLElement) {\n        throw Error(\"Render function was not implemented\");\n    }\n\n    private async initializeStateFirstTime() {\n        this.internalSyncedState = SharedMap.create(\n            this.runtime,\n            this.syncedStateDirectoryId,\n        );\n        this.internalSyncedState.bindToContext();\n        for (const stateConfig of this.syncedStateConfig.values()) {\n            const {\n                syncedStateId,\n                fluidToView,\n                viewToFluid,\n                defaultViewState,\n            } = stateConfig;\n            // Add the SharedMap to store the Fluid state\n            const storedFluidState = SharedMap.create(this.runtime);\n            // Add it to the Fluid object map so that it will have a listener added to it once\n            // we enter the render lifecycle\n            this.fluidObjectMap.set(storedFluidState.handle.absolutePath, {\n                fluidObject: storedFluidState,\n                isRuntimeMap: true,\n            });\n            // Add the state to our map of synced states so that we can load it later for persistence\n            this.syncedState.set(\n                `syncedState-${syncedStateId}`,\n                storedFluidState.handle,\n            );\n            // Initialize any DDSes needed for the state or fetch any values from the root if they are stored\n            // on the root under a different key\n            for (const [key, value] of fluidToView.entries()) {\n                const fluidKey = key as string;\n                const rootKey = value.rootKey;\n                const createCallback = value.sharedObjectCreate;\n                if (createCallback !== undefined) {\n                    const sharedObject = createCallback(this.runtime);\n                    this.fluidObjectMap.set(sharedObject.handle.absolutePath, {\n                        fluidObject: sharedObject,\n                        listenedEvents: value.listenedEvents ?? [\"valueChanged\"],\n                    });\n                    storedFluidState.set(fluidKey, sharedObject.handle);\n                    if (rootKey !== undefined) {\n                        this.root.set(rootKey, sharedObject.handle);\n                    }\n                } else if (rootKey !== undefined) {\n                    storedFluidState.set(fluidKey, this.root.get(rootKey));\n                }\n            }\n\n            // Generate our schema and store it, so that we don't need to parse our maps each time\n            const schema = generateFluidObjectSchema(\n                this.runtime,\n                defaultViewState,\n                fluidToView,\n                viewToFluid,\n            );\n            const schemaHandles = {\n                fluidMatchingMapHandle: schema.fluidMatchingMap\n                    .handle as IFluidHandle<SharedMap>,\n                viewMatchingMapHandle: schema.viewMatchingMap\n                    .handle as IFluidHandle<SharedMap>,\n                storedHandleMapHandle: schema.storedHandleMap\n                    .handle as IFluidHandle<SharedMap>,\n            };\n            this.fluidObjectMap.set(\n                schema.fluidMatchingMap.handle.absolutePath,\n                {\n                    fluidObject: schema.fluidMatchingMap,\n                    isRuntimeMap: true,\n                },\n            );\n            this.fluidObjectMap.set(\n                schema.viewMatchingMap.handle.absolutePath,\n                {\n                    fluidObject: schema.viewMatchingMap,\n                    isRuntimeMap: true,\n                },\n            );\n            this.fluidObjectMap.set(\n                schema.storedHandleMap.handle.absolutePath,\n                {\n                    fluidObject: schema.storedHandleMap,\n                    isRuntimeMap: true,\n                },\n            );\n\n            setSchema(\n                syncedStateId,\n                this.syncedState,\n                schemaHandles,\n            );\n        }\n    }\n\n    private async initializeStateFromExisting() {\n        // Fetch our synced state that stores all of our information to re-initialize the view state\n        this.internalSyncedState = (await this.runtime.getChannel(\n            this.syncedStateDirectoryId,\n        )) as ISharedMap;\n        // Reload the stored state for each config provided\n        for (const stateConfig of this.syncedStateConfig.values()) {\n            const { syncedStateId, fluidToView } = stateConfig;\n            // Fetch this specific view's state using the syncedStateId\n            const storedFluidStateHandle = this.syncedState.get<\n                IFluidHandle<ISharedMap>\n            >(`syncedState-${syncedStateId}`);\n            if (storedFluidStateHandle === undefined) {\n                throw new Error(\n                    this.getUninitializedErrorString(\n                        `syncedState-${syncedStateId}`,\n                    ),\n                );\n            }\n            const storedFluidState = await storedFluidStateHandle.get();\n            // Add it to the Fluid object map so that it will have a listener added to it once\n            // we enter the render lifecycle\n            this.fluidObjectMap.set(storedFluidStateHandle.absolutePath, {\n                fluidObject: storedFluidState,\n                isRuntimeMap: true,\n            });\n            // If the view is using any Fluid data stores or SharedObjects, asynchronously fetch them\n            // from their stored handles\n            for (const [key, value] of fluidToView.entries()) {\n                const fluidKey = key as string;\n                const rootKey = value.rootKey;\n                const createCallback = value.sharedObjectCreate;\n                if (createCallback !== undefined) {\n                    const handle = rootKey !== undefined\n                        ? this.root.get(rootKey)\n                        : storedFluidState.get(fluidKey);\n                    if (handle === undefined) {\n                        throw new Error(\n                            `Failed to find ${fluidKey} in synced state`,\n                        );\n                    }\n                    this.fluidObjectMap.set(handle.absolutePath, {\n                        fluidObject: await handle.get(),\n                        listenedEvents: value.listenedEvents ?? [\"valueChanged\"],\n                    });\n                } else {\n                    const storedValue = rootKey !== undefined\n                        ? this.root.get(rootKey)\n                        : storedFluidState.get(fluidKey);\n                    const handle = storedValue?.IFluidHandle;\n                    if (handle !== undefined) {\n                        this.fluidObjectMap.set(handle.absolutePath, {\n                            fluidObject: await handle.get(),\n                            listenedEvents: value.listenedEvents ?? [\n                                \"valueChanged\",\n                            ],\n                        });\n                    }\n                }\n            }\n            const schemaHandles = getSchema(\n                syncedStateId,\n                this.syncedState,\n            );\n            if (schemaHandles === undefined) {\n                throw new Error(\n                    this.getUninitializedErrorString(\n                        `schema-${syncedStateId}`,\n                    ),\n                );\n            }\n            this.fluidObjectMap.set(\n                schemaHandles.fluidMatchingMapHandle.absolutePath,\n                {\n                    fluidObject: await schemaHandles.fluidMatchingMapHandle.get(),\n                    isRuntimeMap: true,\n                },\n            );\n            this.fluidObjectMap.set(\n                schemaHandles.viewMatchingMapHandle.absolutePath,\n                {\n                    fluidObject: await schemaHandles.viewMatchingMapHandle.get(),\n                    isRuntimeMap: true,\n                },\n            );\n            this.fluidObjectMap.set(\n                schemaHandles.storedHandleMapHandle.absolutePath,\n                {\n                    fluidObject: await schemaHandles.storedHandleMapHandle.get(),\n                    isRuntimeMap: true,\n                },\n            );\n        }\n    }\n}\n"]}

package/lib/syncedObjects/array/fluidSyncedArray.js

@@ -1,72 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { SharedObjectSequence } from "@fluidframework/sequence";
-import { useReducerFluid, } from "../..";
-export function setFluidSyncedArrayConfig(syncedDataObject, syncedStateId, viewKey, fluidKey, defaultViewState, sharedObjectCreate = SharedObjectSequence.create) {
-    syncedDataObject.setFluidConfig(syncedStateId, {
-        syncedStateId,
-        fluidToView: new Map([
-            [
-                fluidKey,
-                {
-                    type: SharedObjectSequence.name,
-                    viewKey,
-                    viewConverter: (viewState, fluidState) => {
-                        if (fluidState[fluidKey] === undefined) {
-                            throw Error("Fluid state was not initialized");
-                        }
-                        viewState[viewKey] = fluidState[fluidKey].getItems(0);
-                        return viewState;
-                    },
-                    sharedObjectCreate,
-                    listenedEvents: ["valueChanged"],
-                },
-            ],
-        ]),
-        viewToFluid: new Map([
-            [
-                viewKey,
-                {
-                    type: "array",
-                    fluidKey,
-                    fluidConverter: (viewState, fluidState) => {
-                        if (fluidState[fluidKey] === undefined) {
-                            throw Error("Fluid state was not initialized");
-                        }
-                        viewState[viewKey] = fluidState[fluidKey].getItems(0);
-                        return fluidState;
-                    },
-                },
-            ],
-        ]),
-        defaultViewState,
-    });
-}
-export function generateSyncedArrayReducer(viewKey, fluidKey) {
-    const syncedArrayReducer = {
-        add: {
-            function: (state, value) => {
-                var _a;
-                if (((_a = state === null || state === void 0 ? void 0 : state.fluidState) === null || _a === void 0 ? void 0 : _a[fluidKey]) === undefined) {
-                    throw Error("State was not initialized prior to dispatch call");
-                }
-                state.fluidState[fluidKey].insert(state.fluidState[fluidKey].getLength(), [Object.assign({}, value)]);
-                state.viewState[viewKey] = state.fluidState[fluidKey].getItems(0);
-                return { state };
-            },
-        },
-    };
-    return syncedArrayReducer;
-}
-export function useSyncedArrayReducerFluid(syncedDataObject, syncedStateId, viewKey, fluidKey, defaultViewState) {
-    const syncedArrayReducer = generateSyncedArrayReducer(viewKey, fluidKey);
-    return useReducerFluid({
-        syncedDataObject,
-        syncedStateId,
-        reducer: syncedArrayReducer,
-        selector: {},
-    }, defaultViewState);
-}
-//# sourceMappingURL=fluidSyncedArray.js.map

package/lib/syncedObjects/array/fluidSyncedArray.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fluidSyncedArray.js","sourceRoot":"","sources":["../../../src/syncedObjects/array/fluidSyncedArray.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAMH,eAAe,GAClB,MAAM,OAAO,CAAC;AAGf,MAAM,UAAU,yBAAyB,CAIrC,gBAAkC,EAClC,aAAqB,EACrB,OAAiB,EACjB,QAAkB,EAClB,gBAAoB,EACpB,kBAAkB,GAAG,oBAAoB,CAAC,MAAM;IAEhD,gBAAgB,CAAC,cAAc,CAAS,aAAa,EAAE;QACnD,aAAa;QACb,WAAW,EAAE,IAAI,GAAG,CAAC;YACjB;gBACI,QAAQ;gBACR;oBACI,IAAI,EAAE,oBAAoB,CAAC,IAAI;oBAC/B,OAAO;oBACP,aAAa,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,EAAE;wBACrC,IAAI,UAAU,CAAC,QAAQ,CAAC,KAAK,SAAS,EAAE;4BACpC,MAAM,KAAK,CAAC,iCAAiC,CAAC,CAAC;yBAClD;wBACD,SAAS,CAAC,OAAO,CAAC,GAAI,UAAU,CAC5B,QAAQ,CACH,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;wBACtB,OAAO,SAAS,CAAC;oBACrB,CAAC;oBACD,kBAAkB;oBAClB,cAAc,EAAE,CAAC,cAAc,CAAC;iBACnC;aACJ;SACJ,CAAC;QACF,WAAW,EAAE,IAAI,GAAG,CAAC;YACjB;gBACI,OAAO;gBACP;oBACI,IAAI,EAAE,OAAO;oBACb,QAAQ;oBACR,cAAc,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,EAAE;wBACtC,IAAI,UAAU,CAAC,QAAQ,CAAC,KAAK,SAAS,EAAE;4BACpC,MAAM,KAAK,CAAC,iCAAiC,CAAC,CAAC;yBAClD;wBACD,SAAS,CAAC,OAAO,CAAC,GAAI,UAAU,CAC5B,QAAQ,CACH,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;wBACtB,OAAO,UAAU,CAAC;oBACtB,CAAC;iBACJ;aACJ;SACJ,CAAC;QACF,gBAAgB;KACnB,CAAC,CAAC;AACP,CAAC;AAED,MAAM,UAAU,0BAA0B,CAGxC,OAAiB,EAAE,QAAkB;IACnC,MAAM,kBAAkB,GAAG;QACvB,GAAG,EAAE;YACD,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAU,EAAE,EAAE;;gBAC5B,IAAI,OAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,0CAAG,QAAQ,OAAM,SAAS,EAAE;oBAC7C,MAAM,KAAK,CACP,kDAAkD,CACrD,CAAC;iBACL;gBACD,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAC7B,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,SAAS,EAAE,EACtC,mBAAM,KAAK,EAAG,CACjB,CAAC;gBACF,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAC1D,CAAC,CACJ,CAAC;gBACF,OAAO,EAAE,KAAK,EAAE,CAAC;YACrB,CAAC;SACJ;KACJ,CAAC;IACF,OAAO,kBAAkB,CAAC;AAC9B,CAAC;AAED,MAAM,UAAU,0BAA0B,CAItC,gBAAkC,EAClC,aAAqB,EACrB,OAAiB,EACjB,QAAkB,EAClB,gBAAoB;IAGpB,MAAM,kBAAkB,GAAG,0BAA0B,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACzE,OAAO,eAAe,CAQlB;QACI,gBAAgB;QAChB,aAAa;QACb,OAAO,EAAE,kBAAkB;QAC3B,QAAQ,EAAE,EAAE;KACf,EACD,gBAAgB,CACnB,CAAC;AACN,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { SharedObjectSequence } from \"@fluidframework/sequence\";\nimport {\n    IViewState,\n    IFluidState,\n    SyncedDataObject,\n    ICombinedState,\n    IFluidDataProps,\n    useReducerFluid,\n} from \"../..\";\nimport { IFluidSyncedArrayReducer } from \"./interface\";\n\nexport function setFluidSyncedArrayConfig<\n    SV extends IViewState,\n    SF extends IFluidState\n>(\n    syncedDataObject: SyncedDataObject,\n    syncedStateId: string,\n    viewKey: keyof SV,\n    fluidKey: keyof SF,\n    defaultViewState: SV,\n    sharedObjectCreate = SharedObjectSequence.create,\n) {\n    syncedDataObject.setFluidConfig<SV, SF>(syncedStateId, {\n        syncedStateId,\n        fluidToView: new Map([\n            [\n                fluidKey,\n                {\n                    type: SharedObjectSequence.name,\n                    viewKey,\n                    viewConverter: (viewState, fluidState) => {\n                        if (fluidState[fluidKey] === undefined) {\n                            throw Error(\"Fluid state was not initialized\");\n                        }\n                        viewState[viewKey] = (fluidState[\n                            fluidKey\n                        ] as any).getItems(0);\n                        return viewState;\n                    },\n                    sharedObjectCreate,\n                    listenedEvents: [\"valueChanged\"],\n                },\n            ],\n        ]),\n        viewToFluid: new Map([\n            [\n                viewKey,\n                {\n                    type: \"array\",\n                    fluidKey,\n                    fluidConverter: (viewState, fluidState) => {\n                        if (fluidState[fluidKey] === undefined) {\n                            throw Error(\"Fluid state was not initialized\");\n                        }\n                        viewState[viewKey] = (fluidState[\n                            fluidKey\n                        ] as any).getItems(0);\n                        return fluidState;\n                    },\n                },\n            ],\n        ]),\n        defaultViewState,\n    });\n}\n\nexport function generateSyncedArrayReducer<\n    SV extends IViewState,\n    SF extends IFluidState\n>(viewKey: keyof SV, fluidKey: keyof SF): IFluidSyncedArrayReducer<SV, SF> {\n    const syncedArrayReducer = {\n        add: {\n            function: (state, value: any) => {\n                if (state?.fluidState?.[fluidKey] === undefined) {\n                    throw Error(\n                        \"State was not initialized prior to dispatch call\",\n                    );\n                }\n                state.fluidState[fluidKey].insert(\n                    state.fluidState[fluidKey].getLength(),\n                    [{ ...value }],\n                );\n                state.viewState[viewKey] = state.fluidState[fluidKey].getItems(\n                    0,\n                );\n                return { state };\n            },\n        },\n    };\n    return syncedArrayReducer;\n}\n\nexport function useSyncedArrayReducerFluid<\n    SV extends IViewState,\n    SF extends IFluidState\n>(\n    syncedDataObject: SyncedDataObject,\n    syncedStateId: string,\n    viewKey: keyof SV,\n    fluidKey: keyof SF,\n    defaultViewState: SV,\n// eslint-disable-next-line @typescript-eslint/ban-types\n): [ICombinedState<SV, SF, IFluidDataProps>, IFluidSyncedArrayReducer<SV, SF>, {}] {\n    const syncedArrayReducer = generateSyncedArrayReducer(viewKey, fluidKey);\n    return useReducerFluid<\n        SV,\n        SF,\n        IFluidSyncedArrayReducer<SV, SF>,\n        // eslint-disable-next-line @typescript-eslint/ban-types\n        {},\n        IFluidDataProps\n    >(\n        {\n            syncedDataObject,\n            syncedStateId,\n            reducer: syncedArrayReducer,\n            selector: {},\n        },\n        defaultViewState,\n    );\n}\n"]}

package/lib/syncedObjects/array/index.js

@@ -1,7 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-export * from "./syncedArray";
-export * from "./interface";
-//# sourceMappingURL=index.js.map

package/lib/syncedObjects/array/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/syncedObjects/array/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./syncedArray\";\nexport * from \"./interface\";\n"]}

package/lib/syncedObjects/array/interface.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=interface.js.map

package/lib/syncedObjects/array/interface.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"interface.js","sourceRoot":"","sources":["../../../src/syncedObjects/array/interface.ts"],"names":[],"mappings":"","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { SharedObjectSequence } from \"@fluidframework/sequence\";\nimport {\n    IViewState,\n    IFluidState,\n    IFluidReducer,\n    IFluidDataProps,\n    FluidStateUpdateFunction,\n} from \"../..\";\n\n/**\n * The state interface exposed to the view for the synced array\n */\nexport interface ISyncedArrayViewState<T> extends IViewState {\n    values: T[];\n}\n\n/**\n * The state interface for the Fluid data source that powers the synced array\n */\nexport interface ISyncedArrayFluidState<T> extends IFluidState {\n    values: SharedObjectSequence<T>;\n}\n\n/**\n * The reducer interface for modifying the synced array\n * TODO: Add more functions that further expose the SharedObjectSequence interface for use\n */\nexport interface ISyncedArrayReducer<T> {\n    add: (value: T) => void;\n}\n\n/**\n * The underlying reducer interface passed to the useReducerFluid hook to bind the view and Fluid\n * state definitions together\n */\nexport interface IFluidSyncedArrayReducer<\n    SV extends IViewState,\n    SF extends IFluidState\n    > extends IFluidReducer<SV, SF, IFluidDataProps> {\n    add: FluidStateUpdateFunction<SV, SF, IFluidDataProps>;\n}\n"]}