@fluidframework/react 0.41.4 → 2.62.0

package/lib/useReducerFluid.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useReducerFluid.js","sourceRoot":"","sources":["../src/useReducerFluid.tsx"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,OAAO,EAIH,6BAA6B,EAC7B,kCAAkC,EAClC,0BAA0B,EAC1B,qCAAqC,EACrC,wBAAwB,EACxB,6BAA6B,GAOhC,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EACH,4BAA4B,EAC5B,2BAA2B,EAC3B,aAAa,EACb,SAAS,EACT,SAAS,GACZ,MAAM,WAAW,CAAC;AAEnB,MAAM,UAAU,eAAe,CAO3B,KAA0C,EAC1C,gBAAoB;;IAEpB,MAAM,EACF,aAAa,EACb,OAAO,EACP,QAAQ,EACR,gBAAgB,GACnB,GAAG,KAAK,CAAC;IACV,MAAM,MAAM,GAAG,gBAAgB,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IACzD,IAAI,MAAM,KAAK,SAAS,EAAE;QACtB,MAAM,KAAK,CAAC,qDAAqD,aAAa,EAAE,CAAC,CAAC;KACrF;IACD,MAAM,SAAS,SAAG,KAAK,CAAC,SAAS,mCAAI,gBAAgB,CAAC,SAAc,CAAC;IACrE,uFAAuF;IACvF,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,GAAG,aAAa,CAAS;QAChD,aAAa;QACb,gBAAgB;QAChB,SAAS;KACZ,EAAE,gBAAgB,CAAC,CAAC;IACrB,MAAM,WAAW,GAAG,gBAAgB,CAAC,WAAW,CAAC;IACjD,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,MAAoC,CAAC;IAE1E,MAAM,aAAa,GAAG,SAAS,CAC3B,aAAa,EACb,WAAW,CACd,CAAC;IACF,IAAI,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,qBAAqB,CAAC,YAAY,MAAK,SAAS,EAAE;QACjE,MAAM,KAAK,CAAC,wDAAwD,aAAa,EAAE,CAAC,CAAC;KACxF;IACD,MAAM,eAAe,GAAG,MAAA,SAAS,CAAC,cAAc,CAAC,GAAG,CAChD,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,qBAAqB,CAAC,YAAY,CACpD,0CAAE,WAAwB,CAAC;IAC5B,IAAI,eAAe,KAAK,SAAS,EAAE;QAC/B,MAAM,KAAK,CAAC,yDAAyD,aAAa,EAAE,CAAC,CAAC;KACzF;IAED,0FAA0F;IAC1F,oFAAoF;IACpF,gFAAgF;IAChF,gGAAgG;IAChG,oDAAoD;IACpD,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,CAC9B,CACI,IAAa,EACb,aAAyC,EACzC,GAAG,IAAS,EACd,EAAE;QACA,yFAAyF;QACzF,MAAM,iBAAiB,GAAG,aAAa,CACnC,aAAa,EACb,WAAW,EACX,SAAS,CAAC,cAAc,EACxB,WAAW,CACd,CAAC;QACF,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACjC,MAAM,KAAK,CACP,mEAAmE,CACtE,CAAC;SACL;QACD,MAAM,0BAA0B,mCACzB,iBAAiB,GACjB,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,UAAU,CAC/B,CAAC;QACF,MAAM,yBAAyB,mCACxB,SAAS,GACT,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,SAAS,CAC9B,CAAC;QACF,MAAM,yBAAyB,mCACxB,SAAS,GACT,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,SAAS,CAC9B,CAAC;QACF,MAAM,qBAAqB,GAAG;YAC1B,UAAU,EAAE,0BAA0B;YACtC,SAAS,EAAE,yBAAyB;YACpC,SAAS,EAAE,yBAAyB;SACvC,CAAC;QACF,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,MAAM,KAAK,SAAS,EAAE;YACtB,IAAI,6BAA6B,CAAY,MAAM,CAAC,EAAE;gBAClD,6EAA6E;gBAC7E,+BAA+B;gBAC/B,MAAM,MAAM,GAAI,MAAM,CAAC,QAAgB,CACnC,qBAAqB,EACrB,GAAG,IAAI,CACV,CAAC;gBACF,IAAI,MAAM,CAAC,mBAAmB,KAAK,SAAS,EAAE;oBAC1C,wEAAwE;oBACxE,8BAA8B;oBAC9B,MAAM,QAAQ,GAAG,2BAA2B,CACxC,yBAAyB,CAAC,cAAc,EACxC,eAAe,EACf,aAAa,EACb,WAAW,EACX,yBAAyB,CAAC,OAAO,EACjC,MAAM,CAAC,KAAK,CAAC,SAAS,EACtB,QAAQ,EACR,WAAW,EACX,WAAW,CACd,CAAC;oBACF,mEAAmE;oBACnE,4BAA4B,CACxB,MAAM,CAAC,mBAAmB,EAC1B,yBAAyB,CAAC,cAAc,EACxC,eAAe,EACf,KAAK,EACL,aAAa,EACb,WAAW,EACX,yBAAyB,CAAC,OAAO,EACjC,MAAM,CAAC,KAAK,CAAC,SAAS,EACtB,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,WAAW,CACd,CAAC;iBACL;qBAAM;oBACH,4BAA4B;oBAC5B,SAAS,CACL,KAAK,EACL,aAAa,EACb,WAAW,EACX,yBAAyB,CAAC,OAAO,EACjC,MAAM,CAAC,KAAK,CAAC,SAAS,EACtB,QAAQ,EACR,yBAAyB,CAAC,cAAc,EACxC,WAAW,EACX,WAAW,CACd,CAAC;iBACL;aACJ;iBAAM,IAAI,kCAAkC,CAAY,MAAM,CAAC,EAAE;gBAC9D,kFAAkF;gBAClF,wEAAwE;gBACvE,MAAM,CAAC,aAAqB,CACzB,qBAAqB,EACrB,GAAG,IAAI,CACV,CAAC,IAAI,CAAC,CAAC,MAAqC,EAAE,EAAE;oBAC7C,MAAM,QAAQ,GAAG,2BAA2B,CACxC,yBAAyB,CAAC,cAAc,EACxC,eAAe,EACf,aAAa,EACb,WAAW,EACX,yBAAyB,CAAC,OAAO,EACjC,MAAM,CAAC,KAAK,CAAC,SAAS,EACtB,QAAQ,EACR,WAAW,EACX,WAAW,CACd,CAAC;oBACF,IAAI,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE;wBACtC,mEAAmE;wBACnE,4BAA4B,CACxB,MAAM,CAAC,eAAe,EACtB,yBAAyB,CAAC,cAAc,EACxC,eAAe,EACf,KAAK,EACL,aAAa,EACb,WAAW,EACX,yBAAyB,CAAC,OAAO,EACjC,MAAM,CAAC,KAAK,CAAC,SAAS,EACtB,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,WAAW,CACd,CAAC;qBACL;yBAAM;wBACH,SAAS,CACL,KAAK,EACL,aAAa,EACb,WAAW,EACX,yBAAyB,CAAC,OAAO,EACjC,MAAM,CAAC,KAAK,CAAC,SAAS,EACtB,QAAQ,EACR,yBAAyB,CAAC,cAAc,EACxC,WAAW,EACX,WAAW,CACd,CAAC;qBACL;gBACL,CAAC,CAAC,CAAC;aACN;iBAAM,IAAI,6BAA6B,CAAY,MAAM,CAAC,EAAE;gBACxD,MAAM,CAAC,aAAqB,CACzB,qBAAqB,EACrB,GAAG,IAAI,CACV,CAAC,IAAI,CAAC,GAAG,EAAE,CACR,SAAS,CACL,KAAK,EACL,aAAa,EACb,WAAW,EACX,yBAAyB,CAAC,OAAO,EACjC,qBAAqB,CAAC,SAAS,EAC/B,QAAQ,EACR,yBAAyB,CAAC,cAAc,EACxC,WAAW,EACX,WAAW,CACd,CACJ,CAAC;aACL;iBAAM,IAAI,wBAAwB,CAAY,MAAM,CAAC,EAAE;gBACnD,MAAM,CAAC,QAAgB,CAAC,qBAAqB,EAAE,GAAG,IAAI,CAAC,CAAC;gBACzD,SAAS,CACL,KAAK,EACL,aAAa,EACb,WAAW,EACX,yBAAyB,CAAC,OAAO,EACjC,qBAAqB,CAAC,SAAS,EAC/B,QAAQ,EACR,yBAAyB,CAAC,cAAc,EACxC,WAAW,EACX,WAAW,CACd,CAAC;aACL;iBAAM;gBACH,MAAM,IAAI,KAAK,CACX,mBAAmB,MAAM,sDAAsD,CAClF,CAAC;aACL;SACJ;aAAM;YACH,MAAM,IAAI,KAAK,CACX,mBAAmB,MAAM;gDACG,CAC/B,CAAC;SACL;IACL,CAAC,EACD,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC,CAC5C,CAAC;IAEF,qFAAqF;IACrF,wFAAwF;IACxF,4FAA4F;IAC5F,+FAA+F;IAC/F,kGAAkG;IAClG,MAAM,eAAe,GAAG,EAAE,CAAC;IAC3B,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,EAAE,YAAY,CAAC,EAAE,CAAC,EAAE,EAAE;QAChE,IAAK,YAAoB,CAAC,aAAa,KAAK,SAAS,EAAE;YACnD,eAAe,CAAC,YAAY,CAAC,GAAG;gBAC5B,aAAa,EAAE,CACX,aAAwC,EACxC,GAAG,IAAS,EACd,EAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC;aACtD,CAAC;SACL;aAAM;YACH,eAAe,CAAC,YAAY,CAAC,GAAG;gBAC5B,QAAQ,EAAE,CACN,aAAwC,EACxC,GAAG,IAAS,EACd,EAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC;aACtD,CAAC;SACL;IACL,CAAC,CAAC,CAAC;IAEH,uFAAuF;IACvF,iFAAiF;IACjF,uGAAuG;IACvG,4FAA4F;IAC5F,uDAAuD;IACvD,0FAA0F;IAC1F,+CAA+C;IAC/C,kHAAkH;IAClH,MAAM,KAAK,GAAG,KAAK,CAAC,WAAW,CAC3B,CACI,IAAa,EACb,UAAsC,EACtC,MAAqB,EACvB,EAAE;QACA,wFAAwF;QACxF,MAAM,iBAAiB,GAAG,aAAa,CACnC,aAAa,EACb,WAAW,EACX,SAAS,CAAC,cAAc,EACxB,WAAW,CACd,CAAC;QACF,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACjC,MAAM,KAAK,CACP,mEAAmE,CACtE,CAAC;SACL;QACD,MAAM,uBAAuB,mCACtB,iBAAiB,GACjB,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,UAAU,CAC5B,CAAC;QACF,MAAM,sBAAsB,mCACrB,SAAS,GACT,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,SAAS,CAC3B,CAAC;QACF,MAAM,sBAAsB,mCACrB,SAAS,GACT,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,SAAS,CAC3B,CAAC;QACF,MAAM,kBAAkB,GAAG;YACvB,UAAU,EAAE,uBAAuB;YACnC,SAAS,EAAE,sBAAsB;YACjC,SAAS,EAAE,sBAAsB;SACpC,CAAC;QACF,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,MAAM,KAAK,SAAS,EAAE;YACtB,IAAI,0BAA0B,CAAY,MAAM,CAAC,EAAE;gBAC/C,qEAAqE;gBACrE,6CAA6C;gBAC7C,IAAI,UAAU,GAAmB,EAAE,CAAC;gBACpC,IACI,MAAM,KAAK,SAAS;oBACpB,qCAAqC,CAAY,MAAM,CAAC;oBACxD,sBAAsB,CAAC,cAAc,CAAC,GAAG,CACrC,MAAM,CAAC,YAAY,CACtB,KAAK,SAAS,EACjB;oBACE,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;iBAC3B;gBACD,MAAM,YAAY,GAAI,MAAM,CAAC,QAAgB,CACzC,kBAAkB,EAClB,MAAM,CACT,CAAC;gBACF,IACI,YAAY,KAAK,SAAS;oBAC1B,YAAY,CAAC,mBAAmB,KAAK,SAAS,EAChD;oBACE,UAAU,GAAG,UAAU,CAAC,MAAM,CAC1B,YAAY,CAAC,mBAAmB,CACnC,CAAC;iBACL;gBACD,gGAAgG;gBAChG,wEAAwE;gBACxE,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;oBACvB,MAAM,QAAQ,GAAG,2BAA2B,CACxC,sBAAsB,CAAC,cAAc,EACrC,eAAe,EACf,aAAa,EACb,WAAW,EACX,sBAAsB,CAAC,OAAO,EAC9B,kBAAkB,CAAC,SAAS,EAC5B,QAAQ,EACR,WAAW,EACX,WAAW,CACd,CAAC;oBACF,mEAAmE;oBACnE,4BAA4B,CACxB,UAAU,EACV,sBAAsB,CAAC,cAAc,EACrC,eAAe,EACf,IAAI,EACJ,aAAa,EACb,WAAW,EACX,sBAAsB,CAAC,OAAO,EAC9B,kBAAkB,CAAC,SAAS,EAC5B,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,WAAW,CACd,CAAC;iBACL;gBACD,uCAAuC;gBACvC,+DAA+D;gBAC/D,OAAO,YAAY,CAAC;aACvB;iBAAM;gBACH,MAAM,IAAI,KAAK,CACX,mBAAmB,MAAM,uDAAuD,CACnF,CAAC;aACL;SACJ;aAAM;YACH,MAAM,IAAI,KAAK,CACX,mBAAmB,MAAM;iDACI,CAChC,CAAC;SACL;IACL,CAAC,EACD,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC,CAC7C,CAAC;IAEF,gHAAgH;IAChH,8DAA8D;IAC9D,MAAM,gBAAgB,GAAG,EAAE,CAAC;IAC5B,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,EAAE,YAAY,CAAC,EAAE,CAAC,EAAE,EAAE;QACjE,gBAAgB,CAAC,YAAY,CAAC,GAAG;YAC7B,QAAQ,EAAE,CACN,UAAqC,EACrC,MAAqB,EAEvB,EAAE,CAAC,KAAK,CAAC,YAAY,EAAE,UAAU,EAAE,MAAM,CAAC;SAC/C,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,wFAAwF;IACxF,MAAM,UAAU,GAAG,aAAa,CAC5B,aAAa,EACb,WAAW,EACX,SAAS,CAAC,cAAc,EACxB,WAAW,CACd,CAAC;IAEF,OAAO;QACH;YACI,SAAS;YACT,UAAU;YACV,SAAS;SACZ;QACD,eAAoB;QACpB,gBAAqB;KACxB,CAAC;AACN,CAAC","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 { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport { SharedMap } from \"@fluidframework/map\";\nimport {\n    IViewState,\n    IFluidReducerProps,\n    IFluidDataProps,\n    instanceOfStateUpdateFunction,\n    instanceOfAsyncStateUpdateFunction,\n    instanceOfSelectorFunction,\n    instanceOfFluidObjectSelectorFunction,\n    instanceOfEffectFunction,\n    instanceOfAsyncEffectFunction,\n    IStateUpdateResult,\n    IFluidState,\n    IFluidReducer,\n    IFluidSelector,\n    ICombinedState,\n    ISyncedStateConfig,\n} from \"./interface\";\nimport { useStateFluid } from \"./useStateFluid\";\nimport {\n    updateStateAndFluidObjectMap,\n    syncedStateCallbackListener,\n    getFluidState,\n    syncState,\n    getSchema,\n} from \"./helpers\";\n\nexport function useReducerFluid<\n    SV extends IViewState,\n    SF extends IFluidState,\n    A extends IFluidReducer<SV, SF, C>,\n    B extends IFluidSelector<SV, SF, C>,\n    C extends IFluidDataProps\n>(\n    props: IFluidReducerProps<SV, SF, A, B, C>,\n    initialViewState: SV,\n): [ICombinedState<SV, SF, C>, A, B] {\n    const {\n        syncedStateId,\n        reducer,\n        selector,\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    const dataProps = props.dataProps ?? syncedDataObject.dataProps as C;\n    // Get our combined synced state and setState callbacks from the useStateFluid function\n    const [viewState, setState] = useStateFluid<SV, SF>({\n        syncedStateId,\n        syncedDataObject,\n        dataProps,\n    }, initialViewState);\n    const syncedState = syncedDataObject.syncedState;\n    const { fluidToView, viewToFluid } = config as ISyncedStateConfig<SV, SF>;\n\n    const schemaHandles = getSchema(\n        syncedStateId,\n        syncedState,\n    );\n    if (schemaHandles?.storedHandleMapHandle.absolutePath === undefined) {\n        throw Error(`Component schema not initialized prior to render for ${syncedStateId}`);\n    }\n    const storedHandleMap = dataProps.fluidObjectMap.get(\n        schemaHandles?.storedHandleMapHandle.absolutePath,\n    )?.fluidObject as SharedMap;\n    if (storedHandleMap === undefined) {\n        throw Error(`Stored handle map not initialized prior to render for ${syncedStateId}`);\n    }\n\n    // Dispatch is an in-memory object that will load the reducer actions provided by the user\n    // and add updates to the view and Fluid state based off of the type of function and\n    // state values that were updated. Think of it as prepping the data in the first\n    // stage of dynamic programming. The dispatch functions are copies of the user-defined functions\n    // but with the updates to synced state also handled\n    const dispatch = React.useCallback(\n        (\n            type: keyof A,\n            dispatchState?: ICombinedState<SV, SF, C>,\n            ...args: any\n        ) => {\n            // Retrieve the current state that is stored on the synced state for this Fluid object ID\n            const currentFluidState = getFluidState(\n                syncedStateId,\n                syncedState,\n                dataProps.fluidObjectMap,\n                fluidToView,\n            );\n            if (currentFluidState === undefined) {\n                throw Error(\n                    \"Attempted to dispatch function before fluid state was initialized\",\n                );\n            }\n            const combinedDispatchFluidState: SF = {\n                ...currentFluidState,\n                ...dispatchState?.fluidState,\n            };\n            const combinedDispatchViewState: SV = {\n                ...viewState,\n                ...dispatchState?.viewState,\n            };\n            const combinedDispatchDataProps: C = {\n                ...dataProps,\n                ...dispatchState?.dataProps,\n            };\n            const combinedDispatchState = {\n                fluidState: combinedDispatchFluidState,\n                viewState: combinedDispatchViewState,\n                dataProps: combinedDispatchDataProps,\n            };\n            const action = reducer[type];\n            if (action !== undefined) {\n                if (instanceOfStateUpdateFunction<SV, SF, C>(action)) {\n                    // If its a synchronous state update function, call it and inspect the result\n                    // for new Fluid object handles\n                    const result = (action.function as any)(\n                        combinedDispatchState,\n                        ...args,\n                    );\n                    if (result.newComponentHandles !== undefined) {\n                        // Fetch any new Fluid objects and add a listener to their synced state.\n                        // Then update the view state.\n                        const callback = syncedStateCallbackListener(\n                            combinedDispatchDataProps.fluidObjectMap,\n                            storedHandleMap,\n                            syncedStateId,\n                            syncedState,\n                            combinedDispatchDataProps.runtime,\n                            result.state.viewState,\n                            setState,\n                            fluidToView,\n                            viewToFluid,\n                        );\n                        // eslint-disable-next-line @typescript-eslint/no-floating-promises\n                        updateStateAndFluidObjectMap(\n                            result.newComponentHandles,\n                            combinedDispatchDataProps.fluidObjectMap,\n                            storedHandleMap,\n                            false,\n                            syncedStateId,\n                            syncedState,\n                            combinedDispatchDataProps.runtime,\n                            result.state.viewState,\n                            setState,\n                            callback,\n                            fluidToView,\n                            viewToFluid,\n                        );\n                    } else {\n                        // Update the state directly\n                        syncState(\n                            false,\n                            syncedStateId,\n                            syncedState,\n                            combinedDispatchDataProps.runtime,\n                            result.state.viewState,\n                            setState,\n                            combinedDispatchDataProps.fluidObjectMap,\n                            fluidToView,\n                            viewToFluid,\n                        );\n                    }\n                } else if (instanceOfAsyncStateUpdateFunction<SV, SF, C>(action)) {\n                    // In the case of an async function, the function promise is treated as a Thenable\n                    // and the returned result is inspected after the function has completed\n                    (action.asyncFunction as any)(\n                        combinedDispatchState,\n                        ...args,\n                    ).then((result: IStateUpdateResult<SV, SF, C>) => {\n                        const callback = syncedStateCallbackListener(\n                            combinedDispatchDataProps.fluidObjectMap,\n                            storedHandleMap,\n                            syncedStateId,\n                            syncedState,\n                            combinedDispatchDataProps.runtime,\n                            result.state.viewState,\n                            setState,\n                            fluidToView,\n                            viewToFluid,\n                        );\n                        if (result.newFluidHandles !== undefined) {\n                            // eslint-disable-next-line @typescript-eslint/no-floating-promises\n                            updateStateAndFluidObjectMap(\n                                result.newFluidHandles,\n                                combinedDispatchDataProps.fluidObjectMap,\n                                storedHandleMap,\n                                false,\n                                syncedStateId,\n                                syncedState,\n                                combinedDispatchDataProps.runtime,\n                                result.state.viewState,\n                                setState,\n                                callback,\n                                fluidToView,\n                                viewToFluid,\n                            );\n                        } else {\n                            syncState(\n                                false,\n                                syncedStateId,\n                                syncedState,\n                                combinedDispatchDataProps.runtime,\n                                result.state.viewState,\n                                setState,\n                                combinedDispatchDataProps.fluidObjectMap,\n                                fluidToView,\n                                viewToFluid,\n                            );\n                        }\n                    });\n                } else if (instanceOfAsyncEffectFunction<SV, SF, C>(action)) {\n                    (action.asyncFunction as any)(\n                        combinedDispatchState,\n                        ...args,\n                    ).then(() =>\n                        syncState(\n                            false,\n                            syncedStateId,\n                            syncedState,\n                            combinedDispatchDataProps.runtime,\n                            combinedDispatchState.viewState,\n                            setState,\n                            combinedDispatchDataProps.fluidObjectMap,\n                            fluidToView,\n                            viewToFluid,\n                        ),\n                    );\n                } else if (instanceOfEffectFunction<SV, SF, C>(action)) {\n                    (action.function as any)(combinedDispatchState, ...args);\n                    syncState(\n                        false,\n                        syncedStateId,\n                        syncedState,\n                        combinedDispatchDataProps.runtime,\n                        combinedDispatchState.viewState,\n                        setState,\n                        combinedDispatchDataProps.fluidObjectMap,\n                        fluidToView,\n                        viewToFluid,\n                    );\n                } else {\n                    throw new Error(\n                        `Action with key ${action} does not match an expected reducer action interface`,\n                    );\n                }\n            } else {\n                throw new Error(\n                    `Action with key ${action} does not\n                 exist in the reducers provided`,\n                );\n            }\n        },\n        [reducer, viewState, setState, dataProps],\n    );\n\n    // The combinedReducer is then created using the dispatch functions we created above.\n    // This allows us to preserve the reducer interface while injecting Fluid-specific logic\n    // into the updating of the state. This is the second phase of DP, using the earlier created\n    // in-memory object to access the function the user is trying to use in constant time and then,\n    // subsequently performing it, taking the updated state, and applying it both locally and remotely\n    const combinedReducer = {};\n    Object.entries(reducer).forEach(([functionName, functionItem], i) => {\n        if ((functionItem as any).asyncFunction !== undefined) {\n            combinedReducer[functionName] = {\n                asyncFunction: (\n                    dispatchState: ICombinedState<SV, SF, C>,\n                    ...args: any\n                ) => dispatch(functionName, dispatchState, ...args),\n            };\n        } else {\n            combinedReducer[functionName] = {\n                function: (\n                    dispatchState: ICombinedState<SV, SF, C>,\n                    ...args: any\n                ) => dispatch(functionName, dispatchState, ...args),\n            };\n        }\n    });\n\n    // Fetch is an in-memory object similar to dispatch, but now made for selector actions.\n    // Selectors are NOT used for updating the state but instead to be able to access\n    // and add other Fluid Fluid objects using the handle provided. If the handle provided is not available\n    // in our Fluid object map, it will be dynamically updated and setState will be called again\n    // with the updated Fluid object map available for use.\n    // Alternatively, if you would like to pre-load Fluid objects before React is initialized,\n    // you can do so and provide them in dataProps.\n    // Fetch can also be used to retrieve data from these Fluid objects as they will also be available as a parameter.\n    const fetch = React.useCallback(\n        (\n            type: keyof B,\n            fetchState?: ICombinedState<SV, SF, C>,\n            handle?: IFluidHandle,\n        ) => {\n            // Retrieve the current state that is stored on the syncedState for this Fluid object ID\n            const currentFluidState = getFluidState(\n                syncedStateId,\n                syncedState,\n                dataProps.fluidObjectMap,\n                fluidToView,\n            );\n            if (currentFluidState === undefined) {\n                throw Error(\n                    \"Attempted to dispatch function before fluid state was initialized\",\n                );\n            }\n            const combinedFetchFluidState: SF = {\n                ...currentFluidState,\n                ...fetchState?.fluidState,\n            };\n            const combinedFetchViewState: SV = {\n                ...viewState,\n                ...fetchState?.viewState,\n            };\n            const combinedFetchDataProps: C = {\n                ...dataProps,\n                ...fetchState?.dataProps,\n            };\n            const combinedFetchState = {\n                fluidState: combinedFetchFluidState,\n                viewState: combinedFetchViewState,\n                dataProps: combinedFetchDataProps,\n            };\n            const action = selector[type];\n            if (action !== undefined) {\n                if (instanceOfSelectorFunction<SV, SF, C>(action)) {\n                    // Add any new handles that were returned by the selector to our list\n                    // to be loaded to the fluid Fluid object map\n                    let newHandles: IFluidHandle[] = [];\n                    if (\n                        handle !== undefined &&\n                        instanceOfFluidObjectSelectorFunction<SV, SF, C>(action) &&\n                        combinedFetchDataProps.fluidObjectMap.get(\n                            handle.absolutePath,\n                        ) === undefined\n                    ) {\n                        newHandles.push(handle);\n                    }\n                    const actionResult = (action.function as any)(\n                        combinedFetchState,\n                        handle,\n                    );\n                    if (\n                        actionResult !== undefined &&\n                        actionResult.newComponentHandles !== undefined\n                    ) {\n                        newHandles = newHandles.concat(\n                            actionResult.newComponentHandles,\n                        );\n                    }\n                    // If there are handles, start a call to update the Fluid object map and then call the set state\n                    // callback when it has finished to provide the updated map in the state\n                    if (newHandles.length > 0) {\n                        const callback = syncedStateCallbackListener(\n                            combinedFetchDataProps.fluidObjectMap,\n                            storedHandleMap,\n                            syncedStateId,\n                            syncedState,\n                            combinedFetchDataProps.runtime,\n                            combinedFetchState.viewState,\n                            setState,\n                            fluidToView,\n                            viewToFluid,\n                        );\n                        // eslint-disable-next-line @typescript-eslint/no-floating-promises\n                        updateStateAndFluidObjectMap(\n                            newHandles,\n                            combinedFetchDataProps.fluidObjectMap,\n                            storedHandleMap,\n                            true,\n                            syncedStateId,\n                            syncedState,\n                            combinedFetchDataProps.runtime,\n                            combinedFetchState.viewState,\n                            setState,\n                            callback,\n                            fluidToView,\n                            viewToFluid,\n                        );\n                    }\n                    // Always return the result immediately\n                    // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n                    return actionResult;\n                } else {\n                    throw new Error(\n                        `Action with key ${action} does not match an expected selector action interface`,\n                    );\n                }\n            } else {\n                throw new Error(\n                    `Action with key ${action} does not\n                 exist in the selectors provided`,\n                );\n            }\n        },\n        [selector, viewState, setState, dataProps],\n    );\n\n    // The combined selector is then similarly created with the Fluid-specific logic of adding any new Fluid objects\n    // to our Fluid object map interjected into the setState logic\n    const combinedSelector = {};\n    Object.entries(selector).forEach(([functionName, functionItem], i) => {\n        combinedSelector[functionName] = {\n            function: (\n                fetchState: ICombinedState<SV, SF, C>,\n                handle?: IFluidHandle,\n            // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n            ) => fetch(functionName, fetchState, handle),\n        };\n    });\n\n    // Retrieve the current state that is stored on the syncedState for this Fluid object ID\n    const fluidState = getFluidState(\n        syncedStateId,\n        syncedState,\n        dataProps.fluidObjectMap,\n        fluidToView,\n    );\n\n    return [\n        {\n            viewState,\n            fluidState,\n            dataProps,\n        },\n        combinedReducer as A,\n        combinedSelector as B,\n    ];\n}\n"]}

package/lib/useStateFluid.js

@@ -1,44 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import * as React from "react";
-import { initializeState, syncState } from "./helpers";
-/**
- * A wrapper around the useState React hook that combines local and Fluid state updates
- */
-export function useStateFluid(props, initialViewState) {
-    var _a;
-    const { syncedStateId, syncedDataObject, } = props;
-    const config = syncedDataObject.getConfig(syncedStateId);
-    if (config === undefined) {
-        throw Error(`Failed to find configuration for synced state ID: ${syncedStateId}`);
-    }
-    const syncedState = syncedDataObject.syncedState;
-    const dataProps = (_a = props.dataProps) !== null && _a !== void 0 ? _a : syncedDataObject.dataProps;
-    const { fluidToView, viewToFluid } = config;
-    // Establish the react state and setState functions using the initialViewState passed in
-    const [reactState, reactSetState] = React.useState(initialViewState);
-    // If this is the first time this function is being called in this session
-    // It's okay to disable eslint here as the state will be updated with the initialized values
-    // after the async call has finished
-    // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
-    if (!reactState.isInitialized) {
-        // eslint-disable-next-line @typescript-eslint/no-floating-promises
-        initializeState(syncedStateId, syncedState, dataProps, reactState, reactSetState, fluidToView, viewToFluid);
-    }
-    // Create the fluidSetState function as a callback that in turn calls either our combined state
-    // update to both the local and Fluid state or just the local state respectively based off of
-    // if the state update is coming locally, i.e. not from the root
-    const fluidSetState = React.useCallback((newState, fromRootUpdate = false, isLocal = false) => {
-        const newCombinedState = Object.assign(Object.assign(Object.assign({}, reactState), newState), { isInitialized: true });
-        if (isLocal) {
-            reactSetState(newCombinedState);
-        }
-        else {
-            syncState(fromRootUpdate, syncedStateId, syncedState, dataProps.runtime, newCombinedState, reactSetState, dataProps.fluidObjectMap, fluidToView, viewToFluid);
-        }
-    }, [syncedState, viewToFluid, reactState, reactSetState, dataProps]);
-    return [reactState, fluidSetState];
-}
-//# sourceMappingURL=useStateFluid.js.map

package/lib/useStateFluid.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useStateFluid.js","sourceRoot":"","sources":["../src/useStateFluid.tsx"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAO/B,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEvD;;GAEG;AACH,MAAM,UAAU,aAAa,CAIzB,KAA0B,EAAE,gBAAoB;;IAEhD,MAAM,EACF,aAAa,EACb,gBAAgB,GACnB,GAAG,KAAK,CAAC;IACV,MAAM,MAAM,GAAG,gBAAgB,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IACzD,IAAI,MAAM,KAAK,SAAS,EAAE;QACtB,MAAM,KAAK,CAAC,qDAAqD,aAAa,EAAE,CAAC,CAAC;KACrF;IACD,MAAM,WAAW,GAAG,gBAAgB,CAAC,WAAW,CAAC;IACjD,MAAM,SAAS,SAAG,KAAK,CAAC,SAAS,mCAAI,gBAAgB,CAAC,SAAS,CAAC;IAChE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,MAAoC,CAAC;IAC1E,wFAAwF;IACxF,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAK,gBAAgB,CAAC,CAAC;IAEzE,0EAA0E;IAC1E,4FAA4F;IAC5F,oCAAoC;IACpC,yEAAyE;IACzE,IAAI,CAAC,UAAU,CAAC,aAAa,EAAE;QAC3B,mEAAmE;QACnE,eAAe,CACX,aAAa,EACb,WAAW,EACX,SAAS,EACT,UAAU,EACV,aAAa,EACb,WAAW,EACX,WAAW,CACd,CAAC;KACL;IAED,+FAA+F;IAC/F,6FAA6F;IAC7F,gEAAgE;IAChE,MAAM,aAAa,GAAG,KAAK,CAAC,WAAW,CACnC,CAAC,QAAqB,EAAE,cAAc,GAAG,KAAK,EAAE,UAAmB,KAAK,EAAE,EAAE;QACxE,MAAM,gBAAgB,iDACf,UAAU,GACV,QAAQ,KACX,aAAa,EAAE,IAAI,GACtB,CAAC;QACF,IAAI,OAAO,EAAE;YACT,aAAa,CAAC,gBAAgB,CAAC,CAAC;SACnC;aAAM;YACH,SAAS,CACL,cAAc,EACd,aAAa,EACb,WAAW,EACX,SAAS,CAAC,OAAO,EACjB,gBAAgB,EAChB,aAAa,EACb,SAAS,CAAC,cAAc,EACxB,WAAW,EACX,WAAW,CACd,CAAC;SACL;IACL,CAAC,EACD,CAAC,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa,EAAE,SAAS,CAAC,CACnE,CAAC;IACF,OAAO,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;AACvC,CAAC","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    IViewState,\n    IFluidProps,\n    IFluidState,\n    ISyncedStateConfig,\n} from \"./interface\";\nimport { initializeState, syncState } from \"./helpers\";\n\n/**\n * A wrapper around the useState React hook that combines local and Fluid state updates\n */\nexport function useStateFluid<\n    SV extends IViewState,\n    SF extends IFluidState\n>(\n    props: IFluidProps<SV, SF>, initialViewState: SV,\n): [SV, (newState: SV, isSyncedStateUpdate?: boolean) => void] {\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    const syncedState = syncedDataObject.syncedState;\n    const dataProps = props.dataProps ?? syncedDataObject.dataProps;\n    const { fluidToView, viewToFluid } = config as ISyncedStateConfig<SV, SF>;\n    // Establish the react state and setState functions using the initialViewState passed in\n    const [reactState, reactSetState] = React.useState<SV>(initialViewState);\n\n    // If this is the first time this function is being called in this session\n    // It's okay to disable eslint here as the state will be updated with the initialized values\n    // after the async call has finished\n    // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions\n    if (!reactState.isInitialized) {\n        // eslint-disable-next-line @typescript-eslint/no-floating-promises\n        initializeState<SV, SF>(\n            syncedStateId,\n            syncedState,\n            dataProps,\n            reactState,\n            reactSetState,\n            fluidToView,\n            viewToFluid,\n        );\n    }\n\n    // Create the fluidSetState function as a callback that in turn calls either our combined state\n    // update to both the local and Fluid state or just the local state respectively based off of\n    // if the state update is coming locally, i.e. not from the root\n    const fluidSetState = React.useCallback(\n        (newState: Partial<SV>, fromRootUpdate = false, isLocal: boolean = false) => {\n            const newCombinedState = {\n                ...reactState,\n                ...newState,\n                isInitialized: true,\n            };\n            if (isLocal) {\n                reactSetState(newCombinedState);\n            } else {\n                syncState(\n                    fromRootUpdate,\n                    syncedStateId,\n                    syncedState,\n                    dataProps.runtime,\n                    newCombinedState,\n                    reactSetState,\n                    dataProps.fluidObjectMap,\n                    fluidToView,\n                    viewToFluid,\n                );\n            }\n        },\n        [syncedState, viewToFluid, reactState, reactSetState, dataProps],\n    );\n    return [reactState, fluidSetState];\n}\n"]}

package/src/createContextFluid.tsx

@@ -1,33 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import * as React from "react";
-import {
-    IViewState,
-    IFluidContextProps,
-    FluidContext,
-    IFluidState,
-} from "./interface";
-import { useStateFluid } from "./useStateFluid";
-
-export function createContextFluid<
-    SV extends IViewState,
-    SF extends IFluidState,
-    C
->(props: IFluidContextProps<SV, SF, C>, initialViewState: SV): FluidContext<SV, C> {
-    const [state, setState] = useStateFluid(props, initialViewState);
-    const PrimedFluidContext = React.createContext({
-        state,
-        setState,
-        reactContext: props.reactContext ?? {},
-    });
-    return {
-        Provider: PrimedFluidContext.Provider,
-        Consumer: PrimedFluidContext.Consumer,
-        usePrimedContext: () => React.useContext(PrimedFluidContext),
-        state,
-        setState,
-    };
-}

package/src/helpers/generateFluidObjectSchema.ts

@@ -1,95 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
-import { SharedMap } from "@fluidframework/map";
-import {
-    IFluidState,
-    IViewState,
-    ViewToFluidMap,
-    FluidToViewMap,
-    IFluidSchema,
-} from "../interface";
-
-/**
- * Identifies which values within the Fluid and view states match
- * The view and Fluid matching map identify if the value in the respective states
- * needs a converter or not
- * @param runtime - The data store runtime used to create the SharedMap objects
- * @param fluidToView - The Fluid to view state conversion mapping
- * @param viewToFluid - The view to Fluid conversion state mapping
- * */
-export function generateFluidObjectSchema<
-    SV extends IViewState,
-    SF extends IFluidState
->(
-    runtime: IFluidDataStoreRuntime,
-    defaultViewState: SV,
-    fluidToView: FluidToViewMap<SV, SF>,
-    viewToFluid?: ViewToFluidMap<SV, SF>,
-): IFluidSchema {
-    // matching primitives w/ the same key in view and fluid
-    // true if needs converter or is a Fluid object, false if not
-    const viewMatchingMap = SharedMap.create(runtime);
-    const fluidMatchingMap = SharedMap.create(runtime);
-    const storedHandleMap = SharedMap.create(runtime);
-    for (const fluidStateKey of fluidToView.keys()) {
-        const value = fluidToView.get(fluidStateKey);
-        if (value === undefined) {
-            throw Error("Cannot find fluidToView value");
-        }
-        const {
-            type,
-            viewKey,
-            viewConverter,
-        } = value;
-        const fluidConverter = viewToFluid?.get(viewKey);
-        if (fluidConverter === undefined) {
-            if (
-                defaultViewState[viewKey] !== undefined
-                && typeof (defaultViewState[viewKey]) !== type
-                && type !== "any"
-            ) {
-                throw Error(`Failed to find Fluid converter for key ${viewKey}`);
-            } else {
-                continue;
-            }
-        }
-        if (type === fluidConverter.type) {
-            fluidMatchingMap.set(fluidStateKey as string, false);
-        } else if (viewConverter !== undefined) {
-            fluidMatchingMap.set(fluidStateKey as string, true);
-        } else {
-            throw Error(`Failed to find view converter for Fluid key ${fluidStateKey}`);
-        }
-    }
-
-    if (viewToFluid !== undefined) {
-        for (const viewStateKey of viewToFluid.keys()) {
-            const value = viewToFluid.get(viewStateKey);
-            if (value === undefined) {
-                throw Error("Cannot find viewToFluid value");
-            }
-            const {
-                type,
-                fluidKey,
-                fluidConverter,
-            } = value;
-            const viewConverter = fluidToView.get(fluidKey);
-            if (viewConverter === undefined) {
-                throw Error(`Failed to find view converter for key ${fluidKey}`);
-            }
-            if (type === viewConverter.type) {
-                viewMatchingMap.set(viewStateKey as string, false);
-            } else if (fluidConverter !== undefined) {
-                viewMatchingMap.set(viewStateKey as string, true);
-            } else {
-                throw Error(`Failed to find Fluid converter for view key ${viewStateKey}`);
-            }
-        }
-    }
-
-    return { viewMatchingMap, fluidMatchingMap, storedHandleMap };
-}

package/src/helpers/getFluidFromView.ts

@@ -1,38 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import {
-    IFluidConverter,
-    IViewState,
-    IFluidState,
-} from "../interface";
-
-/**
- * Return a partial Fluid state containing the view state key identified converted into its
- * corresponding Fluid state value in the partial Fluid state returned
- * @param state - The current view state
- * @param viewKey - The view state key that needs to converted to its Fluid state
- * @param viewToFluid - A map of the view state values that need conversion to their Fluid state counterparts and the
- * respective converters
- */
-export function getFluidFromView<
-    SV extends IViewState,
-    SF extends IFluidState
->(
-    state: SV,
-    viewKey: keyof SV,
-    fluidState: SF,
-    viewToFluid?: Map<keyof SV, IFluidConverter<SV, SF>>,
-): Partial<SF> {
-    const fluidConverter = viewToFluid?.get(viewKey)?.fluidConverter;
-    if (fluidConverter !== undefined) {
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
-        return fluidConverter(state, fluidState);
-    } else {
-        const partialFluidState: Partial<SF> = {};
-        partialFluidState[viewKey as string] = state[viewKey];
-        return partialFluidState;
-    }
-}

package/src/helpers/getFluidState.ts

@@ -1,67 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import {
-    IFluidObject,
-    IFluidHandle,
-} from "@fluidframework/core-interfaces";
-import { ISharedMap, SharedMap } from "@fluidframework/map";
-import {
-    IViewConverter,
-    FluidObjectMap,
-    IViewState,
-    IFluidState,
-    ISyncedState,
-    IFluidObjectMapItem,
-} from "..";
-
-/**
- * Return the Fluid state from the syncedState with all handles converted into Fluid objects
- * @param syncedStateId - Unique ID for the synced state of this view
- * @param syncedState - Shared map the synced state is stored on
- * @param fluidObjectMap - Map of Fluid handle paths to their respective Fluid objects
- * @param fluidToView - Map of the Fluid state keys contains the optional syncedState key parameter,
- * in case the Fluid value is stored in the syncedState under a different key
- */
-export function getFluidState<
-    SV extends IViewState,
-    SF extends IFluidState
->(
-    syncedStateId: string,
-    syncedState: ISyncedState,
-    fluidObjectMap: FluidObjectMap,
-    fluidToView?: Map<keyof SF, IViewConverter<SV, SF>>,
-): SF | undefined {
-    const fluidObjectStateHandle = syncedState.get<IFluidHandle<ISharedMap>>(
-        `syncedState-${syncedStateId}`,
-    );
-    if (fluidObjectStateHandle === undefined) {
-        return;
-    }
-    const fluidObjectState = fluidObjectMap.get(fluidObjectStateHandle.absolutePath)
-        ?.fluidObject as SharedMap;
-    if (fluidObjectState === undefined) {
-        return;
-    }
-    const fluidState = {};
-    for (const fluidKey of fluidObjectState.keys()) {
-        const createCallback = fluidToView?.get(fluidKey as keyof SF)
-            ?.sharedObjectCreate;
-        let value = fluidObjectState.get(fluidKey);
-        if (value !== undefined && createCallback !== undefined) {
-            const possibleFluidObjectId = (value as IFluidObject)
-                ?.IFluidHandle?.absolutePath;
-            if (possibleFluidObjectId !== undefined) {
-                value = (fluidObjectMap.get(possibleFluidObjectId)) as IFluidObjectMapItem;
-                fluidState[fluidKey] = value?.fluidObject;
-            } else {
-                fluidState[fluidKey] = value;
-            }
-        } else {
-            fluidState[fluidKey] = value;
-        }
-    }
-    return fluidState as SF;
-}

package/src/helpers/getSchema.ts

@@ -1,18 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { ISyncedState } from "../interface";
-import { IFluidSchemaHandles } from "./internalInterface";
-
-/**
- * Returns the schema stored on the synced state for this Fluid object
- * @param syncedStateId - Unique ID for this synced data object's state
- * @param syncedState - The shared map this Fluid shared state is stored on
- */
-export const getSchema = (
-    syncedStateId: string,
-    syncedState: ISyncedState,
-): IFluidSchemaHandles | undefined =>
-    syncedState.get<IFluidSchemaHandles>(`schema-${syncedStateId}`);

package/src/helpers/getViewFromFluid.ts

@@ -1,68 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { IFluidObject } from "@fluidframework/core-interfaces";
-import {
-    FluidObjectMap,
-    IViewConverter,
-    IViewState,
-    IFluidState,
-    ISyncedState,
-} from "../interface";
-import { getFluidState } from "./getFluidState";
-
-/**
- * Return a partial view state containing the Fluid state key identified converted into its
- * corresponding view state value in the partial view state returned
- * @param syncedStateId - Unique ID for the synced state of this view
- * @param syncedState - The shared map this shared state is stored on
- * @param fluidKey - The key of the value within the Fluid state that we want converted
- * @param fluidObjectMap - A map of Fluid handle paths to their Fluid objects
- * @param fluidToView - A map of the Fluid state values that need conversion to their view state counterparts and the
- * respective converters
- * @param combinedFluidState - Optional param containing the combined Fluid state so far to fetch from
- */
-export function getViewFromFluid<
-    SV extends IViewState,
-    SF extends IFluidState
->(
-    syncedStateId: string,
-    syncedState: ISyncedState,
-    fluidKey: keyof SF,
-    fluidObjectMap: FluidObjectMap,
-    fluidToView: Map<keyof SF, IViewConverter<SV, SF>>,
-    viewState: SV,
-    combinedFluidState?: Partial<SF>,
-): Partial<SV> {
-    const fluidObjectState = getFluidState(
-        syncedStateId,
-        syncedState,
-        fluidObjectMap,
-        fluidToView,
-    );
-    if (fluidObjectState === undefined) {
-        throw Error(
-            "Attempted to fetch view from Fluid state before it was initialized",
-        );
-    }
-    let value = fluidObjectState[fluidKey];
-    if (combinedFluidState !== undefined) {
-        value = combinedFluidState[fluidKey] ?? value;
-    }
-    const viewConverter = fluidToView.get(fluidKey)?.viewConverter;
-    if (viewConverter !== undefined) {
-        const partialFluidState: Partial<SF> = {};
-        partialFluidState[fluidKey] = value;
-        return viewConverter(viewState, partialFluidState, fluidObjectMap);
-    } else {
-        const partialViewState: Partial<SV> = {};
-        const valueAsIFluidHandle = (value as IFluidObject).IFluidHandle;
-        const convertedValue = valueAsIFluidHandle !== undefined
-            ? fluidObjectMap.get(valueAsIFluidHandle.absolutePath)
-            : value;
-        partialViewState[fluidKey as string] = convertedValue;
-        return partialViewState;
-    }
-}

package/src/helpers/index.tsx

@@ -1,16 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-export * from "./getFluidFromView";
-export * from "./getViewFromFluid";
-export * from "./rootCallbackListener";
-export * from "./syncState";
-export * from "./updateStateAndFluidObjectMap";
-export * from "./generateFluidObjectSchema";
-export * from "./getFluidState";
-export * from "./setFluidState";
-export * from "./getSchema";
-export * from "./setComponentSchema";
-export * from "./initializeState";

package/src/helpers/initializeState.ts

@@ -1,162 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { IFluidHandle } from "@fluidframework/core-interfaces";
-import {
-    IValueChanged,
-    SharedMap,
-} from "@fluidframework/map";
-import {
-    IFluidDataProps,
-    FluidToViewMap,
-    ViewToFluidMap,
-    IViewState,
-    IFluidState,
-    ISyncedState,
-} from "../interface";
-import {
-    syncedStateCallbackListener,
-    updateStateAndFluidObjectMap,
-    getSchema,
-    getFluidState,
-} from ".";
-
-/**
- * Fetch the synced state for this view from the SyncedDataObject sharedState and add
- * listeners for all state updates
- * @param syncedStateId - Unique ID for this synced data object's state
- * @param syncedState - The synced data object's shared state map
- * @param fluidToView - A map of the Fluid state values that need conversion to their view state counterparts and the
- * respective converters
- * @param dataProps - Contains the runtime and fluidObjectMap to create and store DDSes
- * @param state - Current view state
- * @param setState - Callback to update view state
- * @param viewToFluid - A map of the view state values that need conversion to their Fluid state counterparts and the
- * respective converters
- * @param fluidToView - A map of the Fluid state values that need conversion to their view state counterparts and the
- * respective converters
- */
-export async function initializeState<
-    SV extends IViewState,
-    SF extends IFluidState
->(
-    syncedStateId: string,
-    syncedState: ISyncedState,
-    dataProps: IFluidDataProps,
-    state: SV,
-    setState: (
-        newState: SV,
-        fromRootUpdate?: boolean,
-        isLocal?: boolean
-    ) => void,
-    fluidToView: FluidToViewMap<SV, SF>,
-    viewToFluid?: ViewToFluidMap<SV, SF>,
-): Promise<void> {
-    const schemaHandles = getSchema(
-        syncedStateId,
-        syncedState,
-    );
-    if (schemaHandles?.storedHandleMapHandle.absolutePath === undefined) {
-        throw Error(`Schema not initialized prior to render for ${syncedStateId}`);
-    }
-    const storedHandleMap = dataProps.fluidObjectMap.get(
-        schemaHandles?.storedHandleMapHandle.absolutePath,
-    )?.fluidObject as SharedMap;
-    if (storedHandleMap === undefined) {
-        throw Error(`Stored handle map not initialized prior to render for ${syncedStateId}`);
-    }
-    const unlistenedHandles: IFluidHandle[] = [];
-    for (const handle of storedHandleMap.values()) {
-        unlistenedHandles.push(handle);
-    }
-
-    const currentFluidState = getFluidState(
-        syncedStateId,
-        syncedState,
-        dataProps.fluidObjectMap,
-        fluidToView,
-    );
-    if (currentFluidState === undefined) {
-        throw Error("Synced state update triggered before Fluid state was initialized");
-    }
-
-    for (const fluidStateKey of fluidToView.keys()) {
-        const value = fluidToView.get(fluidStateKey);
-        if (value === undefined) {
-            throw Error("Cannot find fluidToView value");
-        }
-        if (value.sharedObjectCreate !== undefined) {
-            const fluidObject = currentFluidState[fluidStateKey] as any;
-            unlistenedHandles.push(fluidObject.handle);
-        }
-    }
-
-    state.isInitialized = true;
-    state.syncedStateId = syncedStateId;
-    // Define the synced state callback listener that will be responsible for triggering state updates on synced state
-    // value changes
-    const syncedStateCallback = (
-        change: IValueChanged,
-        local: boolean,
-    ) => {
-        const callback = syncedStateCallbackListener(
-            dataProps.fluidObjectMap,
-            storedHandleMap,
-            syncedStateId,
-            syncedState,
-            dataProps.runtime,
-            state,
-            setState,
-            fluidToView,
-            viewToFluid,
-        );
-        return callback(change, local);
-    };
-
-    // Add the callback to the fluidObject's own synced state
-    syncedState.addValueChangedListener(syncedStateCallback);
-    storedHandleMap.on("valueChanged", (
-        change: IValueChanged,
-        local: boolean,
-    ) => {
-        const handle = storedHandleMap.get<IFluidHandle>(change.key);
-        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
-        if (handle !== undefined && !state.fluidObjectMap?.has(handle.absolutePath)) {
-            state.fluidObjectMap?.set(handle.absolutePath, {
-                isListened: false,
-            });
-            // eslint-disable-next-line @typescript-eslint/no-floating-promises
-            updateStateAndFluidObjectMap<SV, SF>(
-                [handle],
-                dataProps.fluidObjectMap,
-                storedHandleMap,
-                true,
-                syncedStateId,
-                syncedState,
-                dataProps.runtime,
-                state,
-                setState,
-                syncedStateCallback,
-                fluidToView,
-                viewToFluid,
-            );
-        }
-    });
-
-    return updateStateAndFluidObjectMap<SV, SF>(
-        unlistenedHandles,
-        dataProps.fluidObjectMap,
-        storedHandleMap,
-        true,
-        syncedStateId,
-        syncedState,
-        dataProps.runtime,
-        state,
-        setState,
-        syncedStateCallback,
-        fluidToView,
-        viewToFluid,
-    );
-}

package/src/helpers/internalInterface.ts

@@ -1,16 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { IFluidHandle } from "@fluidframework/core-interfaces";
-import { ISharedMap } from "@fluidframework/map";
-
-/**
- * The respective handles for the Fluid schema params listed above
- */
-export interface IFluidSchemaHandles {
-    viewMatchingMapHandle: IFluidHandle<ISharedMap>;
-    fluidMatchingMapHandle: IFluidHandle<ISharedMap>;
-    storedHandleMapHandle: IFluidHandle<ISharedMap>;
-}